List the fee debts of a ledger, oldest first - Lerian

Error

A valid request URL is required to generate request examples

{
  "items": [
    {
      "assetCode": "BRL",
      "createdAt": "2023-11-07T05:31:56Z",
      "creditBalance": "@fees#default",
      "debtorBalance": "@payer#default",
      "entries": [
        {
          "amount": "30",
          "appliedAt": "2023-11-07T05:31:56Z",
          "kind": "settled",
          "transactionId": "01920000-0000-7000-8000-000000000002",
          "postingRef": "to:0:credit:collect"
        }
      ],
      "id": "01920000-0000-7000-8000-000000000001:from:1:debit",
      "ledgerId": "01920000-0000-7000-8000-00000000000b",
      "openedAmount": "70",
      "organizationId": "01920000-0000-7000-8000-00000000000a",
      "originTransactionId": "01920000-0000-7000-8000-000000000001",
      "remaining": "40",
      "seq": 3,
      "updatedAt": "2023-11-07T05:31:56Z",
      "feePackageId": "01920000-0000-7000-8000-0000000000cc",
      "openedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "limit": 10,
  "next_cursor": "eyJpZCI6IjAxOTI...",
  "openTotal": "25",
  "prev_cursor": "eyJpZCI6IjAxOTE..."
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

GET

/

v2

/

organizations

/

{organization_id}

/

ledgers

/

{ledger_id}

/

fee-debts

Error

A valid request URL is required to generate request examples

{
  "items": [
    {
      "assetCode": "BRL",
      "createdAt": "2023-11-07T05:31:56Z",
      "creditBalance": "@fees#default",
      "debtorBalance": "@payer#default",
      "entries": [
        {
          "amount": "30",
          "appliedAt": "2023-11-07T05:31:56Z",
          "kind": "settled",
          "transactionId": "01920000-0000-7000-8000-000000000002",
          "postingRef": "to:0:credit:collect"
        }
      ],
      "id": "01920000-0000-7000-8000-000000000001:from:1:debit",
      "ledgerId": "01920000-0000-7000-8000-00000000000b",
      "openedAmount": "70",
      "organizationId": "01920000-0000-7000-8000-00000000000a",
      "originTransactionId": "01920000-0000-7000-8000-000000000001",
      "remaining": "40",
      "seq": 3,
      "updatedAt": "2023-11-07T05:31:56Z",
      "feePackageId": "01920000-0000-7000-8000-0000000000cc",
      "openedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "limit": 10,
  "next_cursor": "eyJpZCI6IjAxOTI...",
  "openTotal": "25",
  "prev_cursor": "eyJpZCI6IjAxOTE..."
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

Autorizaciones

Authorization

string

header

requerido

JWT bearer token issued by the identity provider.

Parámetros de ruta

organization_id

string

requerido

Organization ID (UUID)

ledger_id

string

requerido

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

Respuesta

OK

items

object[] | null

requerido

Show child attributes

limit

integer<int64>

requerido

Ejemplo:

10

next_cursor

string

Ejemplo:

"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

Ejemplo:

"25"

prev_cursor

string

Ejemplo:

"eyJpZCI6IjAxOTE..."