ALalegra
Sales Documents

Obtener facturas recurrentes

Herramienta MCP: recurringInvoices_getRecurringInvoices.

Lista facturas recurrentes (paginadas, máximo 30 por página). Permite filtrar por nombre del cliente (name, coincidencia de nombre, no ID), cliente (client_id), fechas de inicio y fin de la recurrencia (startDate/endDate), intervalo (repeatEvery), condición de pago (term) y estado (status).

El filtro status solo acepta draft o open — mapea tú mismo la petición en lenguaje natural del usuario (por ejemplo "borrador"/"pendiente" → draft; "abierta"/"activa"/"emitida" → open); cualquier otro valor se rechaza con un 400 (statusIsInvalid). "draft" incluye también registros antiguos sin atributo de estado; "open" es estricto. Este filtro es transversal en todos los países. Con metadata: true la respuesta se envuelve como { data: [...], metadata: { total } } en lugar de un arreglo simple.

Solo lectura.

post/tools/recurringInvoices_getRecurringInvoices

Request

  • Base URL
    https://mcp.alegra.com
  • URL
    https://mcp.alegra.com/tools/recurringInvoices_getRecurringInvoices
  • Auth
    HTTP bearer

Request body

startinteger

Desplazamiento basado en cero para la paginación. Usa limit * número de página para saltar páginas.

limitinteger

Máximo de facturas recurrentes por página (por defecto 30).

order_direction'ASC' | 'DESC'

Dirección del orden: "ASC" ascendente, "DESC" descendente.

order_fieldstring

Nombre del campo por el que se ordena (por ejemplo "startDate", "nextCreation").

namestring

Filtra por nombre del cliente (coincidencia de nombre, no ID de cliente).

client_idstring

Filtra por ID del cliente.

startDatestring

Filtra por la fecha de inicio de la recurrencia (YYYY-MM-DD).

endDatestring

Filtra por la fecha de fin de la recurrencia (YYYY-MM-DD).

repeatEveryinteger

Filtra por el intervalo de la recurrencia, en meses (por ejemplo 2 = cada 2 meses).

terminteger

Filtra por el ID de la condición de pago.

status'draft' | 'open'

Filtra por estado. Transversal en todos los países. Solo se aceptan "draft" u "open" — cualquier otro valor lo rechaza la API con un 400 (statusIsInvalid), así que mapea tú mismo la petición en lenguaje natural: "borrador"/"draft"/"pendiente" → "draft"; "abierta"/"activa"/"emitida"/"open" → "open" — nunca pases sin más un valor crudo que el usuario escribió. "draft" incluye también registros antiguos sin atributo de estado; "open" es estricto.

metadataboolean

Si es true, envuelve la respuesta como { data: [...], metadata: { total } } en lugar de un arreglo simple.

Response

Lista de facturas recurrentes

Changes

No recorded changes to this operation across all 1 revision of this API.