{"openapi":"3.1.0","info":{"title":"GET /api/v1/customer-statements/{customer_id}","version":"1.0.0","description":"Get customer statement"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/customer-statements/{customer_id}":{"get":{"tags":["customer-statements"],"summary":"Get customer statement","description":"Build an A/R statement for a customer over a date range.","operationId":"get_customer_statement","parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"string","title":"Customer Id"}},{"name":"start_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"description":"Start of the statement period (defaults to 1 year ago).","title":"Start Date"},"description":"Start of the statement period (defaults to 1 year ago)."},{"name":"end_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"description":"End of the statement period (defaults to today).","title":"End Date"},"description":"End of the statement period (defaults to today)."},{"name":"as_of_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"description":"Aging as-of date (defaults to end_date).","title":"As Of Date"},"description":"Aging as-of date (defaults to end_date)."},{"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"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_CustomerStatementResponse_"}}}},"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":"get_customer_statement_api_v1_customer_statements__customer_id__get"}}},"components":{"schemas":{"CustomerStatementResponse":{"properties":{"customer_id":{"type":"string","title":"Customer Id"},"customer_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Name"},"customer_email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Email"},"customer_address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Address"},"business_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Business Name"},"start_date":{"type":"string","format":"date","title":"Start Date"},"end_date":{"type":"string","format":"date","title":"End Date"},"as_of_date":{"type":"string","format":"date","title":"As Of Date"},"opening_balance":{"type":"integer","title":"Opening Balance"},"lines":{"items":{"$ref":"#/components/schemas/StatementLine"},"type":"array","title":"Lines"},"total_charges":{"type":"integer","title":"Total Charges"},"total_payments":{"type":"integer","title":"Total Payments"},"closing_balance":{"type":"integer","title":"Closing Balance"},"aging":{"$ref":"#/components/schemas/StatementAging"}},"type":"object","required":["customer_id","start_date","end_date","as_of_date","opening_balance","lines","total_charges","total_payments","closing_balance","aging"],"title":"CustomerStatementResponse","description":"A fully assembled customer statement."},"StatementAging":{"properties":{"current":{"type":"integer","title":"Current","default":0},"days_1_30":{"type":"integer","title":"Days 1 30","default":0},"days_31_60":{"type":"integer","title":"Days 31 60","default":0},"days_61_90":{"type":"integer","title":"Days 61 90","default":0},"days_91_plus":{"type":"integer","title":"Days 91 Plus","default":0},"total":{"type":"integer","title":"Total","default":0}},"type":"object","title":"StatementAging","description":"Outstanding balance bucketed by days past due, as of the statement date."},"StatementLine":{"properties":{"date":{"type":"string","format":"date","title":"Date"},"type":{"type":"string","title":"Type","description":"invoice, payment, or credit."},"reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reference","description":"Invoice or credit memo number."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"charges":{"type":"integer","title":"Charges","description":"Amount added to the balance, in cents.","default":0},"payments":{"type":"integer","title":"Payments","description":"Amount reducing the balance, in cents.","default":0},"balance":{"type":"integer","title":"Balance","description":"Running balance after this line, in cents."}},"type":"object","required":["date","type","balance"],"title":"StatementLine","description":"A single activity line on a statement."},"SuccessEnvelope_CustomerStatementResponse_":{"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/CustomerStatementResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[CustomerStatementResponse]"},"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":[]}]}