{"openapi":"3.1.0","info":{"title":"POST /api/v1/bills/payment-run","version":"1.0.0","description":"Build the pay list for a run date"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/bills/payment-run":{"post":{"tags":["bills"],"summary":"Build the pay list for a run date","description":"Split open bills into pay (due by pay_through, approved externally when rows are given, amounts agree, affordable), blocked (with reasons) and deferred. Read-only; nothing is paid.","operationId":"build_external_payment_run","parameters":[{"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/PaymentRunRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_PaymentRunResponse_"}}}},"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"}}}},"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":"build_external_payment_run_api_v1_bills_payment_run_post"}}},"components":{"schemas":{"ExternalBillRow":{"properties":{"vendor_name":{"type":"string","maxLength":300,"title":"Vendor Name","default":""},"invoice_number":{"type":"string","maxLength":120,"title":"Invoice Number"},"amount_cents":{"type":"integer","title":"Amount Cents","description":"Amount the external system will pay, in cents"},"status":{"type":"string","maxLength":60,"title":"Status","description":"Free text: Approved, Unpaid, Overdue, Paid, Partial, Unassigned, ...","default":""},"due_on":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Due On"},"approver":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Approver"}},"type":"object","required":["invoice_number","amount_cents"],"title":"ExternalBillRow"},"PaymentRunRequest":{"properties":{"pay_through":{"type":"string","format":"date","title":"Pay Through","description":"Pay bills due on or before this date"},"rows":{"anyOf":[{"items":{"$ref":"#/components/schemas/ExternalBillRow"},"type":"array","maxItems":2000},{"type":"null"}],"title":"Rows"},"csv_text":{"anyOf":[{"type":"string","maxLength":2000000},{"type":"null"}],"title":"Csv Text"},"cash_available_cents":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Cash Available Cents","description":"Cash to spend; default the bank ledgers' book balances"}},"type":"object","required":["pay_through"],"title":"PaymentRunRequest"},"PaymentRunResponse":{"properties":{"pay_through":{"type":"string","title":"Pay Through"},"cash_available_cents":{"type":"integer","title":"Cash Available Cents"},"cash_remaining_cents":{"type":"integer","title":"Cash Remaining Cents"},"cash_source":{"type":"string","title":"Cash Source"},"pay":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Pay"},"blocked":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Blocked"},"deferred":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Deferred"},"totals":{"additionalProperties":true,"type":"object","title":"Totals"}},"additionalProperties":true,"type":"object","required":["pay_through","cash_available_cents","cash_remaining_cents","cash_source","pay","blocked","deferred","totals"],"title":"PaymentRunResponse"},"SuccessEnvelope_PaymentRunResponse_":{"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/PaymentRunResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[PaymentRunResponse]"},"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":[]}]}