E-mail de facturas
Consultar plantilla de correo
Plantilla completa, con el cuerpo y la lista de variables permitidas para el tipo.
/openapi/v2/emails/templates/{templateId}token, timestamp y sign, vea Autenticación.Devuelve una plantilla del integrador por templateId, incluidos corpoHtml y variaveisDisponiveis. Una plantilla de otro integrador no es visible: responde 10021001.
Parámetros de ruta
templateId* | string | Identificador de la plantilla |
* Campo obligatorio
templateId | string | Identificador de la plantilla |
tipoDocumento | string | Tipo de documento |
idioma | string | Idioma de la plantilla |
nome | string | Nombre de la plantilla |
assunto | string | Plantilla del asunto |
corpoHtml | string | Plantilla del cuerpo |
padrao | bool | Plantilla predeterminada |
ativo | bool | Activo |
variaveisDisponiveis | array | Variables permitidas |
criadoEm | string | Creación |
atualizadoEm | string | Última actualización |
variaveisDisponiveis es la lista completa que la plantilla puede usar, en el orden en que la plataforma la declara: primero las once variables comunes, después las propias del tipo. Úsela para construir un editor de plantillas; un nombre fuera de ella se rechaza al guardar con 10021003.
NFe: solo las variables comunes
La NF-e no tiene variable propia; cliente.nome es el comprador.
["numero","serie","chaveAcesso","dataEmissao","valorTotal","emitente.nome","emitente.cnpj","cliente.nome","cliente.documento","linkPdf","linkXml"]
variaveisDisponiveis* | array | Variables permitidas |
* Campo obligatorio
NFSe: comunes más cuatro propias
codigoVerificacao, municipio, descricaoServico y valorIss; cliente.nome es el tomador del servicio.
["numero","serie","chaveAcesso","dataEmissao","valorTotal","emitente.nome","emitente.cnpj","cliente.nome","cliente.documento","linkPdf","linkXml","codigoVerificacao","municipio","descricaoServico","valorIss"]
variaveisDisponiveis* | array | Variables permitidas |
* Campo obligatorio
CTe: comunes más tres propias
remetente.nome, destinatario.nome y valorFrete; cliente.nome es el tomador del flete.
["numero","serie","chaveAcesso","dataEmissao","valorTotal","emitente.nome","emitente.cnpj","cliente.nome","cliente.documento","linkPdf","linkXml","remetente.nome","destinatario.nome","valorFrete"]
variaveisDisponiveis* | array | Variables permitidas |
* Campo obligatorio
DCe: comunes más una propia
marketplace.site, del registro de DC-e del emisor; cliente.nome es el destinatario.
["numero","serie","chaveAcesso","dataEmissao","valorTotal","emitente.nome","emitente.cnpj","cliente.nome","cliente.documento","linkPdf","linkXml","marketplace.site"]
variaveisDisponiveis* | array | Variables permitidas |
* Campo obligatorio
tipoDocumentoTipo de documento
| Valores | Significado |
|---|---|
| NFe | NF-e, factura de mercancías |
| NFSe | NFS-e, factura de servicios |
| CTe | CT-e, conocimiento de transporte |
| DCe | DC-e, declaración de contenido |
idiomaIdioma de la plantilla
El idioma define el formato de importes y fechas en las variables; la hora es siempre la de São Paulo.
| Valores | Significado |
|---|---|
| pt | Portugués; importes 1.234,56, fechas dd/MM/yyyy HH:mm |
| en | Inglés; importes 1,234.56, fechas yyyy-MM-dd HH:mm |
| zh | Chino; importes 1,234.56, fechas yyyy-MM-dd HH:mm |
| es | Español; importes 1.234,56, fechas dd/MM/yyyy HH:mm |
variaveisDisponiveis[]Variables comunes a los cuatro tipos
Escriba {{nome}}; se aceptan espacios dentro de las llaves. Sin valor, la variable queda como texto vacío. En el cuerpo el valor se escapa como HTML; en el asunto no.
| Valores | Significado |
|---|---|
| numero | Número del documento |
| serie | Serie |
| chaveAcesso | Clave de acceso, 44 o 50 dígitos |
| dataEmissao | Fecha de emisión, en el huso de São Paulo y el formato del idioma |
| valorTotal | Importe total, formateado por idioma: total de la NF-e, valor del servicio de la NFS-e, valor total de la prestación del CT-e, valor declarado de la DC-e |
| emitente.nome | Razón social del emisor |
| emitente.cnpj | CNPJ del emisor |
| cliente.nome | Nombre del destinatario de la nota: comprador de la NF-e, tomador de la NFS-e y del CT-e, destinatario de la DC-e |
| cliente.documento | Documento del destinatario, CPF o CNPJ |
| linkPdf | Enlace de descarga del PDF; validez según la configuración del integrador, 7 días por defecto |
| linkXml | Enlace de descarga del XML autorizado; vacío si el XML aún no fue archivado |
variaveisDisponiveis[]Variables solo de la NFSe
En otro tipo de documento la variable se rechaza al guardar con 10021003.
| Valores | Significado |
|---|---|
| codigoVerificacao | Código de verificación de la NFS-e |
| municipio | Nombre del municipio del emisor |
| descricaoServico | Descripción del servicio |
| valorIss | Importe del ISS, formateado por idioma |
variaveisDisponiveis[]Variables solo del CTe
En otro tipo de documento la variable se rechaza al guardar con 10021003.
| Valores | Significado |
|---|---|
| remetente.nome | Nombre del remitente de la carga |
| destinatario.nome | Nombre del destinatario de la carga |
| valorFrete | Valor total de la prestación, formateado por idioma |
variaveisDisponiveis[]Variables solo de la DCe
En otro tipo de documento la variable se rechaza al guardar con 10021003.
| Valores | Significado |
|---|---|
| marketplace.site | Sitio del marketplace, del registro de DC-e del emisor |
| Código | HTTP | |
|---|---|---|
| 10021001 | 404 | Plantilla de correo no encontrada: el templateId no existe o no es de este integrador. |