{"openapi":"3.1.0","info":{"title":"GET /api/v1/businesses/{business_id}/reports/cash-basis/bridge","version":"1.0.0","description":"Accrual to cash-basis net income bridge"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/businesses/{business_id}/reports/cash-basis/bridge":{"get":{"tags":["businesses"],"summary":"Accrual to cash-basis net income bridge","description":"Accrual net income, cash-basis net income and the rows that decompose the difference (invoices not yet collected, collections recognised, bills not yet paid, bill payments recognised, unapplied receipts / payments, rounding, period close). Amounts in cents; row amounts are the effect on net income.","operationId":"get_cash_basis_bridge","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_GetCashBasisBridgeResponse_"}}}},"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"}}}},"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_cash_basis_bridge_api_v1_businesses__business_id__reports_cash_basis_bridge_get"}}},"components":{"schemas":{"CashBasisBridgeRow":{"properties":{"key":{"type":"string","enum":["unpaid_invoices_removed","invoice_collections_recognised","unpaid_bills_removed","bill_payments_recognised","unapplied_receipts","unapplied_payments","rounding","period_close","unexplained"],"title":"Key","description":"Stable row identifier"},"label":{"type":"string","title":"Label","description":"Human-readable row label"},"amount_cents":{"type":"integer","title":"Amount Cents","description":"Effect on net income in cents (positive increases net income)"},"description":{"type":"string","title":"Description","description":"What the row represents"}},"additionalProperties":true,"type":"object","required":["key","label","amount_cents","description"],"title":"CashBasisBridgeRow","description":"One line of the accrual → cash net income reconciliation."},"GetCashBasisBridgeResponse":{"properties":{"start_date":{"type":"string","title":"Start Date"},"end_date":{"type":"string","title":"End Date"},"accrual_net_income_cents":{"type":"integer","title":"Accrual Net Income Cents"},"cash_net_income_cents":{"type":"integer","title":"Cash Net Income Cents"},"rows":{"items":{"$ref":"#/components/schemas/CashBasisBridgeRow"},"type":"array","title":"Rows"},"difference_cents":{"type":"integer","title":"Difference Cents","description":"cash_net_income_cents - accrual_net_income_cents"},"unexplained_cents":{"type":"integer","title":"Unexplained Cents","description":"difference_cents - sum(rows); 0 when ties is true","default":0},"ties":{"type":"boolean","title":"Ties","description":"True when the rows exactly explain the difference"}},"additionalProperties":true,"type":"object","required":["start_date","end_date","accrual_net_income_cents","cash_net_income_cents","difference_cents","ties"],"title":"GetCashBasisBridgeResponse","description":"Response for ``get_cash_basis_bridge`` (cents)."},"SuccessEnvelope_GetCashBasisBridgeResponse_":{"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/GetCashBasisBridgeResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[GetCashBasisBridgeResponse]"},"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":[]}]}