{"openapi":"3.1.0","info":{"title":"GET /api/v1/cfo-projection/scenarios","version":"1.0.0","description":"List scenarios"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/cfo-projection/scenarios":{"get":{"tags":["cfo-projection"],"summary":"List scenarios","description":"List all projection scenarios for the business.","operationId":"list_scenarios_api_v1_cfo_projection_scenarios_get","parameters":[{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for pagination","title":"Cursor"},"description":"Cursor for pagination"},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":1000,"minimum":1},{"type":"null"}],"description":"Pagination limit","title":"Limit"},"description":"Pagination limit"},{"name":"direction","in":"query","required":false,"schema":{"type":"string","description":"Pagination direction: 'next' or 'prev'","default":"next","title":"Direction"},"description":"Pagination direction: 'next' or 'prev'"},{"name":"include_total_count","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include total count (expensive - avoid if possible)","default":false,"title":"Include Total Count"},"description":"Whether to include total count (expensive - avoid if possible)"},{"name":"sort_by","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Column name to sort by (e.g. 'created_at', 'amount', 'name'). When changing sort, reset cursor to None.","title":"Sort By"},"description":"Column name to sort by (e.g. 'created_at', 'amount', 'name'). When changing sort, reset cursor to None."},{"name":"descending","in":"query","required":false,"schema":{"type":"boolean","description":"Sort direction: true for descending (newest/largest first), false for ascending","default":true,"title":"Descending"},"description":"Sort direction: true for descending (newest/largest first), false for ascending"},{"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_ListScenariosResponse_"}}}},"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":{"FixedDriverValue":{"properties":{"base":{"type":"integer","title":"Base","description":"Base $/month in cents","default":0},"esc":{"type":"number","title":"Esc","description":"Annual escalation rate, e.g. 0.03 = 3%","default":0.0}},"type":"object","title":"FixedDriverValue"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ListScenariosResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/ScenarioResponse"},"type":"array","title":"Items","description":"List of items"},"total":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total","description":"Total number of items (null when not calculated for performance)"},"limit":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Limit","description":"Pagination limit"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor","description":"Cursor for next page"},"prev_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prev Cursor","description":"Cursor for previous page"},"has_next":{"type":"boolean","title":"Has Next","description":"Whether there are more items"},"has_prev":{"type":"boolean","title":"Has Prev","description":"Whether there are previous items"}},"additionalProperties":true,"type":"object","required":["items","has_next","has_prev"],"title":"ListScenariosResponse","description":"Response for ``list_scenarios``."},"RevenueDriverValue":{"properties":{"growth":{"type":"number","title":"Growth","description":"MoM compound growth rate, e.g. 0.10 = 10%","default":0.0}},"type":"object","title":"RevenueDriverValue"},"ScenarioResponse":{"properties":{"id":{"type":"string","title":"Id"},"business_id":{"type":"string","title":"Business Id"},"name":{"type":"string","title":"Name"},"is_active":{"type":"boolean","title":"Is Active"},"base_month":{"type":"string","format":"date","title":"Base Month"},"projection_months":{"type":"integer","title":"Projection Months"},"revenue_drivers":{"additionalProperties":{"$ref":"#/components/schemas/RevenueDriverValue"},"type":"object","title":"Revenue Drivers"},"cost_classifications":{"additionalProperties":{"type":"string"},"type":"object","title":"Cost Classifications"},"variable_drivers":{"additionalProperties":{"$ref":"#/components/schemas/VariableDriverValue"},"type":"object","title":"Variable Drivers"},"fixed_drivers":{"additionalProperties":{"$ref":"#/components/schemas/FixedDriverValue"},"type":"object","title":"Fixed Drivers"},"monthly_overrides":{"additionalProperties":{"additionalProperties":{"type":"integer"},"type":"object"},"type":"object","title":"Monthly Overrides"},"tax_rate":{"type":"number","title":"Tax Rate"},"interest_income_monthly":{"type":"integer","title":"Interest Income Monthly"},"interest_expense_monthly":{"type":"integer","title":"Interest Expense Monthly"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","business_id","name","is_active","base_month","projection_months","tax_rate","interest_income_monthly","interest_expense_monthly","created_at","updated_at"],"title":"ScenarioResponse","description":"Full scenario including all persisted drivers."},"SuccessEnvelope_ListScenariosResponse_":{"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/ListScenariosResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[ListScenariosResponse]"},"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"},"VariableDriverValue":{"properties":{"pct_rev":{"type":"number","title":"Pct Rev","description":"Fraction of projected revenue, e.g. 0.085","default":0.0}},"type":"object","title":"VariableDriverValue"}},"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API Token","description":"API token authentication. Format: `Bearer dz_...`"}}},"security":[{"BearerAuth":[]}]}