E-mail de notas

Consultar modelo de e-mail

Modelo completo, com o corpo e a lista de variáveis permitidas para o tipo.

GET/openapi/v2/emails/templates/{templateId}

Requer os cabeçalhos de assinatura token, timestamp e sign, veja Autenticação.

Devolve um modelo do integrador por templateId, incluindo corpoHtml e variaveisDisponiveis. Um modelo de outro integrador não é visível: responde 10021001.

Parâmetros de caminho

templateId*

string

Identificador do modelo

* Campo obrigatório

200

Modelo encontrado.

`templateId`	string	Identificador do modelo
`tipoDocumento`	string	Tipo de documento
`idioma`	string	Idioma do modelo
`nome`	string	Nome do modelo
`assunto`	string	Modelo do assunto
`corpoHtml`	string	Modelo do corpo
`padrao`	bool	Modelo padrão
`ativo`	bool	Ativo
`variaveisDisponiveis`	array	Variáveis permitidas
`criadoEm`	string	Criação
`atualizadoEm`	string	Última atualização

variaveisDisponiveis é a lista completa que o modelo pode usar, na ordem em que a plataforma a declara: as onze variáveis comuns primeiro, depois as próprias do tipo. Use-a para montar um editor de modelos; um nome fora dela é recusado ao salvar com 10021003.

NFe: só as variáveis comuns

A NF-e não tem variável própria; cliente.nome é o comprador.

json

[
  "numero",
  "serie",
  "chaveAcesso",
  "dataEmissao",
  "valorTotal",
  "emitente.nome",
  "emitente.cnpj",
  "cliente.nome",
  "cliente.documento",
  "linkPdf",
  "linkXml"
]

variaveisDisponiveis*

array

Variáveis permitidas

* Campo obrigatório

NFSe: comuns mais quatro próprias

codigoVerificacao, municipio, descricaoServico e valorIss; cliente.nome é o tomador do serviço.

json

[
  "numero",
  "serie",
  "chaveAcesso",
  "dataEmissao",
  "valorTotal",
  "emitente.nome",
  "emitente.cnpj",
  "cliente.nome",
  "cliente.documento",
  "linkPdf",
  "linkXml",
  "codigoVerificacao",
  "municipio",
  "descricaoServico",
  "valorIss"
]

variaveisDisponiveis*

array

Variáveis permitidas

* Campo obrigatório

CTe: comuns mais três próprias

remetente.nome, destinatario.nome e valorFrete; cliente.nome é o tomador do frete.

json

[
  "numero",
  "serie",
  "chaveAcesso",
  "dataEmissao",
  "valorTotal",
  "emitente.nome",
  "emitente.cnpj",
  "cliente.nome",
  "cliente.documento",
  "linkPdf",
  "linkXml",
  "remetente.nome",
  "destinatario.nome",
  "valorFrete"
]

variaveisDisponiveis*

array

Variáveis permitidas

* Campo obrigatório

DCe: comuns mais uma própria

marketplace.site, do cadastro de DC-e do emitente; cliente.nome é o destinatário.

json

[
  "numero",
  "serie",
  "chaveAcesso",
  "dataEmissao",
  "valorTotal",
  "emitente.nome",
  "emitente.cnpj",
  "cliente.nome",
  "cliente.documento",
  "linkPdf",
  "linkXml",
  "marketplace.site"
]

variaveisDisponiveis*

array

Variáveis permitidas

* Campo obrigatório

`tipoDocumento`Tipo de documento

Valores	Significado
NFe	NF-e, nota fiscal de mercadorias
NFSe	NFS-e, nota fiscal de serviços
CTe	CT-e, conhecimento de transporte
DCe	DC-e, declaração de conteúdo

`idioma`Idioma do modelo

O idioma define o formato de valores e datas nas variáveis; a hora é sempre a de São Paulo.

Valores	Significado
pt	Português; valores `1.234,56`, datas `dd/MM/yyyy HH:mm`
en	Inglês; valores `1,234.56`, datas `yyyy-MM-dd HH:mm`
zh	Chinês; valores `1,234.56`, datas `yyyy-MM-dd HH:mm`
es	Espanhol; valores `1.234,56`, datas `dd/MM/yyyy HH:mm`

`variaveisDisponiveis[]`Variáveis comuns aos quatro tipos

Escreva {{nome}}; espaços dentro das chaves são aceitos. Sem valor, a variável vira texto vazio. No corpo o valor é escapado como HTML; no assunto não.

Valores	Significado
numero	Número do documento
serie	Série
chaveAcesso	Chave de acesso, 44 ou 50 dígitos
dataEmissao	Data de emissão, no fuso de São Paulo e no formato do idioma
valorTotal	Valor total, formatado pelo idioma: total da NF-e, valor do serviço da NFS-e, valor total da prestação do CT-e, valor declarado da DC-e
emitente.nome	Razão social do emitente
emitente.cnpj	CNPJ do emitente
cliente.nome	Nome do destinatário da nota: comprador da NF-e, tomador da NFS-e e do CT-e, destinatário da DC-e
cliente.documento	Documento do destinatário, CPF ou CNPJ
linkPdf	Link de download do PDF; validade conforme a configuração do integrador, 7 dias por padrão
linkXml	Link de download do XML autorizado; vazio se o XML ainda não foi arquivado

`variaveisDisponiveis[]`Variáveis só da NFSe

Em outro tipo de documento a variável é recusada ao salvar com 10021003.

Valores	Significado
codigoVerificacao	Código de verificação da NFS-e
municipio	Nome do município do emitente
descricaoServico	Descrição do serviço
valorIss	Valor do ISS, formatado pelo idioma

`variaveisDisponiveis[]`Variáveis só do CTe

Em outro tipo de documento a variável é recusada ao salvar com 10021003.

Valores	Significado
remetente.nome	Nome do remetente da carga
destinatario.nome	Nome do destinatário da carga
valorFrete	Valor total da prestação, formatado pelo idioma

`variaveisDisponiveis[]`Variáveis só da DCe

Em outro tipo de documento a variável é recusada ao salvar com 10021003.

Valores	Significado
marketplace.site	Site do marketplace, do cadastro de DC-e do emitente

Consultar modelo de e-mail

Parâmetros

Parâmetros de caminho

Respostas

Variáveis por tipo de documento4 blocos

NFe: só as variáveis comuns

NFSe: comuns mais quatro próprias

CTe: comuns mais três próprias

DCe: comuns mais uma própria

Enumerações6 tabelas

tipoDocumentoTipo de documento

idiomaIdioma do modelo

variaveisDisponiveis[]Variáveis comuns aos quatro tipos

variaveisDisponiveis[]Variáveis só da NFSe

variaveisDisponiveis[]Variáveis só do CTe

variaveisDisponiveis[]Variáveis só da DCe

Erros1 itens

`tipoDocumento`Tipo de documento

`idioma`Idioma do modelo

`variaveisDisponiveis[]`Variáveis comuns aos quatro tipos

`variaveisDisponiveis[]`Variáveis só da NFSe

`variaveisDisponiveis[]`Variáveis só do CTe

`variaveisDisponiveis[]`Variáveis só da DCe