Skip to main content
POST
Inserir Nota Fiscal de Produto
Campos obrigatórios ausentes ou inválidos retornam 400 com o detalhe em notifications/errors.

Authorizations

Authorization
string
header
required

Envie o token retornado por /v2/autenticar no header Authorization, no formato Bearer {token}.

Body

application/json

Nota Fiscal de Produto (NF-e). Campos obrigatórios: codigoDaFilial, codigoDaNotaFiscal, tipoDeOperacao (Entrada/Saída/Simples Remessa), naturezaDaOperacao, codigoDaFormaDePagamento (deve existir), codigoDoCliente (cliente válido), nomeDoCliente e cep. Os demais campos (contaCorrente, carteira, centroDeCusto, projeto, itemDeLancamento) são opcionais mas, se informados, devem referenciar cadastros válidos.

codigoDaFilial
integer<int16>
required

Código da filial emissora. Deve ser uma filial válida da empresa.

codigoDaNotaFiscal
integer<int16>
required

Código do tipo/modelo de nota fiscal cadastrado. Deve ser válido para a filial.

tipoDeOperacao
string
required

Tipo de operação da nota: Entrada, Saída ou Simples Remessa.

naturezaDaOperacao
string
required

Descrição da natureza da operação (CFOP textual).

codigoDoCliente
integer<int32>
required

Código do cliente. Deve ser um cliente válido cadastrado na empresa.

nomeDoCliente
string
required

Nome/razão social do cliente.

cep
string
required

CEP do cliente.

codigoDaFormaDePagamento
integer<int16>
required

Código da forma/condição de pagamento. Deve existir e estar cadastrada na empresa.

idNF
number

Id. interno da Nota Fiscal. Obrigatório para PUT (alteração); ignorado/gerado pelo servidor na inclusão.

presencialNFe
integer<int16>

Indicador de presença do comprador no momento da operação (NF-e).

codigoDoMunicipioEmissor
string | null

Código IBGE do município emissor.

cnpjEmissor
string | null

CNPJ do estabelecimento emissor.

ufEmissor
string | null

UF do estabelecimento emissor.

codigoDoItemDeLancamento
string | null

Código do item de lançamento de receita (Contas a Receber), quando informado deve ser um item válido.

historicoCR
string | null

Histórico do lançamento de Contas a Receber.

codigoDaContaCorrente
integer<int16> | null

Código da conta corrente para recebimento, quando informado deve ser válida.

codigoDaCarteira
integer<int16> | null

Código da carteira de cobrança, quando informado deve ser válida para a conta corrente.

codigoDoCentroDeCusto
string | null

Código do centro de custo, quando informado deve ser válido.

codigoDoProjeto
integer<int32> | null

Código do projeto, quando informado deve ser válido.

codigoDoVendedor
integer<int32> | null

Código do vendedor responsável.

dataDeCadastro
string<date-time> | null

Data de cadastro da nota.

dataDaProximaEmissao
string<date-time> | null

Data prevista para emissão da nota.

numeroDoPedidoDeVenda
number | null

Número do Pedido de Venda que originou a nota, quando aplicável.

nomeFantasia
string | null

Nome fantasia do cliente.

naturezaJuridica
string | null

Natureza jurídica do cliente (Física/Jurídica).

cnpjcpf
string | null

CNPJ ou CPF do cliente.

inscricaoEstadual
string | null

Inscrição Estadual do cliente.

inscricaoMunicipal
string | null

Inscrição Municipal do cliente.

indicadorContribuinte
string | null

Indicador da inscrição estadual do destinatário (contribuinte de ICMS).

logradouro
string | null

Logradouro do endereço do cliente.

numero
string | null

Número do endereço do cliente.

complemento
string | null

Complemento do endereço do cliente.

bairro
string | null

Bairro do endereço do cliente.

cidade
string | null

Cidade do endereço do cliente.

uf
string | null

UF do endereço do cliente.

telefone
string | null

Telefone de contato do cliente.

email
string | null

E-mail de contato do cliente.

codigoDoMunicipio
string | null

Código IBGE do município do cliente.

codigoDoMunicipioDePrestacaoDoServico
string | null

Código IBGE do município de prestação do serviço, quando a nota contiver itens de serviço.

paisExterior
boolean

Indica se o cliente está localizado no exterior.

codigoDoPais
integer<int32> | null

Código do país do cliente, quando no exterior.

idExterior
string | null

Identificação do cliente no exterior (equivalente ao CNPJ/CPF).

valorTotalFrete
number

Valor total de frete da nota.

valorTotalSeguro
number

Valor total de seguro da nota.

valorTotalOutros
number

Valor total de outras despesas acessórias da nota.

valorTotalAcrescimo
number

Valor total de acréscimo da nota.

valorTotalDesconto
number

Valor total de desconto da nota.

baseICMS
number

Base de cálculo total do ICMS.

valorICMS
number

Valor total do ICMS.

baseICMSST
number

Base de cálculo total do ICMS-ST.

valorICMSST
number

Valor total do ICMS-ST.

valorTotalIPI
number

Valor total do IPI.

valorTotalDosProdutos
number

Valor total dos produtos da nota.

