Nota Fiscal Entrada

notaFiscalEntrada

Obter Listagem de Notas Fiscais de Entrada

get

/notaFiscalEntrada

Autorizações

AuthorizationstringObrigatório

Parâmetros de consulta

continuationTokenstringOpcional

Identificador da Paginação da Consulta

situacaostringObrigatório

Identificador da Situação da Nota Fiscal

Parâmetros de cabeçalho

empresastringObrigatório

Código da Empresa

Respostas

200

application/json

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

get

/notaFiscalEntrada

GET /compras/v10/notaFiscalEntrada?situacao=text HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Accept: */*

{
  "continuationToken": "text",
  "data": [
    {
      "dataEntrada": "2025-11-29",
      "fornecedor": 1,
      "serie": "text",
      "numero": 1,
      "dataEmissao": "2025-11-29",
      "valorMercadoria": 1,
      "valorDespAcessorias": 1,
      "valorDespFinanceira": 1,
      "valorIPI": 1,
      "descontosBonificacao": 1,
      "valorTotal": 1,
      "naturezaOperacao": "text",
      "baseIcmsCredito": 1,
      "valorIcmsCredito": 1,
      "aliquotaIcmsCredito": 1,
      "valorIsentasIcms": 1,
      "valorOutrasIcms": 1,
      "baseIpiCredito": 1,
      "valIpiCredito": 1,
      "valorIsentasIPI": 1,
      "valorOutrasIPI": 1,
      "especieDocumento": 1,
      "situacao": 0,
      "basePisPasepCredito": 1,
      "valorPisPasepCredito": 1,
      "valorISS": 1,
      "valorINSS": 1,
      "dataHoraLancamento": "2025-11-29T00:38:09.584Z",
      "baseCofinsCredito": 1,
      "valorCofinsCredito": 1,
      "valorCsllRetencao": 1,
      "valorPisPasepRetencao": 1,
      "valorCofinsRetencao": 1,
      "valorSubstituicaoTribICMS": 1,
      "UFTransportador": "text",
      "placaVeiculo": "text",
      "qtdVolume": 1,
      "pesoBruto": 1,
      "pesoLiquido": 1,
      "tipoFrete": 1,
      "chaveNFe": "text",
      "valorIcmsOriginal": 1,
      "integradoServicoTerc": 0,
      "baseRetencaoISS": 1,
      "baseRetencaoIRRF": 1,
      "baseRetencaoINSS": 1,
      "baseRetencaoPIS": 1,
      "baseRetencaoCOFINS": 1,
      "baseRetencaoCSLL": 1,
      "indNaturezaFrete": 0,
      "valorSeguro": 1,
      "valorFreteDestacado": 1,
      "valorTotIcmsStInformado": 1,
      "baseICMSRetencao": 1,
      "valorICMSRetencao": 1,
      "inscricaoEstadual": "text",
      "codMunicipioOrigem": "text",
      "codMunicipioDestino": "text",
      "simplesFaturamento": 0,
      "entradaEntregaFutura": 0,
      "finalidadeDocumento": 1,
      "chaveNotaReferencia": "text",
      "modeloDocumento": "01",
      "valorDiferencaAliquota": 1,
      "baseDirfAliq": 1,
      "condPgto": "text",
      "valorCreditoPresumidoICMS": 1,
      "baseICMSSub": 1,
      "valorICMSSub": 1,
      "baseICMSSubSC": 1,
      "valorICMSSubSC": 1,
      "basePreICMS": 1,
      "totalValorSTCalculado": 1,
      "totalValorSTDiferenca": 1,
      "itensNotaFiscalEntrada": [
        {
          "codItem": 1,
          "codMaterial": "text",
          "quantidade": 1,
          "valorTotalItem": 1,
          "valorICMS": 1,
          "valorIPI": 1,
          "aliquotaICMS": 1,
          "naturezaOperacao": 1,
          "contaContabil": 1,
          "codClassifFiscal": "text",
          "valorReducaoICMS": 1,
          "valorReducaoIPI": 1,
          "codigoICMS": 1,
          "codigoIPI": 1,
          "centroCustoValor": "text",
          "valorFreteApropriado": 1,
          "valorICMSApropriado": 1,
          "valorBaseCalcPisPasep": 1,
          "valorPisPasepRec": 1,
          "quantidadeEstoque": 1,
          "codigoServico": 1,
          "tipoOperacao": 1,
          "baseCalculoICMS": 1,
          "baseCalculoCOFINS": 1,
          "valorCOFINS": 1,
          "valorPisPasepAprop": 1,
          "valorCofinsAprop": 1,
          "subTribICMS": 1,
          "baseICMSSub": 1,
          "valorICMSSub": 1,
          "sitICMSST": 0,
          "percPis": 1,
          "percCof": 1,
          "valorBaseIpiCredito": 1,
          "codSitTributariaICMS": 1,
          "valorIcmsOriginal": 1,
          "codSitTributariaPIS": "text",
          "codSitTributariaCOFINS": "text",
          "unidadeCompra": "text",
          "fatorConversao": "text",
          "fatorConversaoQuantidade": 1,
          "fatorConversaoOperador": 0,
          "codListaServicos": 1,
          "baseIpiCredito": 1,
          "percIPI": 1,
          "CSTIpi": "text",
          "tipoBaseCreditoPIS": "01",
          "tipoBaseCreditoCofins": "01",
          "valorSTInformado": 1,
          "valorSTCalculado": 1,
          "baseSTInformado": 1,
          "baseSTCalculado": 1,
          "valorDesconto": 1,
          "tipoCSTICMS": 0,
          "valorICMSPartOrigem": 1,
          "valorICMSPartDestino": 1,
          "valorICMSFCP": 1,
          "valorFCPICMS": 1,
          "valorFCPICMSST": 1,
          "custoEntrada": 1,
          "baseContabilizacao": 1,
          "descricaoItem": "text",
          "unidadeMedida": "text",
          "obsItemDespesa": "text",
          "credPresICMS": 1,
          "valorUniCCI": 1,
          "baseICMSTrib": 1,
          "baseICMSIsenta": 1,
          "baseICMSOutras": 1,
          "valorSTDiferenca": 1,
          "baseSTDiferenca": 1
        }
      ],
      "dadosDevolucao": [
        {
          "chaveNFeSaidaReferencia": "text"
        }
      ],
      "dadosCustomizados": [
        {
          "campo": "text",
          "valor": "text"
        }
      ]
    }
  ]
}

Cadastrar uma Nota Fiscal de Entrada

put

/notaFiscalEntrada

Autorizações

AuthorizationstringObrigatório

Parâmetros de cabeçalho

empresastringObrigatório

Código da Empresa

Corpo

dataEntradastring · dateObrigatório

Data de Entrada da Nota (YYYY-MM-DD)

fornecedorinteger · máx: 99999Obrigatório

Código do Fornecedor

seriestring · máx: 3Obrigatório

Código da Série Fiscal

numerointeger · máx: 9999999999Obrigatório

Código Numérico da Nota

dataEmissaostring · dateOpcional

Data da Emissão da Nota (YYYY-MM-DD)

valorMercadorianumberOpcional

Valor da Mercadoria

valorDespAcessoriasnumberOpcional

Valor das Despesas Acessórias

valorDespFinanceiranumberOpcional

Valor das Despesas Financeiras

valorIPInumberOpcional

Valor do IPI

descontosBonificacaonumberOpcional

Valor de Desconto de Bonificação

valorTotalnumberObrigatório

Valor Total da Nota

naturezaOperacaointeger · máx: 999999Obrigatório

Código da Natureza de Operação

baseIcmsCreditonumberOpcional

Base de ICMS de Crédito

valorIcmsCreditonumberOpcional

Valor de ICMS de Crédito

aliquotaIcmsCreditonumberOpcional

Aliquota de ICMS de Crédito

valorIsentasIcmsnumberOpcional

Valor de ICMS Isentas

valorOutrasIcmsnumberOpcional

Valor de ICMS Outras

baseIpiCreditonumberOpcional

Base de IPI de Crédito

valIpiCreditonumberOpcional

Valor de IPI de Crédito

valorIsentasIPInumberOpcional

Valor de IPI Isentas

valorOutrasIPInumberOpcional

Valor de IPI Outras

especieDocumentointeger · enumObrigatório

Espécie do Documento (1 - Nota Fiscal, 2 - Nota Fiscal com Conhecimento, 3 - Nota Fiscal de Devolução, 4 - Conhecimento, 5 - Fatura Energia Elétrica, 6 - Nota Serviço, 7 - Nota Fiscal Complementar, 8 - Nota Fiscal Retorno Industrialização, 10 - Nota Fiscal Retorno Industrialização com Conhecimento, 11 - Nota Fiscal com Serviço, 12 - Nota Fiscal com Serviço e Conhecimento, 13 - Nota Fiscal Retorno de Industrialização/Serviço, 14 - Nota Fiscal Retorno de Industrialização/Serviço/Conhecimento)

Valores possíveis:

situacaointeger · enumOpcional

Situação (0 - Normal, 1 - Uso futuro, 2 - Cancelada, 3 - Cancelada (Grãos))

Valores possíveis:

basePisPasepCreditonumberOpcional

Base de PIS/PASEP (Crédito)

valorPisPasepCreditonumberOpcional

Valor de PIS/PASEP (Crédito)

valorISSnumberOpcional

Valor de ISS

valorINSSnumberOpcional

Valor de INSS

dataHoraLancamentostring · date-timeOpcional

Data e Hora de Lançamento da Nota (YYYY-MM-DDTHH:mm:ss.sssZ)

baseCofinsCreditonumberOpcional

Base COFINS (Crédito)

valorCofinsCreditonumberOpcional

Valor do COFINS (Crédito)

valorCsllRetencaonumberOpcional

Valor CSLL - Retenção

valorPisPasepRetencaonumberOpcional

Valor PIS/PASEP (Retenção)

valorCofinsRetencaonumberOpcional

Valor COFINS (Retenção)

valorSubstituicaoTribICMSnumberOpcional

Valor Substituição Tributária ICMS a Recolher

UFTransportadorstring · máx: 2Opcional

UF do Transportador (NF-e)

placaVeiculostring · máx: 10Opcional

Placa do Veículo (NF-e)

qtdVolumenumberOpcional

Quantidade de Columes (NF-e)

pesoBrutonumberOpcional

Peso Bruto da Nota (NF-e)

pesoLiquidonumberOpcional

Peso Líquido da Nota (NF-e)

tipoFreteinteger · enumOpcional

Tipo de Frete (1 - Contratação do Frete por conta do Remetente (CIF), 2 - Contratação do Frete por conta do Destinatário (FOB), 3 - Contratação do Frete por conta de Terceiros, 4 - Transporte Próprio por conta do Remetente, 5 - Transporte Próprio por conta do Destinatário, 9 - Sem Ocorrência de Transporte)

Valores possíveis:

chaveNFestring · máx: 44Opcional

Chave de Acesso da NF-e

valorIcmsOriginalnumberOpcional

Valor do ICMS Original

integradoServicoTercinteger · enumOpcional

Integrado com Serviço Terceirizado? (0 - Não, 1 - Sim)

Valores possíveis:

baseRetencaoISSnumberOpcional

Base de Retenção ISS

baseRetencaoIRRFnumberOpcional

Base de Retenção IRRF

baseRetencaoINSSnumberOpcional

Base de Retenção INSS

baseRetencaoPISnumberOpcional

Base de Retenção PIS

baseRetencaoCOFINSnumberOpcional

Base de Retenção COFINS

baseRetencaoCSLLnumberOpcional

Base de Retenção CSLL

indNaturezaFreteinteger · enumOpcional

Indicador da Natureza de Frete (0 - Oper. vendas com ônus suportado vendedor, 1 - Oper. vendas com ônus suportado adquirente, 3 - Oper. compras com bens não geram crédito, 4 - Transf. acabados entre estabelecicmentos, 5 - Transf. elaboração entre estabelecimentos, 9 - Outras)

Valores possíveis:

valorSeguronumberOpcional

Valor de Seguro

valorFreteDestacadonumberOpcional

Valor do Frete Destacado

valorTotIcmsStInformadonumberOpcional

Valor total do ICMS-ST informado (Original)

baseICMSRetencaonumberOpcional

Base de ICMS Retenção

valorICMSRetencaonumberOpcional

Valor de ICMS Retenção

inscricaoEstadualstring · máx: 17Opcional

Inscrição Estadual

codMunicipioOrigemstring · mín: 7 · máx: 7Opcional

Código do Município Origem

codMunicipioDestinostring · mín: 7 · máx: 7Opcional

Código do Município Destino

simplesFaturamentointeger · enumObrigatório

Nota Fiscal de Simples Faturamento Para Entrega Futura (0 - Não, 1 - Sim)

Valores possíveis:

entradaEntregaFuturainteger · enumOpcional

Nota Fiscal de Remessa da Entrega Futura (0 - Não, 1 - Sim)

Valores possíveis:

finalidadeDocumentointeger · enumOpcional

Finalidade Documento (1 - Normal, 2 - Substituição, 3 - Normal com Ajuste)

Valores possíveis:

chaveNotaReferenciastring · mín: 44 · máx: 44Opcional

Chave da Nota Referenciada

modeloDocumentostring · enumObrigatório

Modelo do Documento (01 - Nota Fiscal, 06 - Energia Elétrica, 08 - Conhecimento Transporte, 22 - Telecomunicações, 10 - Frete Aereo, 55 - Nota Fiscal Eletrônica, 57 - Conhecimento Transporte Eletrônico)

Valores possíveis:

valorDiferencaAliquotanumberOpcional

Valor da Diferença da Alíquota

baseDirfAliqnumberOpcional

Base da Diferença da Alíquota

condPgtostringOpcional

Condições de Pagamento

valorCreditoPresumidoICMSnumberOpcional

Valor Crédito Presumido ICMS

baseICMSSubnumberOpcional

Base ICMS Substituição Tributária

valorICMSSubnumberOpcional

Valor ICMS Substituição Tributária

baseICMSSubSCnumberOpcional

Base ICMS Substituição Tributária com Crédito

valorICMSSubSCnumberOpcional

Valor ICMS Substituição Tributária com Crédito

basePreICMSnumberOpcional

Base de Cálculo de Crédito Presumido ICMS

totalValorSTCalculadonumberOpcional

Valor Total do ICMS-ST Calculado

totalValorSTDiferencanumberOpcional

Valor Total de ICMS-ST Corrigido pelo Sistema (Diferença)

Respostas

200

application/json

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

put

/notaFiscalEntrada

PUT /compras/v10/notaFiscalEntrada HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Content-Type: application/json
Accept: */*
Content-Length: 3157

