Factuarea APIDevelopers

Enviar un documento de control por email

Envía por email el PDF guardado de la versión vigente, con el enlace público, a hasta 5 destinatarios en total entre to, cc y bcc, con subject y message opcionales.

  • Sin to, se usa el email del contacto transportista; si no lo hay, 422 transport_document_not_sendable.
  • Solo se pueden enviar documentos issued o closed; el envío queda en el registro de emisión con sus destinatarios.
  • Irreversible: exige Idempotency-Key.
  • Devuelve 410 transport_document_file_unavailable cuando los ficheros se han purgado, y 500 send_failed si el proveedor de correo rechaza el mensaje o no puede aceptarlo (no se anota nada en el registro; reintenta con una Idempotency-Key nueva).
POST
/transport_documents/{transport_document}/send

Authorization

AuthorizationBearer <token>

En: header

Parámetros de ruta

transport_document*string

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 409 idempotency_key_reused. 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
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 petición

application/json

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