Invoice tax entries

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

List invoice tax entries

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

Returns a collection with a key, ID, and link for each 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/invoice-tax-entry/8"
      },
    • {
      • "key": "9",
      • "id": "9",
      • "href": "/objects/accounts-receivable/invoice-tax-entry/9"
      },
    • {
      • "key": "10",
      • "id": "10",
      • "href": "/objects/accounts-receivable/invoice-tax-entry/10"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Get an invoice tax entry
get/objects/accounts-receivable/invoice-tax-entry/{key}
Returns detailed information for a specified invoice tax entry.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the invoice tax entry.


 
 Example:  113
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "id": "2704",
    • "key": "2704",
    • "invoiceLine": {
      • "id": "2702",
      • "key": "2702",
      • "href": "/objects/accounts-receivable/invoice-line/2702"
      },
    • "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/invoice-tax-entry/2704"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Query invoice tax entries
post/services/core/query
Use the query service to find 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
    }
}