{
  "dataEntrada": "2025-11-29",
  "fornecedor": 1,
  "serie": "text",
  "numero": 1,
  "dataEmissao": "2025-11-29",
  "valorMercadoria": 1,
  "valorDespAcessorias": 1,
  "valorDespFinanceira": 1,
  "valorIPI": 1,
  "descontosBonificacao": 1,
  "valorTotal": 1,
  "naturezaOperacao": 1,
  "baseIcmsCredito": 1,
  "valorIcmsCredito": 1,
  "aliquotaIcmsCredito": 1,
  "valorIsentasIcms": 1,
  "valorOutrasIcms": 1,
  "baseIpiCredito": 1,
  "valIpiCredito": 1,
  "valorIsentasIPI": 1,
  "valorOutrasIPI": 1,
  "especieDocumento": 1,
  "situacao": 0,
  "basePisPasepCredito": 1,
  "valorPisPasepCredito": 1,
  "valorISS": 1,
  "valorINSS": 1,
  "dataHoraLancamento": "2025-11-29T00:38:09.584Z",
  "baseCofinsCredito": 1,
  "valorCofinsCredito": 1,
  "valorCsllRetencao": 1,
  "valorPisPasepRetencao": 1,
  "valorCofinsRetencao": 1,
  "valorSubstituicaoTribICMS": 1,
  "UFTransportador": "text",
  "placaVeiculo": "text",
  "qtdVolume": 1,
  "pesoBruto": 1,
  "pesoLiquido": 1,
  "tipoFrete": 1,
  "chaveNFe": "text",
  "valorIcmsOriginal": 1,
  "integradoServicoTerc": 0,
  "baseRetencaoISS": 1,
  "baseRetencaoIRRF": 1,
  "baseRetencaoINSS": 1,
  "baseRetencaoPIS": 1,
  "baseRetencaoCOFINS": 1,
  "baseRetencaoCSLL": 1,
  "indNaturezaFrete": 0,
  "valorSeguro": 1,
  "valorFreteDestacado": 1,
  "valorTotIcmsStInformado": 1,
  "baseICMSRetencao": 1,
  "valorICMSRetencao": 1,
  "inscricaoEstadual": "text",
  "codMunicipioOrigem": "text",
  "codMunicipioDestino": "text",
  "simplesFaturamento": 0,
  "entradaEntregaFutura": 0,
  "finalidadeDocumento": 1,
  "chaveNotaReferencia": "text",
  "modeloDocumento": "01",
  "valorDiferencaAliquota": 1,
  "baseDirfAliq": 1,
  "condPgto": "text",
  "valorCreditoPresumidoICMS": 1,
  "baseICMSSub": 1,
  "valorICMSSub": 1,
  "baseICMSSubSC": 1,
  "valorICMSSubSC": 1,
  "basePreICMS": 1,
  "totalValorSTCalculado": 1,
  "totalValorSTDiferenca": 1,
  "itensNotaFiscalEntrada": [
    {
      "codItem": 1,
      "codMaterial": "text",
      "quantidade": 1,
      "valorTotalItem": 1,
      "valorICMS": 1,
      "valorIPI": 1,
      "aliquotaICMS": 1,
      "naturezaOperacao": 1,
      "contaContabil": 1,
      "codClassifFiscal": "text",
      "valorReducaoICMS": 1,
      "valorReducaoIPI": 1,
      "codigoICMS": 1,
      "codigoIPI": 1,
      "centroCustoValor": "text",
      "valorFreteApropriado": 1,
      "valorICMSApropriado": 1,
      "valorBaseCalcPisPasep": 1,
      "valorPisPasepRec": 1,
      "quantidadeEstoque": 1,
      "codigoServico": 1,
      "tipoOperacao": 1,
      "baseCalculoICMS": 1,
      "baseCalculoCOFINS": 1,
      "valorCOFINS": 1,
      "valorPisPasepAprop": 1,
      "valorCofinsAprop": 1,
      "subTribICMS": 1,
      "baseICMSSub": 1,
      "valorICMSSub": 1,
      "sitICMSST": 0,
      "percPis": 1,
      "percCof": 1,
      "valorBaseIpiCredito": 1,
      "codSitTributariaICMS": 1,
      "valorIcmsOriginal": 1,
      "codSitTributariaPIS": "text",
      "codSitTributariaCOFINS": "text",
      "unidadeCompra": "text",
      "fatorConversao": "text",
      "fatorConversaoQuantidade": 1,
      "fatorConversaoOperador": 0,
      "codListaServicos": 1,
      "baseIpiCredito": 1,
      "percIPI": 1,
      "CSTIpi": "text",
      "tipoBaseCreditoPIS": "01",
      "tipoBaseCreditoCofins": "01",
      "valorSTInformado": 1,
      "valorSTCalculado": 1,
      "baseSTInformado": 1,
      "baseSTCalculado": 1,
      "valorDesconto": 1,
      "tipoCSTICMS": 0,
      "valorICMSPartOrigem": 1,
      "valorICMSPartDestino": 1,
      "valorICMSFCP": 1,
      "valorFCPICMS": 1,
      "valorFCPICMSST": 1,
      "custoEntrada": 1,
      "baseContabilizacao": 1,
      "descricaoItem": "text",
      "unidadeMedida": "text",
      "obsItemDespesa": "text",
      "credPresICMS": 1,
      "valorUniCCI": 1,
      "baseICMSTrib": 1,
      "baseICMSIsenta": 1,
      "baseICMSOutras": 1,
      "valorSTDiferenca": 1,
      "baseSTDiferenca": 1
    }
  ],
  "dadosDevolucao": [
    {
      "chaveNFeSaidaReferencia": "text"
    }
  ],
  "dadosCustomizados": [
    {
      "campo": "text",
      "valor": "text"
    }
  ]
}

