Developers / Referências
Referências

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).

ValorSignificado
RECEIVEDRequisição recebida -- raro de ver, já que a emissão é síncrona (ver Códigos HTTP).
PROCESSINGEm fila na SEFAZ/provedor -- também raro, só em instabilidade.
AUTHORIZEDDocumento autorizado -- estado terminal de sucesso.
REJECTEDRejeitado pela SEFAZ/provedor -- estado terminal, corrigível reenviando.
CANCELLEDCancelamento processado com sucesso.
ERRORFalha 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).

ValorSignificado
HOMOLOGATIONAmbiente de testes, sem validade fiscal.
PRODUCTIONAmbiente real, com validade fiscal.

Regime tributário do contribuinte

Campo regime_tributario no cadastro do contribuinte.

ValorSignificado
SIMPLES_NACIONALOptante pelo Simples Nacional.
LUCRO_PRESUMIDORegime normal, lucro presumido.
LUCRO_REALRegime normal, lucro real.
MEIMicroempreendedor 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.

CampoValorCódigo
tipo_operacao
padrão: SAIDA
ENTRADA0
SAIDA1
finalidade
padrão: NORMAL
NORMAL1
COMPLEMENTAR2
AJUSTE3
DEVOLUCAO4
destino_operacao
padrão: INTERNA
INTERNA1
INTERESTADUAL2
EXTERIOR3
consumidor_final
padrão: NORMAL
NORMAL0
CONSUMIDOR_FINAL1
presenca_comprador
padrão: NAO_PRESENCIAL_OUTROS
NAO_SE_APLICA0
PRESENCIAL1
INTERNET2
TELEATENDIMENTO3
ENTREGA_DOMICILIO4
PRESENCIAL_FORA_ESTABELECIMENTO5
NAO_PRESENCIAL_OUTROS9

MDF-e · tipo_emitente

Campo ide.tipo_emitente, obrigatório na emissão de MDF-e.

Valor aceitoCódigo SEFAZ (tpEmit)Significado
PRESTADOR_SERVICO_TRANSPORTE / PRESTADOR1Transportador presta serviço de transporte a terceiros.
TRANSPORTADOR_CARGA_PROPRIA / CARGA_PROPRIA2Transporta carga própria.
CTE_GLOBALIZADO3CT-e Globalizado.

MDF-e · tipo_transportador (opcional)

ValorSignificado
ETCEmpresa de Transporte de Cargas.
TACTransportador Autônomo de Cargas.
CTCCooperativa de Transporte de Cargas.
💡
Não existe código para "transportador próprio" nesse campo -- se não se encaixar em nenhum dos três, omita o campo em vez de forçar um valor. Um valor fora dessa lista é descartado silenciosamente, não gera erro.

MDF-e/CT-e · unidade de carga

Dois campos parecidos, com listas de valores diferentes -- não misture.

CampoValores aceitos
MDF-e: totais.unidade_cargaKG (código SEFAZ 01) ou TON (código SEFAZ 02) -- aceita o rótulo por extenso.
CT-e: carga.quantidades[].unidadeM3, KG, TON, UNIDADE, LITROS, MMBTU -- também por extenso.

MDF-e · veículo de tração (código SEFAZ direto, sem tradução)

⚠️
Diferente dos campos acima, 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_rodadoSignificado
01Truck
02Toco
03Cavalo Mecânico
04VAN
05Utilitário
06Outros
tipo_carroceriaSignificado
00Não aplicável
01Aberta
02Fechada/Baú
03Granelera
04Porta Container
05Sider