Saltearse al contenido
Host Admin

Envía la representación impresa de un CFE por correo

POST
/v1/cfe/enviar-email/{id}

Envía la representación impresa (PDF) de un CFE ya emitido a una lista de hasta 10 destinatarios.

Validación previa

Antes de intentar cualquier envío, Host Factura valida que todos los correos tengan un formato válido. Si alguno es inválido, se rechaza la solicitud completa con 422 (ningún correo se envía).

Reporte por destinatario

El envío se hace destinatario por destinatario: el rechazo del servidor de correo en una dirección no aborta las demás. La respuesta siempre incluye el detalle por correo en resultados[], indicando cuáles fueron exitosos (exito: true) y cuáles fallaron (exito: false) con el motivo en error.

Códigos de estado HTTP

EstadoSignificado
200Todos los correos fueron aceptados por el servidor (data.todosExitosos: true).
207Envío parcial: algunos aceptados, otros rechazados. Revisá data.resultados.
502El servidor de correo rechazó todos los envíos. El detalle va en error.details.

Autorizaciones

Sección titulada «Autorizaciones »

Parámetros

Sección titulada « Parámetros »

Parámetros de path

Sección titulada «Parámetros de path »
id
required

Identificador único del recurso (UUID v4)

string format: uuid

Identificador único del recurso (UUID v4)

Cuerpo de la solicitud required

Sección titulada «Cuerpo de la solicitud required »

Lista de hasta 10 correos a los que enviar la representación impresa

object
correos
required
Array<string>
>= 1 items <= 10 items
Ejemplos

Reenviar a tres destinatarios

{
  "correos": [
    "cliente@empresa.com.uy",
    "contador@empresa.com.uy",
    "archivo@empresa.com.uy"
  ]
}

Respuestas

Sección titulada « Respuestas »

200

Sección titulada «200 »

Todos los destinatarios recibieron el comprobante

nullable
Ejemplos

Todos los correos fueron aceptados

{
  "data": {
    "total": 3,
    "exitosos": 3,
    "fallidos": 0,
    "todosExitosos": true,
    "ningunoExitoso": false,
    "resultados": [
      {
        "email": "cliente@empresa.com.uy",
        "exito": true
      },
      {
        "email": "contador@empresa.com.uy",
        "exito": true
      },
      {
        "email": "archivo@empresa.com.uy",
        "exito": true
      }
    ]
  }
}

207

Sección titulada «207 »

Envío parcial. Algunos correos fueron aceptados y otros rechazados. Inspeccioná data.resultados para ver el detalle por destinatario.

nullable
Ejemplos

Envío parcial (207): algunos aceptados, otros rechazados

{
  "data": {
    "total": 3,
    "exitosos": 2,
    "fallidos": 1,
    "todosExitosos": false,
    "ningunoExitoso": false,
    "resultados": [
      {
        "email": "cliente@empresa.com.uy",
        "exito": true
      },
      {
        "email": "contador@empresa.com.uy",
        "exito": true
      },
      {
        "email": "buzon-inexistente@empresa.com.uy",
        "exito": false,
        "error": "Message failed: 550 5.1.1 The email account that you tried to reach does not exist — código SMTP 550"
      }
    ]
  }
}

401

Sección titulada «401 »

No autenticado. La API_KEY no fue enviada o no es válida.

Códigos posibles: API_AUTH_HEADER_MISSING, API_AUTH_HEADER_INVALID, API_ACCESS_INVALID.

object
error
required
object
code
required

Identificador estable del error en SCREAMING_SNAKE_CASE

string
message
required

Mensaje legible en español

string
details

Información adicional (puede ser objeto, array o string)

nullable
requestId

UUID de correlación; mismo valor que el header X-Request-ID

string format: uuid
Ejemplos

Falta header Authorization

