Factuarea API
Factures recurrents

Llistar totes les factures recurrents

Llista les teves plantilles de factures recurrents amb paginació per cursor.

GET
/recurring_invoices
AuthorizationBearer <token>

A: header

Paràmetres de consulta

limit?integer

Nombre d'objectes a retornar. Enter entre 1 i 100. Per defecte 25.

Predeterminat25
Rang1 <= value <= 100
starting_after?string

Cursor per a paginació cap endavant. Fes servir l'uuid de l'últim objecte de la pàgina anterior.

Formatuuid
ending_before?string

Cursor per a paginació cap enrere. Fes servir l'uuid del primer objecte de la pàgina actual.

Formatuuid
status?string

Estat del pla recurrent. Coincidència exacta a status.

status[in]?string

Estat del pla recurrent. Llista separada per comes. Coincideix qualsevol dels valors.

client_id?string

Client ID (UUID v7). Coincidència exacta amb client_id.

Formatuuid
client_id[in]?string

Client ID (UUID v7). Llista separada per comes. Coincideix qualsevol dels valors.

frequency?string

Freqüència d'emissió (p. ex. mensual, anual). Coincidència exacta amb frequency.

frequency[in]?string

Freqüència d'emissió (p. ex. mensual, anual). Llista separada per comes. Coincideix qualsevol dels valors.

next_run_at[gte]?string

Data de propera execució. Major o igual que el valor indicat.

Formatdate-time
next_run_at[lte]?string

Data de propera execució. Menor o igual que el valor indicat.

Formatdate-time
next_run_at[gt]?string

Data de propera execució. Estrictament major que el valor indicat.

Formatdate-time
next_run_at[lt]?string

Data de propera execució. Estrictament menor que el valor indicat.

Formatdate-time
tags?string

Filtrar per tag de classificació (slug en minúscula). Admet múltiples valors amb tags[in]=a,b (JSON_CONTAINS, semàntica OR — coincideix amb les factures recurrents que porten QUALSEVOL dels tags). Coincidència exacta sobre tags.

tags[in]?string

Filtrar per tag de classificació (slug en minúscula). Admet múltiples valors amb tags[in]=a,b (JSON_CONTAINS, semàntica OR — coincideix amb les factures recurrents que porten QUALSEVOL dels tags). Llista separada per comes. Coincideix qualsevol dels valors.

sort?string

Ordre dels resultats. Fes servir un camp per a ascendent o un prefix - per a descendent (p. ex. -created). Camps permesos: created, next_run_at. Combinat amb el cursor, l'ordre es manté determinista (un ordre secundari estable per l'id del cursor, a l'estil Stripe). Si s'omet, els resultats segueixen l'ordre de cursor per defecte (created descendent).

Valor a"created" | "-created" | "next_run_at" | "-next_run_at"

Cos de la resposta

application/json

application/json

application/json

application/json

application/json

application/json

{
  "data": [
    {
      "id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a08",
      "object": "recurring_invoice",
      "client": {
        "id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a01",
        "name": "Acme Corporation"
      },
      "series": {
        "id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a0e",
        "code": "F-2026"
      },
      "status": "active",
      "frequency": "monthly",
      "name": "Cuota mantenimiento mensual Acme",
      "description": "Contracte de suport i manteniment Pla Pro",
      "notes": "Renovación automática. Facturar el día 1 de cada mes.",
      "email_to": "facturacion@acme.example",
      "send_automatically": true,
      "days_before_due": 30,
      "max_occurrences": 12,
      "occurrences_count": 3,
      "remaining_occurrences": 9,
      "holiday_handling": "next_business_day",
      "start_on": "2026-01-01",
      "end_on": "2026-12-31",
      "next_run_at": "2026-02-01T09:00:00Z",
      "last_run_at": "2026-01-01T09:00:00Z",
      "cancelled_at": null,
      "subtotal": 200,
      "taxes_total": 42,
      "total": 242,
      "currency": "EUR",
      "lines": [
        {
          "object": "recurring_invoice_line",
          "description": "Quota suport mensual",
          "quantity": 1,
          "unit_price": 200,
          "tax_rate": 21,
          "retention": 0,
          "surcharge": 0,
          "subtotal": 200,
          "taxes": 42,
          "total": 242
        }
      ],
      "metadata": {
        "erp_code": "IVA-GEN",
        "ledger_account": "477000"
      },
      "external_id": "ERP-REC-2026-0008",
      "tags": [
        "suscripcion",
        "mantenimiento"
      ],
      "custom_fields": [
        {
          "field": "contrato",
          "value": "CTR-2026-0007"
        }
      ],
      "created_at": "2025-12-20T15:00:00Z",
      "updated_at": "2026-01-01T09:05:00Z"
    }
  ],
  "has_more": true,
  "next_cursor": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a0c"
}

{
  "error": {
    "type": "authentication_error",
    "code": "missing_api_key",
    "message": "No se ha proporcionado una API key válida en el header Authorization.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#missing_api_key",
    "request_id": "req_01HKQS5N8VR7QXJ9K3T6BWPMZA"
  }
}

{
  "error": {
    "type": "authorization_error",
    "code": "insufficient_scope",
    "message": "Esta API key no tiene el scope requerido para esta operación.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#insufficient_scope",
    "request_id": "req_01HKQS5NBC3P8M1KX4V7SLNHQD"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "parameter_invalid",
    "message": "El campo `name` es obligatorio y no puede estar vacío.",
    "param": "name",
    "doc_url": "https://docs.factuarea.com/guides/errors#parameter_invalid",
    "request_id": "req_01HKQS5NGS8Z3T6Q1D2E7FYVSI"
  }
}

{
  "error": {
    "type": "rate_limit_error",
    "code": "rate_limit_exceeded",
    "message": "Has excedido el rate limit de 60 peticiones por minuto. Reintenta tras 30 segundos.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#rate_limit_exceeded",
    "request_id": "req_01HKQS5NKW1C6W9T4G5H0JBZVL"
  }
}

{
  "error": {
    "type": "api_error",
    "code": "internal_error",
    "message": "Ha ocurrido un error inesperado. Si persiste, contacta con soporte adjuntando el request_id.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#internal_error",
    "request_id": "req_01HKQS5NLX2D7X0U5H6J1KCAWM"
  }
}