{"openapi":"3.1.0","info":{"title":"GET /api/v1/budgets","version":"1.0.0","description":"List budgets"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/budgets":{"get":{"tags":["budgets"],"summary":"List budgets","description":"List all budgets for the business with optional filtering.","operationId":"list_budgets_api_v1_budgets_get","parameters":[{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by status: draft, active, closed","title":"Status"},"description":"Filter by status: draft, active, closed"},{"name":"fiscal_year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Filter by fiscal year","title":"Fiscal Year"},"description":"Filter by fiscal year"},{"name":"search","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Search by budget name","title":"Search"},"description":"Search by budget name"},{"name":"offset","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"description":"Number of records to skip","title":"Offset"},"description":"Number of records to skip"},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":100,"minimum":1},{"type":"null"}],"description":"Maximum records to return","default":50,"title":"Limit"},"description":"Maximum records to return"},{"name":"include_total_count","in":"query","required":false,"schema":{"type":"boolean","description":"Include total count (expensive - avoid if possible)","default":false,"title":"Include Total Count"},"description":"Include total count (expensive - avoid if possible)"},{"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/BudgetListResponse"}}}},"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":{"BudgetListResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/BudgetResponse"},"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"}},"type":"object","required":["items","has_next","has_prev"],"title":"BudgetListResponse","description":"Paginated list of budgets."},"BudgetPeriodTypeEnum":{"type":"string","enum":["monthly","quarterly","annual"],"title":"BudgetPeriodTypeEnum","description":"Budget period granularity."},"BudgetResponse":{"properties":{"id":{"type":"string","title":"Id","description":"Budget UUID."},"name":{"type":"string","title":"Name","description":"Budget name."},"fiscal_year":{"type":"integer","title":"Fiscal Year","description":"Fiscal year."},"start_date":{"type":"string","format":"date","title":"Start Date","description":"Budget period start date."},"end_date":{"type":"string","format":"date","title":"End Date","description":"Budget period end date."},"status":{"$ref":"#/components/schemas/BudgetStatusEnum","description":"Budget status: draft, active, or closed."},"period_type":{"$ref":"#/components/schemas/BudgetPeriodTypeEnum","description":"Period granularity."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Budget description."},"notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Notes","description":"Additional notes."},"line_count":{"type":"integer","title":"Line Count","description":"Number of budget lines.","default":0},"total_budgeted_revenue":{"type":"integer","title":"Total Budgeted Revenue","description":"Total budgeted revenue in cents.","default":0},"total_budgeted_expenses":{"type":"integer","title":"Total Budgeted Expenses","description":"Total budgeted expenses in cents.","default":0},"budgeted_net_income":{"type":"integer","title":"Budgeted Net Income","description":"Budgeted net income (revenue - expenses) in cents.","default":0},"source_scenario_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source Scenario Id","description":"CFO projection scenario UUID that generated this budget."},"business_id":{"type":"string","title":"Business Id","description":"Business UUID."},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Creation timestamp."},"updated_at":{"type":"string","format":"date-time","title":"Updated At","description":"Last update timestamp."}},"type":"object","required":["id","name","fiscal_year","start_date","end_date","status","period_type","business_id","created_at","updated_at"],"title":"BudgetResponse","description":"Response schema for a budget."},"BudgetStatusEnum":{"type":"string","enum":["draft","active","closed"],"title":"BudgetStatusEnum","description":"Budget lifecycle status."},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"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":[]}]}