Xero · Schema

AddressForOrganisation

AccountingBank FeedsFinanceFinancial ServicesInvoicingPayrollSmall Business

Properties

Name Type Description
AddressType string define the type of address
AddressLine1 string max length = 500
AddressLine2 string max length = 500
AddressLine3 string max length = 500
AddressLine4 string max length = 500
City string max length = 255
Region string max length = 255
PostalCode string max length = 50
Country string max length = 50, [A-Z], [a-z] only
AttentionTo string max length = 255
View JSON Schema on GitHub

JSON Schema

xero-addressfororganisation-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/AddressForOrganisation",
  "title": "AddressForOrganisation",
  "externalDocs": {
    "url": "http://developer.xero.com/documentation/api/types"
  },
  "properties": {
    "AddressType": {
      "description": "define the type of address",
      "type": "string",
      "enum": [
        "POBOX",
        "STREET",
        "DELIVERY"
      ]
    },
    "AddressLine1": {
      "description": "max length = 500",
      "maxLength": 500,
      "type": "string"
    },
    "AddressLine2": {
      "description": "max length = 500",
      "maxLength": 500,
      "type": "string"
    },
    "AddressLine3": {
      "description": "max length = 500",
      "maxLength": 500,
      "type": "string"
    },
    "AddressLine4": {
      "description": "max length = 500",
      "maxLength": 500,
      "type": "string"
    },
    "City": {
      "description": "max length = 255",
      "maxLength": 255,
      "type": "string"
    },
    "Region": {
      "description": "max length = 255",
      "maxLength": 255,
      "type": "string"
    },
    "PostalCode": {
      "description": "max length = 50",
      "maxLength": 50,
      "type": "string"
    },
    "Country": {
      "description": "max length = 50, [A-Z], [a-z] only",
      "maxLength": 50,
      "type": "string"
    },
    "AttentionTo": {
      "description": "max length = 255",
      "maxLength": 255,
      "type": "string"
    }
  },
  "type": "object"
}