Add a covenant to a debt instrument

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

Attach a financial covenant to a loan.

Operation ID:

cfo_portal_create_debt_covenant_api_v1_businesses__business_id__cfo_portal_debt_schedule_instruments__instrument_id__covenants_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: DebtCovenantCreateRequest

metric_namestringrequired
operatorstringrequired: CovenantOperatorEnum: greater_than, less_than, greater_than_or_equal, less_than_or_equal.
threshold_valuestringrequired
measurement_frequencystring: PaymentFrequencyEnum cadence for measurement.
descriptionstring

Responses

201Successful Response

Schema: SuccessEnvelope_DebtCovenantResponse_

successboolean
messagestring
codestring
dataDebtCovenantResponse

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}/covenants

bash

curl -X POST 'https://api.ondayzero.com/api/v1/businesses/{business_id}/cfo-portal/debt-schedule/instruments/{instrument_id}/covenants' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID' \
  -H 'Content-Type: application/json' \
  -d '{
  "metric_name": "string",
  "operator": "string",
  "threshold_value": "string"
}'