Credit card transaction tax entries

For VAT enabled transactions, the credit card transaction line item 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 credit card transaction tax entries

get/objects/cash-management/credit-card-txn-tax-entry

Returns a collection with a key, ID, and link for each credit card transaction tax entry.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples
Response samples
application/json
{
  • "ia::result": [
    • {
      • "key": "792",
      • "id": "792",
      • "href": "/objects/cash-management/credit-card-txn-tax-entry/792"
      },
    • {
      • "key": "797",
      • "id": "797",
      • "href": "/objects/cash-management/credit-card-txn-tax-entry/797"
      },
    • {
      • "key": "831",
      • "id": "831",
      • "href": "/objects/cash-management/credit-card-txn-tax-entry/831"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}

Get a credit card transaction tax entry

get/objects/cash-management/credit-card-txn-tax-entry/{key}

Returns detailed information for a particular credit card transaction tax entry.

SecurityOAuth2
Request
path Parameters
key
required
string

system-assigned unique key for the credit card transaction tax entry.

Example: 103
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,
    • "purchasingTaxDetail": {
      • "id": "UK Export Reduced Rate",
      • "key": "24",
      • "href": "/objects/tax/purchasing-tax-detail/24"
      },
    • "creditCardTxnLine": {
      • "id": "148",
      • "key": "148",
      • "href": "/objects/cash-management/credit-card-txn-line/148"
      },
    • "href": "/objects/cash-management/tax/credit-card-txn-tax-entry/300"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}

Query credit card transaction tax entries

post/services/core/query

Use the query service to find credit card transaction tax entries that meet certain criteria and to specify the properties that are returned.

SecurityOAuth2
Responses
200

OK

Request samples