Get a rendered statement

GET/api/v1/credit/lines/{credit_line_id}/statements/{cycle_id}

The statement document for one period: the roll-forward, every loan on it with its term, due date, interest and payments, and the amount due. format=pdf returns the document carrying the program's branding and lending entity; format=csv returns the transaction-level spreadsheet; format=html the printable page. The partner provides the download affordance and nothing else. The issued part is the snapshot written at close and never changes; since_statement lists what has touched the statement's loans since it was issued and ends in what they owe now. view=issued (the default for json, pdf and html) returns the loan rows as issued; view=current (the default for csv) recomputes them from today's records. pdf and html are always the issued document.

Operation ID: get_statement·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

credit_line_idstringrequired
cycle_idstringrequired

Query

formatstringdefault: json

json (the default): the statement as data. html, pdf: the issued document. csv: the transaction-level spreadsheet.

One of: json, html, pdf, csv

viewstring

issued: the loan rows exactly as the statement was issued. current: recomputed from today's records. Defaults to current for csv and issued otherwise; current is refused for pdf and html (CREDIT_641), and any other value is CREDIT_640.

Responses

200The statement: the JSON envelope, or with `format` the printable page (`text/html`), the spreadsheet (`text/csv`) or the document (`application/pdf`).

Schema: SuccessEnvelope_StatementDocumentResponse_

successboolean
messagestring
codestring
dataStatementDocumentResponse

400Bad Request - Invalid input

Schema: ErrorResponse

errorstringrequired: Error category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.
messagestringrequired: Human-readable explanation, safe to show to end users.
codestringrequired: Stable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).
request_idstring: Correlation id for support requests. Echoes the x-request-id request header when one was supplied.
errorsobject: Field-level validation messages keyed by field name. Present on 400/422 validation failures only.

401Unauthorized - Missing or expired token, an MCP OAuth token used against the REST API, or no access to this business

Schema: ErrorResponse

errorstringrequired: Error category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.
messagestringrequired: Human-readable explanation, safe to show to end users.
codestringrequired: Stable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).
request_idstring: Correlation id for support requests. Echoes the x-request-id request header when one was supplied.
errorsobject: Field-level validation messages keyed by field name. Present on 400/422 validation failures only.

403Forbidden - Insufficient permissions

Schema: ErrorResponse

errorstringrequired: Error category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.
messagestringrequired: Human-readable explanation, safe to show to end users.
codestringrequired: Stable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).
request_idstring: Correlation id for support requests. Echoes the x-request-id request header when one was supplied.
errorsobject: Field-level validation messages keyed by field name. Present on 400/422 validation failures only.

404Not Found - Resource does not exist

Schema: ErrorResponse

errorstringrequired: Error category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.
messagestringrequired: Human-readable explanation, safe to show to end users.
codestringrequired: Stable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).
request_idstring: Correlation id for support requests. Echoes the x-request-id request header when one was supplied.
errorsobject: Field-level validation messages keyed by field name. Present on 400/422 validation failures only.

422Validation Error

Schema: ErrorResponse

errorstringrequired: Error category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.
messagestringrequired: Human-readable explanation, safe to show to end users.
codestringrequired: Stable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).
request_idstring: Correlation id for support requests. Echoes the x-request-id request header when one was supplied.
errorsobject: Field-level validation messages keyed by field name. Present on 400/422 validation failures only.

Code samples

GET/api/v1/credit/lines/{credit_line_id}/statements/{cycle_id}

bash

curl -X GET 'https://api.ondayzero.com/api/v1/credit/lines/{credit_line_id}/statements/{cycle_id}' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID'

Authentication

Parameters

Path

Query

Responses

200The statement: the JSON envelope, or with format the printable page (text/html), the spreadsheet (text/csv) or the document (application/pdf).

400Bad Request - Invalid input

401Unauthorized - Missing or expired token, an MCP OAuth token used against the REST API, or no access to this business

403Forbidden - Insufficient permissions

404Not Found - Resource does not exist

422Validation Error

200The statement: the JSON envelope, or with `format` the printable page (`text/html`), the spreadsheet (`text/csv`) or the document (`application/pdf`).