POST
Simulate tax on a price
Company space For: Manager, Accountant · Permission: taxes.simulate Conditions
  • stockable_id must be an item of the organization; a bundle must belong to the current company.
  • stockable_unit_id, when sent, must be a unit of that item.
  • price is in major units, at least 0, with at most the currency’s decimals.
  • stockable_price_id is refused.
  • A price that the configured taxes cannot split (below its inclusive fixed taxes, for example) is refused.
What else happens
  • Nothing is stored: the result is computed only.
  • The answer is 200 with the simulated amounts, in major units.
Part of Set up VAT and the other taxes.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

TaxSimulationResource

gross
number | null
required

Price sent, as total including taxes that are included in it, in major units.

before_vat_amount
number | null
required

Amount on which VAT is computed (net plus the taxes VAT depends on), in major units; equals total when no VAT line applies.

vat_amount
number | null
required

VAT amount, in major units.

after_vat_amount
number | null
required

before_vat_amount plus VAT only, in major units; other taxes stay out of it.

net
number | null
required

Net price without taxes, in major units.

total
number | null
required

Amount to pay including all taxes added on top, in major units.

product_nature
string
required

Nature of the priced item, as resolved for the item.

tax_resolution
string
required

How the tax setup of the item was resolved. untaxed_unconfigured and untaxed_not_taxable mean no tax lines apply.

rounding
object | null
required

Rounding remainder assigned by the extraction; null when there was none.

tax_lines
array
required

One line per applied tax (VAT first): tax_id, tax_kind, tax_name, tax_code, amount_type, configured_rate, configured_fixed_amount, vat_treatment, inclusion_policy, base_amount, dependency_tax_amount, taxable_amount, tax_amount (amounts in major units) and dependencies.