{"openapi":"3.1.0","info":{"title":"GET /api/v1/ar/customer-cash-receipts","version":"1.0.0","description":"Cash received from customers"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/ar/customer-cash-receipts":{"get":{"tags":["ar-subledgers"],"summary":"Cash received from customers","description":"Bank deposits whose offset is an AR ledger, by customer and calendar quarter with QoQ, YoY and YTD comparisons; investor-note, refund and uncategorized inflows listed separately.","operationId":"ar_subledgers_customer_cash_receipts","parameters":[{"name":"start_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"description":"First day (YYYY-MM-DD). Default: Jan 1 of the prior year.","title":"Start Date"},"description":"First day (YYYY-MM-DD). Default: Jan 1 of the prior year."},{"name":"end_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"description":"Last day (YYYY-MM-DD). Default: today.","title":"End Date"},"description":"Last day (YYYY-MM-DD). Default: today."},{"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_CustomerCashReceiptsResponse_"}}}},"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":"ar_subledgers_customer_cash_receipts_api_v1_ar_customer_cash_receipts_get"}}},"components":{"schemas":{"CustomerCashReceiptsResponse":{"properties":{"business_id":{"type":"string","title":"Business Id"},"start_date":{"type":"string","title":"Start Date"},"end_date":{"type":"string","title":"End Date"},"quarters":{"items":{"type":"string"},"type":"array","title":"Quarters"},"cash_from_customers":{"additionalProperties":true,"type":"object","title":"Cash From Customers","description":"by_quarter, quarters (cents, qoq/yoy change and %), total_cents, ytd (current vs prior-year same span), calendar_years."},"highlights":{"additionalProperties":true,"type":"object","title":"Highlights"},"by_customer":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"By Customer"},"investor_notes_and_loans":{"additionalProperties":true,"type":"object","title":"Investor Notes And Loans"},"refunds":{"additionalProperties":true,"type":"object","title":"Refunds"},"transfers_total_cents":{"type":"integer","title":"Transfers Total Cents","default":0},"uncategorized_not_customer":{"additionalProperties":true,"type":"object","title":"Uncategorized Not Customer"},"total_bank_inflows_cents":{"type":"integer","title":"Total Bank Inflows Cents","default":0},"bank_ledger_count":{"type":"integer","title":"Bank Ledger Count","default":0},"ar_ledger_count":{"type":"integer","title":"Ar Ledger Count","default":0}},"type":"object","required":["business_id","start_date","end_date"],"title":"CustomerCashReceiptsResponse","description":"Cash from customers by quarter, with every other bank inflow beside it."},"SuccessEnvelope_CustomerCashReceiptsResponse_":{"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/CustomerCashReceiptsResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[CustomerCashReceiptsResponse]"},"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":[]}]}