Sign in
TaxConfigurations

Test a tax calculation.

Use this endpoint to test a tax calculation for the given tax configuration.

post/shop/tax-configurations/{taxConfigurationId}/calculate

Request body

amountstring integer

Test the tax configuration with the given customer-facing amount.

datestring date-time nullable

Test the tax configuration as it would be applied on the given date.

Response

The results of a tax calculation for a tax configuration.

Example response

{
  "data": {
    "net_amount": 1667,
    "gross_amount": 10000,
    "taxes": [
      {
        "name": "VAT",
        "percentage": 20,
        "amount": 1667,
        "base_amount": 8333,
        "item_amount": 10000,
        "included_remainder": 1
      }
    ]
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.