Get a loan's subledger register

GET/api/v1/loans/{instrument_id}/subledger

A single loan's full subledger register, oldest entry first.

Each row records one event (disbursement, payment, interest accrual, write-off, adjustment) with the running principal and accrued interest balances after the event and a link to the GL entry.

Operation ID: get_loan_register_api_v1_loans__instrument_id__subledger_get·View as markdown·OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Parameters

Path

instrument_idstringrequired

Responses

200Successful Response

Schema: SuccessEnvelope_LoanSubledgerResponse_

successboolean
messagestring
codestring
dataLoanSubledgerResponse

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

404Not Found - Resource does not exist

422Validation Error

Schema: HTTPValidationError

detailarray · ValidationErrorValidationError

5 fields

locarray · string | integerrequired
msgstringrequired
typestringrequired
inputobject
ctxobject

Code samples

GET/api/v1/loans/{instrument_id}/subledger

bash

curl -X GET 'https://api.ondayzero.com/api/v1/loans/{instrument_id}/subledger' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID'