{"openapi":"3.1.0","info":{"title":"POST /api/v1/businesses/{business_id}/cfo-portal/debt-schedule/instruments/{instrument_id}/payment-schedule/rows","version":"1.0.0","description":"Add a row to a loan's paydown table"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/businesses/{business_id}/cfo-portal/debt-schedule/instruments/{instrument_id}/payment-schedule/rows":{"post":{"tags":["cfo-portal"],"summary":"Add a row to a loan's paydown table","description":"Add a user-defined payment row to a loan's paydown table.","operationId":"cfo_portal_add_debt_schedule_row","parameters":[{"name":"business_id","in":"path","required":true,"schema":{"type":"string","title":"Business Id"}},{"name":"instrument_id","in":"path","required":true,"schema":{"type":"string","title":"Instrument Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"x-business-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Business-Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DebtScheduleRowCreateRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_DebtScheduleResponse_"}}}},"400":{"description":"Bad Request - Invalid input","content":{"application/json":{"example":{"error":"validation_error","message":"Validation failed: due_date: Input should be a valid date","errors":{"due_date":"Input should be a valid date"},"code":"GEN_002","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized - Missing/invalid token or no access to this business","content":{"application/json":{"example":{"error":"unauthorized","message":"Authentication required","code":"AUTH_001","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"example":{"error":"forbidden","message":"You don't have permission to access this resource","code":"AUTH_002","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found - Resource does not exist","content":{"application/json":{"example":{"error":"not_found","message":"Resource not found","code":"NOT_FOUND_001","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"validation_error","message":"Validation failed: amount: Input should be a valid integer","errors":{"amount":"Input should be a valid integer"},"code":"GEN_002","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"}}}}},"x-fastapi-operation-id":"cfo_portal_add_debt_schedule_row_api_v1_businesses__business_id__cfo_portal_debt_schedule_instruments__instrument_id__payment_schedule_rows_post"}}},"components":{"schemas":{"DebtScheduleResponse":{"properties":{"instrument_id":{"type":"string","title":"Instrument Id"},"name":{"type":"string","title":"Name"},"direction":{"type":"string","title":"Direction"},"current_balance_cents":{"type":"integer","title":"Current Balance Cents"},"rows":{"items":{"$ref":"#/components/schemas/DebtScheduleRowResponse"},"type":"array","title":"Rows"},"total_principal_cents":{"type":"integer","title":"Total Principal Cents","default":0},"total_interest_cents":{"type":"integer","title":"Total Interest Cents","default":0},"total_payment_cents":{"type":"integer","title":"Total Payment Cents","default":0}},"type":"object","required":["instrument_id","name","direction","current_balance_cents"],"title":"DebtScheduleResponse","description":"The full paydown table for a debt instrument plus summary totals."},"DebtScheduleRowCreateRequest":{"properties":{"due_date":{"type":"string","format":"date","title":"Due Date"},"principal_cents":{"type":"integer","minimum":0.0,"title":"Principal Cents","default":0},"interest_cents":{"type":"integer","minimum":0.0,"title":"Interest Cents","default":0},"note":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}],"title":"Note"}},"type":"object","required":["due_date"],"title":"DebtScheduleRowCreateRequest","description":"Request to add a custom row to a loan's paydown table."},"DebtScheduleRowResponse":{"properties":{"id":{"type":"string","title":"Id"},"debt_instrument_id":{"type":"string","title":"Debt Instrument Id"},"sequence":{"type":"integer","title":"Sequence"},"due_date":{"type":"string","format":"date","title":"Due Date"},"principal_cents":{"type":"integer","title":"Principal Cents"},"interest_cents":{"type":"integer","title":"Interest Cents"},"total_cents":{"type":"integer","title":"Total Cents"},"expected_balance_after_cents":{"type":"integer","title":"Expected Balance After Cents"},"status":{"type":"string","title":"Status"},"is_custom_edited":{"type":"boolean","title":"Is Custom Edited"},"paid_amount_cents":{"type":"integer","title":"Paid Amount Cents"},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note"}},"type":"object","required":["id","debt_instrument_id","sequence","due_date","principal_cents","interest_cents","total_cents","expected_balance_after_cents","status","is_custom_edited","paid_amount_cents"],"title":"DebtScheduleRowResponse","description":"A single persisted, editable row of a loan's paydown table."},"SuccessEnvelope_DebtScheduleResponse_":{"properties":{"success":{"type":"boolean","title":"Success","default":true},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code"},"data":{"anyOf":[{"$ref":"#/components/schemas/DebtScheduleResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[DebtScheduleResponse]"},"ErrorResponse":{"title":"ErrorResponse","type":"object","description":"Envelope returned by every non-2xx response. Branch on `code` (stable) rather than `message` (human-readable, may change).","required":["error","message","code"],"properties":{"error":{"type":"string","description":"Error category: `validation_error`, `unauthorized`, `forbidden`, `not_found`, `conflict`, `rate_limited`, `server_error`, or `service_unavailable`."},"message":{"type":"string","description":"Human-readable explanation, safe to show to end users."},"code":{"type":"string","description":"Stable machine-readable code in `CATEGORY_NNN` form (e.g. `NOT_FOUND_006`, `AUTH_010`, `GEN_002`)."},"request_id":{"type":"string","description":"Correlation id for support requests. Echoes the `x-request-id` request header when one was supplied."},"errors":{"type":"object","additionalProperties":{"type":"string"},"description":"Field-level validation messages keyed by field name. Present on 400/422 validation failures only."}}}},"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API Token","description":"API token authentication. Format: `Bearer dz_...`"}}},"security":[{"BearerAuth":[]}]}