COcodatio
Account transactions

Get account transaction

Changed on

The Get account transaction endpoint returns a single account transaction for a given accountTransactionId.

Account transactions represent bank activity within an accounting software. All transactions that go through a bank account are recorded as account transactions.

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

get/companies/{companyId}/connections/{connectionId}/data/accountTransactions/{accountTransactionId}

Request

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

Path parameters

companyIdstring uuid required

Unique identifier for your SMB in Codat.

Example:8a210b68-6988-11ed-a1eb-0242ac120002

Unique identifier for a company.

connectionIdstring uuid required

Unique identifier for a company's data connection.

Example:2e9d2c44-f675-40ba-8049-353bfcb5e171

Unique identifier for a connection.

accountTransactionIdstring required

Unique identifier for an account transaction.

Response

Success

idstring

Identifier of the direct cost (unique to the company).

transactionIdstring nullable

Identifier of the transaction (unique to the company).

notestring nullable

Additional information about the account transaction, if available.

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

status'Unknown' | 'Unreconciled' | 'Reconciled' | 'Void'

The status of the account transaction.

currencyCurrency (unresolved $ref)
currencyRateCurrencyRate (unresolved $ref)
linesAccountTransactionLine[] nullable(unresolved $ref)

Array of account transaction lines.

totalAmountnumber

Total amount of the account transactions, 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>.

Changes

  • 4bfab0afa6caRevision 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

  • 0fcc5f736d86Revision changes
    • warning

      added the new bankTransactions enum value to the //// response property for the response status

    • warning

      added the new billCreditNotes enum value to the //// response property for the response status

    • warning

      added the new billPayments enum value to the //// response property for the response status

    • warning

      added the new bills enum value to the //// response property for the response status

    • warning

      added the new creditNotes enum value to the //// response property for the response status

    • warning

      added the new directCosts enum value to the //// response property for the response status

    • warning

      added the new directIncomes enum value to the //// response property for the response status

    • warning

      added the new invoices enum value to the //// response property for the response status

    • warning

      added the new journalEntries enum value to the //// response property for the response status

    • warning

      added the new payments enum value to the //// response property for the response status

    • warning

      added the new transfers enum value to the //// response property for the response status