{"openapi":"3.1.0","info":{"title":"GET /api/v1/credit/lines/{credit_line_id}/covenant-checks","version":"1.0.0","description":"List a line's covenant checks"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/credit/lines/{credit_line_id}/covenant-checks":{"get":{"tags":["credit"],"summary":"List a line's covenant checks","description":"Every night's check on the line, newest first, optionally for one covenant. Pass `next_cursor` back as `cursor` for older nights.","operationId":"list_line_covenant_checks","parameters":[{"name":"credit_line_id","in":"path","required":true,"schema":{"type":"string","description":"Credit line ID. The lender's routes need a line this business operates; the borrower's read also accepts a line it borrows on.","title":"Credit Line Id"},"description":"Credit line ID. The lender's routes need a line this business operates; the borrower's read also accepts a line it borrows on."},{"name":"covenant_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Only this covenant's checks.","title":"Covenant Id"},"description":"Only this covenant's checks."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":366,"minimum":1,"description":"Checks per page.","default":60,"title":"Limit"},"description":"Checks per page."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Pass `next_cursor` unchanged for older checks.","title":"Cursor"},"description":"Pass `next_cursor` unchanged for older checks."},{"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"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_CovenantCheckListResponse_"}}}},"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 or expired token, an MCP OAuth token used against the REST API, 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":"list_line_covenant_checks_api_v1_credit_lines__credit_line_id__covenant_checks_get"}}},"components":{"schemas":{"CovenantCheckListResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/CovenantCheckResponse"},"type":"array","title":"Items","description":"Checks, newest first."},"has_next":{"type":"boolean","title":"Has Next","description":"Whether older checks exist."},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor","description":"Pass back as `cursor` for older checks."},"limit":{"type":"integer","title":"Limit","description":"Page size used."}},"type":"object","required":["has_next","limit"],"title":"CovenantCheckListResponse","description":"Checks on a line, newest first."},"CovenantCheckResponse":{"properties":{"id":{"type":"string","title":"Id","description":"Check id."},"covenant_id":{"type":"string","title":"Covenant Id","description":"The covenant tested."},"credit_line_id":{"type":"string","title":"Credit Line Id","description":"The line the covenant is on."},"as_of":{"type":"string","format":"date","title":"As Of","description":"The night the books were read to."},"checked_at":{"type":"string","format":"date-time","title":"Checked At","description":"When the check ran (UTC)."},"value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Value","description":"The measured figure; null when unmeasured."},"threshold":{"type":"number","title":"Threshold","description":"The threshold held to that night."},"status":{"type":"string","enum":["pass","warn","breach","unmeasured"],"title":"Status","description":"pass, warn (inside the band), breach or unmeasured."},"inputs":{"additionalProperties":true,"type":"object","title":"Inputs","description":"The figures behind the value, each a CovenantInputFigure with the ledgers and window to trace through the money-flow lineage."},"consecutive_breaches":{"type":"integer","title":"Consecutive Breaches","description":"Breached nights in a row ending with this one."},"limit_review_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Limit Review Id","description":"The limit-review proposal this night filed, if any."}},"type":"object","required":["id","covenant_id","credit_line_id","as_of","checked_at","threshold","status","consecutive_breaches"],"title":"CovenantCheckResponse","description":"One night's test of one covenant."},"SuccessEnvelope_CovenantCheckListResponse_":{"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/CovenantCheckListResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[CovenantCheckListResponse]"},"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":[]}]}