{"openapi":"3.1.0","info":{"title":"POST /api/v1/credit/lines/{credit_line_id}/covenants","version":"1.0.0","description":"Add a covenant to a line"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/credit/lines/{credit_line_id}/covenants":{"post":{"tags":["credit"],"summary":"Add a covenant to a line","description":"Writes a covenant the nightly sweep tests against the borrower's books from tonight on. `comparison` defaults to the kind's own (gte for the minimums, lte for max_leverage) and is required for `custom_ratio`, which also needs a numerator and a denominator selector naming at least one ledger id, type or concept (`400` otherwise). A line with no `merchant_business_id` accepts covenants but every check reads `unmeasured` until the borrower's business is linked.","operationId":"create_line_covenant","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":"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/CovenantCreate"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_CovenantResponse_"}}}},"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":"create_line_covenant_api_v1_credit_lines__credit_line_id__covenants_post"}}},"components":{"schemas":{"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."},"CovenantCreate":{"properties":{"kind":{"type":"string","enum":["min_cash","max_leverage","min_dscr","min_inventory_turns","min_current_ratio","custom_ratio"],"title":"Kind","description":"min_cash (cash ledgers' balance, currency), max_leverage (total liabilities / total equity), min_dscr (debt service coverage, the underwriting measurer), min_inventory_turns (cost of goods sold over 365 days / average inventory), min_current_ratio (current assets / current liabilities) or custom_ratio (two selectors)."},"label":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Label","description":"How the console names it."},"threshold":{"type":"number","title":"Threshold","description":"Whole currency units for min_cash; a decimal ratio otherwise."},"comparison":{"anyOf":[{"type":"string","enum":["gte","gt","lte","lt"]},{"type":"null"}],"title":"Comparison","description":"value <comparison> threshold passes. Defaults to the kind's own (gte for the minimums, lte for max_leverage); required for custom_ratio."},"warn_band_bps":{"type":"integer","maximum":10000.0,"minimum":0.0,"title":"Warn Band Bps","description":"A pass within this share of the threshold warns (1000 = 10%).","default":0},"numerator_selector":{"anyOf":[{"$ref":"#/components/schemas/LedgerSelector"},{"type":"null"}],"description":"custom_ratio only: the numerator's ledgers."},"denominator_selector":{"anyOf":[{"$ref":"#/components/schemas/LedgerSelector"},{"type":"null"}],"description":"custom_ratio only: the denominator's ledgers."},"active":{"type":"boolean","title":"Active","description":"Checked nightly while true.","default":true},"notes":{"anyOf":[{"type":"string","maxLength":2000},{"type":"null"}],"title":"Notes","description":"Operator notes."}},"additionalProperties":false,"type":"object","required":["kind","threshold"],"title":"CovenantCreate","description":"A covenant to hold a line to."},"CovenantResponse":{"properties":{"id":{"type":"string","title":"Id","description":"Covenant id."},"credit_line_id":{"type":"string","title":"Credit Line Id","description":"The line it is on."},"kind":{"type":"string","enum":["min_cash","max_leverage","min_dscr","min_inventory_turns","min_current_ratio","custom_ratio"],"title":"Kind","description":"What it measures."},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Label","description":"Display name."},"threshold":{"type":"number","title":"Threshold","description":"In the covenant's unit."},"comparison":{"type":"string","enum":["gte","gt","lte","lt"],"title":"Comparison","description":"value <comparison> threshold passes."},"warn_band_bps":{"type":"integer","title":"Warn Band Bps","description":"Warning band (1000 = 10%)."},"numerator_selector":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Numerator Selector","description":"custom_ratio: the numerator's ledgers."},"denominator_selector":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Denominator Selector","description":"custom_ratio: the denominator's ledgers."},"active":{"type":"boolean","title":"Active","description":"Checked nightly while true."},"notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Notes","description":"Operator notes."},"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At","description":"Created (UTC)."},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At","description":"Updated (UTC)."},"latest_check":{"anyOf":[{"$ref":"#/components/schemas/CovenantCheckResponse"},{"type":"null"}],"description":"The most recent night's check."},"recent_checks":{"items":{"$ref":"#/components/schemas/CovenantCheckResponse"},"type":"array","title":"Recent Checks","description":"The last 60 nights, oldest first, for the dot strip."}},"type":"object","required":["id","credit_line_id","kind","threshold","comparison","warn_band_bps","active"],"title":"CovenantResponse","description":"A covenant as the console and the borrower read it."},"LedgerSelector":{"properties":{"ledger_ids":{"items":{"type":"string"},"type":"array","maxItems":50,"title":"Ledger Ids","description":"Ledger ids in the borrower's chart of accounts."},"types":{"items":{"type":"string","enum":["asset","liability","equity","revenue","expense"]},"type":"array","title":"Types","description":"Ledger types to include whole."},"concepts":{"items":{"type":"string"},"type":"array","maxItems":50,"title":"Concepts","description":"Account concept keys (`asset.cash`, `liability.long_term_debt`, `expense.cogs`): chart-independent meanings stamped on ledgers."},"mode":{"type":"string","enum":["balance","flow"],"title":"Mode","description":"balance as of the night, or net flow over window_days.","default":"balance"},"window_days":{"type":"integer","maximum":1095.0,"minimum":1.0,"title":"Window Days","description":"Days the flow window covers, ending on the night checked.","default":365}},"additionalProperties":false,"type":"object","title":"LedgerSelector","description":"Which ledgers make one side of a custom ratio, and how they are read.\n\nA ledger is selected when it matches any of ``ledger_ids``, ``types`` or\n``concepts``. ``balance`` reads the cumulative balance as of the night\n(debit-normal for assets and expenses, credit-normal otherwise); ``flow``\nreads the net movement over the ``window_days`` ending that night."},"SuccessEnvelope_CovenantResponse_":{"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/CovenantResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[CovenantResponse]"},"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":[]}]}