Invoice e-mail
List e-mail templates
Every template of the integrator, unpaged; items do not carry the body.
/openapi/v2/emails/templatestoken, timestamp and sign signature headers, see Authentication.Lists the integrator templates with optional filters by document type, language and status. Each item carries the metadata; corpoHtml and variaveisDisponiveis come as null and are in Get template.
Query parameters
tipoDocumento | string | Document type filter |
idioma | string | Language filter |
ativo | bool | Status filter |
* Required field
total | int | Returned count |
| array | Templates |
The list returns every template of the integrator, unpaged, in creation order. Filters are exact and combine; without filters everything comes. To read the body or the variable list use Get template.
Find the default template of a type
Call with tipoDocumento=NFe&ativo=true and take the item with padrao = true; that is what the send uses when templateId is omitted. If no item has padrao = true, a send without templateId returns 10021012.
{"total": 2,"itens": [{"templateId": "2103150000000000001","tipoDocumento": "NFe","idioma": "pt","nome": "NF-e padrão","assunto": "Nota fiscal {{numero}} - {{emitente.nome}}","corpoHtml": null,"padrao": true,"ativo": true,"variaveisDisponiveis": null,"criadoEm": "2026-09-28T12:00:00Z","atualizadoEm": "2026-09-28T12:00:00Z"},{"templateId": "2103150000000000002","tipoDocumento": "NFe","idioma": "en","nome": "NF-e english","assunto": "Invoice {{numero}} from {{emitente.nome}}","corpoHtml": null,"padrao": false,"ativo": true,"variaveisDisponiveis": null,"criadoEm": "2026-09-28T12:05:00Z","atualizadoEm": "2026-09-28T12:05:00Z"}]}
total* | int | Returned count |
* | array | Templates |
* Required field
Pick the template by language
Only one template per type is the default, regardless of language. To send in another language filter by idioma and pass the chosen item templateId when sending.
{"total": 1,"itens": [{"templateId": "2103150000000000002","tipoDocumento": "NFe","idioma": "en","nome": "NF-e english","assunto": "Invoice {{numero}} from {{emitente.nome}}","corpoHtml": null,"padrao": false,"ativo": true,"variaveisDisponiveis": null,"criadoEm": "2026-09-28T12:05:00Z","atualizadoEm": "2026-09-28T12:05:00Z"}]}
total* | int | Returned count |
* | array | Templates |
* Required field
tipoDocumentoDocument type
Applies to the filter and to itens[].tipoDocumento.
| Values | Meaning |
|---|---|
| NFe | NF-e, goods invoice |
| NFSe | NFS-e, service invoice |
| CTe | CT-e, transport document |
| DCe | DC-e, content declaration |
idiomaTemplate language
Applies to the filter and to itens[].idioma; the language sets the format of amounts and dates in the variables.
| Values | Meaning |
|---|---|
| pt | Portuguese; amounts 1.234,56, dates dd/MM/yyyy HH:mm |
| en | English; amounts 1,234.56, dates yyyy-MM-dd HH:mm |
| zh | Chinese; amounts 1,234.56, dates yyyy-MM-dd HH:mm |
| es | Spanish; amounts 1.234,56, dates dd/MM/yyyy HH:mm |
| Code | HTTP | |
|---|---|---|
| 10021005 | 400 | Unsupported document type in tipoDocumento; only NFe / NFSe / CTe / DCe. |