Avalara · Schema

CalculationRequest

Taxes

Properties

Name Type Description
header object
lines array
View JSON Schema on GitHub

JSON Schema

avalara-calculationrequest-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CalculationRequest",
  "title": "CalculationRequest",
  "type": "object",
  "required": [
    "header",
    "lines"
  ],
  "properties": {
    "header": {
      "type": "object",
      "properties": {
        "transactionType": {
          "type": "string",
          "enum": [
            "Sale",
            "Purchase",
            "Return",
            "Transfer"
          ]
        },
        "companyLocation": {
          "type": "string",
          "description": "Company establishment code"
        },
        "documentCode": {
          "type": "string"
        },
        "transactionDate": {
          "type": "string",
          "format": "date"
        },
        "currency": {
          "type": "string",
          "default": "BRL"
        }
      }
    },
    "lines": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/CalculationLine"
      }
    }
  }
}