A ledger_account_settlement is an object that creates a ledger transaction to safely offset the posted balance of a ledger account.
| Attribute | Description |
|---|---|
| id string | Unique identifier for the ledger account settlement. |
| description string | An optional free-form description for internal use. |
| status string | One of drafting, processing, pending, posted, archiving or archived. |
| settlement_entry_direction string | The direction of the ledger entry with the settled_ledger_account. |
| settled_ledger_account_id string | The Ledger Account that we will query the Entries against, and its balance is reduced as a result. The settled ledger account and the contra ledger account must belong to the same ledger. For example, let’s say we’re a ride-sharing app. To pay out a specific driver, the settled_ledger_account_id would reference a payable account belonging to a driver, and the contra_ledger_accout_id would be your corporate cash account. |
| contra_ledger_account_id string | The Ledger Account that sends to or receives funds from the settled ledger account. The settled ledger account and the contra ledger account must belong to the same ledger. For example, let’s say we’re a ride-sharing app. To pay out a specific driver, the settled_ledger_account_id would reference a payable account belonging to a driver, and the contra_ledger_accout_id would be your corporate cash account. |
| effective_at_upper_bound datetime | The exclusive upper bound of the effective time of entries included in the ledger account settlement. |
| ledger_transaction_id string | The ID of the Settlement Ledger Transaction. |
| amount int | Value in specified currency’s smallest unit. Can be any integer up to 10³⁶. The amount is null when the Settlement is in processing status. |
| currency string | The currency of the ledger account settlement. |
| currency_exponent int32 | The currency exponent of the ledger account settlement. |
| metadata object | Additional data represented as key-value pairs. Both the key and value must be strings. See Metadata. |
| live_mode boolean | This field will be true if this object was created with a production API key or false if created with a test API key. |
{
"id": "dbdbbfe5-da56-4aaf-be36-3fbc415622dd",
"object": "ledger_account_settlement",
"live_mode": true,
"description": "Alice's January settlement",
"settled_ledger_account_id": "d44ad0d0-b3ea-4698-867d-09fe961e52a6",
"contra_ledger_account_id": "3824af4d-4151-48f6-8e8b-bf859cbddbcd",
"effective_at_upper_bound": "2023-01-01T00:00:00.000Z",
"status": "pending",
"amount": 1000,
"currency": "USD",
"ledger_transaction_id": "b47ce462-806b-4d5d-9476-9add11a42529",
"metadata": {
"foo": "bar"
},
"created_at": "2023-01-11T20:35:36Z",
"updated_at": "2023-01-11T20:36:02Z"
}