Ledger Accounts
List ledger accounts
Changed onReturns a paginated list of ledger accounts scoped to the authenticated tenant.
Supports Flop pagination and filtering:
- page - Page number (1-indexed, default: 1)
- page_size - Items per page (default: 20, max: 100)
- order_by - Field to sort by
- order_directions - Sort direction (asc or desc)
- filters - Flop filters (ledger_id, account_holder_id, account_type, status)
get/api/ledger-accounts
Request
- Base URL: http://localhost:4100
- URL: http://localhost:4100/api/ledger-accounts
- Auth: none required
Query parameters
pageinteger
Page number (1-indexed)
page_sizeinteger
Items per page (max: 100)
order_bystring
Field to sort by
order_directionsstring
Sort direction (asc or desc)
Response
Ledger account list
Example response
{
"data": [
{
"account_holder_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
"balance": 0,
"counterparty_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
"currency": "",
"id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
"inserted_at": "2020-04-20T16:20:00Z",
"la_type": "account_holder_root",
"ledger_account_number": "",
"ledger_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
"linked_ledger_accounts": [
null
],
"payment_account_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
"regime": "",
"status": "active",
"tenant_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
"updated_at": "2020-04-20T16:20:00Z"
}
],
"meta": {
"page": 1,
"page_size": 50,
"total_count": 125,
"total_pages": 3
}
}Changes
- breaking
removed the required property
//from the response with the status - warning
removed the optional property
//from the response with the status - warning
removed the optional property
//from the response with the status - info
added the optional property
//to the response with the status - info
added the optional property
//to the response with the status - info
added the optional property
//to the response with the status - info
added the optional property
//to the response with the status - info
added the required property
//to the response with the status
- breaking