The Transactions object

A transaction object represents a balanced double-entry journal. The header carries the date, description, status, and source metadata. Lines carry the account allocations, amounts, VAT treatment, and optional contact references.

The totals object on the detail endpoint confirms the transaction balances (debit equals credit). Amounts on lines follow the sign convention: positive = debit, negative = credit.

Attributes

id string
Prefixed transaction ID (e.g. txn_42). Immutable after creation.
date string
Transaction date (YYYY-MM-DD). Determines the accounting period.
description string
Transaction description. Required, max 500 characters.
reference string
Optional external reference (e.g. bank reference, cheque number). Max 100 characters.
sourceType string
Origin of the transaction: manual, invoice, or bank_import. Determines deletion rules.
sourceId string
Prefixed ID of the source document (e.g. inv_42 for invoice-generated journals), or null for manual entries.
status string
Either draft (editable, excluded from reports) or posted (immutable, included in balances).
isReconciled string
Whether the transaction has been matched against a bank statement. Only posted transactions can be reconciled.
reconciledAt string
ISO 8601 timestamp when reconciled, or null.
periodId string
Accounting period identifier, if period-lock is enabled.
createdBy string
Prefixed user ID of the creator.
createdByName string
Display name of the creator.
metadata string
Custom key-value pairs. Max 50 keys, values must be strings. Keys prefixed _sb_ are reserved.
totalDebit string
Sum of positive line amounts in minor units (pence). List endpoint only.
totalCredit string
Sum of absolute negative line amounts in minor units (pence). List endpoint only.
accountCodes string
Comma-separated list of account codes involved. List endpoint only.
accountLabels string
Comma-separated list of account code + name labels. List endpoint only.
createdAt string
ISO 8601 creation timestamp.
updatedAt string
ISO 8601 last-updated timestamp.