> ## Documentation Index > Fetch the complete documentation index at: https://docs.msportal.ai/llms.txt > Use this file to discover all available pages before exploring further. # Get budget forecast > Retrieve budget forecast data for a company, including forecast rules, category totals, and calculated multi-year projections. ## OpenAPI ````yaml /openapi.json get /api/public/v1/budgets/forecast openapi: 3.0.3 info: title: MSPortal Public API version: 1.0.0 description: >- Public API for MSPortal - provides programmatic access to tenant data. ## Authentication All endpoints require authentication via API key passed as a Bearer token: ``` Authorization: Bearer ``` API keys can be created in the MSPortal dashboard under Settings → Integrations → API Access. **Important:** Do not include cookies in API requests. The public API uses stateless authentication only. ## Scopes API keys are granted specific scopes that determine what operations they can perform. Each endpoint documents its required scope(s). ## Rate Limiting API calls are rate limited per API key. Rate limit information is returned in response headers: - `X-RateLimit-Limit`: Maximum requests per minute - `X-RateLimit-Remaining`: Remaining requests in current window - `X-RateLimit-Reset`: When the rate limit resets (ISO 8601) ## Request ID All responses include an `X-Request-Id` header for debugging and support. You can also pass your own `X-Request-Id` header to correlate requests. contact: name: MSPortal Support email: support@msportal.ai license: name: Proprietary servers: - url: https://app.msportal.ai description: Production environment security: - BearerAuth: [] tags: - name: Budgets description: >- Budget management - create, track, and forecast budgets with line items, categories, and products - name: Calendar description: Calendar and meeting management - events, participants, and meeting types - name: Companies description: Company management endpoints - name: Company Users description: Company user management - client portal contacts (read-only, paginated) - name: Compliance description: Compliance check management - runs, assigned checks, and status updates - name: Dashboards description: Dashboard management - external iframe resources and internal dashboards - name: Devices description: Device management - inventory, types, and locations - name: Goals description: Goal management - create, track, and manage goals with tasks and updates - name: NPS Surveys description: >- NPS survey management - Net Promoter Score surveys, responses, and analytics - name: Reports description: >- Report management - create, manage, and schedule reports with templates and types - name: Planner description: >- Planner item management - tasks, roadmap items, and project planning with linked goals, compliance, and projects - name: Surveys description: >- General survey management - multi-question surveys, responses, and statistics - name: Tickets description: Ticket management - view and filter tickets from PSA integrations - name: Training description: >- Training management - courses, enrollments, certificates, and progress tracking - name: Users description: Tenant user management - internal staff and team members (read-only) - name: Automation Rules description: >- Automation rule management - create, configure, and monitor automation rules with triggers, conditions, and actions - name: Analytics description: >- Analytics and reporting - company audit data, training analytics, user activity, and portfolio metrics paths: /api/public/v1/budgets/forecast: get: tags: - Budgets summary: Get budget forecast description: >- Retrieve budget forecast data for a company, including forecast rules, category totals, and calculated multi-year projections. parameters: - schema: type: string format: uuid description: Company ID (required) required: true description: Company ID (required) name: companyId in: query - schema: type: integer minimum: 1900 maximum: 2100 description: Base year for forecast (required) required: true description: Base year for forecast (required) name: baseYear in: query responses: '200': description: Budget forecast data content: application/json: schema: $ref: '#/components/schemas/BudgetForecastResponse' '400': description: Invalid query parameters content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden - Missing required scope (budgets.read) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Company not found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] components: schemas: BudgetForecastResponse: type: object properties: data: $ref: '#/components/schemas/BudgetForecast' required: - data ErrorResponse: type: object properties: error: type: string description: Error message requestId: type: string description: Request correlation ID details: nullable: true description: Additional error details code: type: string description: Error code required: - error BudgetForecast: type: object properties: companyId: type: string format: uuid description: Company ID companyName: type: string description: Company name baseYear: type: integer description: Base year yearsForward: type: integer description: Years forecasted rules: allOf: - $ref: '#/components/schemas/BudgetForecastRules' - nullable: true description: Forecast rules (if configured) categoryTotals: type: array items: $ref: '#/components/schemas/CategoryTotal' description: Category totals for base year calculatedForecast: $ref: '#/components/schemas/CalculatedForecast' required: - companyId - companyName - baseYear - yearsForward - rules - categoryTotals - calculatedForecast BudgetForecastRules: type: object properties: id: type: string format: uuid description: Rules ID companyId: type: string format: uuid description: Company ID baseYear: type: integer description: Base year for forecast yearsForward: type: integer minimum: 1 maximum: 5 description: Years to forecast (1-5) globalDefaultIncreasePercent: type: number description: Global default increase % applyGlobalToAll: type: boolean description: Apply global rate to all categories rules: type: array items: $ref: '#/components/schemas/BudgetForecastRuleRow' description: Per-category rules createdAt: type: string format: date-time description: Creation timestamp (ISO 8601) updatedAt: type: string format: date-time description: Last update timestamp (ISO 8601) required: - id - companyId - baseYear - yearsForward - globalDefaultIncreasePercent - applyGlobalToAll - rules - createdAt - updatedAt CategoryTotal: type: object properties: categoryKey: type: string description: Category key label: type: string description: Category display label totalAmount: type: number description: Total amount for this category required: - categoryKey - label - totalAmount CalculatedForecast: type: object nullable: true properties: baseYearTotal: type: number description: Base year total amount yearTotals: type: object additionalProperties: type: number description: Total per year yearDeltas: type: object additionalProperties: type: object properties: absolute: type: number description: Absolute change from base year percent: type: number description: Percentage change from base year required: - absolute - percent description: Year-over-year deltas categoryYearAmounts: type: object additionalProperties: type: object additionalProperties: type: number description: Amount per category per year required: - baseYearTotal - yearTotals - yearDeltas - categoryYearAmounts BudgetForecastRuleRow: type: object properties: categoryKey: type: string description: Category key identifier label: type: string description: Category display label baseYearAmount: type: number description: Base year total for this category perYearIncreasePercent: type: number nullable: true description: Annual growth percentage isIncreaseEnabled: type: boolean description: Whether growth is enabled manualOverrides: type: object additionalProperties: type: number nullable: true description: Manual overrides per year required: - categoryKey - label - baseYearAmount - perYearIncreasePercent - isIncreaseEnabled - manualOverrides securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: API Key description: >- Use your API key as a Bearer token. API keys can be generated in Settings → Integrations → API Access. ````