Skip to main content

TaxCalculationRequest

currencystringnullable

ISO 4217 currency; when omitted, uses the requested location's default, or the organization's configured default location's currency when no location is supplied. The currency must be supported by that active, organization-owned location.

Possible values: Value must match regular expression [A-Za-z]{3}

customerAddress objectnullable
citystringnullable
countrystring
line1stringnullable
line2stringnullable
postalCodestringnullable
statestringnullable
lineItems object[]required
  • Array [
  • amountinteger<int64>required

    Possible values: >= 0

    categoryCodestringnullable
    descriptionstringrequired

    Possible values: non-empty

    idstringrequired

    Possible values: non-empty

    taxableboolean
  • ]
  • locationIdstringnullable
    organizationIdstringrequired

    Possible values: non-empty

    taxConfigSnapshot object[]nullable
  • Array [
  • activebooleanrequired
    appliesToCategorystringnullable
    effectiveFromstringrequired
    effectiveTostringnullable
    idstringrequired
    jurisdictionCodestringrequired
    jurisdictionNamestringnullable
    jurisdictionTypestringrequired
    labelstringnullable
    priorityinteger<int32>required
    rateAmountMinorinteger<int64>nullable
    rateBpsinteger<int32>nullable
    rateTypestringrequired
    scopestringrequired
    scopeIdstringrequired
    taxBasisstringrequired
  • ]
  • transactionTimestampstring<date-time>nullable
    TaxCalculationRequest
    {
    "currency": "string",
    "customerAddress": {
    "city": "string",
    "country": "string",
    "line1": "string",
    "line2": "string",
    "postalCode": "string",
    "state": "string"
    },
    "lineItems": [
    {
    "amount": 0,
    "categoryCode": "string",
    "description": "string",
    "id": "string",
    "taxable": true
    }
    ],
    "locationId": "string",
    "organizationId": "string",
    "taxConfigSnapshot": [
    {
    "active": true,
    "appliesToCategory": "string",
    "effectiveFrom": "string",
    "effectiveTo": "string",
    "id": "string",
    "jurisdictionCode": "string",
    "jurisdictionName": "string",
    "jurisdictionType": "string",
    "label": "string",
    "priority": 0,
    "rateAmountMinor": 0,
    "rateBps": 0,
    "rateType": "string",
    "scope": "string",
    "scopeId": "string",
    "taxBasis": "string"
    }
    ],
    "transactionTimestamp": "2024-07-29T15:51:28.071Z"
    }