Avalara · Schema

CompanyModel

CompanyModel schema from Avalara API

Taxes

Properties

Name Type Description
id integer Unique identifier for the company
companyCode string Short code identifying this company
name string Display name of the company
isDefault boolean Whether this is the default company for the account
isActive boolean
taxpayerIdNumber string Tax identification number (EIN, TIN)
hasProfile boolean
isReportingEntity boolean
defaultCountry string Default country for this company
baseCurrencyCode string Default currency code
sstEffDate string
roundingLevelId string
sstPId string
createdDate string
modifiedDate string
View JSON Schema on GitHub

JSON Schema

avatax-rest-company-model-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/avalara/refs/heads/main/json-schema/avatax-rest-company-model-schema.json",
  "title": "CompanyModel",
  "description": "CompanyModel schema from Avalara API",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "description": "Unique identifier for the company"
    },
    "companyCode": {
      "type": "string",
      "description": "Short code identifying this company"
    },
    "name": {
      "type": "string",
      "description": "Display name of the company"
    },
    "isDefault": {
      "type": "boolean",
      "description": "Whether this is the default company for the account"
    },
    "isActive": {
      "type": "boolean"
    },
    "taxpayerIdNumber": {
      "type": "string",
      "description": "Tax identification number (EIN, TIN)"
    },
    "hasProfile": {
      "type": "boolean"
    },
    "isReportingEntity": {
      "type": "boolean"
    },
    "defaultCountry": {
      "type": "string",
      "description": "Default country for this company"
    },
    "baseCurrencyCode": {
      "type": "string",
      "description": "Default currency code"
    },
    "sstEffDate": {
      "type": "string",
      "format": "date"
    },
    "roundingLevelId": {
      "type": "string",
      "enum": [
        "Line",
        "Document"
      ]
    },
    "sstPId": {
      "type": "string"
    },
    "createdDate": {
      "type": "string",
      "format": "date-time"
    },
    "modifiedDate": {
      "type": "string",
      "format": "date-time"
    }
  }
}