{"openapi":"3.1.0","info":{"title":"POST /api/v1/bills/payments/batch","version":"1.0.0","description":"Split one transaction across multiple bills"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/bills/payments/batch":{"post":{"tags":["bills"],"summary":"Split one transaction across multiple bills","description":"Apply a single bank transaction to multiple bills and/or direct expense lines in one atomic request. Validates the total allocation against the transaction's remaining unallocated balance before creating any payments.","operationId":"create_bill_payments_batch","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/BillBatchPaymentRequest"},"example":{"allocations":[{"amount":50000,"bill_id":"019ab37c-b111-7000-8000-000000000001"},{"amount":75000,"bill_id":"019ab37c-b111-7000-8000-000000000002"}],"transaction_id":"019ab37c-7801-7000-8000-000000000001"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_BillBatchPaymentResponse_"}}}},"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_bill_payments_batch_api_v1_bills_payments_batch_post"}}},"components":{"schemas":{"BillBatchExpenseLine":{"properties":{"ledger_id":{"type":"string","title":"Ledger Id","description":"UUID of the expense ledger account to debit."},"amount":{"type":"integer","exclusiveMinimum":0.0,"title":"Amount","description":"Amount in cents to categorize as expense. Must be > 0."},"description":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}],"title":"Description","description":"Optional memo stored on the journal-entry line."}},"type":"object","required":["ledger_id","amount"],"title":"BillBatchExpenseLine","description":"Direct expense categorization for a slice of the bank transaction."},"BillBatchPaymentAllocation":{"properties":{"bill_id":{"type":"string","title":"Bill Id","description":"UUID of the bill receiving this slice of the transaction."},"amount":{"type":"integer","exclusiveMinimum":0.0,"title":"Amount","description":"Amount in cents to allocate to this bill. Must be > 0."}},"type":"object","required":["bill_id","amount"],"title":"BillBatchPaymentAllocation","description":"A single bill allocation inside a batch payment request."},"BillBatchPaymentRequest":{"properties":{"transaction_id":{"type":"string","title":"Transaction Id","description":"UUID of the bank transaction representing the payment."},"allocations":{"items":{"$ref":"#/components/schemas/BillBatchPaymentAllocation"},"type":"array","title":"Allocations","description":"Bill slices (0+). Each `bill_id` must be unique."},"expense_lines":{"items":{"$ref":"#/components/schemas/BillBatchExpenseLine"},"type":"array","title":"Expense Lines","description":"Optional expense lines for any remaining balance. Each line debits an expense ledger on the transaction's journal entry."},"paid_on":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Paid On","description":"Override payment date applied to every allocation. Defaults to the transaction datetime if omitted."},"override_hold":{"type":"boolean","title":"Override Hold","description":"Record the payment even though an allocated bill is on payment hold. Requires `override_reason`; both are written to the audit log.","default":false},"override_reason":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}],"title":"Override Reason","description":"Why a held bill is being paid anyway (required with override_hold)."}},"type":"object","required":["transaction_id"],"title":"BillBatchPaymentRequest","description":"Schema for splitting a single bank transaction across multiple bills.\n\nAll allocations are applied atomically *after* up-front validation: if\nthe total allocation would exceed the transaction's remaining\nunallocated balance, or any bill is invalid, no payment records are\ncreated.","example":{"allocations":[{"amount":50000,"bill_id":"019ab37c-b111-7000-8000-000000000001"},{"amount":75000,"bill_id":"019ab37c-b111-7000-8000-000000000002"}],"transaction_id":"019ab37c-7801-7000-8000-000000000001"},"examples":[{"allocations":[{"amount":50000,"bill_id":"019ab37c-b111-7000-8000-000000000001"},{"amount":75000,"bill_id":"019ab37c-b111-7000-8000-000000000002"}],"transaction_id":"019ab37c-7801-7000-8000-000000000001"}]},"BillBatchPaymentResponse":{"properties":{"transaction_id":{"type":"string","title":"Transaction Id","description":"Bank transaction UUID."},"total_allocated":{"type":"integer","title":"Total Allocated","description":"Total cents allocated across all bills in this batch."},"total_expense_allocated":{"type":"integer","title":"Total Expense Allocated","description":"Total cents categorized as direct expense in this batch.","default":0},"payment_count":{"type":"integer","title":"Payment Count","description":"Number of BillPayment records created."},"expense_line_count":{"type":"integer","title":"Expense Line Count","description":"Number of expense lines categorized in this batch.","default":0},"payments":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Payments","description":"Per-bill payment payloads (mirrors BillPaymentResponse)."}},"type":"object","required":["transaction_id","total_allocated","payment_count"],"title":"BillBatchPaymentResponse","description":"Response for a batch payment split across multiple bills."},"SuccessEnvelope_BillBatchPaymentResponse_":{"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/BillBatchPaymentResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[BillBatchPaymentResponse]"},"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":[]}]}