Avalara · Schema

SubmitDocumentRequest

Taxes

Properties

Name Type Description
dataFormat string Format of the e-invoice document
dataFormatVersion string Version of the data format
data string Base64-encoded document content or raw UBL/CII XML
metadata object
View JSON Schema on GitHub

JSON Schema

avalara-submitdocumentrequest-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SubmitDocumentRequest",
  "title": "SubmitDocumentRequest",
  "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"
        }
      }
    }
  }
}