Recurring invoice tax entries

For VAT enabled transactions, recurring invoice line items will have tax entries.

List recurring invoice tax entries

get/objects/accounts-receivable/recurring-invoice-tax-entry

Returns a collection with a key, ID, and link for each recurring invoice tax entry.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples
Response samples
application/json
{
  • "ia::result": [
    • {
      • "key": "8",
      • "id": "8",
      • "href": "/objects/accounts-receivable/recurring-invoice-tax-entry/8"
      },
    • {
      • "key": "9",
      • "id": "9",
      • "href": "/objects/accounts-receivable/recurring-invoice-tax-entry/9"
      },
    • {
      • "key": "10",
      • "id": "10",
      • "href": "/objects/accounts-receivable/recurring-invoice-tax-entry/10"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}

Get a recurring invoice tax entry

get/objects/accounts-receivable/recurring-invoice-tax-entry/{key}

Returns detailed information for a specified recurring invoice tax entry.

SecurityOAuth2
Request
path Parameters
key
required
string

System-assigned key for the recurring invoice tax entry.

Example: 92
Responses
200

OK

400

Bad Request

Request samples
Response samples
application/json
{
  • "ia::result": {
    • "id": "52",
    • "key": "52",
    • "recurringInvoiceLine": {
      • "id": "51",
      • "key": "51",
      • "href": "/objects/accounts-receivable/recurring-invoice-line/51"
      },
    • "baseTaxAmount": "40.00",
    • "txnTaxAmount": "40.00",
    • "taxRate": 10,
    • "orderEntryTaxDetail": {
      • "id": "G1 Goods and Services Tax",
      • "key": "20",
      • "href": "/objects/tax/order-entry-tax-detail/20"
      },
    • "href": "/objects/accounts-receivable/recurring-invoice-tax-entry/52"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}

Query recurring invoice tax entries

post/services/core/query

Use the query service to find recurring invoice tax entries that meet certain criteria and to specify the properties that are returned.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples
Response samples
application/json
{
  • "ia::result": {
    • "ia::error": {
      • "code": "invalidRequest",
      • "message": "A POST request requires a payload",
      • "errorId": "REST-1028",
      • "additionalInfo": {
        },
      • "supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
      }
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 0,
    • "totalError": 1
    }
}