200Successful Response
Schema: SuccessEnvelope_PoFinancingPreviewResponse_
successbooleanmessagestringcodestringdataPoFinancingPreviewResponse
Preview funding a purchase order from a credit line
GET
/api/v1/purchase-orders/{po_id}/financing-previewFor the PO's total (its remaining balance once partly received): the 13-week cash forecast with the PO paid from cash and with it financed, each with its lowest week and balance; and, for each active line the business holds under a per-transaction program, the available credit against the PO amount and an estimated cost of funding it over term_days (simple interest at the program's default_rate_bps plus the disbursement fee), labelled an estimate. Read-only.
Authentication
Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.
Parameters
Path
po_idstringrequired
Query
term_daysintegerPrice the estimate over this term; defaults to each line's term.
Responses
400Bad Request - Invalid input
Schema: ErrorResponse
errorstringrequiredError category:
validation_error,unauthorized,forbidden,not_found,conflict,rate_limited,server_error, orservice_unavailable.messagestringrequiredHuman-readable explanation, safe to show to end users.
codestringrequiredStable machine-readable code in
CATEGORY_NNNform (e.g.NOT_FOUND_006,AUTH_010,GEN_002).request_idstringCorrelation id for support requests. Echoes the
x-request-idrequest header when one was supplied.errorsobjectField-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
errorstringrequiredError category:
validation_error,unauthorized,forbidden,not_found,conflict,rate_limited,server_error, orservice_unavailable.messagestringrequiredHuman-readable explanation, safe to show to end users.
codestringrequiredStable machine-readable code in
CATEGORY_NNNform (e.g.NOT_FOUND_006,AUTH_010,GEN_002).request_idstringCorrelation id for support requests. Echoes the
x-request-idrequest header when one was supplied.errorsobjectField-level validation messages keyed by field name. Present on 400/422 validation failures only.
403Forbidden - Insufficient permissions
Schema: ErrorResponse
errorstringrequiredError category:
validation_error,unauthorized,forbidden,not_found,conflict,rate_limited,server_error, orservice_unavailable.messagestringrequiredHuman-readable explanation, safe to show to end users.
codestringrequiredStable machine-readable code in
CATEGORY_NNNform (e.g.NOT_FOUND_006,AUTH_010,GEN_002).request_idstringCorrelation id for support requests. Echoes the
x-request-idrequest header when one was supplied.errorsobjectField-level validation messages keyed by field name. Present on 400/422 validation failures only.
404Not Found - Resource does not exist
Schema: ErrorResponse
errorstringrequiredError category:
validation_error,unauthorized,forbidden,not_found,conflict,rate_limited,server_error, orservice_unavailable.messagestringrequiredHuman-readable explanation, safe to show to end users.
codestringrequiredStable machine-readable code in
CATEGORY_NNNform (e.g.NOT_FOUND_006,AUTH_010,GEN_002).request_idstringCorrelation id for support requests. Echoes the
x-request-idrequest header when one was supplied.errorsobjectField-level validation messages keyed by field name. Present on 400/422 validation failures only.
422Validation Error
Schema: ErrorResponse
errorstringrequiredError category:
validation_error,unauthorized,forbidden,not_found,conflict,rate_limited,server_error, orservice_unavailable.messagestringrequiredHuman-readable explanation, safe to show to end users.
codestringrequiredStable machine-readable code in
CATEGORY_NNNform (e.g.NOT_FOUND_006,AUTH_010,GEN_002).request_idstringCorrelation id for support requests. Echoes the
x-request-idrequest header when one was supplied.errorsobjectField-level validation messages keyed by field name. Present on 400/422 validation failures only.