Financials pillar · v0.16.0

bank-transaction BankTransaction

One bank-statement line.

$id · https://corpospec.com/schemas/v0.16.0/bank-transaction.schema.json

Fields

Field Type Required Description
amount number yes Signed amount (positive = inflow, negative = outflow).
bank_account PathRef yes Path-based cross-reference relative to .corpospec/ root. Pattern: `^[a-z0-9_-]+(/[a-z0-9_.-]+)+$`
booking_date IsoDate yes When the bank posted the transaction.
currency IsoCurrency yes ISO 4217 currency code.
description string yes
id PathRef yes Path-based cross-reference relative to .corpospec/ root. Pattern: `^[a-z0-9_-]+(/[a-z0-9_.-]+)+$`
import_source ImportSource yes Where the bank transaction came from.
reconciliation_status BankReconcStatus yes Reconciliation status of a bank transaction.
value_date IsoDate yes When the transaction cleared.
bank_statement_id string? Bank-statement identifier (required for HBCI / EBICS imports).
counterparty PathRef? PathRef into the counterparty's `legal/parties/<slug>` when identifiable.
reconciled_to PathRef[] Invoice / journal PathRefs this transaction matches against.
reference string? SEPA reference (EREF / KREF / SVWZ / Mandate ID).

Definitions

Shared types referenced within this schema.

BankReconcStatus
Reconciliation status of a bank transaction.
enum: "unreconciled", "partially_reconciled", "reconciled", "disputed"
ImportSource
Where the bank transaction came from.
IsoCurrency
ISO 4217 currency code.
pattern: ^[A-Z]{3}$
IsoDate
ISO 8601 date (YYYY-MM-DD).
type: string
PathRef
Path-based cross-reference relative to .corpospec/ root. Pattern: `^[a-z0-9_-]+(/[a-z0-9_.-]+)+$`
pattern: ^[a-z0-9_-]+(/[a-z0-9_.-]+)+$

Reference in your YAML

# yaml-language-server: $schema=https://corpospec.com/schemas/v0.16.0/bank-transaction.schema.json