Factuarea APIDevelopers

Llistar elements de l'agenda

Retorna una agenda combinada entre from i to (com a màxim 93 dies, tots dos inclosos): tasques amb venciment i, d'altres mòduls, venciments de factures i de despeses, caducitats de pressupostos i proformes, execucions de factures recurrents, terminis fiscals, absències i festius.

  • sources tria les capes.
  • Cada capa exigeix a més el scope de lectura del seu propi recurs i el seu mòdul (per exemple invoices:read per als venciments de factures, absences:read per a les absències); les capes que la clau no pot llegir s'ometen sense error, i sources a la resposta llista les capes realment servides.
  • assignee_id (me o l'id d'un membre) filtra la capa de tasques.
  • Tota la finestra es retorna en una sola pàgina.
GET
/agenda
AuthorizationBearer <token>

A: header

Paràmetres de consulta

from*string

Primer dia de la finestra (YYYY-MM-DD, inclòs). Obligatori.

Formatdate
to*string

Últim dia de la finestra (YYYY-MM-DD, inclòs). Obligatori. La finestra abasta com a màxim 93 dies: una finestra més llarga o invertida retorna 400 parameter_invalid_range a to.

Formatdate
sources?string

Capes que s'inclouen, separades per comes: tasks, invoice_due, purchase_invoice_due, quote_expiry, proforma_expiry, recurring_invoice_run, fiscal_deadline, absence, holiday. Omet-lo per incloure totes les capes; un valor buit no n'inclou cap. Cada capa exigeix a més el scope de lectura del seu recurs (per exemple invoices:read per a invoice_due) i el seu mòdul: les capes que la clau no pot llegir s'ometen sense error, i sources a la resposta llista només les capes realment servides. Una capa desconeguda retorna 400 parameter_invalid_enum.

assignee_id?|

Només filtra la capa tasks: me per al membre titular de l'API key, o l'UUID d'un membre de la teva empresa. Qualsevol altre valor retorna 422 invalid_param_value.

Headers

Factuarea-Version?string

Fixa la versió de l'API (YYYY-MM-DD, versionat per data estil Stripe) per a aquesta petició; omet-lo per usar la versió fixada de la clau, o l'última si no n'hi ha cap. Versió no suportada → 400 unsupported_api_version; mal formada → 400 parameter_invalid_format. La versió efectiva es reflecteix a la capçalera de resposta Factuarea-Version. Consulta la guia de Versioning.

Formatdate
X-Active-Profile?string

Opera en nom d'una empresa filla (API key mestra de gestoria): passa el seu id públic (UUID v7) i la petició s'executa contra les dades d'aquella filla sense canviar l'scope, el tier ni l'environment de la clau (omet-lo per usar la pròpia empresa de la clau). UUID no vàlid → 400 parameter_invalid_uuid; id desconegut o no propi → 404 profile_not_found. Consulta la guia d'Acting on behalf.

Formatuuid

Cos de la resposta

application/json

application/json

application/json

application/json

application/json

application/json

application/json