{
  "error": {
    "code": "API_AUTH_HEADER_MISSING",
    "message": "Se esperaba la cabecera Authorization con esquema Bearer"
  },
  "requestId": "5b2c7c8a-1f6e-4d29-9a0b-7c3a8d1e2f4c"
}

403

Sección titulada «403 »

Acceso prohibido. La credencial es válida pero el plan o el alcance de sucursal lo impiden.

Códigos posibles: API_FEATURE_DISABLED, API_ACCESS_BRANCH_MISMATCH.

object
error
required
object
code
required

Identificador estable del error en SCREAMING_SNAKE_CASE

string
message
required

Mensaje legible en español

string
details

Información adicional (puede ser objeto, array o string)

nullable
requestId

UUID de correlación; mismo valor que el header X-Request-ID

string format: uuid
Ejemplos

El plan no incluye API

{
  "error": {
    "code": "API_FEATURE_DISABLED",
    "message": "El plan de esta cuenta no tiene habilitado el acceso a la API"
  },
  "requestId": "5b2c7c8a-1f6e-4d29-9a0b-7c3a8d1e2f4c"
}

404

Sección titulada «404 »

CFE no encontrado o pertenece a otra cuenta

object
error
required
object
code
required

Identificador estable del error en SCREAMING_SNAKE_CASE

string
message
required

Mensaje legible en español

string
details

Información adicional (puede ser objeto, array o string)

nullable
requestId

UUID de correlación; mismo valor que el header X-Request-ID

string format: uuid
Ejemplos

CFE no encontrado

{
  "error": {
    "code": "CFE_EMITIDO_NO_ENCONTRADO",
    "message": "CFE no encontrado (uuid)"
  },
  "requestId": "5b2c7c8a-1f6e-4d29-9a0b-7c3a8d1e2f4c"
}

429

Sección titulada «429 »

Rate limit excedido. Esperá los segundos indicados en el header Retry-After.

object
error
required
object
code
required

Identificador estable del error en SCREAMING_SNAKE_CASE

string
message
required

Mensaje legible en español

string
details

Información adicional (puede ser objeto, array o string)

nullable
requestId

UUID de correlación; mismo valor que el header X-Request-ID

string format: uuid
Ejemplos

Excediste el rate limit

{
  "error": {
    "code": "API_RATE_LIMITED",
    "message": "Se superó el límite de requests para esta API key"
  },
  "requestId": "5b2c7c8a-1f6e-4d29-9a0b-7c3a8d1e2f4c"
}

Headers

Sección titulada «Headers »
Retry-After
integer
Ejemplo
42

Segundos hasta que se libera la ventana de rate limit

502

Sección titulada «502 »

El servidor de correo rechazó todos los envíos. El detalle por destinatario (con el motivo de cada rechazo) viene en error.details.

object
error
required
object
code
required

Identificador estable del error en SCREAMING_SNAKE_CASE

string
message
required

Mensaje legible en español

string
details

Información adicional (puede ser objeto, array o string)

nullable
requestId

UUID de correlación; mismo valor que el header X-Request-ID

string format: uuid
Ejemplos

El servidor de correo rechazó todos los envíos

{
  "error": {
    "code": "EMAIL_ENVIO_FALLIDO",
    "message": "El servidor de correo rechazó el envío a todos los destinatarios",
    "details": {
      "total": 2,
      "exitosos": 0,
      "fallidos": 2,
      "todosExitosos": false,
      "ningunoExitoso": true,
      "resultados": [
        {
          "email": "no-existe@empresa.com.uy",
          "exito": false,
          "error": "Message failed: 550 5.1.1 The email account that you tried to reach does not exist — código SMTP 550"
        },
        {
          "email": "dominio-caido@empresa.com.uy",
          "exito": false,
          "error": "getaddrinfo ENOTFOUND mail.dominio-caido.com — código ENOTFOUND"
        }
      ]
    }
  },
  "requestId": "5b2c7c8a-1f6e-4d29-9a0b-7c3a8d1e2f4c"
}