valorTotalDosServicos
number

Valor total dos serviços da nota, quando houver.

informacoesDosTributos
string | null

Informações complementares sobre tributos aproximados (Lei da Transparência Fiscal).

baseISSRetido
number

Base de cálculo do ISS retido, quando a nota contiver serviços.

aliquotaISSRetido
number

Alíquota do ISS retido.

valorISSRetido
number

Valor do ISS retido.

valorINSSRetido
number

Valor do INSS retido.

valorPISRetido
number

Valor do PIS retido.

valorCOFINSRetido
number

Valor da COFINS retida.

valorCSLLRetido
number

Valor da CSLL retida.

baseIRRetido
number

Base de cálculo do IR retido.

aliquotaIRRetido
number

Alíquota do IR retido.

valorIRRetido
number

Valor do IR retido.

transportadoraNome
string | null

Nome/razão social da transportadora.

transportadoraEndereco
string | null

Endereço da transportadora.

transportadoraCidade
string | null

Cidade da transportadora.

transportadoraUF
string | null

UF da transportadora.

transportadoraPlaca
string | null

Placa do veículo transportador.

transportadoraPlacaUF
string | null

UF da placa do veículo transportador.

transportadoraNatureza
string | null

Natureza jurídica da transportadora.

transportadoraCNPJ
string | null

CNPJ da transportadora.

transportadoraIE
string | null

Inscrição Estadual da transportadora.

transportadoraEspecie
string | null

Espécie dos volumes transportados.

transportadoraVolume
string | null

Descrição do(s) volume(s) transportado(s).

transportadoraFreteEmiDest
string | null

Modalidade do frete (emitente/destinatário/terceiros/sem frete).

transportadoraPesoBruto
number

Peso bruto total transportado.

transportadoraPesoLiquido
number

Peso líquido total transportado.

transportadoraValorFrete
number

Valor do frete pago à transportadora.

transportadoraValorSeguro
number

Valor do seguro do transporte.

transportadoraVolumeComprimento
number

Comprimento do volume transportado.

transportadoraVolumeAltura
number

Altura do volume transportado.

transportadoraVolumeLargura
number

Largura do volume transportado.

transportadoraQtde
integer<int16>

Quantidade de volumes transportados.

transportadoraObservacao
string | null

Observação sobre o transporte.

entregaNomeContato
string | null

Nome do contato no endereço de entrega.

entregaCEP
string | null

CEP do endereço de entrega.

entregaLogradouro
string | null

Logradouro do endereço de entrega.

entregaNumero
string | null

Número do endereço de entrega.

entregaComplemento
string | null

Complemento do endereço de entrega.

entregaBairro
string | null

Bairro do endereço de entrega.

entregaCidade
string | null

Cidade do endereço de entrega.

entregaCodigoMunicipio
string | null

Código IBGE do município de entrega.

entregaUF
string | null

UF do endereço de entrega.

entregaCodigoDeRastreamento
string | null

Código de rastreamento da entrega.

gerarDuplicatasNaEmissao
boolean

Indica se duplicatas (parcelas de Contas a Receber) devem ser geradas automaticamente na emissão.

codigoDaCondicaoDePagamento
integer<int32>

Código da condição de pagamento aplicada à nota.

numeroDoPedidoDeCompra
string | null

Número do pedido de compra do cliente, referenciado na nota.

observacaoPagamento
string | null

Observação sobre a condição/forma de pagamento.

produtos
object[]

Itens de produto da nota fiscal.

servicos
object[]

Itens de serviço embutidos na nota fiscal, quando aplicável.

parcelas
object[]

Parcelas de recebimento da nota fiscal. Se não informadas, são geradas automaticamente conforme a condição de pagamento.

pagamentoCartaoTipoIntegracao
integer<int16> | null

Tipo de integração de pagamento por cartão, quando aplicável.

pagamentoCartaoCnpjCredenciadora
string | null

CNPJ da credenciadora de cartão.

pagamentoCartaoBandeiraOperadora
string | null

Bandeira da operadora de cartão.

pagamentoCartaoNumeroAutorizacao
string | null

Número de autorização da transação de cartão.

pagamentoCartaoCnpjBeneficiario
string | null

CNPJ do beneficiário do pagamento por cartão.

pagamentoCartaoIdTerminal
string | null

Id. do terminal (POS) utilizado na transação de cartão.

dadosAdicionais
string | null

Informações complementares de interesse do contribuinte, impressas no DANFE.

redeIdentificadorTID
string | null

Identificador da transação (TID) da Rede, para conciliação de pagamentos com cartão.

Response

Sucesso.

success
boolean
Example:

true

data
object

Nota Fiscal de Produto (NF-e). Campos obrigatórios: codigoDaFilial, codigoDaNotaFiscal, tipoDeOperacao (Entrada/Saída/Simples Remessa), naturezaDaOperacao, codigoDaFormaDePagamento (deve existir), codigoDoCliente (cliente válido), nomeDoCliente e cep. Os demais campos (contaCorrente, carteira, centroDeCusto, projeto, itemDeLancamento) são opcionais mas, se informados, devem referenciar cadastros válidos.