GET

Listado de escenarios del Business Plan

Scope:accounting:cashflow.read

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

Devuelve los escenarios del Business Plan configurados para la cuenta autenticada. Un Business Plan puede tener varios escenarios, cada uno con sus propios objetivos; usa el id devuelto como scenario_id al consultar el endpoint de objetivos. Úsalo cuando el usuario pregunte qué escenarios existen, o antes de pedir objetivos de un escenario distinto del principal. Devuelve una lista vacía, no un error, cuando la cuenta todavía no tiene Business Plan configurado.

Petición

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())

Respuestas

Respuesta

json

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

Respuestas exitosas

200Listado de escenarios del Business Planapplication/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

Respuestas de error

401API key inválida o no proporcionadaapplication/json

403Permisos insuficientesapplication/json

429Límite de solicitudes excedidoapplication/json