Avalara · JSON Structure

Vat Reporting Onboarding Request Structure

OnboardingRequest schema from Avalara API

Type: object Properties: 3 Required: 2
Taxes

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

Properties

companyId companyName countries

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/vat-reporting-onboarding-request-structure.json",
  "description": "OnboardingRequest schema from Avalara API",
  "type": "object",
  "required": [
    "companyId",
    "countries"
  ],
  "properties": {
    "companyId": {
      "type": "string"
    },
    "companyName": {
      "type": "string"
    },
    "countries": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "countryCode": {
            "type": "string"
          },
          "vatRegistrationNumber": {
            "type": "string"
          },
          "filingFrequency": {
            "type": "string",
            "enum": [
              "Monthly",
              "Quarterly",
              "Annual"
            ]
          }
        }
      }
    }
  },
  "name": "OnboardingRequest"
}