Sign in
Direct incomes

Get direct income

The Get direct income endpoint returns a single direct income for a given directIncomeId.

Direct incomes are incomes received directly from the business' operations at the point of the sale.

Before using this endpoint, you must have retrieved data for the company.

get/companies/{companyId}/connections/{connectionId}/data/directIncomes/{directIncomeId}

Response

Success

idstring

Identifier of the direct income, unique for the company.

referencestring nullable

User-friendly reference for the direct income.

notestring nullable

An optional note on the direct income that can be used to assign the direct income with a reference ID in your application.

contactRefContactRef — unresolved $ref
issueDatestring required

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.

currencyCurrency required— unresolved $ref
currencyRateCurrencyRate — unresolved $ref
lineItemsDirectIncomeLineItem[] required— unresolved $ref

An array of line items.

paymentAllocationsItems[] required— unresolved $ref
subTotalnumber required

The total amount of the direct incomes, excluding any taxes.

taxAmountnumber required

The total amount of tax on the direct incomes.

totalAmountnumber required

The amount of the direct incomes, inclusive of tax.

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