Balance Message
The Balance message represents the balance of a ledger account. This message is used to request
current balances and to set opening balances on ledger creation.
Business Rules
- The account referenced by the
account
, domain
, and currency
properties must be defined.
Balance Message Properties
Property |
Type |
Description |
account |
entityRef |
The unique code for the referenced account. |
amount |
string |
The current account balance (only on ledger create). |
currency |
string |
The currency of the requested balance. |
domain |
string |
Ledger domain code. If not provided the default is used. |
Requirements for each Command
Property |
Add |
Create |
Delete |
Get |
Update |
account |
X |
M |
X |
M |
X |
amount |
X |
M |
X |
_ |
X |
currency |
X |
M |
X |
M |
X |
domain |
X |
O |
X |
O |
X |
- O - Optional
- M - Must be supplied
- X - Invalid
- _ - Ignored