{
  "dataEntrada": "2025-11-29",
  "fornecedor": 1,
  "serie": "text",
  "numero": 1,
  "dataEmissao": "2025-11-29",
  "valorMercadoria": 1,
  "valorDespAcessorias": 1,
  "valorDespFinanceira": 1,
  "valorIPI": 1,
  "descontosBonificacao": 1,
  "valorTotal": 1,
  "naturezaOperacao": "text",
  "baseIcmsCredito": 1,
  "valorIcmsCredito": 1,
  "aliquotaIcmsCredito": 1,
  "valorIsentasIcms": 1,
  "valorOutrasIcms": 1,
  "baseIpiCredito": 1,
  "valIpiCredito": 1,
  "valorIsentasIPI": 1,
  "valorOutrasIPI": 1,
  "especieDocumento": 1,
  "situacao": 0,
  "basePisPasepCredito": 1,
  "valorPisPasepCredito": 1,
  "valorISS": 1,
  "valorINSS": 1,
  "dataHoraLancamento": "2025-11-29T00:38:09.584Z",
  "baseCofinsCredito": 1,
  "valorCofinsCredito": 1,
  "valorCsllRetencao": 1,
  "valorPisPasepRetencao": 1,
  "valorCofinsRetencao": 1,
  "valorSubstituicaoTribICMS": 1,
  "UFTransportador": "text",
  "placaVeiculo": "text",
  "qtdVolume": 1,
  "pesoBruto": 1,
  "pesoLiquido": 1,
  "tipoFrete": 1,
  "chaveNFe": "text",
  "valorIcmsOriginal": 1,
  "integradoServicoTerc": 0,
  "baseRetencaoISS": 1,
  "baseRetencaoIRRF": 1,
  "baseRetencaoINSS": 1,
  "baseRetencaoPIS": 1,
  "baseRetencaoCOFINS": 1,
  "baseRetencaoCSLL": 1,
  "indNaturezaFrete": 0,
  "valorSeguro": 1,
  "valorFreteDestacado": 1,
  "valorTotIcmsStInformado": 1,
  "baseICMSRetencao": 1,
  "valorICMSRetencao": 1,
  "inscricaoEstadual": "text",
  "codMunicipioOrigem": "text",
  "codMunicipioDestino": "text",
  "simplesFaturamento": 0,
  "entradaEntregaFutura": 0,
  "finalidadeDocumento": 1,
  "chaveNotaReferencia": "text",
  "modeloDocumento": "01",
  "valorDiferencaAliquota": 1,
  "baseDirfAliq": 1,
  "condPgto": "text",
  "valorCreditoPresumidoICMS": 1,
  "baseICMSSub": 1,
  "valorICMSSub": 1,
  "baseICMSSubSC": 1,
  "valorICMSSubSC": 1,
  "basePreICMS": 1,
  "totalValorSTCalculado": 1,
  "totalValorSTDiferenca": 1,
  "itensNotaFiscalEntrada": [
    {
      "codItem": 1,
      "codMaterial": "text",
      "quantidade": 1,
      "valorTotalItem": 1,
      "valorICMS": 1,
      "valorIPI": 1,
      "aliquotaICMS": 1,
      "naturezaOperacao": 1,
      "contaContabil": 1,
      "codClassifFiscal": "text",
      "valorReducaoICMS": 1,
      "valorReducaoIPI": 1,
      "codigoICMS": 1,
      "codigoIPI": 1,
      "centroCustoValor": "text",
      "valorFreteApropriado": 1,
      "valorICMSApropriado": 1,
      "valorBaseCalcPisPasep": 1,
      "valorPisPasepRec": 1,
      "quantidadeEstoque": 1,
      "codigoServico": 1,
      "tipoOperacao": 1,
      "baseCalculoICMS": 1,
      "baseCalculoCOFINS": 1,
      "valorCOFINS": 1,
      "valorPisPasepAprop": 1,
      "valorCofinsAprop": 1,
      "subTribICMS": 1,
      "baseICMSSub": 1,
      "valorICMSSub": 1,
      "sitICMSST": 0,
      "percPis": 1,
      "percCof": 1,
      "valorBaseIpiCredito": 1,
      "codSitTributariaICMS": 1,
      "valorIcmsOriginal": 1,
      "codSitTributariaPIS": "text",
      "codSitTributariaCOFINS": "text",
      "unidadeCompra": "text",
      "fatorConversao": "text",
      "fatorConversaoQuantidade": 1,
      "fatorConversaoOperador": 0,
      "codListaServicos": 1,
      "baseIpiCredito": 1,
      "percIPI": 1,
      "CSTIpi": "text",
      "tipoBaseCreditoPIS": "01",
      "tipoBaseCreditoCofins": "01",
      "valorSTInformado": 1,
      "valorSTCalculado": 1,
      "baseSTInformado": 1,
      "baseSTCalculado": 1,
      "valorDesconto": 1,
      "tipoCSTICMS": 0,
      "valorICMSPartOrigem": 1,
      "valorICMSPartDestino": 1,
      "valorICMSFCP": 1,
      "valorFCPICMS": 1,
      "valorFCPICMSST": 1,
      "custoEntrada": 1,
      "baseContabilizacao": 1,
      "descricaoItem": "text",
      "unidadeMedida": "text",
      "obsItemDespesa": "text",
      "credPresICMS": 1,
      "valorUniCCI": 1,
      "baseICMSTrib": 1,
      "baseICMSIsenta": 1,
      "baseICMSOutras": 1,
      "valorSTDiferenca": 1,
      "baseSTDiferenca": 1
    }
  ],
  "dadosDevolucao": [
    {
      "chaveNFeSaidaReferencia": "text"
    }
  ],
  "dadosCustomizados": [
    {
      "campo": "text",
      "valor": "text"
    }
  ]
}

Obter uma Nota Fiscal de Entrada

get

/notaFiscalEntrada/{id}

Autorizações

AuthorizationstringObrigatório

Parâmetros de rota

idstringObrigatório

Chave da Nota Fiscal de Entrada

Parâmetros de cabeçalho

empresastringObrigatório

Código da Empresa

Respostas

200

application/json

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

get

/notaFiscalEntrada/{id}

