Accounting: Company information

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/AccountingCompanyInfo",
  "title": "Accounting: Company information",
  "description": "Company info provides standard details about a linked company such as their address, phone number, and company registration.\n\n> **Company information or companies?**\n> \n> Company information is standard information that is held in the accounting software about a company. `Companies` is an endpoint that lists businesses in the Codat system that have linked and shared their data sources.",
  "type": "object",
  "properties": {
    "companyName": {
      "type": "string",
      "nullable": true,
      "description": "Name of the linked company."
    },
    "accountingPlatformRef": {
      "type": "string",
      "nullable": true,
      "description": "Identifier or reference for the company in the accounting software."
    },
    "companyLegalName": {
      "type": "string",
      "nullable": true,
      "description": "Registered legal name of the linked company."
    },
    "addresses": {
      "type": "array",
      "nullable": true,
      "description": "An array of Addresses.",
      "items": {
        "$ref": "#/components/schemas/AccountingAddress"
      }
    },
    "phoneNumbers": {
      "type": "array",
      "nullable": true,
      "description": "An array of phone numbers.",
      "items": {
        "$ref": "#/components/schemas/PhoneNumber"
      }
    },
    "webLinks": {
      "type": "array",
      "nullable": true,
      "description": "An array of weblinks.",
      "items": {
        "$ref": "#/components/schemas/WebLink"
      }
    },
    "ledgerLockDate": {
      "$ref": "#/components/schemas/DateTime",
      "description": "If set in the accounting software, the date (in the ISO 8601 date/time format) after which accounting transactions cannot be edited. Commonly used when books are closed at year-end."
    },
    "registrationNumber": {
      "type": "string",
      "nullable": true,
      "description": "Registration number given to the linked company by the companies authority in the country of origin. In the UK this is Companies House."
    },
    "taxNumber": {
      "type": "string",
      "nullable": true,
      "description": "Company tax number."
    },
    "financialYearStartDate": {
      "$ref": "#/components/schemas/DateTime",
      "description": "Start date of the financial year for the company."
    },
    "baseCurrency": {
      "type": "string",
      "nullable": true,
      "description": "Currency set in the accounting software of the linked company. Used by the currency rate."
    },
    "sourceUrls": {
      "type": "object",
      "additionalProperties": {
        "type": "string",
        "nullable": true
      },
      "nullable": true,
      "description": "URL addresses for the accounting source.\n\nFor example, for Xero integrations two URLs are returned. These have many potential use cases, such as [deep linking](https://developer.xero.com/documentation/api-guides/deep-link-xero)."
    },
    "createdDate": {
      "$ref": "#/components/schemas/DateTime",
      "description": "Date the linked company was created in the accounting software."
    },
    "supplementalData": {
      "$ref": "#/components/schemas/SupplementalData"
    }
  },
  "examples": [
    {
      "companyName": "ACME Corporation",
      "accountingPlatformRef": "4444e827-401b-4925-92cb-d79086bf3b6b",
      "companyLegalName": "ACME Corporation Ltd.",
      "addresses": [
        {
          "type": "Billing",
          "line1": "Warner House",
          "line2": "98 Theobald's Road",
          "city": "London",
          "region": "",
          "country": "United Kingdom",
          "postalcode": "WC1X 8WB"
        },
        {
          "type": "Unknown",
          "line1": "123 Sierra Way",
          "line2": "",
          "city": "San Pablo",
          "region": "CA",
          "country": "",
          "postalCode": "87999"
        }
      ],
      "phoneNumbers": [
        {
          "number": "010 1234 5678",
          "type": "Landline"
        }
      ],
      "webLinks": [
        {
          "type": "Website",
          "url": "https://www.wbsl.com/"
        }
      ],
      "ledgerLockDate": "2019-03-04T12:08:01.881Z",
      "registrationNumber": "1234567890",
      "taxNumber": "GB 123456789",
      "financialYearStartDate": "2019-04-01T00:00:00Z",
      "baseCurrency": "USD",
      "sourceUrls": {
        "url1": "https://go.xero.com/organisationlogin/default.aspx?shortcode=!rxs0Q",
        "url2": "https://reporting.xero.com/!rxs0Q"
      },
      "createdDate": "2020-02-03T16:42:02Z"
    }
  ]
}