Open Balance Schemas¶

All fields applicable to the Open Balance product. Open Balance is a lightweight schema — its primary purpose is delivering a current balance snapshot per document for portal display and payment facilitation.

For shared schemas (Currency Models, etc.) see Shared Schemas & Currency Models.

Account¶

Only the account name and reference are applicable to Open Balance. Account records are still required as parent resources for documents.

Field	Type	Required	Description
reference	string	Yes	Caller-defined unique identifier.
name	string	Yes	Customer name.

Document¶

Core Fields¶

Field	Type	Required	Description
account_number	string	Yes	Account this document belongs to.
invoice_num	string	Conditional	Display invoice number shown in portals. If omitted, the URL path `document_number` is used.
applies_to_invoice	string	Conditional	Required when `document_type` is `credit_note`.
invoice_date	date (ISO 8601)	Yes	Document issue date.
ship_to_account_num	string	No	Ship-to customer account number.
po_number	string	No	Purchase order number.
fabricated_record	boolean	No	True indicates this document was synthesised by Data Bridge and does not correspond to a real invoice in the caller's ERP.
branch_name	string	Conditional	Branch / territory identifier. Required for multi-entity deployments.
discount_date	date	No	Early-payment discount expiry date.
discount_amount	string	No	Early-payment discount amount.
template_id	string	Conditional	Open Balance template ID. Required when configured to accept flexible payments on fabricated records.

Custom Fields (UDP)¶

Up to 5 User Defined Properties, configurable for portal display columns.

Field	Type	Description
udp1	string	Open Balance custom field 1
udp2	string	Open Balance custom field 2
udp3	string	Open Balance custom field 3
udp4	string	Open Balance custom field 4
udp5	string	Open Balance custom field 5

Financial Fields — Basic Currency Model¶

All three fields must be provided together.

Field	Type	Required	Description
currency	ISO 4217	Conditional*	ISO 4217 currency code. *All three Basic fields must be provided together.
original_denomination	denomination	Conditional*	Original gross amount. Does not change when partially paid.
denomination	denomination	Conditional*	Current open balance. When 0, document is automatically closed.

Closure¶

Field	Type	Required	Description
closure_reason	string	Yes	One of: `paid`, `write_off`, `contra`, `adjustment`, `other`
closure_date	date (ISO 8601)	No	Date of closure. Defaults to current date if absent.
notes	string	No	Free-text notes on the closure.