GET

List business plan scenarios

Scope:accounting:cashflow.read

https://api.holded.com/api/v2/business-plan/scenarios

Returns the Business Plan scenarios configured for the authenticated account. A Business Plan can hold several scenarios, each with its own goals; use the returned `id` as `scenario_id` when calling the goals endpoint. Use when the user asks which business plan scenarios exist, or before requesting goals for a scenario other than the main one. Returns an empty list, not an error, when the account has no Business Plan configured yet.

Request

python

import requests

url = "https://api.holded.com/api/v2/business-plan/scenarios"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Accept": "application/json",
}

response = requests.get(url, headers=headers)
print(response.json())

Responses

Response

json

{
  "items": [
    {
      "id": "507f1f77bcf86cd799439011",
      "name": "Base",
      "color": "color_1",
      "is_main": true
    }
  ],
  "cursor": null,
  "has_more": false
}

Success responses

200List of business plan scenariosapplication/json

object

items[]object[]

idstring

Scenario identifier

namestring

Scenario name

colorstring

Color assigned to the scenario in the UI

Enum:color_1color_2color_3color_4color_5color_6color_7

is_mainboolean

Whether this is the account's main scenario — the default used when a request does not specify scenario_id

cursorstring | null

Always null — scenarios are not paginated

has_moreboolean

Always false — scenarios are not paginated

Error responses

401Invalid or missing API keyapplication/json

403Insufficient permissionsapplication/json

429Rate limit exceededapplication/json