Factuarea APIDevelopers

Listar elementos de la agenda

Devuelve una agenda combinada entre from y to (como máximo 93 días, ambos incluidos): tareas con vencimiento y, de otros módulos, vencimientos de facturas y de gastos, caducidades de presupuestos y proformas, ejecuciones de facturas recurrentes, plazos fiscales, ausencias y festivos.

  • sources elige las capas.
  • Cada capa exige además el scope de lectura de su propio recurso y su módulo (por ejemplo invoices:read para los vencimientos de facturas, absences:read para las ausencias); las capas que la clave no puede leer se omiten sin error, y sources en la respuesta lista las capas realmente servidas.
  • assignee_id (me o el id de un miembro) filtra la capa de tareas.
  • Toda la ventana se devuelve en una sola página.
GET
/agenda
AuthorizationBearer <token>

En: header

Parámetros de consulta

from*string

Primer día de la ventana (YYYY-MM-DD, incluido). Obligatorio.

Formatodate
to*string

Último día de la ventana (YYYY-MM-DD, incluido). Obligatorio. La ventana abarca como máximo 93 días: una ventana más larga o invertida devuelve 400 parameter_invalid_range en to.

Formatodate
sources?string

Capas que se incluyen, separadas por comas: tasks, invoice_due, purchase_invoice_due, quote_expiry, proforma_expiry, recurring_invoice_run, fiscal_deadline, absence, holiday. Omítelo para incluir todas las capas; un valor vacío no incluye ninguna. Cada capa exige además el scope de lectura de su recurso (por ejemplo invoices:read para invoice_due) y su módulo: las capas que la clave no puede leer se omiten sin error, y sources en la respuesta lista solo las capas realmente servidas. Una capa desconocida devuelve 400 parameter_invalid_enum.

assignee_id?|

Solo filtra la capa tasks: me para el miembro titular de la API key, o el UUID de un miembro de tu empresa. Cualquier otro valor devuelve 422 invalid_param_value.

Headers

Factuarea-Version?string

Fija la versión de la API (YYYY-MM-DD, versionado por fecha estilo Stripe) para esta petición; omítelo para usar la versión fijada de la clave, o la última si no hay ninguna. Versión no soportada → 400 unsupported_api_version; malformada → 400 parameter_invalid_format. La versión efectiva se refleja en la cabecera de respuesta Factuarea-Version. Consulta la guía de Versioning.

Formatodate
X-Active-Profile?string

Opera en nombre de una empresa hija (API key maestra de gestoría): pasa su id público (UUID v7) y la petición se ejecuta contra los datos de esa hija sin cambiar el scope, el tier ni el environment de la clave (omítelo para usar la propia empresa de la clave). UUID inválido → 400 parameter_invalid_uuid; id desconocido o no propio → 404 profile_not_found. Consulta la guía de Acting on behalf.

Formatouuid

Cuerpo de la respuesta

application/json

application/json

application/json

application/json

application/json

application/json

application/json