200Successful Response
Schema: SuccessEnvelope_SubledgerResponse_
successbooleanmessagestringcodestringdataSubledgerResponse
/api/v1/credit/lines/{credit_line_id}/subledgerPer-transaction programs: the summary band (Total Balance and Statement Balance, which are different figures), one row per card transaction with its loan id, fee, term, due date, accrued interest, outstanding and status, and the period history. Filters run server-side on loan status and on a date range by transaction date or due date, with a cursor over the rows. Selecting a period re-renders the band for it. Cycle-draw programs return the roll-forward band and cycle rows.
Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.
credit_line_idstringrequiredcycle_idstringRender the band for this period. Defaults to the latest.
statusstringComma-separated loan states (active, past_due, paid, written_off) or cycle states.
startstring · dateRange start (inclusive).
endstring · dateRange end (inclusive).
date_basisstringdefault: transactionWhich date the range applies to.
One of: transaction, due
limitintegerdefault: 200Loan rows per page.
cursorstringloans_next_cursor from the previous page.
Schema: SuccessEnvelope_SubledgerResponse_
successbooleanmessagestringcodestringdataSubledgerResponseSchema: ErrorResponse
errorstringrequiredError category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.
messagestringrequiredHuman-readable explanation, safe to show to end users.
codestringrequiredStable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).
request_idstringCorrelation id for support requests. Echoes the x-request-id request header when one was supplied.
errorsobjectField-level validation messages keyed by field name. Present on 400/422 validation failures only.
Schema: ErrorResponse
errorstringrequiredError category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.
messagestringrequiredHuman-readable explanation, safe to show to end users.
codestringrequiredStable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).
request_idstringCorrelation id for support requests. Echoes the x-request-id request header when one was supplied.
errorsobjectField-level validation messages keyed by field name. Present on 400/422 validation failures only.
Schema: ErrorResponse
errorstringrequiredError category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.
messagestringrequiredHuman-readable explanation, safe to show to end users.
codestringrequiredStable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).
request_idstringCorrelation id for support requests. Echoes the x-request-id request header when one was supplied.
errorsobjectField-level validation messages keyed by field name. Present on 400/422 validation failures only.
Schema: ErrorResponse
errorstringrequiredError category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.
messagestringrequiredHuman-readable explanation, safe to show to end users.
codestringrequiredStable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).
request_idstringCorrelation id for support requests. Echoes the x-request-id request header when one was supplied.
errorsobjectField-level validation messages keyed by field name. Present on 400/422 validation failures only.
Schema: ErrorResponse
errorstringrequiredError category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.
messagestringrequiredHuman-readable explanation, safe to show to end users.
codestringrequiredStable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).
request_idstringCorrelation id for support requests. Echoes the x-request-id request header when one was supplied.
errorsobjectField-level validation messages keyed by field name. Present on 400/422 validation failures only.