Factuarea APIDevelopers

Enviar facturas en bloque

Envía hasta 200 facturas por email (encolado) en una sola llamada, reutilizando la ruta de envío individual por id.

Devuelve un BulkPartialSuccessResult con los contadores total, successful y failed más una lista failures (id + error_code + error_message en español) por cada factura que no se pudo enviar (no encontrada, estado terminal o sin destinatario resoluble).

POST
/companies/{company}/invoices/bulk-send

Authorization

AuthorizationBearer <token>

Tu API key como token Bearer: fact_live_… en producción, fact_test_… en sandbox. Consulta la guía de autenticación.

En: header

Parámetros de ruta

company*string

Identificador público (UUID v7) de la empresa. Obtenlo de GET /v1/me (data.scope[].id).

Formatouuid

Headers

Idempotency-Key*string

Clave opaca generada por el cliente (hasta 255 caracteres; se recomienda UUID v7) que permite reintentos seguros: la primera respuesta se almacena y se reproduce en las repeticiones sin volver a ejecutar la mutación. Reutilizar una clave con un cuerpo distinto devuelve 422 idempotency_key_reused; los valores de los campos secretos (password, secret…) cuentan como parte del cuerpo, así que reintentar con un secreto corregido bajo la misma clave es una petición distinta, nunca la repetición de la respuesta anterior. Consulta la guía de idempotencia. Obligatoria en esta operación: repetirla produce un efecto irreversible (un email enviado, un archivo generado, una llamada a un tercero o un cargo), por lo que una petición sin esta cabecera se rechaza con 422 idempotency_key_required antes de ejecutar lógica de negocio.

Longitud1 <= length <= 255
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

Cuerpo de la petición

application/json

El envío masivo de facturas acepta un mapa opcional, con UUID como claves, de precondiciones de presentación completas de siete campos. Cuando la presentación con revisiones está activada para la empresa, cada fila en BORRADOR debe llevar su precondición porque enviarla la emite: una fila en borrador sin ella no se emite ni se envía y se notifica en failures[] con 428 pdf_presentation_precondition_required, mientras las demás filas continúan. Las filas que no son borradores se reenvían tal como están. Con la presentación con revisiones desactivada, los campos de precondición se ignoran.

Definiciones de TypeScript

Usa el tipo request body en TypeScript.

Cuerpo de la respuesta

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json