NotaFiscalXML

Descrição

Nota fiscal versão 4.0. Tag XML NFe

Atributos

natureza_operacao (obrigatório) String[1-60] Tag XML natOp

Descrição da natureza de operação.

serie Integer[1-3] Tag XML serie

Série da nota fiscal. Deixe em branco para que a API se responsabilize pela numeração automática (recomendado)

numero Integer[1-9] Tag XML nNF

Número da nota fiscal. Deixe em branco para que a API se responsabilize pela numeração automática (recomendado)

data_emissao (obrigatório) Tag XML dhEmi

Data e hora de emissão.

data_entrada_saida Tag XML dhSaiEnt

Data e hora de entrada (em notas de entrada) ou saída (em notas de saída)

tipo_documento (obrigatório) Tag XML tpNF

Tipo da nota fiscal.

Valores permitidos

  • 0: Nota de entrada

  • 1: Nota de saída

local_destino (obrigatório) Tag XML idDest

Identificador de local de destino da operação

Valores permitidos

  • 1: Operação interna

  • 2: Operação interestadual

  • 3: Operação com exterior

finalidade_emissao (obrigatório) Tag XML finNFe

Finalidade da nota fiscal.

Valores permitidos

  • 1: Nota normal

  • 2: Nota complementar

  • 3: Nota de ajuste

  • 4: Devolução de mercadoria

consumidor_final (obrigatório) Tag XML indFinal

Indica operação com consumidor final

Valores permitidos

  • 0: Normal

  • 1: Consumidor final

presenca_comprador (obrigatório) Tag XML indPres

Indicador de presença do comprador no estabelecimento comercial no momento da operação

Valores permitidos

  • 0: Não se aplica (por exemplo, para a Nota Fiscal complementar ou de ajuste);

  • 1: Operação presencial

  • 2: Operação não presencial, pela Internet

  • 3: Operação não presencial, Teleatendimento

  • 4: NFC-e em operação com entrega em domicílio

  • 5: Operação presencial, fora do estabelecimento;

  • 9: Operação não presencial, outros

notas_referenciadas Coleção[0-500] [coleção: NotaReferenciadaXML]

Notas referenciadas.

cnpj_emitente (obrigatório) Integer[14] Tag XML CNPJ

CNPJ da empresa emitente.

nome_emitente String[2-60] Tag XML xNome

Razão social da empresa emitente.

nome_fantasia_emitente String[1-60] Tag XML xFant

Nome fantasia da empresa emitente.

logradouro_emitente (obrigatório) String[2-60] Tag XML xLgr

Logradouro (rua, avenida, travessa etc.) da empresa emitente.

numero_emitente (obrigatório) String[1-60] Tag XML nro

Número do endereço da empresa emitente.

complemento_emitente String[1-60] Tag XML xCpl

Complemento do endereço da empresa emitente.

bairro_emitente (obrigatório) String[2-60] Tag XML xBairro

Bairro da empresa emitente.

municipio_emitente (obrigatório) String[2-60] Tag XML xMun

Município da empresa emitente.

uf_emitente (obrigatório) String[2] Tag XML UF

UF da empresa emitente.

cep_emitente Integer[8] Tag XML CEP

CEP da empresa emitente.

telefone_emitente Integer[6-14] Tag XML fone

Telefone da empresa emitente.

inscricao_estadual_emitente (obrigatório) String[2-14] Tag XML IE

Inscrição Estadual da empresa emitente

inscricao_estadual_st_emitente String[2-14] Tag XML IEST

Inscrição Estadual do Substituto Tributário da empresa emitente

inscricao_municipal_emitente String[1-15] Tag XML IM

Inscrição Municipal da empresa emitente. Se este campo for informado também deverá ser informado o CNAE Fiscal do emitente.

cnae_fiscal_emitente Integer[7] Tag XML CNAE

CNAE Fiscal da empresa emitente. Se este campo for informado também deverá ser informada a Inscrição Municipal do emitente.

regime_tributario_emitente (obrigatório) Tag XML CRT

Código de regime tributário.

Valores permitidos

  • 1: Simples Nacional

  • 2: Simples Nacional - excesso de sublimite de receita bruta

  • 3: Regime Normal

cnpj_destinatario Integer[14] Tag XML CNPJ

