{"openapi":"3.1.0","info":{"title":"GET /api/v1/invoices/cash-receipts","version":"1.0.0","description":"Weekly cash receipts reconciliation"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/invoices/cash-receipts":{"get":{"tags":["invoices"],"summary":"Weekly cash receipts reconciliation","description":"Returns a weekly breakdown of cash received (bank deposits) versus amounts applied to invoices and bills. Highlights unapplied deposits to aid reconciliation.","operationId":"get_cash_receipts_api_v1_invoices_cash_receipts_get","parameters":[{"name":"start_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Report start date (YYYY-MM-DD). Default: 12 weeks ago.","title":"Start Date"},"description":"Report start date (YYYY-MM-DD). Default: 12 weeks ago."},{"name":"end_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Report end date (YYYY-MM-DD). Default: today.","title":"End Date"},"description":"Report end date (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/CashReceiptsResponse"}}}},"401":{"description":"Unauthorized - Authentication required","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"example":{"detail":"Not enough permissions"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"CashReceiptsResponse":{"properties":{"start_date":{"type":"string","title":"Start Date","description":"Report start date (YYYY-MM-DD)."},"end_date":{"type":"string","title":"End Date","description":"Report end date (YYYY-MM-DD)."},"weeks":{"items":{"$ref":"#/components/schemas/CashReceiptsWeekSummary"},"type":"array","title":"Weeks","description":"Weekly breakdown of cash received."},"unapplied_transactions":{"items":{"$ref":"#/components/schemas/UnappliedTransaction"},"type":"array","title":"Unapplied Transactions","description":"Deposit transactions with remaining unapplied balance."},"summary":{"$ref":"#/components/schemas/CashReceiptsSummary","description":"Period totals."}},"type":"object","required":["start_date","end_date","weeks","unapplied_transactions","summary"],"title":"CashReceiptsResponse","description":"Full cash receipts reconciliation report."},"CashReceiptsSummary":{"properties":{"total_received":{"type":"integer","title":"Total Received","description":"Total deposits in cents."},"total_applied":{"type":"integer","title":"Total Applied","description":"Total applied to invoices/bills in cents."},"total_unapplied":{"type":"integer","title":"Total Unapplied","description":"Total unapplied in cents."},"transaction_count":{"type":"integer","title":"Transaction Count","description":"Total deposit transactions."}},"type":"object","required":["total_received","total_applied","total_unapplied","transaction_count"],"title":"CashReceiptsSummary","description":"Period-level totals for cash receipts."},"CashReceiptsWeekSummary":{"properties":{"week_start":{"type":"string","title":"Week Start","description":"Start of the ISO week (YYYY-MM-DD)."},"week_end":{"type":"string","title":"Week End","description":"End of the ISO week (YYYY-MM-DD)."},"total_received":{"type":"integer","title":"Total Received","description":"Total deposits received in cents."},"total_applied":{"type":"integer","title":"Total Applied","description":"Amount applied to invoices/bills in cents."},"unapplied":{"type":"integer","title":"Unapplied","description":"Unapplied remainder in cents."},"transaction_count":{"type":"integer","title":"Transaction Count","description":"Number of deposit transactions."}},"type":"object","required":["week_start","week_end","total_received","total_applied","unapplied","transaction_count"],"title":"CashReceiptsWeekSummary","description":"Weekly summary of cash received and how much was applied to invoices."},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"UnappliedTransaction":{"properties":{"id":{"type":"string","title":"Id"},"date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Date"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"counterparty":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Counterparty"},"amount":{"type":"integer","title":"Amount","description":"Full transaction amount in cents."},"applied":{"type":"integer","title":"Applied","description":"Amount already applied in cents."},"unapplied":{"type":"integer","title":"Unapplied","description":"Remaining unapplied amount in cents."},"ledger_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ledger Name"}},"type":"object","required":["id","amount","applied","unapplied"],"title":"UnappliedTransaction","description":"A deposit transaction with remaining unapplied balance."},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}},"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API Token","description":"API token authentication. Format: `Bearer dz_...`"}}},"security":[{"BearerAuth":[]}]}