Avalara · JSON Structure

Vat Reporting Vat Return Structure

VATReturn schema from Avalara API

Type: object Properties: 13

Taxes

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

Properties

returnId companyId countryCode vatRegistrationNumber returnType periodStart periodEnd status totalOutputVAT totalInputVAT netVATDue submissionDate currency

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/avalara/refs/heads/main/json-structure/vat-reporting-vat-return-structure.json",
  "description": "VATReturn schema from Avalara API",
  "type": "object",
  "properties": {
    "returnId": {
      "type": "string"
    },
    "companyId": {
      "type": "string"
    },
    "countryCode": {
      "type": "string",
      "description": "ISO 3166-1 alpha-2 country code"
    },
    "vatRegistrationNumber": {
      "type": "string"
    },
    "returnType": {
      "type": "string",
      "enum": [
        "VATReturn",
        "ECListing",
        "Intrastat"
      ]
    },
    "periodStart": {
      "type": "date"
    },
    "periodEnd": {
      "type": "date"
    },
    "status": {
      "type": "string",
      "enum": [
        "Draft",
        "Submitted",
        "Accepted",
        "Rejected"
      ]
    },
    "totalOutputVAT": {
      "type": "double"
    },
    "totalInputVAT": {
      "type": "double"
    },
    "netVATDue": {
      "type": "double"
    },
    "submissionDate": {
      "type": "datetime"
    },
    "currency": {
      "type": "string"
    }
  },
  "name": "VATReturn"
}