CNPJ do destinatário. Obrigatório informar CNPJ ou CPF do destinatário.

cpf_destinatario Integer[11] Tag XML CPF

CPF do destinatário. Obrigatório informar CNPJ ou CPF do destinatário.

id_estrangeiro_destinatario String[5-20] Tag XML idEstrangeiro

Identificação do destinatário no caso de comprador estrangeiro

nome_destinatario (obrigatório) String[2-60] Tag XML xNome

Nome ou razão social do destinatário

logradouro_destinatario (obrigatório) String[2-60] Tag XML xLgr

Logradouro (rua, avenida, travessa etc.) do destinatário.

numero_destinatario (obrigatório) String[1-60] Tag XML nro

Número do endereço do destinatário

complemento_destinatario String[1-60] Tag XML xCpl

Complemento do endereço do destinatário

bairro_destinatario (obrigatório) String[2-60] Tag XML xBairro

Bairro do destinatário.

codigo_municipio_destinatario Integer[7] Tag XML cMun

Código do município do destinatário (7 dígitos), de acordo com a tabela do IBGE. Se não informado o sistema tentará encontrar o código com base no nome do município e da UF.

municipio_destinatario (obrigatório) String[2-60] Tag XML xMun

Município do destinatário.

uf_destinatario (obrigatório) String[2] Tag XML UF

UF do destinatário. Deve ser omitido em operações com o exterior.

cep_destinatario String[8] Tag XML CEP

CEP do destinatário.

codigo_pais_destinatario Integer[2-4] Tag XML cPais

Código IBGE do país do destinatário. (Apenas se diferente de 1058 - Brasil)

pais_destinatario Integer[2-4] Tag XML xPais

Nome do país do destinatário. (Apenas se diferente de Brasil)

telefone_destinatario Integer[6-14] Tag XML fone

Telefone do destinatário.

indicador_inscricao_estadual_destinatario (obrigatório) Tag XML indIEDest

Inscrição Estadual do destinatário.

Valores permitidos

  • 1: Contribuinte ICMS (informar a IE do destinatário)

  • 2: Contribuinte isento de Inscrição no cadastro de Contribuintes do ICMS

  • 9: Não Contribuinte, que pode ou não possuir Inscrição Estadual no Cadastro de Contribuintes do ICMS

inscricao_estadual_destinatario Integer[2-14] Tag XML IE

Inscrição Estadual do destinatário. Obrigatório informar caso exista.

inscricao_suframa_destinatario Integer[8-9] Tag XML ISUF

Inscrição Suframa do destinatário.

inscricao_municipal_destinatario String[1-15] Tag XML IM

Inscrição Municipal do Tomador do Serviço (apenas para NFe conjugada)

email_destinatario String[1-60] Tag XML email

E-mail do destinatário. O destinatário receberá um e-mail com o XML e a DANFE gerados, adicione mais de um email separando por vírgulas. Será informado apenas o primeiro email no XML da NFe mas todos os emails informados receberão os arquivos.

cnpj_retirada Integer[14] Tag XML CNPJ

CNPJ do local de retirada. (Informar apenas quando o local de retirada for diferente do destinatário.)

cpf_retirada Integer[11] Tag XML CPF

CPF do local de retirada. (Informar apenas quando o local de retirada for diferente do destinatário.)

logradouro_retirada String[2-60] Tag XML xLgr

Logradouro do local de retirada. (Informar apenas quando o local de retirada for diferente do destinatário.)

numero_retirada String[1-60] Tag XML nro

Número do local de retirada. (Informar apenas quando o local de retirada for diferente do destinatário.)

complemento_retirada String[1-60] Tag XML xCpl

Complemento do local de retirada. (Informar apenas quando o local de retirada for diferente do destinatário.)

bairro_retirada String[2-60] Tag XML xBairro

Bairro do local de retirada. (Informar apenas quando o local de retirada for diferente do destinatário.)

codigo_municipio_retirada Integer[7] Tag XML cMun

Código do município de retirada (7 dígitos), de acordo com a tabela do IBGE. Se não informado o sistema tentará encontrar o código com base no nome do município e da UF.

municipio_retirada String[2-60] Tag XML xMun

Município do local de retirada. (Informar apenas quando o local de retirada for diferente do destinatário.)

