Get a fee debt

{ "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" }

{ "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" } }

Authorizations

Authorization

string

header

required

JWT bearer token issued by the identity provider.

Path Parameters

organization_id

string

required

Organization ID (UUID)

ledger_id

string

required

Ledger ID (UUID)

debt_id

string

required

Fee debt ID

Response

assetCode

string

required

Example:

"BRL"

createdAt

string<date-time>

required

When the earliest recorded change was applied

creditBalance

string

required

Fee account balance the debt pays, as alias#key

Example:

"@fees#default"

debtorBalance

string

required

Debtor balance as alias#key

Example:

"@payer#default"

entries

object[] | null

required

Recorded changes, oldest first

Show child attributes

string

required

Origin transaction id and the fee debit posting the debt opened in

Example:

"01920000-0000-7000-8000-000000000001:from:1:debit"

ledgerId

string

required

Example:

"01920000-0000-7000-8000-00000000000b"

openedAmount

string

required

Example:

"70"

organizationId

string

required

Example:

"01920000-0000-7000-8000-00000000000a"

originTransactionId

string

required

Example:

"01920000-0000-7000-8000-000000000001"

remaining

string

required

Example:

"40"

seq

integer<int64>

required

Settlement order among the debtor's debts, oldest first

Example:

3

updatedAt

string<date-time>

required

When the latest recorded change was applied

feePackageId

string

Example:

"01920000-0000-7000-8000-0000000000cc"

openedAt

string<date-time>

Getting started

Core

CRM

Fees

Error handling

Events

Get a fee debt

Authorizations

Path Parameters

Response