{"openapi":"3.1.0","info":{"title":"GET /api/v1/businesses/{business_id}/reports/cash-basis/unapplied","version":"1.0.0","description":"List cash-basis unapplied settlements"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/businesses/{business_id}/reports/cash-basis/unapplied":{"get":{"tags":["businesses"],"summary":"List cash-basis unapplied settlements","description":"Customer receipts and vendor payments booked against AR/AP that the cash-basis view could not trace to an invoice or bill. On the cash basis they are recognised as Uncategorized Income / Expense; this list lets the user find and match them. Amounts in cents.","operationId":"get_cash_basis_unapplied_api_v1_businesses__business_id__reports_cash_basis_unapplied_get","parameters":[{"name":"business_id","in":"path","required":true,"schema":{"type":"string","title":"Business Id"}},{"name":"start_date","in":"query","required":true,"schema":{"type":"string","minLength":1,"description":"Start date (YYYY-MM-DD)","title":"Start Date"},"description":"Start date (YYYY-MM-DD)"},{"name":"end_date","in":"query","required":true,"schema":{"type":"string","minLength":1,"description":"End date (YYYY-MM-DD)","title":"End Date"},"description":"End date (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/SuccessEnvelope_GetCashBasisUnappliedResponse_"}}}},"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"}}}},"404":{"description":"Not Found - Resource does not exist","content":{"application/json":{"example":{"detail":"Resource not found"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"CashBasisUnappliedItem":{"properties":{"journal_entry_id":{"type":"string","title":"Journal Entry Id","description":"Settlement journal entry"},"date":{"type":"string","title":"Date","description":"Settlement date (YYYY-MM-DD)"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Journal entry description"},"control":{"type":"string","enum":["ar","ap"],"title":"Control","description":"Control account the settlement was booked against"},"amount_cents":{"type":"integer","title":"Amount Cents","description":"Unapplied residue in cents. Positive for a settlement in the normal direction (received against AR / paid against AP), negative for a reversal such as a refund."},"settled_cents":{"type":"integer","title":"Settled Cents","description":"Full AR/AP leg amount the residue came from (cents)"},"reason":{"type":"string","enum":["no_allocation","missing_template","overpayment","no_unapplied_ledger"],"title":"Reason","description":"Why it is unapplied: no_allocation (no invoice/bill payment row or link, or allocations cover less than the leg), missing_template (the document has no usable booking entry), overpayment (allocated more than the document total), no_unapplied_ledger (no Uncategorized Income/Expense ledger — residue stayed on AR/AP)."},"counterparty_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Counterparty Name","description":"Merchant / customer behind the bank transaction"},"transaction_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Transaction Id","description":"Bank transaction behind the journal entry, if any"},"fallback_ledger_id":{"type":"string","title":"Fallback Ledger Id","description":"Ledger the residue is recognised on in the cash view"},"fallback_ledger_name":{"type":"string","title":"Fallback Ledger Name","description":"Display name of that ledger"},"document_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Document Id","description":"Invoice / bill the settlement was allocated to, if any"},"document_type":{"anyOf":[{"type":"string","enum":["invoice","bill"]},{"type":"null"}],"title":"Document Type"}},"additionalProperties":true,"type":"object","required":["journal_entry_id","date","control","amount_cents","settled_cents","reason","fallback_ledger_id","fallback_ledger_name"],"title":"CashBasisUnappliedItem","description":"One settlement (journal entry × control account) with unapplied residue."},"GetCashBasisUnappliedResponse":{"properties":{"basis":{"type":"string","const":"cash","title":"Basis","default":"cash"},"start_date":{"type":"string","title":"Start Date"},"end_date":{"type":"string","title":"End Date"},"total_unapplied_receipts_cents":{"type":"integer","title":"Total Unapplied Receipts Cents","description":"Sum of AR-side residue in the window (cents)"},"total_unapplied_payments_cents":{"type":"integer","title":"Total Unapplied Payments Cents","description":"Sum of AP-side residue in the window (cents)"},"count":{"type":"integer","title":"Count"},"items":{"items":{"$ref":"#/components/schemas/CashBasisUnappliedItem"},"type":"array","title":"Items","description":"Sorted by date desc, then amount desc"}},"additionalProperties":true,"type":"object","required":["start_date","end_date","total_unapplied_receipts_cents","total_unapplied_payments_cents","count"],"title":"GetCashBasisUnappliedResponse","description":"Response for ``get_cash_basis_unapplied`` (cents)."},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"SuccessEnvelope_GetCashBasisUnappliedResponse_":{"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/GetCashBasisUnappliedResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[GetCashBasisUnappliedResponse]"},"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":[]}]}