> ## 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. # Update budget > Update an existing budget. Only provided fields will be updated. ## OpenAPI ````yaml /openapi.json patch /api/public/v1/budgets/{id} 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/{id}: patch: tags: - Budgets summary: Update budget description: Update an existing budget. Only provided fields will be updated. parameters: - schema: type: string format: uuid description: Budget ID required: true description: Budget ID name: id in: path requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateBudgetRequest' responses: '200': description: Budget updated successfully content: application/json: schema: $ref: '#/components/schemas/BudgetSingleResponse' '400': description: Validation error 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.write) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Budget not found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] components: schemas: UpdateBudgetRequest: type: object properties: title: type: string minLength: 1 maxLength: 255 description: Budget title fiscalYear: type: integer minimum: 1900 maximum: 2100 description: Fiscal year periodType: allOf: - $ref: '#/components/schemas/BudgetPeriodType' - description: Period type status: allOf: - $ref: '#/components/schemas/BudgetStatus' - description: Status currency: type: string minLength: 3 maxLength: 3 description: Currency code notes: type: string nullable: true maxLength: 10000 description: Budget notes (null to clear) BudgetSingleResponse: type: object properties: data: $ref: '#/components/schemas/BudgetDetail' 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 BudgetPeriodType: type: string enum: - Annual - Quarterly - Monthly BudgetStatus: type: string enum: - Draft - PendingApproval - Approved - Obsolete BudgetDetail: allOf: - $ref: '#/components/schemas/Budget' - type: object properties: lineItems: type: array items: $ref: '#/components/schemas/BudgetLineItem' description: Budget line items required: - lineItems Budget: type: object properties: id: type: string format: uuid description: Budget ID title: type: string description: Budget title fiscalYear: type: integer description: Fiscal year periodType: $ref: '#/components/schemas/BudgetPeriodType' status: $ref: '#/components/schemas/BudgetStatus' currency: type: string minLength: 3 maxLength: 3 description: Currency code (e.g., USD) notes: type: string nullable: true description: Budget notes company: $ref: '#/components/schemas/BudgetCompanyRef' createdBy: $ref: '#/components/schemas/BudgetCreatedByRef' totals: $ref: '#/components/schemas/BudgetTotals' lineItemCount: type: integer description: Number of line items 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 - title - fiscalYear - periodType - status - currency - notes - company - createdBy - totals - lineItemCount - createdAt - updatedAt BudgetLineItem: type: object properties: id: type: string format: uuid description: Line item ID type: $ref: '#/components/schemas/BudgetItemType' description: type: string description: Item description quantity: type: number minimum: 0 description: Quantity unitPrice: type: number minimum: 0 description: Unit price recurrence: $ref: '#/components/schemas/BudgetRecurrence' termMonths: type: integer minimum: 1 description: Term in months annualisedCost: type: number description: Annualised cost (auto-calculated) status: $ref: '#/components/schemas/BudgetLineItemStatus' currency: type: string minLength: 3 maxLength: 3 description: Currency code (e.g., USD) notes: type: string nullable: true description: Item notes category: $ref: '#/components/schemas/BudgetCategoryRef' linkedItem: $ref: '#/components/schemas/BudgetLinkedItemRef' 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 - type - description - quantity - unitPrice - recurrence - termMonths - annualisedCost - status - currency - notes - category - linkedItem - createdAt - updatedAt BudgetCompanyRef: type: object properties: id: type: string format: uuid description: Company ID name: type: string description: Company name required: - id - name BudgetCreatedByRef: type: object properties: id: type: string nullable: true format: uuid description: User ID name: type: string nullable: true description: Author name required: - id - name BudgetTotals: type: object properties: softwareTotal: type: number description: Total for Software items hardwareTotal: type: number description: Total for Hardware items labourTotal: type: number description: Total for Labour items subscriptionTotal: type: number description: Total for Subscription items otherTotal: type: number description: Total for Other items grandTotal: type: number description: Grand total of all items required: - softwareTotal - hardwareTotal - labourTotal - subscriptionTotal - otherTotal - grandTotal BudgetItemType: type: string enum: - Software - Hardware - Labour - Other - Subscription BudgetRecurrence: type: string enum: - One-Time - Monthly - Annual BudgetLineItemStatus: type: string enum: - pending - approved - rejected - draft BudgetCategoryRef: type: object nullable: true properties: id: type: string description: Category ID name: type: string description: Category name required: - id - name BudgetLinkedItemRef: type: object nullable: true properties: id: type: string format: uuid description: Linked item ID type: $ref: '#/components/schemas/BudgetLinkedItemType' name: type: string nullable: true description: Linked item name required: - id - type - name BudgetLinkedItemType: type: string enum: - device - planner - goal - other 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. ````