Company info

Explore company Info endpoints in Swagger.

Overview

In the Codat system, company information includes standard details about a linked company, such as their address, phone number, and company registration.

📘

Company information or companies?

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.

Data model

Field

Type

Description

companyName

string

Name of the linked company.

accountingPlatformRef

string

Identifier or reference for the company in the accounting platform.

companyLegalName

string

Registered legal name of the linked company.

addresses

An array of Addresses.

phoneNumbers

An array of PhoneNumbers.

webLinks

An array of WebLinks.

ledgerLockDate

string See date

If set in the accounting platform, 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

string

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

taxNumber

string

Company tax number.

financialYearStartDate

string
See date

Start date of the financial year for the company.

baseCurrency

string
See currency

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

sourceUrls

dictionary of strings

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.

createdDate

string
See date

Date the linked company was created in the accounting platform.

Addresses

Field

Type

Description

type

string

Type of address, either:

  • Billing
  • Delivery
  • Unknown

line1

string

Line 1 of the address for the linked company.

line2

string

Line 2 of the address for the linked company.

city

string

City address of the linked company.

region

string

Regional address of the linked company.

country

string

Country address of the linked company.

postalCode

string

Postal code or zip code address of the linked company.

Phone numbers

Field

Description

Type

number

string

Phone number of the linked company.

type

string

Type of phone number, either:

  • Primary
  • Landline
  • Mobile
  • Fax
  • Unknown

Web links

Field

Description

Type

type

string

Type of web link, either:

  • Website
  • Social
  • Unknown

url

string

URL of a web link for a linked company

Example data

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

Did this page help you?