Company info

Get company accounting profile

Changed on

Gets the latest basic info for a company.

get/companies/{companyId}/data/info

Request

  • Base URL
    https://api.codat.io
  • URL
    https://api.codat.io/companies/{companyId}/data/info
  • Auth
    API key in header Authorization

Response

Success

companyNamestring nullable

Name of the linked company.

accountingPlatformRefstring nullable

Identifier or reference for the company in the accounting software.

companyLegalNamestring nullable

Registered legal name of the linked company.

ledgerLockDateCreated (unresolved $ref)
registrationNumberstring nullable

Registration number given to the linked company by the companies authority in the country of origin. In the UK this is Companies House.

taxNumberstring nullable

Company tax number.

financialYearStartDateCreated (unresolved $ref)
baseCurrencystring nullable

Currency set in the accounting software of the linked company. Used by the currency rate.

sourceUrlsobject nullable

URL addresses for the accounting source.

For example, for Xero integrations two URLs are returned. These have many potential use cases, such as deep linking.

createdDateCreated (unresolved $ref)

Example response

{
  "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"
}

Changes

  • 0368cd2c8719Revision changes
    • breaking

      the response property // became optional for the status

  • fc70787de2f3Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status