Calculate tax for a document

post https://api.nitrobox.io/v2/tax/calculate/documents

Calculate tax information for a specific document. For more information on tax calculation please see the model below.

Body Params

requestId

string

If forecast leave null. If not forecast mandatory.

billingGroupIdent

string

Billing group ident to control billing group specific configurations.
Must not be blank.

referencedDocumentNumber

string

Reference document number for credit notes.

type

string

Type of the document.
Must not be null.
Must be one of:

INVOICE

CREDIT_MEMO

ORDER

DEPOSIT_INVOICE

DEPOSIT_INVOICE_CANCELLATION

CREDIT_MEMO_GOODWILL

CREDIT_MEMO_WARRANTY

SELF_BILLING_INVOICE

SELF_BILLING_INVOICE_CORRECTION

UNKNOWN

documentDateTime

date-time

The date of the document. Mandatory for Avalara if not a forecast.

customer

object

required

Customer details.

items

array of objects

required

List of line items of the document. Must not be empty.
Must not be empty.

items*

forecast

boolean

Defaults to false

Tax calculation forecast.

vatIdValidationResult

object

Result of the VAT ID validation for this customer. If it is used in a request, it overwrites any VAT ID validation.

properties

array of objects

Document properties.

properties

Responses

Response body

object

int64

deprecated

DEPRECATED

transactionCode

string

totalAmount

object

Structure containing the result of the tax calculation. All numbers are rounded to a scale of 4 with bankers' rounding.

tax

number

Calculated tax for the total of all quantities of one item before discounts.
Must be a number with up to 19 integral digits and up to 4 fractional digits.

net

number

Calculated net for the total of all quantities of one item after discounts.
Must be a number with up to 19 integral digits and up to 4 fractional digits.

gross

number

Calculated gross for the price of one unit of an item.
Must be a number with up to 19 integral digits and up to 4 fractional digits.

originalTotalAmount

object

Structure containing the result of the tax calculation. All numbers are rounded to a scale of 4 with bankers' rounding.

tax

number

Calculated tax for the total of all quantities of one item before discounts.
Must be a number with up to 19 integral digits and up to 4 fractional digits.

net

number

Calculated net for the total of all quantities of one item after discounts.
Must be a number with up to 19 integral digits and up to 4 fractional digits.

gross

number

Calculated gross for the price of one unit of an item.
Must be a number with up to 19 integral digits and up to 4 fractional digits.

totalTaxSummary

array of objects

deprecated

DEPRECATED

totalTaxSummary

object

rowTotalTax

number

originalTotalTax

number

taxType

string

taxName

string

taxRate

number

taxCode

string

jurisdiction

object

lineItems

array of objects

lineItems

object

ident

string

taxProviderProductCode

string

taxRate

number

currency

string

required

The currency. Must be one of:

unitPrice

object

Structure containing the result of the tax calculation. All numbers are rounded to a scale of 4 with bankers' rounding.

rowTotal

object

Structure containing the result of the tax calculation. All numbers are rounded to a scale of 4 with bankers' rounding.

originalRowTotal

object

Structure containing the result of the tax calculation. All numbers are rounded to a scale of 4 with bankers' rounding.

taxProviderType

string

taxLocation

object

Location details.

taxInformation

array of objects

taxInformation

object

rowTotalTax

number

originalRowTotalTax

number

unitPriceTax

number

taxType

string

taxName

string

taxRate

number

taxCode

string

jurisdiction

object

properties

array of objects

properties

object

key

string

required

length between 0 and 255

Key of the property.
Must not be blank.
Size must be between 0 and 255.

value

string

required

length between 0 and 255

Value of the property.
Must not be null.
Size must be between 0 and 255.

extras

array of objects

required

Must not be null.

extras*

object

ident

string

taxInformation

array of objects

taxInformation

object

tax

number

taxType

string

taxName

string

taxRate

number

taxCode

string

jurisdiction

object

taxRate

number

value

object

Structure containing the result of the tax calculation. All numbers are rounded to a scale of 4 with bankers' rounding.

taxProviderType

string

deprecated

DEPRECATED

vatIdValidationResult

object

Result of the VAT ID validation for this customer. If it is used in a request, it overwrites any VAT ID validation.

ident

string

required

length between 1 and 100

Unique identifier of this VatId validation.
Must have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.

vatId

string

VatId used for the validation.

validatedAt

date-time

required

Technical request date and time of the VatId validation.
Must not be null.

status

string

required

Mapped status of the validation response.
Must not be null.
Must be one of:

VALID

INVALID

FAILED

NONE

validationProvider

string

required

Validation provider used to validate the VatId.
Must not be blank.

Language

Credentials

OAuth2


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.nitrobox.io/v2/tax/calculate/documents \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '{"forecast":false}'

Choose an example:

application/json

200Standard response for successful HTTP requests.

4XXerror response for all http error codes in range 4XX

5XXerror response for all http error codes in range 5XX