uf_retirada String[2] Tag XML UF

UF do local de retirada. (Informar apenas quando o local de retirada for diferente do destinatário.)

cnpj_entrega Integer[14] Tag XML CNPJ

CNPJ do local de entrega. (Informar apenas quando o local de entrega for diferente do destinatário.)

cpf_entrega Integer[11] Tag XML CPF

CPF do local de entrega. (Informar apenas quando o local de entrega for diferente do destinatário.)

logradouro_entrega String[2-60] Tag XML xLgr

Logradouro do local de entrega. (Informar apenas quando o local de entrega for diferente do destinatário.)

numero_entrega String[1-60] Tag XML nro

Número do local de entrega. (Informar apenas quando o local de entrega for diferente do destinatário.)

complemento_entrega String[1-60] Tag XML xCpl

Complemento do local de entrega. (Informar apenas quando o local de entrega for diferente do destinatário.)

bairro_entrega String[2-60] Tag XML xBairro

Bairro do local de entrega. (Informar apenas quando o local de entrega for diferente do destinatário.)

codigo_municipio_entrega Integer[7] Tag XML cMun

Código do município de entrega (7 dígitos), de acordo com a tabela do IBGE. Se não informado o sistema tentará encontrar o código com base no nome do município e da UF.

municipio_entrega String[2-60] Tag XML xMun

Município do local de entrega. (Informar apenas quando o local de entrega for diferente do destinatário.)

uf_entrega String[2] Tag XML UF

UF do local de entrega. (Informar apenas quando o local de entrega for diferente do destinatário.)

pessoas_autorizadas Coleção[0-10] [coleção: PessoaAutorizadaXML]

Pessoas autorizadas a acessar o XML da NF-e

itens Coleção[1-990] [coleção: ItemNotaFiscalXML]

Itens da nota fiscal.

icms_base_calculo Decimal[13.2] Tag XML vBC

Valor total da base de cálculo do ICMS. Calculado automaticamente se omitido.

icms_valor_total Decimal[13.2] Tag XML vICMS

Valor total do ICMS. Calculado automaticamente se omitido.

icms_valor_total_desonerado Decimal[13.2] Tag XML vICMSDeson

Valor total do ICMS Desonerado. Calculado automaticamente se omitido.

fcp_valor_total_uf_destino Decimal[13.2] Tag XML 'vFCPUFDest'

(apenas para venda interestadual para consumidor final) Valor total do ICMS relativo Fundo de Combate à Pobreza (FCP) da UF de destino. Calculado automaticamente se omitido.

icms_valor_total_uf_destino Decimal[13.2] Tag XML 'vICMSUFDest'

(apenas para venda interestadual para consumidor final) Valor total do ICMS Interestadual para a UF de destino. Calculado automaticamente se omitido.

icms_valor_total_uf_remetente Decimal[13.2] Tag XML 'vICMSUFRemet'

(apenas para venda interestadual para consumidor final) Valor total do ICMS Interestadual para a UF do remetente. Calculado automaticamente se omitido.

fcp_valor_total (obrigatório) Decimal[13.2] Tag XML 'vFCP'

Valor Total do FCP (Fundo de Combate à Pobreza). Calculado automaticamente se omitido.

icms_base_calculo_st Decimal[13.2] Tag XML vBCST

Valor total da base de cálculo do ICMS do substituto tributário. Calculado automaticamente se omitido.

icms_valor_total_st Decimal[13.2] Tag XML vST

Valor total do ICMS do substituto tributário. Calculado automaticamente se omitido.

fcp_valor_total_st (obrigatório) Decimal[13.2] Tag XML 'vFCPST'

Valor Total do FCP (Fundo de Combate à Pobreza) retido por substituição tributária. Calculado automaticamente se omitido.

fcp_valor_total_retido_st (obrigatório) Decimal[13.2] Tag XML 'vFCPSTRet'

Valor Total do FCP (Fundo de Combate à Pobreza) retido anteriormente substituição tributária. Calculado automaticamente se omitido.

valor_produtos (obrigatório) Decimal[13.2] Tag XML vProd

Valor total dos produtos. Calculado automaticamente se omitido.

valor_frete (obrigatório) Decimal[13.2] Tag XML vFrete