GET /compras/v10/notaFiscalEntrada/{id} HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Accept: */*

[
  {
    "dataEntrada": "2025-11-29",
    "fornecedor": 1,
    "serie": "text",
    "numero": 1,
    "dataEmissao": "2025-11-29",
    "valorMercadoria": 1,
    "valorDespAcessorias": 1,
    "valorDespFinanceira": 1,
    "valorIPI": 1,
    "descontosBonificacao": 1,
    "valorTotal": 1,
    "naturezaOperacao": "text",
    "baseIcmsCredito": 1,
    "valorIcmsCredito": 1,
    "aliquotaIcmsCredito": 1,
    "valorIsentasIcms": 1,
    "valorOutrasIcms": 1,
    "baseIpiCredito": 1,
    "valIpiCredito": 1,
    "valorIsentasIPI": 1,
    "valorOutrasIPI": 1,
    "especieDocumento": 1,
    "situacao": 0,
    "basePisPasepCredito": 1,
    "valorPisPasepCredito": 1,
    "valorISS": 1,
    "valorINSS": 1,
    "dataHoraLancamento": "2025-11-29T00:38:09.584Z",
    "baseCofinsCredito": 1,
    "valorCofinsCredito": 1,
    "valorCsllRetencao": 1,
    "valorPisPasepRetencao": 1,
    "valorCofinsRetencao": 1,
    "valorSubstituicaoTribICMS": 1,
    "UFTransportador": "text",
    "placaVeiculo": "text",
    "qtdVolume": 1,
    "pesoBruto": 1,
    "pesoLiquido": 1,
    "tipoFrete": 1,
    "chaveNFe": "text",
    "valorIcmsOriginal": 1,
    "integradoServicoTerc": 0,
    "baseRetencaoISS": 1,
    "baseRetencaoIRRF": 1,
    "baseRetencaoINSS": 1,
    "baseRetencaoPIS": 1,
    "baseRetencaoCOFINS": 1,
    "baseRetencaoCSLL": 1,
    "indNaturezaFrete": 0,
    "valorSeguro": 1,
    "valorFreteDestacado": 1,
    "valorTotIcmsStInformado": 1,
    "baseICMSRetencao": 1,
    "valorICMSRetencao": 1,
    "inscricaoEstadual": "text",
    "codMunicipioOrigem": "text",
    "codMunicipioDestino": "text",
    "simplesFaturamento": 0,
    "entradaEntregaFutura": 0,
    "finalidadeDocumento": 1,
    "chaveNotaReferencia": "text",
    "modeloDocumento": "01",
    "valorDiferencaAliquota": 1,
    "baseDirfAliq": 1,
    "condPgto": "text",
    "valorCreditoPresumidoICMS": 1,
    "baseICMSSub": 1,
    "valorICMSSub": 1,
    "baseICMSSubSC": 1,
    "valorICMSSubSC": 1,
    "basePreICMS": 1,
    "totalValorSTCalculado": 1,
    "totalValorSTDiferenca": 1,
    "itensNotaFiscalEntrada": [
      {
        "codItem": 1,
        "codMaterial": "text",
        "quantidade": 1,
        "valorTotalItem": 1,
        "valorICMS": 1,
        "valorIPI": 1,
        "aliquotaICMS": 1,
        "naturezaOperacao": 1,
        "contaContabil": 1,
        "codClassifFiscal": "text",
        "valorReducaoICMS": 1,
        "valorReducaoIPI": 1,
        "codigoICMS": 1,
        "codigoIPI": 1,
        "centroCustoValor": "text",
        "valorFreteApropriado": 1,
        "valorICMSApropriado": 1,
        "valorBaseCalcPisPasep": 1,
        "valorPisPasepRec": 1,
        "quantidadeEstoque": 1,
        "codigoServico": 1,
        "tipoOperacao": 1,
        "baseCalculoICMS": 1,
        "baseCalculoCOFINS": 1,
        "valorCOFINS": 1,
        "valorPisPasepAprop": 1,
        "valorCofinsAprop": 1,
        "subTribICMS": 1,
        "baseICMSSub": 1,
        "valorICMSSub": 1,
        "sitICMSST": 0,
        "percPis": 1,
        "percCof": 1,
        "valorBaseIpiCredito": 1,
        "codSitTributariaICMS": 1,
        "valorIcmsOriginal": 1,
        "codSitTributariaPIS": "text",
        "codSitTributariaCOFINS": "text",
        "unidadeCompra": "text",
        "fatorConversao": "text",
        "fatorConversaoQuantidade": 1,
        "fatorConversaoOperador": 0,
        "codListaServicos": 1,
        "baseIpiCredito": 1,
        "percIPI": 1,
        "CSTIpi": "text",
        "tipoBaseCreditoPIS": "01",
        "tipoBaseCreditoCofins": "01",
        "valorSTInformado": 1,
        "valorSTCalculado": 1,
        "baseSTInformado": 1,
        "baseSTCalculado": 1,
        "valorDesconto": 1,
        "tipoCSTICMS": 0,
        "valorICMSPartOrigem": 1,
        "valorICMSPartDestino": 1,
        "valorICMSFCP": 1,
        "valorFCPICMS": 1,
        "valorFCPICMSST": 1,
        "custoEntrada": 1,
        "baseContabilizacao": 1,
        "descricaoItem": "text",
        "unidadeMedida": "text",
        "obsItemDespesa": "text",
        "credPresICMS": 1,
        "valorUniCCI": 1,
        "baseICMSTrib": 1,
        "baseICMSIsenta": 1,
        "baseICMSOutras": 1,
        "valorSTDiferenca": 1,
        "baseSTDiferenca": 1
      }
    ],
    "dadosDevolucao": [
      {
        "chaveNFeSaidaReferencia": "text"
      }
    ],
    "dadosCustomizados": [
      {
        "campo": "text",
        "valor": "text"
      }
    ]
  }
]

Atualizar uma Nota Fiscal de Entrada

put

/notaFiscalEntrada/{id}

Autorizações

AuthorizationstringObrigatório

Parâmetros de rota

idstringObrigatório

Chave da Nota Fiscal de Entrada

Parâmetros de cabeçalho

empresastringObrigatório

Código da Empresa

Corpo

dataEntradastring · dateObrigatório

Data de Entrada da Nota (YYYY-MM-DD)

fornecedorinteger · máx: 99999Obrigatório

Código do Fornecedor

seriestring · máx: 3Obrigatório

Código da Série Fiscal

numerointeger · máx: 9999999999Obrigatório

Código Numérico da Nota

dataEmissaostring · dateOpcional

Data da Emissão da Nota (YYYY-MM-DD)

valorMercadorianumberOpcional

Valor da Mercadoria

valorDespAcessoriasnumberOpcional

Valor das Despesas Acessórias

valorDespFinanceiranumberOpcional

Valor das Despesas Financeiras

valorIPInumberOpcional

Valor do IPI

descontosBonificacaonumberOpcional

Valor de Desconto de Bonificação

valorTotalnumberObrigatório

Valor Total da Nota

naturezaOperacaointeger · máx: 999999Obrigatório

Código da Natureza de Operação

baseIcmsCreditonumberOpcional

Base de ICMS de Crédito

valorIcmsCreditonumberOpcional

Valor de ICMS de Crédito

aliquotaIcmsCreditonumberOpcional

Aliquota de ICMS de Crédito

valorIsentasIcmsnumberOpcional

Valor de ICMS Isentas

valorOutrasIcmsnumberOpcional

Valor de ICMS Outras

baseIpiCreditonumberOpcional

Base de IPI de Crédito

valIpiCreditonumberOpcional

Valor de IPI de Crédito

valorIsentasIPInumberOpcional

Valor de IPI Isentas

valorOutrasIPInumberOpcional

Valor de IPI Outras

especieDocumentointeger · enumObrigatório

Valores possíveis:

situacaointeger · enumOpcional

Situação (0 - Normal, 1 - Uso futuro, 2 - Cancelada, 3 - Cancelada (Grãos))

Valores possíveis:

basePisPasepCreditonumberOpcional

Base de PIS/PASEP (Crédito)

valorPisPasepCreditonumberOpcional

Valor de PIS/PASEP (Crédito)

valorISSnumberOpcional

Valor de ISS

valorINSSnumberOpcional

Valor de INSS

dataHoraLancamentostring · date-timeOpcional

Data e Hora de Lançamento da Nota (YYYY-MM-DDTHH:mm:ss.sssZ)

baseCofinsCreditonumberOpcional

Base COFINS (Crédito)

valorCofinsCreditonumberOpcional

Valor do COFINS (Crédito)

valorCsllRetencaonumberOpcional

Valor CSLL - Retenção

valorPisPasepRetencaonumberOpcional

Valor PIS/PASEP (Retenção)

valorCofinsRetencaonumberOpcional

Valor COFINS (Retenção)

valorSubstituicaoTribICMSnumberOpcional

Valor Substituição Tributária ICMS a Recolher

UFTransportadorstring · máx: 2Opcional

UF do Transportador (NF-e)

placaVeiculostring · máx: 10Opcional

Placa do Veículo (NF-e)

qtdVolumenumberOpcional

Quantidade de Columes (NF-e)

pesoBrutonumberOpcional

Peso Bruto da Nota (NF-e)

pesoLiquidonumberOpcional

Peso Líquido da Nota (NF-e)

tipoFreteinteger · enumOpcional

Valores possíveis:

chaveNFestring · máx: 44Opcional

Chave de Acesso da NF-e

valorIcmsOriginalnumberOpcional

Valor do ICMS Original

integradoServicoTercinteger · enumOpcional

Integrado com Serviço Terceirizado? (0 - Não, 1 - Sim)

Valores possíveis:

baseRetencaoISSnumberOpcional

Base de Retenção ISS

baseRetencaoIRRFnumberOpcional

Base de Retenção IRRF

baseRetencaoINSSnumberOpcional

Base de Retenção INSS

baseRetencaoPISnumberOpcional

Base de Retenção PIS

baseRetencaoCOFINSnumberOpcional

Base de Retenção COFINS

baseRetencaoCSLLnumberOpcional

Base de Retenção CSLL

indNaturezaFreteinteger · enumOpcional

Valores possíveis:

valorSeguronumberOpcional

Valor de Seguro

valorFreteDestacadonumberOpcional

Valor do Frete Destacado

valorTotIcmsStInformadonumberOpcional

Valor total do ICMS-ST informado (Original)

baseICMSRetencaonumberOpcional

Base de ICMS Retenção

valorICMSRetencaonumberOpcional

Valor de ICMS Retenção

inscricaoEstadualstring · máx: 17Opcional

Inscrição Estadual

codMunicipioOrigemstring · mín: 7 · máx: 7Opcional

Código do Município Origem

codMunicipioDestinostring · mín: 7 · máx: 7Opcional

Código do Município Destino

simplesFaturamentointeger · enumObrigatório

Nota Fiscal de Simples Faturamento Para Entrega Futura (0 - Não, 1 - Sim)

Valores possíveis:

entradaEntregaFuturainteger · enumOpcional

Nota Fiscal de Remessa da Entrega Futura (0 - Não, 1 - Sim)

Valores possíveis:

finalidadeDocumentointeger · enumOpcional

Finalidade Documento (1 - Normal, 2 - Substituição, 3 - Normal com Ajuste)

Valores possíveis:

chaveNotaReferenciastring · mín: 44 · máx: 44Opcional

Chave da Nota Referenciada

modeloDocumentostring · enumObrigatório

Valores possíveis:

valorDiferencaAliquotanumberOpcional

Valor da Diferença da Alíquota

baseDirfAliqnumberOpcional

Base da Diferença da Alíquota

condPgtostringOpcional

Condições de Pagamento

valorCreditoPresumidoICMSnumberOpcional

Valor Crédito Presumido ICMS

baseICMSSubnumberOpcional

Base ICMS Substituição Tributária

valorICMSSubnumberOpcional

Valor ICMS Substituição Tributária

baseICMSSubSCnumberOpcional

Base ICMS Substituição Tributária com Crédito

valorICMSSubSCnumberOpcional

Valor ICMS Substituição Tributária com Crédito

basePreICMSnumberOpcional

Base de Cálculo de Crédito Presumido ICMS

totalValorSTCalculadonumberOpcional

Valor Total do ICMS-ST Calculado

totalValorSTDiferencanumberOpcional

Valor Total de ICMS-ST Corrigido pelo Sistema (Diferença)

Respostas

200

application/json

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

put

/notaFiscalEntrada/{id}

PUT /compras/v10/notaFiscalEntrada/{id} HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Content-Type: application/json
Accept: */*
Content-Length: 3157

