Skip to main content
GET
/
api
/
public
/
v1
/
budgets
/
forecast
Get budget forecast
curl --request GET \
  --url https://app.msportal.ai/api/public/v1/budgets/forecast \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "companyName": "<string>",
    "baseYear": 123,
    "yearsForward": 123,
    "rules": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "baseYear": 123,
      "yearsForward": 3,
      "globalDefaultIncreasePercent": 123,
      "applyGlobalToAll": true,
      "rules": [
        {
          "categoryKey": "<string>",
          "label": "<string>",
          "baseYearAmount": 123,
          "perYearIncreasePercent": 123,
          "isIncreaseEnabled": true,
          "manualOverrides": {}
        }
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    },
    "categoryTotals": [
      {
        "categoryKey": "<string>",
        "label": "<string>",
        "totalAmount": 123
      }
    ],
    "calculatedForecast": {
      "baseYearTotal": 123,
      "yearTotals": {},
      "yearDeltas": {},
      "categoryYearAmounts": {}
    }
  }
}

Authorizations

​
Authorization
string
header
required

Use your API key as a Bearer token. API keys can be generated in Settings → Integrations → API Access.

Query Parameters

​
companyId
string<uuid>
required

Company ID (required)

​
baseYear
integer
required

Base year for forecast (required)

Required range: 1900 <= x <= 2100

Response

Budget forecast data

​
data
object
required