{"openapi":"3.1.0","info":{"title":"POST /api/v1/bills/tie-out","version":"1.0.0","description":"Tie bills out against an external bill-pay export"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/bills/tie-out":{"post":{"tags":["bills"],"summary":"Tie bills out against an external bill-pay export","description":"Compare an external bill-pay system's bill list (rows or CSV text) with the books in both directions: missing bills, amount deltas, double-payment risk, duplicates, bills paid here but open there and external payments with no cash in the bank feed yet. Read-only.","operationId":"tie_out_external_bills","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/ExternalBillTieoutRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ExternalBillTieoutResponse_"}}}},"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":"tie_out_external_bills_api_v1_bills_tie_out_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"},"ExternalBillTieoutRequest":{"properties":{"rows":{"anyOf":[{"items":{"$ref":"#/components/schemas/ExternalBillRow"},"type":"array","maxItems":2000},{"type":"null"}],"title":"Rows","description":"External rows (send rows or csv_text, not both; max 2000)"},"csv_text":{"anyOf":[{"type":"string","maxLength":2000000},{"type":"null"}],"title":"Csv Text","description":"The export as CSV text: header row first (vendor, invoice, amount in dollars, status, due)"},"as_of":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"As Of","description":"Date the bank-feed settlement window (7 days) ends on; default today"}},"type":"object","title":"ExternalBillTieoutRequest"},"ExternalBillTieoutResponse":{"properties":{"as_of":{"type":"string","title":"As Of"},"external_rows":{"type":"integer","title":"External Rows"},"forward":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Forward"},"reverse":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Reverse"},"duplicates":{"additionalProperties":{"items":{"additionalProperties":true,"type":"object"},"type":"array"},"type":"object","title":"Duplicates"},"paid_here_open_there":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Paid Here Open There"},"settlement_in_flight":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Settlement In Flight"},"totals":{"additionalProperties":true,"type":"object","title":"Totals"}},"additionalProperties":true,"type":"object","required":["as_of","external_rows","forward","reverse","duplicates","paid_here_open_there","settlement_in_flight","totals"],"title":"ExternalBillTieoutResponse"},"SuccessEnvelope_ExternalBillTieoutResponse_":{"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/ExternalBillTieoutResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[ExternalBillTieoutResponse]"},"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":[]}]}