Avalara · JSON Structure

Avatax Brazil Calculation Request Structure

CalculationRequest schema from Avalara API

Type: object Properties: 2 Required: 2
Taxes

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

Properties

header lines

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-brazil-calculation-request-structure.json",
  "description": "CalculationRequest schema from Avalara API",
  "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": "date"
        },
        "currency": {
          "type": "string",
          "default": "BRL"
        }
      }
    },
    "lines": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/CalculationLine"
      }
    }
  },
  "name": "CalculationRequest"
}