Line Item Input

Input representation of the details of the line item for tax calculation.

JSON Example

1{
2  "lineItems": [
3    {
4      "quantity": 1,
5      "amount": 100,
6      "taxCode": "TX0001",
7      "productCode": "Y0001",
8      "productSKU": "PRES-RX-12896745",
9      "description": "New Product",
10      "effectiveDate": "2022-03-09T10:30:41.000Z",
11      "lineNumber": "5TVxx0000004C92GAE",
12      "addresses": {
13        "shipFrom": {
14          "street": "123 Alaskan Way",
15          "city": "Seattle",
16          "state": "WA",
17          "country": "US",
18          "postalCode": "98101",
19          "latitude": 45.12,
20          "longitude": 45.12
21        },
22        "shipTo": {
23          "street": "123 Auburn Blvd",
24          "city": "Sacramento",
25          "state": "CA",
26          "country": "US",
27          "postalCode": "95841",
28          "latitude": 45.12,
29          "longitude": 45.12
30        },
31        "soldTo": {
32          "street": "123 Auburn Blvd",
33          "city": "Sacramento",
34          "state": "CA",
35          "country": "US",
36          "postalCode": "95841",
37          "latitude": 45.12,
38          "longitude": 45.12
39        },
40        "billTo": {
41          "street": "123 Auburn Blvd",
42          "city": "Sacramento",
43          "state": "CA",
44          "country": "US",
45          "postalCode": "95841",
46          "latitude": 45.12,
47          "longitude": 45.12
48        }
49      }
50    }
51  ]
52}

Properties

Name	Type	Description	Required or Optional	Available Version
`addresses`	Addresses Input	Address types that specify different locations associated with the transaction of the line item.	Optional	62.0
`amount`	Double	Total amount for the line item.	Required	62.0
`description`	String	Description of the line item.	Optional	62.0
`effectiveDate`	String	Date that tax rules are applicable from. This property value overrides the global effective date.	Optional	62.0
`legalEntity`	String	Legal entity that’s related to the tax treatment.	Optional	63.0
`lineNumber`	String	Unique identifier for the line item.	Required	62.0
`productCode`	String	Product code of the line item according to the tax treatment rules of the tax engine.	Optional	62.0
`productId`	String	ID of the product.	Optional	63.0
`productSKU`	String	Unique identifier of a product that can be used to identify products that are exempted from tax.	Optional	64.0
`quantity`	Double	Quantity of the line item.	Required	62.0
`taxCode`	String	Tax code of the line item according to the tax treatment rules of the tax engine.	Optional	62.0
`unitPrice`	Double	Unit price of the product.	Optional	63.0