{
  "dataEntrada": "2025-11-29",
  "fornecedor": 1,
  "serie": "text",
  "numero": 1,
  "dataEmissao": "2025-11-29",
  "valorMercadoria": 1,
  "valorDespAcessorias": 1,
  "valorDespFinanceira": 1,
  "valorIPI": 1,
  "descontosBonificacao": 1,
  "valorTotal": 1,
  "naturezaOperacao": 1,
  "baseIcmsCredito": 1,
  "valorIcmsCredito": 1,
  "aliquotaIcmsCredito": 1,
  "valorIsentasIcms": 1,
  "valorOutrasIcms": 1,
  "baseIpiCredito": 1,
  "valIpiCredito": 1,
  "valorIsentasIPI": 1,
  "valorOutrasIPI": 1,
  "especieDocumento": 1,
  "situacao": 0,
  "basePisPasepCredito": 1,
  "valorPisPasepCredito": 1,
  "valorISS": 1,
  "valorINSS": 1,
  "dataHoraLancamento": "2025-11-29T00:38:09.584Z",
  "baseCofinsCredito": 1,
  "valorCofinsCredito": 1,
  "valorCsllRetencao": 1,
  "valorPisPasepRetencao": 1,
  "valorCofinsRetencao": 1,
  "valorSubstituicaoTribICMS": 1,
  "UFTransportador": "text",
  "placaVeiculo": "text",
  "qtdVolume": 1,
  "pesoBruto": 1,
  "pesoLiquido": 1,
  "tipoFrete": 1,
  "chaveNFe": "text",
  "valorIcmsOriginal": 1,
  "integradoServicoTerc": 0,
  "baseRetencaoISS": 1,
  "baseRetencaoIRRF": 1,
  "baseRetencaoINSS": 1,
  "baseRetencaoPIS": 1,
  "baseRetencaoCOFINS": 1,
  "baseRetencaoCSLL": 1,
  "indNaturezaFrete": 0,
  "valorSeguro": 1,
  "valorFreteDestacado": 1,
  "valorTotIcmsStInformado": 1,
  "baseICMSRetencao": 1,
  "valorICMSRetencao": 1,
  "inscricaoEstadual": "text",
  "codMunicipioOrigem": "text",
  "codMunicipioDestino": "text",
  "simplesFaturamento": 0,
  "entradaEntregaFutura": 0,
  "finalidadeDocumento": 1,
  "chaveNotaReferencia": "text",
  "modeloDocumento": "01",
  "valorDiferencaAliquota": 1,
  "baseDirfAliq": 1,
  "condPgto": "text",
  "valorCreditoPresumidoICMS": 1,
  "baseICMSSub": 1,
  "valorICMSSub": 1,
  "baseICMSSubSC": 1,
  "valorICMSSubSC": 1,
  "basePreICMS": 1,
  "totalValorSTCalculado": 1,
  "totalValorSTDiferenca": 1,
  "itensNotaFiscalEntrada": [
    {
      "codItem": 1,
      "codMaterial": "text",
      "quantidade": 1,
      "valorTotalItem": 1,
      "valorICMS": 1,
      "valorIPI": 1,
      "aliquotaICMS": 1,
      "naturezaOperacao": 1,
      "contaContabil": 1,
      "codClassifFiscal": "text",
      "valorReducaoICMS": 1,
      "valorReducaoIPI": 1,
      "codigoICMS": 1,
      "codigoIPI": 1,
      "centroCustoValor": "text",
      "valorFreteApropriado": 1,
      "valorICMSApropriado": 1,
      "valorBaseCalcPisPasep": 1,
      "valorPisPasepRec": 1,
      "quantidadeEstoque": 1,
      "codigoServico": 1,
      "tipoOperacao": 1,
      "baseCalculoICMS": 1,
      "baseCalculoCOFINS": 1,
      "valorCOFINS": 1,
      "valorPisPasepAprop": 1,
      "valorCofinsAprop": 1,
      "subTribICMS": 1,
      "baseICMSSub": 1,
      "valorICMSSub": 1,
      "sitICMSST": 0,
      "percPis": 1,
      "percCof": 1,
      "valorBaseIpiCredito": 1,
      "codSitTributariaICMS": 1,
      "valorIcmsOriginal": 1,
      "codSitTributariaPIS": "text",
      "codSitTributariaCOFINS": "text",
      "unidadeCompra": "text",
      "fatorConversao": "text",
      "fatorConversaoQuantidade": 1,
      "fatorConversaoOperador": 0,
      "codListaServicos": 1,
      "baseIpiCredito": 1,
      "percIPI": 1,
      "CSTIpi": "text",
      "tipoBaseCreditoPIS": "01",
      "tipoBaseCreditoCofins": "01",
      "valorSTInformado": 1,
      "valorSTCalculado": 1,
      "baseSTInformado": 1,
      "baseSTCalculado": 1,
      "valorDesconto": 1,
      "tipoCSTICMS": 0,
      "valorICMSPartOrigem": 1,
      "valorICMSPartDestino": 1,
      "valorICMSFCP": 1,
      "valorFCPICMS": 1,
      "valorFCPICMSST": 1,
      "custoEntrada": 1,
      "baseContabilizacao": 1,
      "descricaoItem": "text",
      "unidadeMedida": "text",
      "obsItemDespesa": "text",
      "credPresICMS": 1,
      "valorUniCCI": 1,
      "baseICMSTrib": 1,
      "baseICMSIsenta": 1,
      "baseICMSOutras": 1,
      "valorSTDiferenca": 1,
      "baseSTDiferenca": 1
    }
  ],
  "dadosDevolucao": [
    {
      "chaveNFeSaidaReferencia": "text"
    }
  ],
  "dadosCustomizados": [
    {
      "campo": "text",
      "valor": "text"
    }
  ]
}

