Generate or rebuild a loan's paydown table

POST/api/v1/businesses/{business_id}/cfo-portal/debt-schedule/instruments/{instrument_id}/payment-schedule/generate

(Re)generate a loan's paydown table from its terms.

Request Body:

overwrite_custom: when true, discard hand-edited rows and rebuild the whole table; when false, preserve customized rows.

Operation ID:

cfo_portal_generate_debt_schedule_api_v1_businesses__business_id__cfo_portal_debt_schedule_instruments__instrument_id__payment_schedule_generate_post

·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

business_idstringrequired
instrument_idstringrequired

Request body

Schema: DebtScheduleGenerateRequest

overwrite_customboolean: When true, discard existing rows (including user-edited ones) and rebuild the whole schedule from the instrument's terms. When false, regeneration preserves rows the user customized.

Responses

201Successful Response

Schema: SuccessEnvelope_DebtScheduleResponse_

successboolean
messagestring
codestring
dataDebtScheduleResponse

400Bad Request - Invalid input

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

POST/api/v1/businesses/{business_id}/cfo-portal/debt-schedule/instruments/{instrument_id}/payment-schedule/generate

bash

curl -X POST 'https://api.ondayzero.com/api/v1/businesses/{business_id}/cfo-portal/debt-schedule/instruments/{instrument_id}/payment-schedule/generate' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID' \
  -H 'Content-Type: application/json' \
  -d '{
  "overwrite_custom": false
}'