order_id string, not null
The unique identifier of the order.
date_from timestamp, null
Indicates the service period start of the tax rate for the line item.
date_to timestamp, null
Indicates the service period end of the tax rate for the line item.
is_non_compliance_tax boolean, null
Indicates whether the tax is a non-compliance tax that should not be reported to the jurisdiction. Possible values are:
false
: This is a compliance tax and should be reported to the jurisdiction.true
: This is a non-compliance tax and should not be reported to the jurisdiction.
is_partial_tax_applied boolean, null
Indicates if tax is applied only on a portion of the line item amount. Possible values are:
false
: Tax is applied on the full line item amount.true
: Tax is applied only on a portion of the line item amount.
line_item_id string, null
The unique reference id of the line item for which the tax is applicable
local_currency_code string, null
The currency code (
ISO 4217 format) of the place of supply in which VAT needs to be converted and displayed. This is applicable only for Invoice and Credit Notes API.
prorated_taxable_amount decimal, null
Indicates the prorated line item amount in cents.
tax_amount long, not null
The tax amount
tax_amount_in_local_currency long, null
Total tax amount in the currency of the place of supply. This is applicable only for Invoice and Credit Notes API.
tax_juris_code string, null
The tax jurisdiction code
tax_juris_name string, null
The name of the tax jurisdiction
tax_juris_type string, null
The type of tax jurisdiction. Possible values are:
city
: The tax jurisdiction is a city.country
: The tax jurisdiction is a country.county
: The tax jurisdiction is a county.federal
: The tax jurisdiction is a federal.special
: Special tax jurisdiction.state
: The tax jurisdiction is a state.unincorporated
: Combined tax of state and county.other
: Jurisdictions other than the ones listed above.
tax_name string, not null
The name of the tax applied
tax_rate double, not null, default=0
The rate of tax used to calculate tax amount
taxable_amount long, not null
Indicates the actual portion of the line item amount that is taxable.