Company info

Get company info

Retrieve information about the company, as seen in the commerce software.

This may include information like addresses, tax registration details and social media or website information.

get/companies/{companyId}/connections/{connectionId}/data/commerce-info

Response

companyNamestring

The name of the company

commercePlatformRefstring

Identifier or reference for the company in the commerce software

companyLegalNamestring

The full legal name of the company

registrationNumberstring

The registration number of the company

baseCurrencyCurrency — unresolved $ref

accountBalancesAccountBalance[] — unresolved $ref

The available and current cash balances for the company's accounts

sourceUrlsobject

URL addresses for the originating system. For example, potential use cases include 'deeplinking' to the originating system

createdDatestring

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:

2020-10-08T22:40:50Z
2021-01-01T00:00:00

When syncing data that contains DateTime fields from Codat, make sure you support the following cases when reading time information:

Coordinated Universal Time (UTC): 2021-11-15T06:00:00Z
Unqualified local time: 2021-11-15T01:00:00
UTC time offsets: 2021-11-15T01:00:00-05:00

Time zones

Not all dates from Codat will contain information about time zones.
Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced.

modifiedDatestring

The date when the record was last fetched from the accounting software, commerce software, or open banking provider and updated in Codat’s data cache.

Use it to identify and retrieve records that have changed since your last fetch. For example, filtering modifiedDate to today will provide new records updated in Codat today.

This date is populated for all data types except for attachments, balance sheets, company information, and profit & loss reports (read more).

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>.

sourceModifiedDatestring

The date when a record was last modified in the accounting software, usually by the business or a business process. For example, when payments are made against an invoice.

It is not populated (read more) when:

Pulling attachments
The accounting software does not provide modification dates for a data type
A record has been deleted from the source platform and Codat doesn't have a record of when the deletion occurred
A record has been voided. For certain platforms that soft delete records, isDeleted metadata is used to identify void records

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>.

Changes

Changed in 7 of the 53 revisions of this API.2218

Feb 22, 2024b21f93ec971b1See the full diff
- ▲
  the response property /// became optional for the status
  response-property-became-optional
Feb 13, 20248ba9a6a9b56a8See the full diff
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
Oct 23, 2023638d28ff67734See the full diff
- ○
  added the non-success response with the status
  response-non-success-status-added
- ○
  added the non-success response with the status
  response-non-success-status-added
- ○
  added the non-success response with the status
  response-non-success-status-added
- ○
  added the non-success response with the status
  response-non-success-status-added
Sep 5, 20232b1806a71cd21See the full diff
- ▲
  the /// response's property type changed from number to no type for status
  response-property-type-changed
Jul 6, 2023f5898440c7ad2See the full diff
- ●
  removed the optional property /// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
Jul 4, 2023494a393d5cec2See the full diff
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
May 30, 20230e88541f84be4See the full diff
- ○
  added the non-success response with the status
  response-non-success-status-added
- ○
  added the non-success response with the status
  response-non-success-status-added
- ○
  added the non-success response with the status
  response-non-success-status-added
- ○
  added the non-success response with the status
  response-non-success-status-added

Full history