TF Fiscal
Documentación

E-mail de facturas

Consultar correo de la factura

Estado, motivo de la espera o del fallo y lo que se envió efectivamente, por el emailId de la aceptación.

GET/openapi/v2/empresas/{empresaId}/emails/{emailId}
Requiere las cabeceras de firma token, timestamp y sign, vea Autenticación.

Consulta un correo aceptado en Enviar correo. Sirve de reserva al webhook: email.sent y email.failed traen el mismo veredicto, pero exigen suscripción explícita. Un emailId de otra empresa responde 10021020.

Parámetros de ruta

empresaId*
stringIdentificador de la empresa
emailId*
stringIdentificador del correo

* Campo obligatorio

200
Correo encontrado. Los campos sin valor en el estado actual vienen como null.
emailId
stringIdentificador del correo
id
stringIdentificador de la solicitud
tipoDocumento
stringTipo de documento
documentoId
stringIdentificador de la factura
numero
intNúmero del documento
chaveAcesso
stringClave de acceso
codigoVerificacao
stringCódigo de verificación
templateId
stringPlantilla usada
status
stringEstado del correo
motivoEspera
stringMotivo de la espera
motivoFalha
stringMotivo del fallo
destinatarios
arrayDestinatarios efectivos
anexos
arrayAdjuntos pedidos
assunto
stringAsunto renderizado
criadoEm
stringAceptación
enviadoEm
stringEntrega al servicio de envío
atualizadoEm
stringÚltima actualización

Los campos del documento (numero, chaveAcesso, codigoVerificacao) vienen del momento de la aceptación y se actualizan en el envío; assunto y enviadoEm solo existen después de enviado; motivoEspera solo en Aguardando y motivoFalha solo en Falha. Enviado y Falha son terminales: a partir de ellos el mismo documento acepta un nuevo envío.

Aguardando: falta la clave

NFS-e de São Paulo cuya clave de 50 dígitos aún no volvió: chaveAcesso es null, codigoVerificacao ya existe, motivoEspera = chaveAcesso. La plataforma vuelve a comprobar cada 30 segundos hasta 120 minutos; nada que hacer de su lado.

json
{
  "emailId": "2103160000000000002",
  "id": "mail-sp-000045",
  "tipoDocumento": "NFSe",
  "documentoId": "SP-20260928-045",
  "numero": 45,
  "chaveAcesso": null,
  "codigoVerificacao": "ABCD1234",
  "templateId": "2103150000000000002",
  "status": "Aguardando",
  "motivoEspera": "chaveAcesso",
  "motivoFalha": null,
  "destinatarios": ["financeiro@cliente.com.br"],
  "anexos": ["pdf", "xml"],
  "assunto": null,
  "criadoEm": "2026-09-28T12:00:00Z",
  "enviadoEm": null,
  "atualizadoEm": "2026-09-28T12:03:00Z"
}
status*
stringEstado del correo
motivoEspera*
stringMotivo de la espera

* Campo obligatorio

Aguardando: falta el PDF o el XML

Pidió un adjunto y el archivo aún no está disponible: motivoEspera = pdf cuando el servicio de renderizado está caído, xml cuando el XML autorizado aún no fue archivado. Misma comprobación cada 30 segundos y mismo plazo de 120 minutos.

json
{
  "emailId": "2103160000000000003",
  "id": "email-pedido-8843-1",
  "tipoDocumento": "NFe",
  "documentoId": "pedido-8843",
  "numero": 11770,
  "chaveAcesso": "35241204893402000113650010000117701017244270",
  "codigoVerificacao": null,
  "templateId": "2103150000000000001",
  "status": "Aguardando",
  "motivoEspera": "pdf",
  "motivoFalha": null,
  "destinatarios": ["comprador@exemplo.com"],
  "anexos": ["pdf"],
  "assunto": null,
  "criadoEm": "2026-09-28T12:10:00Z",
  "enviadoEm": null,
  "atualizadoEm": "2026-09-28T12:10:30Z"
}
status*
stringEstado del correo
motivoEspera*
stringMotivo de la espera

* Campo obligatorio

Enviado

El servicio de envío aceptó el mensaje: assunto trae el texto final y enviadoEm el momento de la entrega al servicio. Llega un email.sent con los mismos datos. La entrega en la bandeja del destinatario depende de su proveedor.

json
{
  "emailId": "2103160000000000001",
  "id": "email-pedido-8842-1",
  "tipoDocumento": "NFe",
  "documentoId": "pedido-8842",
  "numero": 11769,
  "chaveAcesso": "35241204893402000113650010000117691017244265",
  "codigoVerificacao": null,
  "templateId": "2103150000000000001",
  "status": "Enviado",
  "motivoEspera": null,
  "motivoFalha": null,
  "destinatarios": ["comprador@exemplo.com"],
  "anexos": ["pdf", "xml"],
  "assunto": "Nota fiscal 11769 - Loja Exemplo LTDA",
  "criadoEm": "2026-09-28T12:00:00Z",
  "enviadoEm": "2026-09-28T12:00:31Z",
  "atualizadoEm": "2026-09-28T12:00:31Z"
}
status*
stringEstado del correo
assunto*
stringAsunto renderizado
enviadoEm*
stringEntrega al servicio de envío

* Campo obligatorio

Falha

Terminal. Causas: espera agotada (motivoFalha nombra chaveAcesso, pdf o xml), intentos de envío agotados, documento que dejó de estar autorizado, plantilla desactivada tras la aceptación o comprobante que no puede emitirse. Llega un email.failed con motivo_falha. Corrija la causa y reenvíe con un id nuevo.

json
{
  "emailId": "2103160000000000002",
  "id": "mail-sp-000045",
  "tipoDocumento": "NFSe",
  "documentoId": "SP-20260928-045",
  "numero": 45,
  "chaveAcesso": null,
  "codigoVerificacao": "ABCD1234",
  "templateId": "2103150000000000002",
  "status": "Falha",
  "motivoEspera": null,
  "motivoFalha": "Tempo esgotado aguardando: chaveAcesso",
  "destinatarios": ["financeiro@cliente.com.br"],
  "anexos": ["pdf", "xml"],
  "assunto": null,
  "criadoEm": "2026-09-28T12:00:00Z",
  "enviadoEm": null,
  "atualizadoEm": "2026-09-28T14:00:30Z"
}
status*
stringEstado del correo
motivoFalha*
stringMotivo del fallo

* Campo obligatorio

AnteriorEnviar correo de la facturaSiguienteWebhooks