Account transactions
Explore the Account transactions endpoints in Swagger.
Overview
In Codat’s data model, account transactions represent bank activity within an accounting platform. All transactions that go through a bank account are recorded as account transactions.
Account transactions are created as a result of different business activities, for example:
- Payments: for example, receiving money for payment against an invoice.
- Bill payments: for example, spending money for a payment against a bill.
- Direct costs: for example, withdrawing money from a bank account, either for cash purposes or to make a payment.
- Direct incomes: for example, selling an item directly to a contact and receiving payment at point of sale.
- Transfers: for example, transferring money between two bank accounts.
Account transactions is the parent data type of payments, bill payments, direct costs, direct incomes, and transfers.
Perform the following tasks using the Account transactions endpoints:
Supported integrations
Account transactions is currently supported for the Xero and QBO integrations only.
Data model
Field | Type | Description |
---|---|---|
Id | string | Identifier of the direct cost (unique to the company). |
transactionId | string | Identifier of the transaction (unique to the company). |
note | string | Additional information about the account transaction, if available. |
bankAccountRef | See Reference types | Reference to the bank account the account transaction is recorded against. |
date | string | The date the account transaction was recorded in the platform. |
status | string | The status of the account transaction:
|
currency | string | Currency of the account transaction. |
currencyRate | decimal | Conversion rate between the account transaction currency and the base currency used by the company. |
lines | array | Array of account transaction lines. |
totalAmount | decimal | Total amount of the account transactions, inclusive of tax. |
modifiedDate | string | Date the record was last updated in Codat. |
sourceModifiedDate | string | Date the record was last changed in the accounting platform. |
Account transaction lines
Field | Type | Description |
---|---|---|
description | string | Description of the account transaction. |
recordRef | See Reference types | Links an account transaction line to the underlying record that created it. |
amount | decimal | Amount in the bill payment currency. |
Example data
{
"id": "d1c5aed6-8f0b-4f9f-b381-b4ce551b9b82",
"transactionId": "dc5b6989-ad59-43fa-ba0b-7b825020bdbc",
"note": "Direct income b1dadf18-a666-44de-bd1a-4c3d85a8c270",
"bankAccountRef": {
"id": "dbcaf288-2b39-4b95-8ab3-42202ab15918",
"name": "Current Account"
},
"date": "2020-12-02T00:00:00",
"status": "Reconciled",
"currency": "GBP",
"currencyRate": 1,
"lines": [
{
"description": "Payment for direct income $b1dadf18-a666-44de-bd1a-4c3d85a8c270",
"recordRef": {
"id": "b1dadf18-a666-44de-bd1a-4c3d85a8c270",
"dataType": "directIncomes"
},
"amount": 37349.14
}
],
"totalAmount": 37349.14,
"modifiedDate": "2022-05-16T13:55:30",
"sourceModifiedDate": "2021-10-16T03:44:08"
}
Updated 12 days ago