{
  "dataEntrada": "2025-11-29",
  "fornecedor": 1,
  "serie": "text",
  "numero": 1,
  "dataEmissao": "2025-11-29",
  "valorMercadoria": 1,
  "valorDespAcessorias": 1,
  "valorDespFinanceira": 1,
  "valorIPI": 1,
  "descontosBonificacao": 1,
  "valorTotal": 1,
  "naturezaOperacao": "text",
  "baseIcmsCredito": 1,
  "valorIcmsCredito": 1,
  "aliquotaIcmsCredito": 1,
  "valorIsentasIcms": 1,
  "valorOutrasIcms": 1,
  "baseIpiCredito": 1,
  "valIpiCredito": 1,
  "valorIsentasIPI": 1,
  "valorOutrasIPI": 1,
  "especieDocumento": 1,
  "situacao": 0,
  "basePisPasepCredito": 1,
  "valorPisPasepCredito": 1,
  "valorISS": 1,
  "valorINSS": 1,
  "dataHoraLancamento": "2025-11-29T00:38:09.584Z",
  "baseCofinsCredito": 1,
  "valorCofinsCredito": 1,
  "valorCsllRetencao": 1,
  "valorPisPasepRetencao": 1,
  "valorCofinsRetencao": 1,
  "valorSubstituicaoTribICMS": 1,
  "UFTransportador": "text",
  "placaVeiculo": "text",
  "qtdVolume": 1,
  "pesoBruto": 1,
  "pesoLiquido": 1,
  "tipoFrete": 1,
  "chaveNFe": "text",
  "valorIcmsOriginal": 1,
  "integradoServicoTerc": 0,
  "baseRetencaoISS": 1,
  "baseRetencaoIRRF": 1,
  "baseRetencaoINSS": 1,
  "baseRetencaoPIS": 1,
  "baseRetencaoCOFINS": 1,
  "baseRetencaoCSLL": 1,
  "indNaturezaFrete": 0,
  "valorSeguro": 1,
  "valorFreteDestacado": 1,
  "valorTotIcmsStInformado": 1,
  "baseICMSRetencao": 1,
  "valorICMSRetencao": 1,
  "inscricaoEstadual": "text",
  "codMunicipioOrigem": "text",
  "codMunicipioDestino": "text",
  "simplesFaturamento": 0,
  "entradaEntregaFutura": 0,
  "finalidadeDocumento": 1,
  "chaveNotaReferencia": "text",
  "modeloDocumento": "01",
  "valorDiferencaAliquota": 1,
  "baseDirfAliq": 1,
  "condPgto": "text",
  "valorCreditoPresumidoICMS": 1,
  "baseICMSSub": 1,
  "valorICMSSub": 1,
  "baseICMSSubSC": 1,
  "valorICMSSubSC": 1,
  "basePreICMS": 1,
  "totalValorSTCalculado": 1,
  "totalValorSTDiferenca": 1,
  "itensNotaFiscalEntrada": [
    {
      "codItem": 1,
      "codMaterial": "text",
      "quantidade": 1,
      "valorTotalItem": 1,
      "valorICMS": 1,
      "valorIPI": 1,
      "aliquotaICMS": 1,
      "naturezaOperacao": 1,
      "contaContabil": 1,
      "codClassifFiscal": "text",
      "valorReducaoICMS": 1,
      "valorReducaoIPI": 1,
      "codigoICMS": 1,
      "codigoIPI": 1,
      "centroCustoValor": "text",
      "valorFreteApropriado": 1,
      "valorICMSApropriado": 1,
      "valorBaseCalcPisPasep": 1,
      "valorPisPasepRec": 1,
      "quantidadeEstoque": 1,
      "codigoServico": 1,
      "tipoOperacao": 1,
      "baseCalculoICMS": 1,
      "baseCalculoCOFINS": 1,
      "valorCOFINS": 1,
      "valorPisPasepAprop": 1,
      "valorCofinsAprop": 1,
      "subTribICMS": 1,
      "baseICMSSub": 1,
      "valorICMSSub": 1,
      "sitICMSST": 0,
      "percPis": 1,
      "percCof": 1,
      "valorBaseIpiCredito": 1,
      "codSitTributariaICMS": 1,
      "valorIcmsOriginal": 1,
      "codSitTributariaPIS": "text",
      "codSitTributariaCOFINS": "text",
      "unidadeCompra": "text",
      "fatorConversao": "text",
      "fatorConversaoQuantidade": 1,
      "fatorConversaoOperador": 0,
      "codListaServicos": 1,
      "baseIpiCredito": 1,
      "percIPI": 1,
      "CSTIpi": "text",
      "tipoBaseCreditoPIS": "01",
      "tipoBaseCreditoCofins": "01",
      "valorSTInformado": 1,
      "valorSTCalculado": 1,
      "baseSTInformado": 1,
      "baseSTCalculado": 1,
      "valorDesconto": 1,
      "tipoCSTICMS": 0,
      "valorICMSPartOrigem": 1,
      "valorICMSPartDestino": 1,
      "valorICMSFCP": 1,
      "valorFCPICMS": 1,
      "valorFCPICMSST": 1,
      "custoEntrada": 1,
      "baseContabilizacao": 1,
      "descricaoItem": "text",
      "unidadeMedida": "text",
      "obsItemDespesa": "text",
      "credPresICMS": 1,
      "valorUniCCI": 1,
      "baseICMSTrib": 1,
      "baseICMSIsenta": 1,
      "baseICMSOutras": 1,
      "valorSTDiferenca": 1,
      "baseSTDiferenca": 1
    }
  ],
  "dadosDevolucao": [
    {
      "chaveNFeSaidaReferencia": "text"
    }
  ],
  "dadosCustomizados": [
    {
      "campo": "text",
      "valor": "text"
    }
  ]
}

Excluir uma Nota Fiscal de Entrada

delete

/notaFiscalEntrada/{id}

Autorizações

AuthorizationstringObrigatório

Parâmetros de rota

idstringObrigatório

Chave da Nota Fiscal de Entrada

Parâmetros de cabeçalho

empresastringObrigatório

Código da Empresa

Respostas

200

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

delete

/notaFiscalEntrada/{id}

DELETE /compras/v10/notaFiscalEntrada/{id} HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Accept: */*

Sem conteúdo

Obter Histórico de Compras de Material com Base em Cotação de Moedas Estrangeiras

get

/dadosCotacaoMoedaEstrangeiraHistoricoComprasMaterial/{id}

Autorizações

AuthorizationstringObrigatório

Parâmetros de rota

idstringObrigatório

Código do Produto/Material

Parâmetros de consulta

continuationTokenstringOpcional

Identificador da Paginação da Consulta

Parâmetros de cabeçalho

empresastringObrigatório

Código da Empresa

Respostas

200

application/json

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

get

/dadosCotacaoMoedaEstrangeiraHistoricoComprasMaterial/{id}

GET /compras/v10/dadosCotacaoMoedaEstrangeiraHistoricoComprasMaterial/{id} HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Accept: */*

[
  {
    "continuationToken": "text",
    "historicoComprasMaterial": [
      {
        "dataEmissao": "2025-11-29",
        "dataEntrada": "2025-11-29",
        "fornecedor": 1,
        "serie": "text",
        "codNFEntrada": 1,
        "codItem": 1,
        "codMaterial": "text",
        "quantidade": 1,
        "valorTotalItem": 1,
        "valorCustoItem": 1,
        "cotacaoMoedaEstrangeira": [
          {
            "codMoeda": "text",
            "descMoeda": "text",
            "valorCotacaoDataEntrada": 1
          }
        ]
      }
    ]
  }
]

Replicar uma Nota Fiscal de Entrada

put

/notaFiscalEntrada/replicar

Autorizações

AuthorizationstringObrigatório

Parâmetros de cabeçalho

empresastringObrigatório

Código da Empresa

Corpo

dataEntradastring · dateObrigatório

Data de Entrada da Nota (YYYY-MM-DD)

fornecedorinteger · máx: 99999Obrigatório

Código do Fornecedor

seriestring · máx: 3Obrigatório

Código da Série Fiscal

numerointeger · máx: 9999999999Obrigatório

Código Numérico da Nota

dataEmissaostring · dateOpcional

Data da Emissão da Nota (YYYY-MM-DD)

valorMercadorianumberOpcional

Valor da Mercadoria

valorDespAcessoriasnumberOpcional

Valor das Despesas Acessórias

valorDespFinanceiranumberOpcional

Valor das Despesas Financeiras

