Get company info

{
  "type": "object",
  "description": "> View the coverage for company info in the <a className=\"external\" href=\"https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=cashFlowStatement\" target=\"_blank\">Data coverage explorer</a>.\n\nCompany 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 platform about a company. `Companies` is an endpoint that lists businesses in the Codat system that have linked and shared their data sources.",
  "properties": {
    "accountingPlatformRef": {
      "type": [
        "string",
        "null"
      ],
      "description": "Identifier or reference for the company in the accounting platform."
    },
    "addresses": {
      "type": [
        "array",
        "null"
      ],
      "description": "An array of Addresses.",
      "items": {
        "type": "object",
        "required": [
          "type"
        ],
        "properties": {
          "city": {
            "type": [
              "string",
              "null"
            ],
            "description": "City of the customer address."
          },
          "country": {
            "type": [
              "string",
              "null"
            ],
            "description": "Country of the customer address."
          },
          "line1": {
            "type": [
              "string",
              "null"
            ],
            "description": "Line 1 of the customer address."
          },
          "line2": {
            "type": [
              "string",
              "null"
            ],
            "description": "Line 2 of the customer address."
          },
          "postalCode": {
            "type": [
              "string",
              "null"
            ],
            "description": "Postal code or zip code."
          },
          "region": {
            "type": [
              "string",
              "null"
            ],
            "description": "Region of the customer address."
          },
          "type": {
            "type": "string",
            "description": "The type of the address",
            "enum": [
              "Unknown",
              "Billing",
              "Delivery"
            ]
          }
        }
      }
    },
    "baseCurrency": {
      "type": [
        "string",
        "null"
      ],
      "description": "Currency set in the accounting platform of the linked company. Used by the currency rate."
    },
    "companyLegalName": {
      "type": [
        "string",
        "null"
      ],
      "description": "Registered legal name of the linked company."
    },
    "companyName": {
      "type": [
        "string",
        "null"
      ],
      "description": "Name of the linked company."
    },
    "createdDate": {
      "type": "string",
      "description": "In Codat's data model, dates and times are represented using the <a class=\"external\" href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:\n\n```\n2020-10-08T22:40:50Z\n2021-01-01T00:00:00\n```\n\n\n\nWhen syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:\n\n- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`\n- Unqualified local time: `2021-11-15T01:00:00`\n- UTC time offsets: `2021-11-15T01:00:00-05:00`\n\n> Time zones\n> \n> Not all dates from Codat will contain information about time zones.  \n> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced."
    },
    "financialYearStartDate": {
      "type": "string",
      "description": "In Codat's data model, dates and times are represented using the <a class=\"external\" href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:\n\n```\n2020-10-08T22:40:50Z\n2021-01-01T00:00:00\n```\n\n\n\nWhen syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:\n\n- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`\n- Unqualified local time: `2021-11-15T01:00:00`\n- UTC time offsets: `2021-11-15T01:00:00-05:00`\n\n> Time zones\n> \n> Not all dates from Codat will contain information about time zones.  \n> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced."
    },
    "ledgerLockDate": {
      "type": "string",
      "description": "In Codat's data model, dates and times are represented using the <a class=\"external\" href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:\n\n```\n2020-10-08T22:40:50Z\n2021-01-01T00:00:00\n```\n\n\n\nWhen syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:\n\n- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`\n- Unqualified local time: `2021-11-15T01:00:00`\n- UTC time offsets: `2021-11-15T01:00:00-05:00`\n\n> Time zones\n> \n> Not all dates from Codat will contain information about time zones.  \n> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced."
    },
    "phoneNumbers": {
      "type": [
        "array",
        "null"
      ],
      "description": "An array of phone numbers.",
      "items": {
        "type": "object",
        "required": [
          "number",
          "type"
        ],
        "properties": {
          "number": {
            "type": [
              "string",
              "null"
            ],
            "description": "A phone number."
          },
          "type": {
            "type": "string",
            "description": "The type of phone number",
            "enum": [
              "Primary",
              "Landline",
              "Mobile",
              "Fax",
              "Unknown"
            ]
          }
        }
      }
    },
    "registrationNumber": {
      "type": [
        "string",
        "null"
      ],
      "description": "Registration number given to the linked company by the companies authority in the country of origin. In the UK this is Companies House."
    },
    "sourceUrls": {
      "type": [
        "object",
        "null"
      ],
      "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)."
    },
    "taxNumber": {
      "type": [
        "string",
        "null"
      ],
      "description": "Company tax number."
    },
    "webLinks": {
      "type": [
        "array",
        "null"
      ],
      "description": "An array of weblinks.",
      "items": {
        "type": "object",
        "description": "Weblink associated with the company.",
        "properties": {
          "type": {
            "type": "string",
            "description": "The type of the weblink.",
            "enum": [
              "Website",
              "Social",
              "Unknown"
            ]
          },
          "url": {
            "type": "string",
            "format": "url",
            "description": "The full URL for the weblink."
          }
        }
      }
    }
  }
}