Enums
Conjuntos de valores fixos usados nos campos da API -- consolidados aqui pra você não precisar caçar em cada página de endpoint.
Status do documento
Campo status, presente em toda emissão/cancelamento (NF-e/CT-e/MDF-e/NFS-e).
| Valor | Significado |
|---|---|
RECEIVED | Requisição recebida -- raro de ver, já que a emissão é síncrona (ver Códigos HTTP). |
PROCESSING | Em fila na SEFAZ/provedor -- também raro, só em instabilidade. |
AUTHORIZED | Documento autorizado -- estado terminal de sucesso. |
REJECTED | Rejeitado pela SEFAZ/provedor -- estado terminal, corrigível reenviando. |
CANCELLED | Cancelamento processado com sucesso. |
ERROR | Falha interna do motor ou do provedor -- não é rejeição fiscal. |
Ambiente
Campo de resposta ambiente -- nunca é enviado por você, é determinado pela
API key (ver Ambientes).
| Valor | Significado |
|---|---|
HOMOLOGATION | Ambiente de testes, sem validade fiscal. |
PRODUCTION | Ambiente real, com validade fiscal. |
Regime tributário do contribuinte
Campo regime_tributario no cadastro do contribuinte.
| Valor | Significado |
|---|---|
SIMPLES_NACIONAL | Optante pelo Simples Nacional. |
LUCRO_PRESUMIDO | Regime normal, lucro presumido. |
LUCRO_REAL | Regime normal, lucro real. |
MEI | Microempreendedor Individual. |
NF-e/NFC-e · campos de ide
Cinco campos opcionais de ide que definem o tipo/contexto da operação --
aceitam o código SEFAZ cru ("1") ou o rótulo por extenso (PRESENCIAL).
O mais importante pra NFC-e: presenca_comprador, cujo
padrão é NAO_PRESENCIAL_OUTROS -- errado pra venda de balcão se você não
setar explicitamente.
| Campo | Valor | Código |
|---|---|---|
tipo_operacaopadrão: SAIDA | ENTRADA | 0 |
| SAIDA | 1 | |
finalidadepadrão: NORMAL | NORMAL | 1 |
| COMPLEMENTAR | 2 | |
| AJUSTE | 3 | |
| DEVOLUCAO | 4 | |
destino_operacaopadrão: INTERNA | INTERNA | 1 |
| INTERESTADUAL | 2 | |
| EXTERIOR | 3 | |
consumidor_finalpadrão: NORMAL | NORMAL | 0 |
| CONSUMIDOR_FINAL | 1 | |
presenca_compradorpadrão: NAO_PRESENCIAL_OUTROS | NAO_SE_APLICA | 0 |
| PRESENCIAL | 1 | |
| INTERNET | 2 | |
| TELEATENDIMENTO | 3 | |
| ENTREGA_DOMICILIO | 4 | |
| PRESENCIAL_FORA_ESTABELECIMENTO | 5 | |
| NAO_PRESENCIAL_OUTROS | 9 |
MDF-e · tipo_emitente
Campo ide.tipo_emitente, obrigatório na emissão de MDF-e.
| Valor aceito | Código SEFAZ (tpEmit) | Significado |
|---|---|---|
PRESTADOR_SERVICO_TRANSPORTE / PRESTADOR | 1 | Transportador presta serviço de transporte a terceiros. |
TRANSPORTADOR_CARGA_PROPRIA / CARGA_PROPRIA | 2 | Transporta carga própria. |
CTE_GLOBALIZADO | 3 | CT-e Globalizado. |
MDF-e · tipo_transportador (opcional)
| Valor | Significado |
|---|---|
ETC | Empresa de Transporte de Cargas. |
TAC | Transportador Autônomo de Cargas. |
CTC | Cooperativa de Transporte de Cargas. |
MDF-e/CT-e · unidade de carga
Dois campos parecidos, com listas de valores diferentes -- não misture.
| Campo | Valores aceitos |
|---|---|
MDF-e: totais.unidade_carga | KG (código SEFAZ 01) ou TON (código SEFAZ 02) -- aceita o rótulo por extenso. |
CT-e: carga.quantidades[].unidade | M3, KG, TON, UNIDADE, LITROS, MMBTU -- também por extenso. |
MDF-e · veículo de tração (código SEFAZ direto, sem tradução)
rodoviario.veiculo_tracao.tipo_rodado e
tipo_carroceria exigem o código numérico SEFAZ
diretamente -- não há tradução por rótulo (ex.: enviar "TRUCK" não
funciona, é descartado; o valor certo é "01").
| tipo_rodado | Significado |
|---|---|
01 | Truck |
02 | Toco |
03 | Cavalo Mecânico |
04 | VAN |
05 | Utilitário |
06 | Outros |
| tipo_carroceria | Significado |
|---|---|
00 | Não aplicável |
01 | Aberta |
02 | Fechada/Baú |
03 | Granelera |
04 | Porta Container |
05 | Sider |