COcodatio
Transfers

Get transfer

Changed on

The Get transfer endpoint returns a single transfer for a given transferId.

Transfers record the movement of money between two bank accounts, or between a bank account and a nominal account.

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

get/companies/{companyId}/connections/{connectionId}/data/transfers/{transferId}

Request

  • Base URL
    https://api.codat.io
  • Auth
    API key in header Authorization

Response

Success

idstring

Unique identifier for the transfer.

descriptionstring nullable

Description of the transfer.

contactRefContactRef (unresolved $ref)
datestring

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.

fromTransferAccount (unresolved $ref)
toTransferAccount (unresolved $ref)
status'Unknown' | 'Unreconciled' | 'Reconciled' | 'Void' nullable

The status of the transfer in the account

trackingCategoryRefsTrackingCategoryRef[] nullable(unresolved $ref)

Reference to the tracking categories this transfer is being tracked against.

depositedRecordRefsInvoiceTo[] nullable(unresolved $ref)

List of selected transactions to associate with the transfer. Use this field to include transactions which are posted to the undeposited funds (or other holding) account within the transfer.

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

  • 45a22c8cd476Revision changes
    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from 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

  • 97daeec184e7Revision changes
    • info

      added the optional property / to the response with the status