A transaction is a debit or credit transaction on a connected account. Numeral connects to your bank to retrieve account statements and extract transactions.
Attribute | Description |
---|---|
id string | The UUID of the transaction. |
object string | The object, here transaction . |
connected_account_id string | The ID of the connected account. |
booking_date date | The date when a transaction is registered on the account. |
value_date date | The date when a transaction is effectively credited or debited on the account. |
category string | The category of the transaction. Existing transaction categories are:
|
description string | The description of the transaction. |
direction string | The direction of the transaction, either debit or credit . |
amount integer | The absolute value of the transaction, in the specified currency's smallest unit. For euro transactions, the smallest unit is cents. €20 is represented as 2000 . |
currency string | The currency of the transaction. All ISO-4217 currency codes are supported. |
counterparty_account object | The account of the counterparty, which is either the debitor or the creditor depending on the direction of the transaction.The object includes the following attributes:
|
virtual_account_number string | The number of the virtual account linked to the transaction. |
bank_data object | Bank data containing a reference to the file in which this transaction has been described (file_id ), as well as bank specific information related to this transaction (optional).For instance: statement_id (ISO 20022). |
reconciliation_status string | The reconciliation status of the transaction, which is either unreconciled , reconciled , or partially_reconciled . See Reconciliations. |
reconciled_amount integer | The amount of the transaction that is already reconciled. It is the sum of the amount of the reconciliations related to this transaction. See Reconciliations. |
created_at datetime | The UTC timestamp of the creation of this transaction. |
Below is an example of a transaction
:
{
"id": "f6ada630-1774-46c1-a27f-1ce2f5fb8647",
"object": "transaction",
"connected_account_id": "ff1714ae-3ec8-450d-984c-c6ee44c82a88",
"booking_date": "2022-01-03",
"value_date": "2022-01-03",
"category": "credit_transfer",
"description": "MyCompany Invoice 5678",
"direction": "credit",
"amount": 2000,
"currency": "EUR",
"counterparty_account": {
"account_number": "FR5412739000504811631858C47",
"holder_name": "Jane Doe"
},
"virtual_account_number": "FR4714508000301359366727T71",
"reconciliation_status": "unreconciled",
"reconciled_amount": 0,
"bank_data": {
"file_id": "26f4ca1c-65b0-412f-b464-206721d1e6d8",
"statement_id": "STS-C4RR9YPLL0HHIFFHR-D8CET1",
"end_to_end_id": "2144F77DJZB5949E0B15A7Z8923TX1"
},
"created_at": "2022-01-03T00:11:07Z"
}