COcodatio
Transactions

Get bank transaction

Changed on

The Get transaction endpoint returns a single transaction for a given transactionId.

Transactions provide an immutable source of up-to-date information on income and expenditure.

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

get/companies/{companyId}/connections/{connectionId}/data/banking-transactions/{transactionId}

Request

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

Response

Success

idstring required

The unique identifier of the bank transaction.

accountIdstring required

The unique identifier of the bank account.

descriptionstring nullable

The description of the bank transaction.

amountnumber

The amount of the bank transaction.

currencystring required

The currency of the bank transaction.

postedDatestring

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.

authorizedDatestring

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.

codeTransactionCode (unresolved $ref)
merchantNamestring nullable

The name of the merchant.

transactionCategoryRefTransactionCategoryRef (unresolved $ref)
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>.

Example response

{
  "id": "0130b5bb-1419-40f6-8a27-7362d0381229",
  "accountId": "1703194f-7805-4da8-bac0-2ba5da4a4216",
  "description": "Payments for direct income ce149943-c157-43fc-aac7-42a716b655b6",
  "amount": 5062.39,
  "currency": "GBP",
  "postedDate": "2021-07-06T00:00:00",
  "authorizedDate": "2021-07-06T00:00:00",
  "merchantName": "New Look",
  "transactionCategoryRef": {
    "id": "health-and-fitness-sports"
  },
  "modifiedDate": "2022-05-23T16:32:50Z",
  "sourceModifiedDate": "2021-06-28T10:48:12"
}

Changes

  • a26d38c3e530Revision 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

  • 63409d8e7593Revision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status