valorIPInumberOpcional

Valor do IPI

descontosBonificacaonumberOpcional

Valor de Desconto de Bonificação

valorTotalnumberObrigatório

Valor Total da Nota

naturezaOperacaointeger · máx: 999999Obrigatório

Código da Natureza de Operação

baseIcmsCreditonumberOpcional

Base de ICMS de Crédito

valorIcmsCreditonumberOpcional

Valor de ICMS de Crédito

aliquotaIcmsCreditonumberOpcional

Aliquota de ICMS de Crédito

valorIsentasIcmsnumberOpcional

Valor de ICMS Isentas

valorOutrasIcmsnumberOpcional

Valor de ICMS Outras

baseIpiCreditonumberOpcional

Base de IPI de Crédito

valIpiCreditonumberOpcional

Valor de IPI de Crédito

valorIsentasIPInumberOpcional

Valor de IPI Isentas

valorOutrasIPInumberOpcional

Valor de IPI Outras

especieDocumentointeger · enumObrigatório

Valores possíveis:

situacaointeger · enumOpcional

Situação (0 - Normal, 1 - Uso futuro, 2 - Cancelada, 3 - Cancelada (Grãos))

Valores possíveis:

basePisPasepCreditonumberOpcional

Base de PIS/PASEP (Crédito)

valorPisPasepCreditonumberOpcional

Valor de PIS/PASEP (Crédito)

valorISSnumberOpcional

Valor de ISS

valorINSSnumberOpcional

Valor de INSS

dataHoraLancamentostring · date-timeOpcional

Data e Hora de Lançamento da Nota (YYYY-MM-DDTHH:mm:ss.sssZ)

baseCofinsCreditonumberOpcional

Base COFINS (Crédito)

valorCofinsCreditonumberOpcional

Valor do COFINS (Crédito)

valorCsllRetencaonumberOpcional

Valor CSLL - Retenção

valorPisPasepRetencaonumberOpcional

Valor PIS/PASEP (Retenção)

valorCofinsRetencaonumberOpcional

Valor COFINS (Retenção)

valorSubstituicaoTribICMSnumberOpcional

Valor Substituição Tributária ICMS a Recolher

UFTransportadorstring · máx: 2Opcional

UF do Transportador (NF-e)

placaVeiculostring · máx: 10Opcional

Placa do Veículo (NF-e)

qtdVolumenumberOpcional

Quantidade de Columes (NF-e)

pesoBrutonumberOpcional

Peso Bruto da Nota (NF-e)

pesoLiquidonumberOpcional

Peso Líquido da Nota (NF-e)

tipoFreteinteger · enumOpcional

Valores possíveis:

chaveNFestring · máx: 44Opcional

Chave de Acesso da NF-e

valorIcmsOriginalnumberOpcional

Valor do ICMS Original

integradoServicoTercinteger · enumOpcional

Integrado com Serviço Terceirizado? (0 - Não, 1 - Sim)

Valores possíveis:

baseRetencaoISSnumberOpcional

Base de Retenção ISS

baseRetencaoIRRFnumberOpcional

Base de Retenção IRRF

baseRetencaoINSSnumberOpcional

Base de Retenção INSS

baseRetencaoPISnumberOpcional

Base de Retenção PIS

baseRetencaoCOFINSnumberOpcional

Base de Retenção COFINS

baseRetencaoCSLLnumberOpcional

Base de Retenção CSLL

indNaturezaFreteinteger · enumOpcional

Valores possíveis:

valorSeguronumberOpcional

Valor de Seguro

valorFreteDestacadonumberOpcional

Valor do Frete Destacado

valorTotIcmsStInformadonumberOpcional

Valor total do ICMS-ST informado (Original)

baseICMSRetencaonumberOpcional

Base de ICMS Retenção

valorICMSRetencaonumberOpcional

Valor de ICMS Retenção

inscricaoEstadualstring · máx: 17Opcional

Inscrição Estadual

codMunicipioOrigemstring · mín: 7 · máx: 7Opcional

Código do Município Origem

codMunicipioDestinostring · mín: 7 · máx: 7Opcional

Código do Município Destino

simplesFaturamentointeger · enumObrigatório

Nota Fiscal de Simples Faturamento Para Entrega Futura (0 - Não, 1 - Sim)

Valores possíveis:

entradaEntregaFuturainteger · enumOpcional

Nota Fiscal de Remessa da Entrega Futura (0 - Não, 1 - Sim)

Valores possíveis:

finalidadeDocumentointeger · enumOpcional

Finalidade Documento (1 - Normal, 2 - Substituição, 3 - Normal com Ajuste)

Valores possíveis:

chaveNotaReferenciastring · mín: 44 · máx: 44Opcional

Chave da Nota Referenciada

modeloDocumentostring · enumObrigatório

Valores possíveis:

valorDiferencaAliquotanumberOpcional

Valor da Diferença da Alíquota

baseDirfAliqnumberOpcional

Base da Diferença da Alíquota

condPgtostringOpcional

Condições de Pagamento

valorCreditoPresumidoICMSnumberOpcional

Valor Crédito Presumido ICMS

baseICMSSubnumberOpcional

Base ICMS Substituição Tributária

valorICMSSubnumberOpcional

Valor ICMS Substituição Tributária

baseICMSSubSCnumberOpcional

Base ICMS Substituição Tributária com Crédito

valorICMSSubSCnumberOpcional

Valor ICMS Substituição Tributária com Crédito

basePreICMSnumberOpcional

Base de Cálculo de Crédito Presumido ICMS

totalValorSTCalculadonumberOpcional

Valor Total do ICMS-ST Calculado

totalValorSTDiferencanumberOpcional

Valor Total de ICMS-ST Corrigido pelo Sistema (Diferença)

Respostas

200

application/json

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

put

/notaFiscalEntrada/replicar

