Avalara · JSON Structure

Avatax Brazil Invoice Response Structure

InvoiceResponse schema from Avalara API

Type: object Properties: 7
Taxes

InvoiceResponse is a JSON Structure definition published by Avalara, describing 7 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

invoiceId accessKey invoiceNumber series status protocolNumber issuanceDate

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-invoice-response-structure.json",
  "description": "InvoiceResponse schema from Avalara API",
  "type": "object",
  "properties": {
    "invoiceId": {
      "type": "string"
    },
    "accessKey": {
      "type": "string",
      "description": "44-digit NF-e access key"
    },
    "invoiceNumber": {
      "type": "int32"
    },
    "series": {
      "type": "int32"
    },
    "status": {
      "type": "string",
      "enum": [
        "Authorized",
        "Cancelled",
        "Denied",
        "Pending"
      ]
    },
    "protocolNumber": {
      "type": "string"
    },
    "issuanceDate": {
      "type": "datetime"
    }
  },
  "name": "InvoiceResponse"
}