Tax Calculation

Output representation of the details of the calculated tax.

JSON Example

1{
2    "referenceEntityId": "001xx000003HYEhAAO",
3    "status": "Committed",
4    "taxEngineLogs": [
5        {
6            "createdDate": "2022-03-09T10:55:38.000Z",
7            "id": "3l1xx00000000PpAAI",
8            "resultCode": "Success"
9        }
10    ],
11    "taxTransactionType": "Debit",
12    "taxType": "Actual",
13    "transactionDate": "2022-03-09T10:30:41.000Z",
14    "addresses": {
15        "shipFrom": {
16            "locationCode": "67890"
17        },
18        "shipTo": {
19            "locationCode": "23456"
20        },
21        "soldTo": {
22            "locationCode": "23456"
23        }
24    },
25    "amountDetails": {
26        "exemptAmount": 0.0,
27        "taxAmount": 12.5,
28        "totalAmount": 100.0,
29        "totalAmountWithTax": 112.5
30    },
31    "currencyIsoCode": "USD",
32    "description": "Monthly invoice for account 001xx000003HYEhAAO",
33    "documentCode": "INV-003",
34    "effectiveDate": "2022-03-09T10:55:38.410Z",
35    "lineItems": [
36        {
37            "addresses": {
38                "shipFrom": {
39                    "locationCode": "67890"
40                },
41                "shipTo": {
42                    "locationCode": "12345"
43                },
44                "soldTo": {
45                    "locationCode": "12345"
46                }
47            },
48            "amountDetails": {
49                "exemptAmount": 0.0,
50                "taxAmount": 12.5,
51                "totalAmount": 100.0,
52                "totalAmountWithTax": 112.5
53            },
54            "effectiveDate": "2022-03-09T10:55:38.416Z",
55            "lineNumber": "001xx000003HYEiAAO",
56            "productCode": "Y0001",
57            "quantity": 1.0,
58            "taxCode": "TX0001",
59            "taxes": [
60                {
61                    "exemptAmount": 0.0,
62                    "exemptReason": "NoExemption",
63                    "imposition": {
64                        "type": "General"
65                    },
66                    "jurisdiction": {
67                        "country": "US",
68                        "id": "63000",
69                        "level": "CIT",
70                        "name": "SEATTLE",
71                        "region": "WA",
72                        "stateAssignedNo": "1726"
73                    },
74                    "rate": 12.5,
75                    "tax": 12.5,
76                    "taxId": "11000378132466",
77                    "taxableAmount": 100.0
78                }
79            ]
80        }
81    ]
82}

Property Name	Type	Description	Filter Group and Version	Available Version
`adapterError`	Error Response	Details of the adapter error.	Big, 62.0	62.0
`addresses`	Addresses	Addresses that are used for calculating tax.	Big, 62.0	62.0
`amountDetails`	Tax Amount Details	Details of the transaction amount and taxes.	Big, 62.0	62.0
`currencyIsoCode`	String	Currency ISO code that’s used for tax calculation.	Big, 62.0	62.0
`description`	String	Description of the transaction status.	Big, 62.0	62.0
`documentCode`	String	Unique identifier for the tax document. If the `documentCode` property isn’t specified, the tax engine auto-generates it.	Big, 62.0	62.0
`effectiveDate`	String	Date when the tax rules are applied.	Big, 62.0	62.0
`lineItems`	Line Item []	Line items that the taxes are calculated for.	Big, 62.0	62.0
`referenceDocumentCode`	String	Reference document code. For subsequent transactions such as a credit tax, the `referenceDocumentCode` property value refers to the original document code.	Big, 62.0	62.0
`referenceEntityId`	String	ID of the related quote, invoice, or other transaction documents.	Big, 62.0	62.0
`status`	String	Commit status of the tax transaction. Valid values are `Committed`—Committed transaction, which is marked for tax reporting or `Uncommitted`— Uncommitted transaction, which isn’t marked for tax reporting.	Big, 62.0	62.0
`taxEngineLogs`	Tax Engine Log []	Records that the tax engine generates while calculating taxes for the transaction.	Big, 62.0	62.0
`taxTransactionId`	String	Unique ID for the tax transaction.	Big, 62.0	62.0
`transactionDate`	String	Date of the transaction that appears on the invoice, order, and other transaction documents.	Big, 62.0	62.0
`taxTransactionType`	String	Tax transaction type. Valid values are `Debit`—Increases tax liability for the user, requiring the user to pay tax on the transaction, `Credit`—Decreases tax liability for the user, resulting in a tax refund for the user, or `Void`—Specifies that the tax engine has voided the document that’s mentioned as the `referenceDocumentCode` property value.	Big, 62.0	62.0
`taxType`	String	Type of calculated tax. Valid values are `Actual`—Exact tax amount that’s calculated based on the actual sales or `Estimated`— Estimated tax amount, which is adjusted later to match the actual tax calculations.	Big, 62.0	62.0