{"openapi":"3.1.0","info":{"title":"GET /api/v1/invoices/cash-receipts/week-detail","version":"1.0.0","description":"Cash receipts week detail"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/invoices/cash-receipts/week-detail":{"get":{"tags":["invoices"],"summary":"Cash receipts week detail","description":"Returns individual deposit transactions for a given week, including which invoices and bills each deposit was applied to.","operationId":"get_cash_receipts_week_detail_api_v1_invoices_cash_receipts_week_detail_get","parameters":[{"name":"week_start","in":"query","required":true,"schema":{"type":"string","description":"Monday of the target week (YYYY-MM-DD).","title":"Week Start"},"description":"Monday of the target week (YYYY-MM-DD)."},{"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/WeekDetailResponse"}}}},"400":{"description":"Bad Request - Invalid input","content":{"application/json":{"example":{"detail":"Invalid request parameters"}}}},"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":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"TransactionApplication":{"properties":{"type":{"type":"string","title":"Type","description":"'invoice' or 'bill'."},"invoice_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoice Id"},"invoice_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Invoice Number"},"bill_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bill Id"},"bill_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bill Number"},"amount":{"type":"integer","title":"Amount","description":"Amount applied in cents."}},"type":"object","required":["type","amount"],"title":"TransactionApplication","description":"A single invoice or bill payment linked to a deposit transaction."},"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"},"WeekDetailResponse":{"properties":{"week_start":{"type":"string","title":"Week Start"},"week_end":{"type":"string","title":"Week End"},"total_received":{"type":"integer","title":"Total Received","description":"Total deposits in this week in cents."},"total_applied":{"type":"integer","title":"Total Applied","description":"Total applied in this week in cents."},"unapplied":{"type":"integer","title":"Unapplied","description":"Unapplied remainder in cents."},"transactions":{"items":{"$ref":"#/components/schemas/WeekTransactionDetail"},"type":"array","title":"Transactions","description":"Individual deposit transactions for the week."}},"type":"object","required":["week_start","week_end","total_received","total_applied","unapplied","transactions"],"title":"WeekDetailResponse","description":"Detail view for a single week of cash receipts."},"WeekTransactionDetail":{"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"},"applications":{"items":{"$ref":"#/components/schemas/TransactionApplication"},"type":"array","title":"Applications","description":"Invoice/bill payments linked to this transaction."}},"type":"object","required":["id","amount","applied","unapplied"],"title":"WeekTransactionDetail","description":"A deposit transaction within a week, with its applied breakdown."}},"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API Token","description":"API token authentication. Format: `Bearer dz_...`"}}},"security":[{"BearerAuth":[]}]}