Avalara · JSON Structure

E Invoicing Submit Document Request Structure

SubmitDocumentRequest schema from Avalara API

Type: object Properties: 4 Required: 2
Taxes

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

Properties

dataFormat dataFormatVersion data metadata

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/e-invoicing-submit-document-request-structure.json",
  "description": "SubmitDocumentRequest schema from Avalara API",
  "type": "object",
  "required": [
    "dataFormat",
    "data"
  ],
  "properties": {
    "dataFormat": {
      "type": "string",
      "enum": [
        "ubl-invoice",
        "ubl-creditnote",
        "cii"
      ],
      "description": "Format of the e-invoice document"
    },
    "dataFormatVersion": {
      "type": "string",
      "description": "Version of the data format"
    },
    "data": {
      "type": "string",
      "description": "Base64-encoded document content or raw UBL/CII XML"
    },
    "metadata": {
      "type": "object",
      "properties": {
        "workflowId": {
          "type": "string",
          "description": "Workflow identifier for the mandate"
        },
        "countryCode": {
          "type": "string",
          "description": "ISO 3166-1 alpha-2 country code"
        },
        "countryMandate": {
          "type": "string",
          "description": "Country mandate identifier"
        }
      }
    }
  },
  "name": "SubmitDocumentRequest"
}