Properties
| Name | Type | Description |
|---|---|---|
| effective_at_lower_bound | string | The inclusive lower bound of the effective_at timestamp for the returned balances. |
| effective_at_upper_bound | string | The exclusive upper bound of the effective_at timestamp for the returned balances. |
| pending_balance | object | The pending_balance is the sum of all pending and posted entries. |
| posted_balance | object | The posted_balance is the sum of all posted entries. |
| available_balance | object | The available_balance is the sum of all posted inbound entries and pending outbound entries. For credit normal, available_amount = posted_credits - pending_debits; for debit normal, available_amount = |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/ledger_balances_with_effective_at",
"title": "ledger_balances_with_effective_at",
"type": "object",
"properties": {
"effective_at_lower_bound": {
"type": "string",
"format": "date-time",
"description": "The inclusive lower bound of the effective_at timestamp for the returned balances.",
"nullable": true
},
"effective_at_upper_bound": {
"type": "string",
"format": "date-time",
"description": "The exclusive upper bound of the effective_at timestamp for the returned balances.",
"nullable": true
},
"pending_balance": {
"$ref": "#/components/schemas/ledger_balance",
"description": "The pending_balance is the sum of all pending and posted entries."
},
"posted_balance": {
"$ref": "#/components/schemas/ledger_balance",
"description": "The posted_balance is the sum of all posted entries."
},
"available_balance": {
"$ref": "#/components/schemas/ledger_balance",
"description": "The available_balance is the sum of all posted inbound entries and pending outbound entries. For credit normal, available_amount = posted_credits - pending_debits; for debit normal, available_amount = posted_debits - pending_credits."
}
},
"additionalProperties": false,
"minProperties": 5,
"required": [
"effective_at_lower_bound",
"effective_at_upper_bound",
"pending_balance",
"posted_balance",
"available_balance"
]
}