Parse debt contract into a draft payment schedule

POST/api/v1/businesses/{business_id}/cfo-portal/debt-schedule/parse-contract

Parse an uploaded lending contract into structured terms and schedule.

Request Body:

s3_key: S3 key of an uploaded contract document (required).

Returns: A draft :class:ParsedDebtContract and projected payout table. Fixed-term loans return up to 12 months of amortization; revenue-based financing returns a single "until cap" row instead of fabricated rows.

Operation ID: cfo_portal_parse_debt_contract_api_v1_businesses__business_id__cfo_portal_debt_schedule_parse_contract_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

Request body

Schema: DebtContractParseRequest

s3_keystringrequired: S3 key of the uploaded debt contract document.

Responses

201Successful Response

Schema: SuccessEnvelope_ParseDebtContractResponse_

successboolean
messagestring
codestring
dataParseDebtContractResponse

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/parse-contract

bash

curl -X POST 'https://api.ondayzero.com/api/v1/businesses/{business_id}/cfo-portal/debt-schedule/parse-contract' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID' \
  -H 'Content-Type: application/json' \
  -d '{
  "s3_key": "string"
}'