Transaction object

A transaction is a debit or credit transaction booked on a connected account. Numeral connects to your bank to retrieve account statements and extract transactions.

AttributeDescription
id
string
The transaction ID
object
string
Always transaction.
connected_account_id
string
The ID of the connected account where the transaction has been booked.
booking_date
date
The transaction booking date.
value_date
date
The transaction value date.
category
string
The transaction category. Existing transaction categories include:
  • credit_transfer
  • cash_concentration
  • direct_debit
  • cheque
  • card
  • lockbox
  • counter_operation
  • bill_of_order
  • instant_credit_transfer
  • other_payment
  • cash_pooling
  • account_balancing
  • other_cash_management
  • derivative
  • loan
  • fx
  • precious_metals
  • commodities
  • trade_services
  • securities
  • account_management
  • unavailable
description
string
The transaction description.
direction
string
The transaction debit or credit direction.
amount
integer
The payment amount, in the currency's smallest unit.

For instance, euro smallest unit is cents and €20 is thus represented as 2000.
currency
string
The transaction currency. All ISO-4217 currency codes are supported.
counterparty_account
object
The counterparty account. The counterparty is either the debtor or the creditor, depending on the transaction direction.

The counterparty_account object includes the following attributes:
  • account_number: the account number or IBAN
  • holder_name: the name of the company or individual holding the account
virtual_account_number
string
The virtual account number linked to this transaction.
reconciliation_status
string
The reconciliation status of the transaction. Either unreconciled, reconciled, or partially_reconciled. See Reconciliations for more details.
reconciled_amount
integer
The amount reconciled, calculated as the sum of the reconciliations created for this transaction.
bank_data
object
Bank data, such as message and transaction IDs, in JSON key:value format.
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"
}