Avalara · JSON Structure

Avatax Rest Line Item Model Structure

LineItemModel schema from Avalara API

Type: object Properties: 8 Required: 1
Taxes

LineItemModel is a JSON Structure definition published by Avalara, describing 8 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

number quantity amount taxCode itemCode description addresses exemptionCode

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/avalara/refs/heads/main/json-structure/avatax-rest-line-item-model-structure.json",
  "description": "LineItemModel schema from Avalara API",
  "type": "object",
  "required": [
    "amount"
  ],
  "properties": {
    "number": {
      "type": "string",
      "description": "Line number within the transaction"
    },
    "quantity": {
      "type": "double",
      "default": 1,
      "description": "Quantity of items"
    },
    "amount": {
      "type": "double",
      "description": "Total amount for this line"
    },
    "taxCode": {
      "type": "string",
      "description": "Tax code for this line item"
    },
    "itemCode": {
      "type": "string",
      "description": "Item code for the product or service"
    },
    "description": {
      "type": "string",
      "description": "Description of the line item"
    },
    "addresses": {
      "type": "object",
      "properties": {
        "shipFrom": {
          "$ref": "#/components/schemas/AddressInfo"
        },
        "shipTo": {
          "$ref": "#/components/schemas/AddressInfo"
        }
      }
    },
    "exemptionCode": {
      "type": "string",
      "description": "Exemption code for tax-exempt purchases"
    }
  },
  "name": "LineItemModel"
}