TaxEntry
Tax calculation entry for a specific line item or document. References a Tax definition and calculates the actual tax amount applied. Used in CommercialDocument.taxDetails[].
6 properties
Schema
Properties
| Property | Type | Mode | Description | Required |
|---|---|---|---|---|
| tax | Tax | stored | Reference to the Tax entity (contains code, name, type, rate, jurisdiction) | Required |
| taxableAmount | MonetaryAmount | stored | Amount subject to this tax (base for calculation) | Required |
| taxAmount | MonetaryAmount | computed | Calculated tax amount (taxableAmount * tax.rate / 100 or per tax.calculationMethod) | Optional |
| appliedRate | number | stored | Actual rate applied (may differ from tax.rate due to exemptions or overrides) Example: | Optional |
| isExempt | boolean | stored | Whether this line is tax exempt (overrides normal tax application) | Optional |
| exemptionReason | string | stored | Reason for tax exemption if isExempt is true Example: | Optional |
Examples
Example 1
{
"@type": "TaxEntry",
"tax": {
"@type": "Tax",
"code": "VAT-STD-20",
"name": "VAT Standard Rate",
"taxType": "vat",
"rate": 20,
"jurisdiction": "FR"
},
"taxableAmount": {
"@type": "MonetaryAmount",
"value": 1000,
"currency": {
"@type": "Currency",
"code": "EUR",
"symbol": "€"
}
},
"taxAmount": {
"@type": "MonetaryAmount",
"value": 200,
"currency": {
"@type": "Currency",
"code": "EUR",
"symbol": "€"
}
},
"appliedRate": 20,
"isExempt": false
}Example 2
{
"@type": "TaxEntry",
"tax": {
"@type": "Tax",
"code": "NY-SALES-8.875",
"name": "New York Sales Tax",
"taxType": "sales_tax",
"rate": 8.875,
"jurisdiction": "NY"
},
"taxableAmount": {
"@type": "MonetaryAmount",
"value": 500,
"currency": {
"@type": "Currency",
"code": "USD",
"symbol": "$"
}
},
"taxAmount": {
"@type": "MonetaryAmount",
"value": 44.38,
"currency": {
"@type": "Currency",
"code": "USD",
"symbol": "$"
}
},
"appliedRate": 8.875,
"isExempt": false
}Example 3
{
"@type": "TaxEntry",
"tax": {
"@type": "Tax",
"code": "VAT-RED-5.5",
"name": "VAT Reduced Rate",
"taxType": "vat",
"rate": 5.5,
"jurisdiction": "FR"
},
"taxableAmount": {
"@type": "MonetaryAmount",
"value": 100,
"currency": {
"@type": "Currency",
"code": "EUR",
"symbol": "€"
}
},
"taxAmount": {
"@type": "MonetaryAmount",
"value": 0,
"currency": {
"@type": "Currency",
"code": "EUR",
"symbol": "€"
}
},
"appliedRate": 0,
"isExempt": true,
"exemptionReason": "Essential food product - exempt from VAT"
}