Saltar al contenido principal
GET

Listado de objetivos del Business Plan frente a la realidad

Scope:accounting:cashflow.read
https://api.holded.com/api/v2/business-plan/goals

Devuelve los objetivos del Business Plan de la cuenta autenticada, con una fila por cuenta contable desglosada por mes. Cada mes incluye tanto el objetivo (la meta que la cuenta se marcó) como el valor real (lo que realmente ocurrió, según el libro mayor) para el mismo periodo, de forma que se pueden comparar sin una segunda llamada. Úsalo cuando el usuario quiera comparar los objetivos del Business Plan de un cliente con lo que realmente ocurrió, por ejemplo para preparar una revisión mensual. Hoy solo se admite tree=profit_and_loss; los objetivos de Cashflow aún no están disponibles en este endpoint. Devuelve una lista vacía, no un error, cuando la cuenta no tiene Business Plan configurado o no hay objetivos en el rango solicitado.

Parámetros

Parámetros de consulta

start_datestring<date>obligatorio

Inicio del rango a consultar (inclusive, se ajusta al primer día de su mes)

end_datestring<date>obligatorio

Fin del rango a consultar (inclusive — cualquier día dentro del último mes deseado)

treestringobligatorio

Árbol de objetivos a consultar. Hoy solo se admite profit_and_loss

"profit_and_loss"
scenario_idstringopcional

Escenario del Business Plan a consultar — ver GET /api/v2/business-plan/scenarios. Por defecto, el escenario principal de la cuenta

accounting_account_idstringopcional

Restringe la respuesta a una única cuenta contable. Omítelo para devolver todas las cuentas del árbol

only_with_goalsbooleanopcional= false

Si es true, excluye las cuentas contables sin ningún objetivo en el rango solicitado. Sin él, un plan contable con pocos objetivos devuelve mayormente filas con goal: null — esto las filtra antes de paginar, para no gastar páginas en cuentas vacías

cursorstringopcional

Cursor opaco para paginación

limitintegeropcional= 50

Número máximo de cuentas contables a devolver por página. Por defecto 50, máximo 200

Petición

python
import requests

url = "https://api.holded.com/api/v2/business-plan/goals?start_date=2026-01-01&end_date=2026-12-31&tree=profit_and_loss"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Accept": "application/json",
}

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

Respuestas

Respuesta

json
{
  "items": [
    {
      "accounting_account_id": "507f1f77bcf86cd799439011",
      "accounting_account_number": 70500001,
      "accounting_account_name": "Ventas",
      "months": [
        {
          "month": "...",
          "goal": "...",
          "actual": "..."
        }
      ]
    }
  ],
  "cursor": "string",
  "has_more": true
}

Respuestas exitosas

200Listado de objetivos del Business Plan frente a la realidad, por cuenta contableapplication/json
object
items[]object[]
accounting_account_idstring

Identifier of the accounting account

accounting_account_numberinteger

Chart of accounts number

accounting_account_namestring

Name of the accounting account

months[]object[]

One entry per month in the requested range, always present even when both goal and actual are empty for that month

cursorstring | null

Opaque cursor pointing to the next page. Pass as `cursor` in the next request. Null when there is no next page.

has_moreboolean

Whether more pages are available after this one

Respuestas de error

400Árbol, rango de fechas o identificador inválidoapplication/json
401API key inválida o no proporcionadaapplication/json
403Permisos insuficientesapplication/json
404Escenario no encontradoapplication/json
429Límite de solicitudes excedidoapplication/json