Other receipt tax entries

For VAT enabled transactions, other receipt line items will have tax entries. Providing multiple entries is allowed if the tax solution supports it (AU, GB, FR). For ZA, only one tax entry is allowed.

List other receipts tax entries

get/objects/cash-management/other-receipt-tax-entry

Returns a collection of other receipts tax entries. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned.

SecurityOAuth2
Responses
200

OK

400

Bad Request

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


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


 
 Example:  99
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "300",
    • "id": "300",
    • "baseTaxAmount": "100",
    • "txnTaxAmount": "100",
    • "description": "Standard Rate for UK Import Services",
    • "taxRate": 5.5,
    • "taxDetail": {
      • "id": "UK Export Reduced Rate",
      • "key": "24",
      • "href": "/objects/tax/order-entry-tax-detail/24"
      },
    • "otherReceiptLine": {
      • "id": "148",
      • "key": "148",
      • "href": "/objects/cash-management/other-receipt-line/148"
      },
    • "href": "/objects/cash-management/tax/other-receipt-tax-entry/300"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Query other receipt tax entries
post/services/core/query
Use the query service to find other receipt 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
    }
}