Skip to main content
GET
Error

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Parâmetros de caminho

organization_id
string
obrigatório

Organization ID (UUID)

ledger_id
string
obrigatório

Ledger ID (UUID)

Parâmetros de consulta

account_alias
string

Only the debts of this debtor account, in settlement order

balance_key
string

Debtor balance key; requires account_alias (default "default")

status
string

open: remaining above zero; settled: the rest. Absent lists both

limit
string

Number of items per page (default 10, max 100)

cursor
string

Opaque cursor from a previous page

Resposta

OK

items
object[] | null
obrigatório
limit
integer<int64>
obrigatório
Exemplo:

10

next_cursor
string
Exemplo:

"eyJpZCI6IjAxOTI..."

openTotal
string

What this debtor balance (account_alias and balance_key) owes over all its open debts, not only this page, each counting at most its opened amount; present only with account_alias

Exemplo:

"25"

prev_cursor
string
Exemplo:

"eyJpZCI6IjAxOTE..."