Valor total do frete. Calculado automaticamente se omitido.

valor_seguro (obrigatório) Decimal[13.2] Tag XML vSeg

Valor total do seguro. Calculado automaticamente se omitido.

valor_desconto (obrigatório) Decimal[13.2] Tag XML vDesc

Valor total do desconto. Calculado automaticamente se omitido.

valor_total_ii (obrigatório) Decimal[13.2] Tag XML vII

Valor total do imposto de importação. Calculado automaticamente se omitido.

valor_ipi (obrigatório) Decimal[13.2] Tag XML vIPI

Valor total do IPI. Calculado automaticamente se omitido.

valor_ipi_devolvido (obrigatório) Decimal[13.2] Tag XML vIPIDevol

Valor total do IPI devolvido. Calculado automaticamente se omitido.

valor_pis (obrigatório) Decimal[13.2] Tag XML vPIS

Valor do PIS. Calculado automaticamente se omitido.

valor_cofins (obrigatório) Decimal[13.2] Tag XML vCOFINS

Valor do COFINS. Calculado automaticamente se omitido.

valor_outras_despesas (obrigatório) Decimal[13.2] Tag XML vOutro

Valor das despesas acessórias. Calculado automaticamente se omitido.

valor_total (obrigatório) Decimal[13.2] Tag XML vNF

Valor total da nota fiscal. Se não informado o valor será calculado como valor_produtos - valor_desconto - icms_valor_total_desonerado + icms_valor_total_st + valor_frete + valor_seguro + valor_outras_despesas + valor_total_ii + valor_ipi + valor_total_servicos. Este campo não será calculado se a nota for de importação (CFOP começando com 3).

valor_total_tributos Decimal[13.2] Tag XML vTotTrib

Valor total aproximado dos tributos - calculado automaticamente pela API

valor_total_servicos Decimal[13.2] Tag XML vServ

(ISSQN) Valor Total dos Serviços sob não-incidência ou não tributados pelo ICMS.

issqn_base_calculo Decimal[13.2] Tag XML vBC

(ISSQN) Base de Cálculo do ISS.

issqn_valor_total Decimal[13.2] Tag XML vISS

(ISSQN) Valor Total do ISS.

valor_pis_servicos Decimal[13.2] Tag XML vPIS

(ISSQN) Valor do PIS sobre serviços.

valor_cofins_servicos Decimal[13.2] Tag XML vCOFINS

(ISSQN) Valor do COFINS sobre serviços.

data_prestacao_servico Tag XML dCompet

(ISSQN) Data da prestação do serviço. Obrigatório se houver serviços

issqn_valor_total_deducao Decimal[13.2] Tag XML vDeducao

(ISSQN) Valor total da dedução para redução da Base de Cálculo

issqn_valor_total_outras_retencoes Decimal[13.2] Tag XML vOutro

(ISSQN) Valor total outras retenções

issqn_valor_total_desconto_incondicionado Decimal[13.2] Tag XML vDescIncond

(ISSQN) Valor total desconto incondicionado

issqn_valor_total_desconto_condicionado Decimal[13.2] Tag XML vDescCond

(ISSQN) Valor total desconto condicionado

issqn_valor_total_retencao Decimal[13.2] Tag XML vISSRet

(ISSQN) Valor total retenção ISS

codigo_regime_especial_tributacao Tag XML cRegTrib

(ISSQN) Código do regime especial de tributação

Valores permitidos

  • 1: Microempresa Municipal

  • 2: Estimativa

  • 3: Sociedade de Profissionais

  • 4: Cooperativa

  • 5: Microempresário Individual (MEI)

  • 6: Microempresário e Empresa de Pequeno Porte (ME/EPP)

pis_valor_retido Decimal[13.2] Tag XML vRetPIS

Valor Retido de PIS.

cofins_valor_retido Decimal[13.2] Tag XML vRetCOFINS

Valor Retido de COFINS.

csll_valor_retido Decimal[13.2] Tag XML vRetCSLL

Valor Retido de CSLL.

irrf_base_calculo Decimal[13.2] Tag XML vBCIRRF

Base de Cálculo do IRRF.

irrf_valor_retido Decimal[13.2] Tag XML vIRRF

Valor Retido de IRRF.

prev_social_base_calculo Decimal[13.2] Tag XML vBCRetPrev

