Soft-delete a debt instrument

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

Remove a debt instrument from the schedule (soft delete).

Operation ID:

cfo_portal_delete_debt_instrument_api_v1_businesses__business_id__cfo_portal_debt_schedule_instruments__instrument_id__delete

·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

Responses

200Successful Response

Schema: app__core__success__MessageResponse

successboolean
messagestring
codestring

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

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

bash

curl -X DELETE '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'