{"openapi":"3.1.0","info":{"title":"POST /api/v1/purchase-orders/{po_id}/financing-request","version":"1.0.0","description":"Request funding of a purchase order from a credit line"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/purchase-orders/{po_id}/financing-request":{"post":{"tags":["purchase-orders"],"summary":"Request funding of a purchase order from a credit line","description":"Records a `po_financing_intents` row for the PO and the chosen line. When the amount exceeds the line's available credit, a limit-change request for the shortfall is created through the existing limit-change service, so the program's `limit_change_policy` governs who approves it, and the intent records that request's id. The lender is alerted and the business is notified. This does not move money and does not create a loan: actual draws happen on card spend under the existing per-transaction model.","operationId":"request_purchase_order_financing","parameters":[{"name":"po_id","in":"path","required":true,"schema":{"type":"string","title":"Po 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/PoFinancingRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_PoFinancingRequestResponse_"}}}},"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"}}}},"409":{"description":"Conflict - Resource already exists or is in an incompatible state","content":{"application/json":{"example":{"error":"conflict","message":"Resource already exists","code":"CONFLICT_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":"request_purchase_order_financing_api_v1_purchase_orders__po_id__financing_request_post"}}},"components":{"schemas":{"LimitChangeRequestResponse":{"properties":{"id":{"type":"string","title":"Id"},"business_id":{"type":"string","title":"Business Id"},"credit_line_id":{"type":"string","title":"Credit Line Id"},"credit_line_external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Credit Line External Id","description":"The line's `external_line_id`."},"program_id":{"type":"string","title":"Program Id"},"status":{"type":"string","enum":["pending","approved","rejected","cancelled","expired"],"title":"Status"},"previous_limit_cents":{"type":"integer","title":"Previous Limit Cents","description":"The line's limit when asked."},"requested_limit_cents":{"type":"integer","title":"Requested Limit Cents"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"requested_by_user_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Requested By User Id","description":"The person who asked; null when an API token asked."},"requested_via":{"type":"string","enum":["api_token","console"],"title":"Requested Via"},"requested_by_token_jti":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Requested By Token Jti","description":"The id (jti) of the API token that asked."},"decided_by_user_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Decided By User Id"},"decided_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Decided At"},"decision_note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Decision Note"},"applied_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Applied At","description":"When the approved limit was written to the line."},"applied_limit_cents":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Applied Limit Cents","description":"The limit the approval set: `requested_limit_cents`, or the approver's own `limit_cents`. Null unless approved."},"expires_at":{"type":"string","format":"date-time","title":"Expires At","description":"A request still pending at this instant (UTC) lapses."},"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"}},"type":"object","required":["id","business_id","credit_line_id","program_id","status","previous_limit_cents","requested_limit_cents","requested_via","expires_at"],"title":"LimitChangeRequestResponse","description":"One requested move of a line's limit, and what became of it."},"PoFinancingIntentResponse":{"properties":{"id":{"type":"string","title":"Id"},"business_id":{"type":"string","title":"Business Id"},"po_id":{"type":"string","title":"Po Id"},"line_id":{"type":"string","title":"Line Id"},"amount_cents":{"type":"integer","title":"Amount Cents"},"term_days":{"type":"integer","title":"Term Days"},"status":{"type":"string","enum":["requested","cancelled","fulfilled"],"title":"Status"},"created_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created By"},"limit_change_request_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Limit Change Request Id"},"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"}},"type":"object","required":["id","business_id","po_id","line_id","amount_cents","term_days","status"],"title":"PoFinancingIntentResponse"},"PoFinancingRequest":{"properties":{"line_id":{"type":"string","title":"Line Id"},"term_days":{"anyOf":[{"type":"integer","maximum":3650.0,"minimum":1.0},{"type":"null"}],"title":"Term Days","description":"One of the program's terms. Defaults to the line's term."},"amount_cents":{"anyOf":[{"type":"integer","exclusiveMinimum":0.0},{"type":"null"}],"title":"Amount Cents","description":"Defaults to the PO's financing amount from the preview."}},"additionalProperties":false,"type":"object","required":["line_id"],"title":"PoFinancingRequest","description":"Ask to fund the PO from one of the business's lines."},"PoFinancingRequestResponse":{"properties":{"kind":{"type":"string","enum":["intent","limit_change_request"],"title":"Kind","description":"`intent`: the headroom covers the PO and the intent is recorded. `limit_change_request`: the PO exceeded the headroom, so a limit-change request was raised under the program's approval mode."},"intent":{"$ref":"#/components/schemas/PoFinancingIntentResponse"},"limit_change_request":{"anyOf":[{"$ref":"#/components/schemas/LimitChangeRequestResponse"},{"type":"null"}]},"headroom_cents":{"type":"integer","title":"Headroom Cents"},"shortfall_cents":{"type":"integer","title":"Shortfall Cents"},"message":{"type":"string","title":"Message"}},"type":"object","required":["kind","intent","headroom_cents","shortfall_cents","message"],"title":"PoFinancingRequestResponse"},"SuccessEnvelope_PoFinancingRequestResponse_":{"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/PoFinancingRequestResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[PoFinancingRequestResponse]"},"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":[]}]}