Base de Cálculo da Retenção da Previdêncica Social.

prev_social_valor_retido Decimal[13.2] Tag XML vRetPrev

Valor da Retenção da Previdêncica Social.

modalidade_frete (obrigatório) Tag XML modFrete

Modalidade do frete.

Valores permitidos

  • 0: por conta do emitente

  • 1: por conta do destinatário

  • 2: por conta de terceiros

  • 3: Transporte Próprio por conta do Remetente

  • 4: Transporte Próprio por conta do Destinatário

  • 9: sem frete

cnpj_transportador Integer[14] Tag XML CNPJ

CNPJ do transportador. Se este campo for informado não deverá ser informado o CPF.

cpf_transportador Integer[11] Tag XML CPF

CPF do transportador. Se este campo for informado não deverá ser informado o CNPJ.

nome_transportador String[2-60] Tag XML xNome

Nome ou razão social do transportador.

inscricao_estadual_transportador String[2-14] Tag XML IE

Inscrição Estadual do transportador.

endereco_transportador String[1-60] Tag XML xEnder

Endereço (logradouro, número, complemento e bairro) do transportador.

municipio_transportador String[1-60] Tag XML xMun

Município do transportador.

uf_transportador String[2] Tag XML UF

UF do transportador.

transporte_icms_servico Decimal[13.2] Tag XML vServ

Valor do serviço de transporte.

transporte_icms_base_calculo Decimal[13.2] Tag XML vBCRet

Base de cálculo da retenção do ICMS de transporte.

transporte_icms_aliquota Decimal[3.2-4] Tag XML pICMSRet

Alíquota da retenção do ICMS de transporte.

transporte_icms_valor Decimal[13.2] Tag XML vICMSRet

Valor retido do ICMS de transporte.

transporte_icms_cfop Integer[4] Tag XML CFOP

CFOP do serviço de transporte. (Valores aceitos: 5351, 5352, 5353, 5354, 5355, 5356, 5357, 5359, 5360, 5931, 5932, 6351, 6352, 6353, 6354, 6355, 6356, 6357, 6359, 6360, 6931, 6932, 7358)

transporte_icms_codigo_municipio Integer[7] Tag XML cMunFG

Código do município de ocorrência do fato gerador.

veiculo_placa Tag XML placa

Placa do veículo de transporte.

veiculo_uf Tag XML UF

UF do veículo de transporte.

veiculo_rntc Tag XML RNTC

RNTC (Registro Nacional de Transportador de Carga - ANTT) do veículo de transporte.

reboques Coleção[0-5] [coleção: ReboqueXML]

Reboques

veiculo_identificacao_vagao String[1-20] Tag XML vagao

Identificação do vagão de transporte.

veiculo_identificacao_balsa String[1-20] Tag XML balsa

Identificação da balsa de transporte.

volumes Coleção[0-5000] [coleção: VolumeTransportadoXML]

Volumes transportados.

numero_fatura String[1-60] Tag XML nFat

Número da fatura.

valor_original_fatura Decimal[13.2] Tag XML vOrig

Valor original da fatura.

valor_desconto_fatura Decimal[13.2] Tag XML vDesc

Valor do desconto da fatura.

valor_liquido_fatura Decimal[13.2] Tag XML vLiq

Valor líquido da fatura.

duplicatas Coleção[0-120] [coleção: DuplicataNotaFiscalXML]

Duplicatas da nota fiscal.

formas_pagamento Coleção[0-100] [coleção: FormaPagamentoXML]

Formas de Pagamento (Tanto NF-e quanto NFC-e)

valor_troco Decimal[13.2] Tag XML vTroco

Valor do troco

informacoes_adicionais_fisco String[1-2000] Tag XML infAdFisco

Informações adicionais de interesse do fisco.

informacoes_adicionais_contribuinte String[1-5000] Tag XML infCpl

Informações adicionais de interesse do contribuinte.

uf_local_embarque String[2] Tag XML UFSaidaPais

Sigla da UF de Embarque ou de transposição de fronteira

local_embarque String[1-60] Tag XML xLocExporta

Descrição do Local de Embarque ou de transposição de fronteira

local_despacho String[1-60] Tag XML xLocDespacho

Descrição do local de despacho