Adjustment tax entries

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

List adjustment tax entries

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

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

Get an adjustment tax entry

get/objects/accounts-payable/adjustment-tax-entry/{key}

Returns detailed information for a specified adjustment tax entry.

SecurityOAuth2
Request
path Parameters
key
required
string

System-assigned key for the adjustment tax entry.

Example: 186
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"
      },
    • "adjustmentLine": {
      • "id": "148",
      • "key": "148",
      • "href": "/objects/accounts-payable/adjustment-line/148"
      },
    • "href": "/objects/accounts-payable/adjustment-tax-entry/300"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}

Query adjustment tax entries

post/services/core/query

Use the query service to find adjustment 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
    }
}