PUT /compras/v10/notaFiscalEntrada/replicar HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Content-Type: application/json
Accept: */*
Content-Length: 3157

{
  "dataEntrada": "2025-11-29",
  "fornecedor": 1,
  "serie": "text",
  "numero": 1,
  "dataEmissao": "2025-11-29",
  "valorMercadoria": 1,
  "valorDespAcessorias": 1,
  "valorDespFinanceira": 1,
  "valorIPI": 1,
  "descontosBonificacao": 1,
  "valorTotal": 1,
  "naturezaOperacao": 1,
  "baseIcmsCredito": 1,
  "valorIcmsCredito": 1,
  "aliquotaIcmsCredito": 1,
  "valorIsentasIcms": 1,
  "valorOutrasIcms": 1,
  "baseIpiCredito": 1,
  "valIpiCredito": 1,
  "valorIsentasIPI": 1,
  "valorOutrasIPI": 1,
  "especieDocumento": 1,
  "situacao": 0,
  "basePisPasepCredito": 1,
  "valorPisPasepCredito": 1,
  "valorISS": 1,
  "valorINSS": 1,
  "dataHoraLancamento": "2025-11-29T00:38:09.584Z",
  "baseCofinsCredito": 1,
  "valorCofinsCredito": 1,
  "valorCsllRetencao": 1,
  "valorPisPasepRetencao": 1,
  "valorCofinsRetencao": 1,
  "valorSubstituicaoTribICMS": 1,
  "UFTransportador": "text",
  "placaVeiculo": "text",
  "qtdVolume": 1,
  "pesoBruto": 1,
  "pesoLiquido": 1,
  "tipoFrete": 1,
  "chaveNFe": "text",
  "valorIcmsOriginal": 1,
  "integradoServicoTerc": 0,
  "baseRetencaoISS": 1,
  "baseRetencaoIRRF": 1,
  "baseRetencaoINSS": 1,
  "baseRetencaoPIS": 1,
  "baseRetencaoCOFINS": 1,
  "baseRetencaoCSLL": 1,
  "indNaturezaFrete": 0,
  "valorSeguro": 1,
  "valorFreteDestacado": 1,
  "valorTotIcmsStInformado": 1,
  "baseICMSRetencao": 1,
  "valorICMSRetencao": 1,
  "inscricaoEstadual": "text",
  "codMunicipioOrigem": "text",
  "codMunicipioDestino": "text",
  "simplesFaturamento": 0,
  "entradaEntregaFutura": 0,
  "finalidadeDocumento": 1,
  "chaveNotaReferencia": "text",
  "modeloDocumento": "01",
  "valorDiferencaAliquota": 1,
  "baseDirfAliq": 1,
  "condPgto": "text",
  "valorCreditoPresumidoICMS": 1,
  "baseICMSSub": 1,
  "valorICMSSub": 1,
  "baseICMSSubSC": 1,
  "valorICMSSubSC": 1,
  "basePreICMS": 1,
  "totalValorSTCalculado": 1,
  "totalValorSTDiferenca": 1,
  "itensNotaFiscalEntrada": [
    {
      "codItem": 1,
      "codMaterial": "text",
      "quantidade": 1,
      "valorTotalItem": 1,
      "valorICMS": 1,
      "valorIPI": 1,
      "aliquotaICMS": 1,
      "naturezaOperacao": 1,
      "contaContabil": 1,
      "codClassifFiscal": "text",
      "valorReducaoICMS": 1,
      "valorReducaoIPI": 1,
      "codigoICMS": 1,
      "codigoIPI": 1,
      "centroCustoValor": "text",
      "valorFreteApropriado": 1,
      "valorICMSApropriado": 1,
      "valorBaseCalcPisPasep": 1,
      "valorPisPasepRec": 1,
      "quantidadeEstoque": 1,
      "codigoServico": 1,
      "tipoOperacao": 1,
      "baseCalculoICMS": 1,
      "baseCalculoCOFINS": 1,
      "valorCOFINS": 1,
      "valorPisPasepAprop": 1,
      "valorCofinsAprop": 1,
      "subTribICMS": 1,
      "baseICMSSub": 1,
      "valorICMSSub": 1,
      "sitICMSST": 0,
      "percPis": 1,
      "percCof": 1,
      "valorBaseIpiCredito": 1,
      "codSitTributariaICMS": 1,
      "valorIcmsOriginal": 1,
      "codSitTributariaPIS": "text",
      "codSitTributariaCOFINS": "text",
      "unidadeCompra": "text",
      "fatorConversao": "text",
      "fatorConversaoQuantidade": 1,
      "fatorConversaoOperador": 0,
      "codListaServicos": 1,
      "baseIpiCredito": 1,
      "percIPI": 1,
      "CSTIpi": "text",
      "tipoBaseCreditoPIS": "01",
      "tipoBaseCreditoCofins": "01",
      "valorSTInformado": 1,
      "valorSTCalculado": 1,
      "baseSTInformado": 1,
      "baseSTCalculado": 1,
      "valorDesconto": 1,
      "tipoCSTICMS": 0,
      "valorICMSPartOrigem": 1,
      "valorICMSPartDestino": 1,
      "valorICMSFCP": 1,
      "valorFCPICMS": 1,
      "valorFCPICMSST": 1,
      "custoEntrada": 1,
      "baseContabilizacao": 1,
      "descricaoItem": "text",
      "unidadeMedida": "text",
      "obsItemDespesa": "text",
      "credPresICMS": 1,
      "valorUniCCI": 1,
      "baseICMSTrib": 1,
      "baseICMSIsenta": 1,
      "baseICMSOutras": 1,
      "valorSTDiferenca": 1,
      "baseSTDiferenca": 1
    }
  ],
  "dadosDevolucao": [
    {
      "chaveNFeSaidaReferencia": "text"
    }
  ],
  "dadosCustomizados": [
    {
      "campo": "text",
      "valor": "text"
    }
  ]
}

{
  "dataEntrada": "2025-11-29",
  "fornecedor": 1,
  "serie": "text",
  "numero": 1,
  "dataEmissao": "2025-11-29",
  "valorMercadoria": 1,
  "valorDespAcessorias": 1,
  "valorDespFinanceira": 1,
  "valorIPI": 1,
  "descontosBonificacao": 1,
  "valorTotal": 1,
  "naturezaOperacao": "text",
  "baseIcmsCredito": 1,
  "valorIcmsCredito": 1,
  "aliquotaIcmsCredito": 1,
  "valorIsentasIcms": 1,
  "valorOutrasIcms": 1,
  "baseIpiCredito": 1,
  "valIpiCredito": 1,
  "valorIsentasIPI": 1,
  "valorOutrasIPI": 1,
  "especieDocumento": 1,
  "situacao": 0,
  "basePisPasepCredito": 1,
  "valorPisPasepCredito": 1,
  "valorISS": 1,
  "valorINSS": 1,
  "dataHoraLancamento": "2025-11-29T00:38:09.584Z",
  "baseCofinsCredito": 1,
  "valorCofinsCredito": 1,
  "valorCsllRetencao": 1,
  "valorPisPasepRetencao": 1,
  "valorCofinsRetencao": 1,
  "valorSubstituicaoTribICMS": 1,
  "UFTransportador": "text",
  "placaVeiculo": "text",
  "qtdVolume": 1,
  "pesoBruto": 1,
  "pesoLiquido": 1,
  "tipoFrete": 1,
  "chaveNFe": "text",
  "valorIcmsOriginal": 1,
  "integradoServicoTerc": 0,
  "baseRetencaoISS": 1,
  "baseRetencaoIRRF": 1,
  "baseRetencaoINSS": 1,
  "baseRetencaoPIS": 1,
  "baseRetencaoCOFINS": 1,
  "baseRetencaoCSLL": 1,
  "indNaturezaFrete": 0,
  "valorSeguro": 1,
  "valorFreteDestacado": 1,
  "valorTotIcmsStInformado": 1,
  "baseICMSRetencao": 1,
  "valorICMSRetencao": 1,
  "inscricaoEstadual": "text",
  "codMunicipioOrigem": "text",
  "codMunicipioDestino": "text",
  "simplesFaturamento": 0,
  "entradaEntregaFutura": 0,
  "finalidadeDocumento": 1,
  "chaveNotaReferencia": "text",
  "modeloDocumento": "01",
  "valorDiferencaAliquota": 1,
  "baseDirfAliq": 1,
  "condPgto": "text",
  "valorCreditoPresumidoICMS": 1,
  "baseICMSSub": 1,
  "valorICMSSub": 1,
  "baseICMSSubSC": 1,
  "valorICMSSubSC": 1,
  "basePreICMS": 1,
  "totalValorSTCalculado": 1,
  "totalValorSTDiferenca": 1,
  "itensNotaFiscalEntrada": [
    {
      "codItem": 1,
      "codMaterial": "text",
      "quantidade": 1,
      "valorTotalItem": 1,
      "valorICMS": 1,
      "valorIPI": 1,
      "aliquotaICMS": 1,
      "naturezaOperacao": 1,
      "contaContabil": 1,
      "codClassifFiscal": "text",
      "valorReducaoICMS": 1,
      "valorReducaoIPI": 1,
      "codigoICMS": 1,
      "codigoIPI": 1,
      "centroCustoValor": "text",
      "valorFreteApropriado": 1,
      "valorICMSApropriado": 1,
      "valorBaseCalcPisPasep": 1,
      "valorPisPasepRec": 1,
      "quantidadeEstoque": 1,
      "codigoServico": 1,
      "tipoOperacao": 1,
      "baseCalculoICMS": 1,
      "baseCalculoCOFINS": 1,
      "valorCOFINS": 1,
      "valorPisPasepAprop": 1,
      "valorCofinsAprop": 1,
      "subTribICMS": 1,
      "baseICMSSub": 1,
      "valorICMSSub": 1,
      "sitICMSST": 0,
      "percPis": 1,
      "percCof": 1,
      "valorBaseIpiCredito": 1,
      "codSitTributariaICMS": 1,
      "valorIcmsOriginal": 1,
      "codSitTributariaPIS": "text",
      "codSitTributariaCOFINS": "text",
      "unidadeCompra": "text",
      "fatorConversao": "text",
      "fatorConversaoQuantidade": 1,
      "fatorConversaoOperador": 0,
      "codListaServicos": 1,
      "baseIpiCredito": 1,
      "percIPI": 1,
      "CSTIpi": "text",
      "tipoBaseCreditoPIS": "01",
      "tipoBaseCreditoCofins": "01",
      "valorSTInformado": 1,
      "valorSTCalculado": 1,
      "baseSTInformado": 1,
      "baseSTCalculado": 1,
      "valorDesconto": 1,
      "tipoCSTICMS": 0,
      "valorICMSPartOrigem": 1,
      "valorICMSPartDestino": 1,
      "valorICMSFCP": 1,
      "valorFCPICMS": 1,
      "valorFCPICMSST": 1,
      "custoEntrada": 1,
      "baseContabilizacao": 1,
      "descricaoItem": "text",
      "unidadeMedida": "text",
      "obsItemDespesa": "text",
      "credPresICMS": 1,
      "valorUniCCI": 1,
      "baseICMSTrib": 1,
      "baseICMSIsenta": 1,
      "baseICMSOutras": 1,
      "valorSTDiferenca": 1,
      "baseSTDiferenca": 1
    }
  ],
  "dadosDevolucao": [
    {
      "chaveNFeSaidaReferencia": "text"
    }
  ],
  "dadosCustomizados": [
    {
      "campo": "text",
      "valor": "text"
    }
  ]
}

AnteriorPedido de Compra PróximoModels

Atualizado há 4 horas

Boa noite

Obter Listagem de Notas Fiscais de Entrada

Cadastrar uma Nota Fiscal de Entrada

Obter uma Nota Fiscal de Entrada

Atualizar uma Nota Fiscal de Entrada

Excluir uma Nota Fiscal de Entrada

Obter Histórico de Compras de Material com Base em Cotação de Moedas Estrangeiras

Replicar uma Nota Fiscal de Entrada