Read actual obligation allocations and opaque cash-reconciliation status

GET/ledger/payable-obligations/{id}/status

Verified owning source service or svc_payments reads exact reserved, gross paid, returned, refunded, unallocated and net unpaid amounts plus opaque remittance identities and current independent cash readiness. These values do not claim a receiving servicer applied a payment to a loan.

Path parameters

idstringRequired

Returns

200 OK

blockersarray of stringsOptional

cash_readybooleanRequired

obligationobjectRequired

22 child attributes

account_idstringOptional

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

amount_minorintegerRequired

content_sha256stringRequired

created_atstring · date-timeRequired

currencystringRequired

customer_idstringRequired

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

evidence_referencestringRequired

hold_idstringRequired

Example hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm

idstringRequired

issuerstringRequired

jurisdictionstringOptional

kindstringRequired

legal_entitystringRequired

loan_idstringOptional

Example loan_2tVh8nqLxq4GbDe0K1F6S9zRcWm

payee_referencestringOptional

sourceobjectRequired

6 child attributes

closure_componentstringOptional

closure_ledger_account_idstringOptional

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

journal_idstringRequired

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

journal_keystringRequired

journal_sha256stringRequired

ledger_account_idstringRequired

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

source_datestring · dateRequired

A business date, YYYY-MM-DD

source_date_basisstringOptional

source_idstringRequired

source_sha256stringRequired

tax_customer_idstringOptional

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

tax_periodstringOptional

paid_minorintegerRequired

refunded_minorintegerRequired

remittance_idsarray of stringsRequired

reserved_minorintegerRequired

returned_minorintegerRequired

unallocated_minorintegerRequired

unpaid_minorintegerRequired

Errors

Every error is a problem document with a stable code. See Errors.

400401403404409412413422424429500503