TF Fiscal
开发文档

发票邮件

查询邮件模板

完整模板，含正文与该类型允许的变量清单。

GET/openapi/v2/emails/templates/{templateId}
需要 token、timestamp、sign 三个签名头，参见认证与签名。

按 templateId 返回本集成商的一份模板，含 corpoHtml 与 variaveisDisponiveis。其他集成商的模板不可见，返回 10021001。

路径参数

templateId*
string模板标识

* 必填字段

200
模板存在。
templateId
string模板标识
tipoDocumento
string发票类型
idioma
string模板语言
nome
string模板名
assunto
string主题模板
corpoHtml
string正文模板
padrao
bool是否默认模板
ativo
bool是否启用
variaveisDisponiveis
array可用变量清单
criadoEm
string创建时间
atualizadoEm
string更新时间

variaveisDisponiveis 是模板可用变量的完整清单，顺序与平台声明一致：先是 11 个公共变量，再是该类型专属的。可以用它来做模板编辑器；不在清单内的名字在保存时被 10021003 拒绝。

NFe：只有公共变量

NF-e 没有专属变量；cliente.nome 是买方。

json
[
  "numero",
  "serie",
  "chaveAcesso",
  "dataEmissao",
  "valorTotal",
  "emitente.nome",
  "emitente.cnpj",
  "cliente.nome",
  "cliente.documento",
  "linkPdf",
  "linkXml"
]
variaveisDisponiveis*
array可用变量清单

* 必填字段

NFSe：公共加四个专属

codigoVerificacao、municipio、descricaoServico、valorIss；cliente.nome 是服务承担方。

json
[
  "numero",
  "serie",
  "chaveAcesso",
  "dataEmissao",
  "valorTotal",
  "emitente.nome",
  "emitente.cnpj",
  "cliente.nome",
  "cliente.documento",
  "linkPdf",
  "linkXml",
  "codigoVerificacao",
  "municipio",
  "descricaoServico",
  "valorIss"
]
variaveisDisponiveis*
array可用变量清单

* 必填字段

CTe：公共加三个专属

remetente.nome、destinatario.nome、valorFrete；cliente.nome 是运费承担方。

json
[
  "numero",
  "serie",
  "chaveAcesso",
  "dataEmissao",
  "valorTotal",
  "emitente.nome",
  "emitente.cnpj",
  "cliente.nome",
  "cliente.documento",
  "linkPdf",
  "linkXml",
  "remetente.nome",
  "destinatario.nome",
  "valorFrete"
]
variaveisDisponiveis*
array可用变量清单

* 必填字段

DCe：公共加一个专属

marketplace.site 取自主体的 DC-e 档案；cliente.nome 是收货人。

json
[
  "numero",
  "serie",
  "chaveAcesso",
  "dataEmissao",
  "valorTotal",
  "emitente.nome",
  "emitente.cnpj",
  "cliente.nome",
  "cliente.documento",
  "linkPdf",
  "linkXml",
  "marketplace.site"
]
variaveisDisponiveis*
array可用变量清单

* 必填字段

上一页邮件模板列表下一页发送发票邮件