{"openapi":"3.1.0","info":{"title":"POST /api/v1/bills/{bill_id}/payments","version":"1.0.0","description":"Add payment to bill"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/bills/{bill_id}/payments":{"post":{"tags":["bills"],"summary":"Add payment to bill","description":"Create a new payment for a specific bill.","operationId":"create_bill_payment","parameters":[{"name":"bill_id","in":"path","required":true,"schema":{"type":"string","title":"Bill 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/BillPaymentRequest"},"example":{"amount":125000,"transaction_id":"019ab37c-7801-7000-8000-000000000001"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_BillPaymentResponse_"}}}},"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/invalid token 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_payment_api_v1_bills__bill_id__payments_post"}}},"components":{"schemas":{"BillPaymentRequest":{"properties":{"transaction_id":{"type":"string","title":"Transaction Id","description":"UUID of the bank transaction representing the payment."},"amount":{"type":"integer","exclusiveMinimum":0.0,"title":"Amount","description":"Payment amount in cents. Must be > 0."},"paid_on":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Paid On","description":"Override payment date (ISO 8601). Defaults to the transaction datetime if omitted."}},"type":"object","required":["transaction_id","amount"],"title":"BillPaymentRequest","description":"Schema for recording a payment against a bill.\n\nLinks a bank transaction to a bill to track partial or full payment.\nSupports split payments (one transaction paying multiple bills) and\npartial payments (multiple transactions paying one bill).","example":{"amount":125000,"transaction_id":"019ab37c-7801-7000-8000-000000000001"},"examples":[{"amount":125000,"transaction_id":"019ab37c-7801-7000-8000-000000000001"}]},"BillPaymentResponse":{"properties":{"id":{"type":"string","title":"Id","description":"Payment record UUID."},"bill_id":{"type":"string","title":"Bill Id","description":"UUID of the bill being paid."},"transaction_id":{"type":"string","title":"Transaction Id","description":"UUID of the bank transaction."},"amount":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Amount","description":"Payment amount in cents."},"currency":{"type":"string","title":"Currency","description":"Currency for the payment (USD, CAD, AUD, EUR, or GBP).","default":"USD"},"paid_on":{"type":"string","format":"date-time","title":"Paid On","description":"Payment date."},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Record creation timestamp."},"updated_at":{"type":"string","format":"date-time","title":"Updated At","description":"Last update timestamp."},"business_id":{"type":"string","title":"Business Id","description":"Business UUID."}},"type":"object","required":["id","bill_id","transaction_id","amount","paid_on","created_at","updated_at","business_id"],"title":"BillPaymentResponse","description":"Response schema for a bill payment record.\n\nRepresents a payment made against a bill, linking to the bank transaction.","example":{"amount":250000,"bill_id":"019ab37c-b111-7000-8000-000000000001","business_id":"019ab37c-b051-7000-8000-000000000001","created_at":"2024-01-25T10:30:00Z","id":"019ab37c-9a41-7000-8000-000000000001","paid_on":"2024-01-25T00:00:00Z","transaction_id":"019ab37c-7801-7000-8000-000000000001","updated_at":"2024-01-25T10:30:00Z"},"examples":[{"amount":250000,"bill_id":"019ab37c-b111-7000-8000-000000000001","business_id":"019ab37c-b051-7000-8000-000000000001","created_at":"2024-01-25T10:30:00Z","id":"019ab37c-9a41-7000-8000-000000000001","paid_on":"2024-01-25T00:00:00Z","transaction_id":"019ab37c-7801-7000-8000-000000000001","updated_at":"2024-01-25T10:30:00Z"}]},"SuccessEnvelope_BillPaymentResponse_":{"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/BillPaymentResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[BillPaymentResponse]"},"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":[]}]}