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": {}
}
}
}Retrieve budget forecast data for a company, including forecast rules, category totals, and calculated multi-year projections.
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": {}
}
}
}Use your API key as a Bearer token. API keys can be generated in Settings → Integrations → API Access.
Company ID (required)
Base year for forecast (required)
1900 <= x <= 2100Budget forecast data
Show child attributes