Bill tax entries

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

List bill tax entries

get/objects/accounts-payable/bill-tax-entry

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

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "8",
      • "id": "8",
      • "href": "/objects/accounts-payable/bill-tax-entry/8"
      },
    • {
      • "key": "9",
      • "id": "9",
      • "href": "/objects/accounts-payable/bill-tax-entry/9"
      },
    • {
      • "key": "10",
      • "id": "10",
      • "href": "/objects/accounts-payable/bill-tax-entry/10"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Get a bill tax entry
get/objects/accounts-payable/bill-tax-entry/{key}
Returns detailed information for a specified bill tax entry.


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


 
 Example:  113
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "300",
    • "id": "300",
    • "baseTaxAmount": "100",
    • "txnTaxAmount": "100",
    • "taxRate": 5.5,
    • "purchasingTaxDetail": {
      • "id": "UK Export Reduced Rate",
      • "key": "24",
      • "href": "/objects/tax/purchasing-tax-detail/24"
      },
    • "billLine": {
      • "id": "148",
      • "key": "148",
      • "href": "/objects/accounts-payable/bill-line/148"
      },
    • "href": "/objects/accounts-payable/bill-tax-entry/300"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Query bill tax entries
post/services/core/query
Use the query service to find bill 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
    }
}