Update a debt instrument

PATCH/api/v1/businesses/{business_id}/cfo-portal/debt-schedule/instruments/{instrument_id}

Update editable fields on an existing debt instrument.

Request Body: Any of name, current_balance_cents, notes, amount_repaid_cents, revenue_share_bps, total_repayment_cap_cents.

Returns: The updated instrument snapshot.

Operation ID:

cfo_portal_update_debt_instrument_api_v1_businesses__business_id__cfo_portal_debt_schedule_instruments__instrument_id__patch

·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: DebtInstrumentUpdateRequest

namestring
current_balance_centsinteger
notesstring
amount_repaid_centsinteger
revenue_share_bpsinteger
total_repayment_cap_centsinteger

Responses

200Successful Response

Schema: SuccessEnvelope_DebtInstrumentUpdateResponse_

successboolean
messagestring
codestring
dataDebtInstrumentUpdateResponse

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

PATCH/api/v1/businesses/{business_id}/cfo-portal/debt-schedule/instruments/{instrument_id}

bash

curl -X PATCH 'https://api.ondayzero.com/api/v1/businesses/{business_id}/cfo-portal/debt-schedule/instruments/{instrument_id}' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string",
  "current_balance_cents": 0,
  "notes": "string",
  "amount_repaid_cents": 0,
  "revenue_share_bps": 0,
  "total_repayment_cap_cents": 0
}'