OpenAPITodas as operações em OpenAPI (Postman, Insomnia).
Produtos · NFConsultar

Realiza as consultas na Nota Fiscal

POSThttps://app.omie.com.br/api/v1/produtos/nfconsultar/WSDL
2consultas
0alterações
Claude 2 de 2 · ChatGPT 1 de 2 · MCP 2 de 2pelos assistentes de IA
JSON · XMLformato

ConsultarNF

consultaClaudeMCP

Consulta uma Nota Fiscal.

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 12Campos e estruturas que você pode enviar
CampoTipoDescrição
cChaveNFetexto · até 44Chave da NF-e.
cCodNFInttexto · até 20Código de Integração da NF (DEPRECATED).
cDetalhesPedidotexto · até 1Exibe os detalhes do pedido que originou a Nota Fiscal. Preecher com "S" ou "N".
cnpj_cpftexto · até 100CNPJ / CPF.
dEmitexto · até 10Data de emissão.
nCodNFnúmero inteiroCódigo de Identificação da NF. É o nIdNF devolvido no grupo compl por ListarNF e ConsultarNF.
nIdClientenúmero inteiroID do Cliente.
nIdPedidonúmero inteiroCódigo de identificação do pedido. Interno, utilizando apenas nas APIs.
nNFtexto · até 10Número do Documento Fiscal.
serietexto · até 5Série do Documento Fiscal.
tpAmbtexto · até 1Tipo de Ambiente. Pode Ser: 1 - Produção 2 - Homologação.
tpNFtexto · até 1Tipo de Operação: 0-entrada / 1-saída.
Retorno 9O que volta numa chamada bem-sucedida
CampoTipoDescrição
complobjetoDados complementares da NF.
compl.cChaveNFetextoChave da NF-e.
compl.cCodCategtextoCódigo da categoria.
compl.cModFretetextoCódigo da modalidade do frete.
compl.nIdNFnúmero inteiroCódigo da Nota Fiscal. Interno, utilizando apenas nas APIs.
compl.nIdPedidonúmero inteiroCódigo de identificação do pedido. Interno, utilizando apenas nas APIs.
compl.nIdRecebnúmero inteiroIdentificação do Recebimento. Interno, utilizando apenas nas APIs.
compl.nIdTranspnúmero inteiroIdentificação da Transportadora. Interno, utilizando apenas nas APIs.
detlista de objetos
det[].itemPedidoobjetoDados do Item do Pedido de Venda.
det[].itemPedido.cItemDevolvidotextoIndica se o Item do Pedido de Vendas foi devolvido (S/N).
det[].itemPedido.nIdItemPedidonúmero inteiroId do item do Pedido de Venda.
det[].itemPedido.nItemQtdDevolvidadecimalQuantidade devolvida do Item do Pedido de Vendas.
det[].nfProdIntobjeto
det[].nfProdInt.cCodItemInttextoCódigo de Integração do Item.
det[].nfProdInt.cCodProdInttextoCódigo de Integração do produto.
det[].nfProdInt.nCodItemnúmero inteiroCódigo do item.
det[].nfProdInt.nCodProdnúmero inteiroCódigo do Produto.
det[].prodobjeto
det[].prod.CFOPtextoCódigo Fiscal de Operações e Prestações.
det[].prod.EXTIPItextoDEPRECATED.
det[].prod.NCMtexto
det[].prod.cCOFINSRetidotextoIndica se houve retenção de COFINS Possíveis valores: S = Sim N = Não.
det[].prod.cCSLLRetidotextoIndica se houve retenção de CSLL Possíveis valores: S = Sim N = Não.
det[].prod.cEANtextoGTIN (Global Trade Item Number) do produto, antigo código EAN ou código de barras.
det[].prod.cEANTribtextoGTIN (Global Trade Item Number) da unidade tributável, antigo código EAN ou código de barras.
det[].prod.cICMSRetidotextoIndica se houve retenção de ICMS Possíveis valores: S = Sim N = Não.
det[].prod.cINSSRetidotextoIndica se houve retenção de INSS Possíveis valores: S = Sim N = Não.
det[].prod.cIRRetidotextoIndica se houve retenção de IR Possíveis valores: S = Sim N = Não.
det[].prod.cISSRetidotextoIndica se houve retenção de ISS Possíveis valores: S = Sim N = Não.
det[].prod.cOrigemtexto
det[].prod.cPISRetidotextoIndica se houve retenção de PIS Possíveis valores: S = Sim N = Não.
det[].prod.cProdtextoCódigo do produto ou serviço.
det[].prod.cProdOrigtextoCódigo do produto conforme informado na Nota Fiscal.
det[].prod.codigo_local_estoquenúmero inteiroCódigo do local do estoque.
det[].prod.indTotdecimalIndica se valor do Item (vProd) entra no valor total da NF-e (vProd).
det[].prod.nCMCTotaldecimalCMC Total.
det[].prod.nCMCUnitariodecimalCMC Unitário.
det[].prod.pAliqCbsdecimalAlíquota da CBS.
det[].prod.pAliqIBSMundecimalAlíquota do IBS de competência do Município.
det[].prod.pAliqIBSUFdecimalAlíquota do IBS de competência das UF.
det[].prod.pCOFINSdecimalAlíquota de COFINS.
det[].prod.pCSLLdecimalAlíquota de Contribuição Social sobre Lucro Líquido.
det[].prod.pFCPdecimalAlíquota de FCP.
det[].prod.pFCPSTdecimalAlíquota de FCPST.
det[].prod.pICMSdecimalAlíquota de ICMS.
det[].prod.pICMSSTdecimalAlíquota de ICMSST.
det[].prod.pINSSdecimalAlíquota de INSS.
det[].prod.pIPIdecimalAlíquota de IPI.
det[].prod.pIRdecimalAlíquota de IR.
det[].prod.pISSdecimalAlíquota de ISS.
det[].prod.pIcmsInterestdecimalAlíquota Interestadual das UF envolvidas.
det[].prod.pIcmsUfDestdecimalAlíquota interna da UF de Destino.
det[].prod.pMVASTdecimalPercentual da margem do valor adicionado da base de cálculo do ICMS ST.
det[].prod.pPISdecimalAlíquota de PIS.
det[].prod.pRedBCdecimalPercentual de Redução da Base de Cálculo do ICMS.
det[].prod.pRedBcICMDestdecimalPercentual de Redução da Base de Cálculo do ICMS Destino.
det[].prod.pReducaoCbsdecimalPercentual da redução de alíquota do cClassTrib.
det[].prod.pReducaoIbsMundecimalPercentual da redução de alíquota do cClassTrib - IBS UF.
det[].prod.pReducaoIbsUfdecimalPercentual da redução de alíquota do cClassTrib - IBS UF.
det[].prod.qComdecimalQuantidade Comercial.
det[].prod.qTribdecimalQuantidade Tributável.
det[].prod.uComtextoUnidade Comercial.
det[].prod.uTribtextoUnidade Tributável.
det[].prod.vAliqCbsdecimalValor da alíquota da CBS.
det[].prod.vAliqIbsMundecimalValor da alíquota do IBS do Município.
det[].prod.vAliqIbsUfdecimalValor da alíquota do IBS da UF.
det[].prod.vBCdecimalBase de Cálculo do ICMS.
det[].prod.vBCCOFINSdecimalBase de Cálculo do COFINS.
det[].prod.vBCIPIdecimalBase de Cálculo do IPI.
det[].prod.vBCISSdecimalBase de Cálculo do ISS.
det[].prod.vBCIbsCbsdecimalBase de cálculo do IBS e CBS.
det[].prod.vBCPISdecimalBase de Cálculo do PIS.
det[].prod.vBCSTdecimalBase de Cálculo do ICMS ST.
det[].prod.vBCUFDestdecimalBase de Cálculo do ICMS na UF de Destino.
det[].prod.vCOFINSdecimalValor de COFINS.
det[].prod.vCSLLdecimalValor da Contribuição Social sobre Lucro Líquido.
det[].prod.vCbsdecimalValor da CBS.
det[].prod.vDescdecimalValor do Desconto.
det[].prod.vFCPdecimalValor do ICMS relativo ao Fundo de Combate à Pobreza (FCP) da UF de Destino.
det[].prod.vFCPSTdecimalValor do FCPST.
det[].prod.vFretedecimalValor Total do Frete.
det[].prod.vICMDestdecimalValor do ICMS Interestadual para a UF de Destino.
det[].prod.vICMRemetdecimalValor do ICMS Interestadual para a UF do Remetente.
det[].prod.vICMSdecimalValor de ICMS.
det[].prod.vICMSSTdecimalValor de ICMSST.
det[].prod.vIIdecimalValor de Impostos de Importação.
det[].prod.vINSSdecimalValor de INSS.
det[].prod.vIPIdecimalValor de IPI.
det[].prod.vIRdecimalValor de IR.
det[].prod.vISSdecimalValor de ISS.
det[].prod.vIbsdecimalValor do IBS.
det[].prod.vIbsMundecimalValor do IBS de competência do Município.
det[].prod.vIbsUfdecimalValor do IBS de competência da UF.
det[].prod.vOutrodecimalOutras despesas acessórias.
det[].prod.vPISdecimalValor do PIS.
det[].prod.vProddecimalValor Total Bruto dos Produtos.
det[].prod.vSegdecimalValor Total do Seguro.
det[].prod.vTotItemdecimalValor total do item.
det[].prod.vUnComdecimalValor Unitário de Comercialização.
det[].prod.vUnTribdecimalValor Unitário de tributação.
det[].prod.xProdtextoDescrição do produto ou serviço.
det[].prod.xProdOrigtextoDescrição original do produto conforme informado na Nota Fiscal.
det[].rastreabilidadeobjetoDados específicos para rastreabilidade do produto.
det[].rastreabilidade.codigoAgregacaoLotetextoCódigo de Agregação.
det[].rastreabilidade.dataFabricacaoLotetextoData de Fabricação/Produção.
det[].rastreabilidade.dataValidadeLotetextoData de Validade.
det[].rastreabilidade.numeroLotetextoNúmero do Lote.
det[].rastreabilidade.qtdeProdutoLotedecimalQuantidade de Produto.
ideobjeto
ide.cDenegtexto
ide.dCantextoData de cancelamento.
ide.dEmitextoData de emissão.
ide.dInuttextoData de Inutilização.
ide.dRegtextoData de Registro.
ide.dSaiEnttextoData de saida.
ide.finNFetextoFinalidade de emissão da NFe: 1 - NF-e normal 2 - NF-e complementar 3 - NF-e de ajuste 4 - NF-e de devolução.
ide.hEmitextoHora de Emissão.
ide.hSaiEnttextoHora de Saída ou da Entrada da Mercadoria/Produto.
ide.indPagtextoIndicador da forma de pagamento: 0 - pagamento à vista; 1 - pagamento à prazo; 2 - outros.
ide.modtextoCódigo do Modelo do Documento Fiscal: Utilizar o código 55 para identificação da NF-e, emitida em substituição ao modelo 1 ou 1A.
ide.nNFtextoNúmero do Documento Fiscal.
ide.serietextoSérie do Documento Fiscal.
ide.tpAmbtextoTipo de Ambiente = 1-Produção / 2-Homologação.
ide.tpNFtextoTipo de Operação: 0-entrada / 1-saída.
infoobjetoInformações complementares.
info.cImpAPItextoImportado pela API.
info.dAlttextoData da Alteração.
info.dInctextoData da Inclusão.
info.hAlttextoHora da Alteração.
info.hInctextoHora da Inclusão.
info.uAlttextoUsuário da Alteração.
info.uInctextoUsuário da Inclusão.
nfDestIntobjeto
nfDestInt.cCodCliInttextoCódigo de integração do cliente Fornecedor.
nfDestInt.cRazaotexto
nfDestInt.cnpj_cpftexto
nfDestInt.nCodClinúmero inteiroCódigo do cliente.
nfEmitIntobjeto
nfEmitInt.cCodEmpInttextoCódigo de integração da empresa.
nfEmitInt.nCodEmpnúmero inteiroCódigo da Empresa.
pedidoobjetoDados do pedido.
pedido.Categoriaslista de objetosDistribuição por Categorias.
pedido.Categorias[].cCodigoCategoriatextoCódigo do Categoria.
pedido.Categorias[].nPercentualDistribuicaodecimalPercentual da distribuição.
pedido.Categorias[].nValorDistribuicaodecimalValor da distribuição.
pedido.Categorias[].nValorFixotextoIndica que o valor foi fixado na distribuição (S/N).
pedido.Departamentoslista de objetosDistribuição por Departamentos.
pedido.Departamentos[].cCodigoDepartamentotextoCódigo do Departamento.
pedido.Departamentos[].nPercentualDistribuicaodecimalPercentual da distribuição.
pedido.Departamentos[].nValorDistribuicaodecimalValor da distribuição.
pedido.Departamentos[].nValorFixotextoIndica que o valor foi fixado na distribuição (S/N).
pedido.cCanceladotextoIndica que o Pedido de Venda foi cancelado.
pedido.cDevParcialtextoIndica que o Pedido de Venda se foi uma devolução parcial.
pedido.cDevolvidotextoIndica que o Pedido de Venda foi devolvido.
pedido.cNumPedidotextoNúmero do Pedido do Venda.
pedido.dAltPedidotextoData da Alteração do Pedido de Venda.
pedido.dCanPedidotextoData de Cancelamento do Pedido de Venda.
pedido.dDevPedidotextoData de Cancelamento do Pedido de Venda.
pedido.dIncPedidotextoData da Inclusão do Pedido de Venda.
pedido.hAltPedidotextoHora da Alteração do Pedido de Venda.
pedido.hCanPedidotextoHora de Cancelamento do Pedido de Venda.
pedido.hDevPedidotextoHora de Cancelamento do Pedido de Venda.
pedido.hIncPedidotextoHora da Inclusão do Pedido de Venda.
pedido.nIdPedDevnúmero inteiroId do Pedido de venda devolvido.
pedido.nIdProjetonúmero inteiroCódigo do Projeto no Pedido.
pedido.nIdVendedornúmero inteiroCódigo do Vendedor no Pedido.
pedido.opPedidotextoOperação do Pedido de venda que originou a NF. Pode ser: Vendas 01 Venda de Serviço 11 Venda de Produto 12 Venda de Produto pelo PDV 13 Devolução de Venda 14 Remessa de Produto 16 Nota Complementar de Saída Compras 21 Compra de Produto 23 Devolução ao Fornecedor 24 Retorno de Remessa 26 Nota Complementar de Entrada 22 Compra de Produto (Importação) 28 Ordem de Produção.
pedido.uAltPedidotextoUsuário da Alteração do Pedido de Venda.
pedido.uCanPedidotextoUsuário de Cancelamento do Pedido de Venda.
pedido.uDevPedidotextoUsuário de Cancelamento do Pedido de Venda.
pedido.uIncPedidotextoUsuário da Inclusão do Pedido de Venda.
tituloslista de objetosTitulos gerados para a nota fiscal.
titulos[].cCodCategtextoCódigo da Categoria.
titulos[].cCodIntTitulotextoCódigo de integração do título. (Utilizado em títulos criados via API, não é visualizado na tela).
titulos[].cDoctexto
titulos[].cNumTitulotextoNúmero do título. (Informado pelo usuário / visualizado na tela).
titulos[].cPagFormatexto
titulos[].dDtEmissaotextoData de emissão do título.
titulos[].dDtPrevisaotextoData de previsão de Pagamento/Recebimento.
titulos[].dDtVenctextoData de vencimento do título.
titulos[].dRegtextoData de Registro.
titulos[].nCodCompradornúmero inteiroNúmero do Comprador.
titulos[].nCodProjetonúmero inteiroCódigo do Projeto.
titulos[].nCodTitRepetnúmero inteiroCódigo do título da repetição.
titulos[].nCodTitulonúmero inteiroCódigo do titulo. (Gerado internamente, não é visualizado na tela).
titulos[].nCodVendedornúmero inteiroCódigo do Vendedor.
titulos[].nParcelanúmero inteiroNúmero da parcela.
titulos[].nTotParcnúmero inteiroNúmero total de parcelas.
titulos[].nValorTitulodecimalValor do título.
totalobjeto
total.CBSTotobjetoGrupo de Valores Totais referentes ao CBS.
total.CBSTot.vCBCbsdecimalValor total da base de cálculo da CBS.
total.CBSTot.vCbsdecimalValor total da CBS.
total.CBSTot.vCbsCreddecimalValor total do crédito presumido.
total.CBSTot.vCbsDifdecimalValor total do diferimento da CBS.
total.IBSTotobjetoGrupo de Valores Totais referentes ao IBS.
total.IBSTot.vBCIbsdecimalValor total da base de cálculo do IBS.
total.IBSTot.vIbsdecimalValor total do IBS.
total.IBSTot.vIbsCreddecimalValor total do crédito presumido.
total.IBSTot.vIbsMundecimalValor total do IBS do município.
total.IBSTot.vIbsMunDifdecimalValor total do diferimento do IBS do município.
total.IBSTot.vIbsUfdecimalValor total do IBS da UF.
total.IBSTot.vIbsUfDifdecimalValor total do diferimento do IBS UF.
total.ICMSTotobjetoGrupo de Valores Totais referentes ao ICMS.
total.ICMSTot.vBCdecimalBase de Cálculo do ICMS.
total.ICMSTot.vBCFCPdecimalBase de Cálculo do Fundo de Combate a Pobreza.
total.ICMSTot.vBCFCPSTdecimalBase de Cálculo do Fundo de Combate a Pobreza ST.
total.ICMSTot.vBCSTdecimalBase de Cálculo do ICMS ST.
total.ICMSTot.vCOFINSdecimalValor do COFINS.
total.ICMSTot.vDescdecimalValor Total do Desconto.
total.ICMSTot.vFCPdecimalValor do Fundo de Combate a Pobreza.
total.ICMSTot.vFCPSTdecimalValor do Fundo de Combate a Pobreza ST.
total.ICMSTot.vFretedecimalValor Total do Frete.
total.ICMSTot.vICMSdecimalValor Total do ICMS.
total.ICMSTot.vICMSDesoneradodecimalValor do ICMS Desonerado.
total.ICMSTot.vIIdecimalValor Total do II.
total.ICMSTot.vIPIdecimalValor Total do IPI.
total.ICMSTot.vNFdecimalValor Total da NF-e.
total.ICMSTot.vOutrodecimalOutras Despesas acessórias.
total.ICMSTot.vPISdecimalValor do PIS.
total.ICMSTot.vProddecimalValor Total dos produtos e serviços.
total.ICMSTot.vSTdecimalValor Total do ICMS ST.
total.ICMSTot.vSegdecimalValor Total do Seguro.
total.ICMSTot.vTotTribdecimalValor aproximado total de tributos federais, estaduais e municipais.
total.ISSQNtotobjetoGrupo de Valores Totais referentes ao ISSQN.
total.ISSQNtot.vBCdecimalBase de Cálculo do ISS.
total.ISSQNtot.vCOFINSdecimalValor do COFINS sobre serviços.
total.ISSQNtot.vISSdecimalValor Total do ISS.
total.ISSQNtot.vPISdecimalValor do PIS sobre serviços.
total.ISSQNtot.vServdecimalValor Total dos Serviços sob não-incidência ou não tributados pelo ICMS.
total.retTribobjetoGrupo de Retenções de Tributos.
total.retTrib.vBCIRRFdecimalBase de Cálculo do IRRF.
total.retTrib.vBCRetPrevdecimalBase de Cálculo da Retenção da Previdência Social.
total.retTrib.vIRRFdecimalValor Retido do IRRF.
total.retTrib.vRetCOFINSdecimalValor Retido de COFINS.
total.retTrib.vRetCSLLdecimalValor Retido de CSLL.
total.retTrib.vRetPISdecimalValor Retido de PIS.
total.retTrib.vRetPrevdecimalValor da Retenção da Previdência Social.
POST /api/v1/produtos/nfconsultar/
curl -s https://app.omie.com.br/api/v1/produtos/nfconsultar/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "ConsultarNF", "param": [{"nCodNF": 0, "nNF": "1"}]}'

ListarNF

consultaClaudeChatGPTMCP

Listar as Notas Fiscais cadastradas.

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 33Campos e estruturas que você pode enviar
CampoTipoDescrição
apenas_importado_apitexto · até 1
cApenasResumotexto · até 1Exibe apenas a resumo da Nota Fiscal. Preencher com "S" ou "N".
cDetalhesPedidotexto · até 1Exibe os detalhes do pedido que originou a Nota Fiscal. Preecher com "S" ou "N".
cNumeroPedidoClientetexto · até 30Pesquisa pelo numero do Pedido do Cliente.
cSerietexto · até 5Série da NF-e.
cnpj_cpftexto · até 100CNPJ / CPF.
dCanFinaltexto · até 10Data de Cancelamento final.
dCanInicialtexto · até 10Data de Cancelamento inicial.
dEmiFinaltexto · até 10Data de Emissão final.
dEmiInicialtexto · até 10Data de Emissão inicial.
dInutFinaltexto · até 10Data de Inutilização final.
dInutInicialtexto · até 10Data de Inutilização inicial.
dRegFinaltexto · até 10Data de Registro final.
dRegInicialtexto · até 10Data de Registro inicial.
dSaiEntFinaltexto · até 10Data de Saida final.
dSaiEntInicialtexto · até 10Data de Saida inicial.
filtrar_apenas_alteracaotexto · até 1
filtrar_apenas_inclusaotexto · até 1
filtrar_por_data_atetexto · até 10
filtrar_por_data_detexto · até 10
filtrar_por_statustexto · até 1Status da NF: N-Não cancelada C-Cancelada.
hEmiFinaltexto · até 8Hora de Emissão final.
hEmiInicialtexto · até 8Hora de Emissão inicial.
nIdClientenúmero inteiroID do Cliente.
nNFFinalnúmero inteiroNúmero da Nota Fiscal final.
nNFInicialnúmero inteiroNúmero da Nota Fiscal inicial.
opPedidotexto · até 2Operação do Pedido de venda que originou a NF. Pode ser: Vendas 01 Venda de Serviço 11 Venda de Produto 12 Venda de Produto pelo PDV 13 Devolução de Venda 14 Remessa de Produto 16 Nota Complementar de Saída Compras 21 Compra de Produto 23 Devolução ao Fornecedor 24 Retorno de Remessa 26 Nota Complementar de Entrada 22 Compra de Produto (Importação) 28 Ordem de Produção.
ordem_decrescentetexto · até 1Ordem decrescente.
ordenar_portexto · até 100
paginanúmero inteiro
registros_por_paginanúmero inteiro
tpAmbtexto · até 1Tipo de Ambiente. Pode Ser: 1 - Produção 2 - Homologação.
tpNFtexto · até 1Tipo de Operação. Pode ser: 0 - Entrada 1 - Saída.
Descontinuados 1Ainda aceitos, fora do fluxo principal
CampoTipoDescrição
ordem_descrescentedescontinuadotexto · até 1DEPRECATED.
Retorno 5O que volta numa chamada bem-sucedida
CampoTipoDescrição
nfCadastrolista de objetos
nfCadastro[].complobjetoDados complementares da NF.
nfCadastro[].compl.cChaveNFetextoChave da NF-e.
nfCadastro[].compl.cCodCategtextoCódigo da categoria.
nfCadastro[].compl.cModFretetextoCódigo da modalidade do frete.
nfCadastro[].compl.nIdNFnúmero inteiroCódigo da Nota Fiscal. Interno, utilizando apenas nas APIs.
nfCadastro[].compl.nIdPedidonúmero inteiroCódigo de identificação do pedido. Interno, utilizando apenas nas APIs.
nfCadastro[].compl.nIdRecebnúmero inteiroIdentificação do Recebimento. Interno, utilizando apenas nas APIs.
nfCadastro[].compl.nIdTranspnúmero inteiroIdentificação da Transportadora. Interno, utilizando apenas nas APIs.
nfCadastro[].detlista de objetos
nfCadastro[].det[].itemPedidoobjetoDados do Item do Pedido de Venda.
nfCadastro[].det[].itemPedido.cItemDevolvidotextoIndica se o Item do Pedido de Vendas foi devolvido (S/N).
nfCadastro[].det[].itemPedido.nIdItemPedidonúmero inteiroId do item do Pedido de Venda.
nfCadastro[].det[].itemPedido.nItemQtdDevolvidadecimalQuantidade devolvida do Item do Pedido de Vendas.
nfCadastro[].det[].nfProdIntobjeto
nfCadastro[].det[].nfProdInt.cCodItemInttextoCódigo de Integração do Item.
nfCadastro[].det[].nfProdInt.cCodProdInttextoCódigo de Integração do produto.
nfCadastro[].det[].nfProdInt.nCodItemnúmero inteiroCódigo do item.
nfCadastro[].det[].nfProdInt.nCodProdnúmero inteiroCódigo do Produto.
nfCadastro[].det[].prodobjeto
nfCadastro[].det[].prod.CFOPtextoCódigo Fiscal de Operações e Prestações.
nfCadastro[].det[].prod.EXTIPItextoDEPRECATED.
nfCadastro[].det[].prod.NCMtexto
nfCadastro[].det[].prod.cCOFINSRetidotextoIndica se houve retenção de COFINS Possíveis valores: S = Sim N = Não.
nfCadastro[].det[].prod.cCSLLRetidotextoIndica se houve retenção de CSLL Possíveis valores: S = Sim N = Não.
nfCadastro[].det[].prod.cEANtextoGTIN (Global Trade Item Number) do produto, antigo código EAN ou código de barras.
nfCadastro[].det[].prod.cEANTribtextoGTIN (Global Trade Item Number) da unidade tributável, antigo código EAN ou código de barras.
nfCadastro[].det[].prod.cICMSRetidotextoIndica se houve retenção de ICMS Possíveis valores: S = Sim N = Não.
nfCadastro[].det[].prod.cINSSRetidotextoIndica se houve retenção de INSS Possíveis valores: S = Sim N = Não.
nfCadastro[].det[].prod.cIRRetidotextoIndica se houve retenção de IR Possíveis valores: S = Sim N = Não.
nfCadastro[].det[].prod.cISSRetidotextoIndica se houve retenção de ISS Possíveis valores: S = Sim N = Não.
nfCadastro[].det[].prod.cOrigemtexto
nfCadastro[].det[].prod.cPISRetidotextoIndica se houve retenção de PIS Possíveis valores: S = Sim N = Não.
nfCadastro[].det[].prod.cProdtextoCódigo do produto ou serviço.
nfCadastro[].det[].prod.cProdOrigtextoCódigo do produto conforme informado na Nota Fiscal.
nfCadastro[].det[].prod.codigo_local_estoquenúmero inteiroCódigo do local do estoque.
nfCadastro[].det[].prod.indTotdecimalIndica se valor do Item (vProd) entra no valor total da NF-e (vProd).
nfCadastro[].det[].prod.nCMCTotaldecimalCMC Total.
nfCadastro[].det[].prod.nCMCUnitariodecimalCMC Unitário.
nfCadastro[].det[].prod.pAliqCbsdecimalAlíquota da CBS.
nfCadastro[].det[].prod.pAliqIBSMundecimalAlíquota do IBS de competência do Município.
nfCadastro[].det[].prod.pAliqIBSUFdecimalAlíquota do IBS de competência das UF.
nfCadastro[].det[].prod.pCOFINSdecimalAlíquota de COFINS.
nfCadastro[].det[].prod.pCSLLdecimalAlíquota de Contribuição Social sobre Lucro Líquido.
nfCadastro[].det[].prod.pFCPdecimalAlíquota de FCP.
nfCadastro[].det[].prod.pFCPSTdecimalAlíquota de FCPST.
nfCadastro[].det[].prod.pICMSdecimalAlíquota de ICMS.
nfCadastro[].det[].prod.pICMSSTdecimalAlíquota de ICMSST.
nfCadastro[].det[].prod.pINSSdecimalAlíquota de INSS.
nfCadastro[].det[].prod.pIPIdecimalAlíquota de IPI.
nfCadastro[].det[].prod.pIRdecimalAlíquota de IR.
nfCadastro[].det[].prod.pISSdecimalAlíquota de ISS.
nfCadastro[].det[].prod.pIcmsInterestdecimalAlíquota Interestadual das UF envolvidas.
nfCadastro[].det[].prod.pIcmsUfDestdecimalAlíquota interna da UF de Destino.
nfCadastro[].det[].prod.pMVASTdecimalPercentual da margem do valor adicionado da base de cálculo do ICMS ST.
nfCadastro[].det[].prod.pPISdecimalAlíquota de PIS.
nfCadastro[].det[].prod.pRedBCdecimalPercentual de Redução da Base de Cálculo do ICMS.
nfCadastro[].det[].prod.pRedBcICMDestdecimalPercentual de Redução da Base de Cálculo do ICMS Destino.
nfCadastro[].det[].prod.pReducaoCbsdecimalPercentual da redução de alíquota do cClassTrib.
nfCadastro[].det[].prod.pReducaoIbsMundecimalPercentual da redução de alíquota do cClassTrib - IBS UF.
nfCadastro[].det[].prod.pReducaoIbsUfdecimalPercentual da redução de alíquota do cClassTrib - IBS UF.
nfCadastro[].det[].prod.qComdecimalQuantidade Comercial.
nfCadastro[].det[].prod.qTribdecimalQuantidade Tributável.
nfCadastro[].det[].prod.uComtextoUnidade Comercial.
nfCadastro[].det[].prod.uTribtextoUnidade Tributável.
nfCadastro[].det[].prod.vAliqCbsdecimalValor da alíquota da CBS.
nfCadastro[].det[].prod.vAliqIbsMundecimalValor da alíquota do IBS do Município.
nfCadastro[].det[].prod.vAliqIbsUfdecimalValor da alíquota do IBS da UF.
nfCadastro[].det[].prod.vBCdecimalBase de Cálculo do ICMS.
nfCadastro[].det[].prod.vBCCOFINSdecimalBase de Cálculo do COFINS.
nfCadastro[].det[].prod.vBCIPIdecimalBase de Cálculo do IPI.
nfCadastro[].det[].prod.vBCISSdecimalBase de Cálculo do ISS.
nfCadastro[].det[].prod.vBCIbsCbsdecimalBase de cálculo do IBS e CBS.
nfCadastro[].det[].prod.vBCPISdecimalBase de Cálculo do PIS.
nfCadastro[].det[].prod.vBCSTdecimalBase de Cálculo do ICMS ST.
nfCadastro[].det[].prod.vBCUFDestdecimalBase de Cálculo do ICMS na UF de Destino.
nfCadastro[].det[].prod.vCOFINSdecimalValor de COFINS.
nfCadastro[].det[].prod.vCSLLdecimalValor da Contribuição Social sobre Lucro Líquido.
nfCadastro[].det[].prod.vCbsdecimalValor da CBS.
nfCadastro[].det[].prod.vDescdecimalValor do Desconto.
nfCadastro[].det[].prod.vFCPdecimalValor do ICMS relativo ao Fundo de Combate à Pobreza (FCP) da UF de Destino.
nfCadastro[].det[].prod.vFCPSTdecimalValor do FCPST.
nfCadastro[].det[].prod.vFretedecimalValor Total do Frete.
nfCadastro[].det[].prod.vICMDestdecimalValor do ICMS Interestadual para a UF de Destino.
nfCadastro[].det[].prod.vICMRemetdecimalValor do ICMS Interestadual para a UF do Remetente.
nfCadastro[].det[].prod.vICMSdecimalValor de ICMS.
nfCadastro[].det[].prod.vICMSSTdecimalValor de ICMSST.
nfCadastro[].det[].prod.vIIdecimalValor de Impostos de Importação.
nfCadastro[].det[].prod.vINSSdecimalValor de INSS.
nfCadastro[].det[].prod.vIPIdecimalValor de IPI.
nfCadastro[].det[].prod.vIRdecimalValor de IR.
nfCadastro[].det[].prod.vISSdecimalValor de ISS.
nfCadastro[].det[].prod.vIbsdecimalValor do IBS.
nfCadastro[].det[].prod.vIbsMundecimalValor do IBS de competência do Município.
nfCadastro[].det[].prod.vIbsUfdecimalValor do IBS de competência da UF.
nfCadastro[].det[].prod.vOutrodecimalOutras despesas acessórias.
nfCadastro[].det[].prod.vPISdecimalValor do PIS.
nfCadastro[].det[].prod.vProddecimalValor Total Bruto dos Produtos.
nfCadastro[].det[].prod.vSegdecimalValor Total do Seguro.
nfCadastro[].det[].prod.vTotItemdecimalValor total do item.
nfCadastro[].det[].prod.vUnComdecimalValor Unitário de Comercialização.
nfCadastro[].det[].prod.vUnTribdecimalValor Unitário de tributação.
nfCadastro[].det[].prod.xProdtextoDescrição do produto ou serviço.
nfCadastro[].det[].prod.xProdOrigtextoDescrição original do produto conforme informado na Nota Fiscal.
nfCadastro[].det[].rastreabilidadeobjetoDados específicos para rastreabilidade do produto.
nfCadastro[].det[].rastreabilidade.codigoAgregacaoLotetextoCódigo de Agregação.
nfCadastro[].det[].rastreabilidade.dataFabricacaoLotetextoData de Fabricação/Produção.
nfCadastro[].det[].rastreabilidade.dataValidadeLotetextoData de Validade.
nfCadastro[].det[].rastreabilidade.numeroLotetextoNúmero do Lote.
nfCadastro[].det[].rastreabilidade.qtdeProdutoLotedecimalQuantidade de Produto.
nfCadastro[].ideobjeto
nfCadastro[].ide.cDenegtexto
nfCadastro[].ide.dCantextoData de cancelamento.
nfCadastro[].ide.dEmitextoData de emissão.
nfCadastro[].ide.dInuttextoData de Inutilização.
nfCadastro[].ide.dRegtextoData de Registro.
nfCadastro[].ide.dSaiEnttextoData de saida.
nfCadastro[].ide.finNFetextoFinalidade de emissão da NFe: 1 - NF-e normal 2 - NF-e complementar 3 - NF-e de ajuste 4 - NF-e de devolução.
nfCadastro[].ide.hEmitextoHora de Emissão.
nfCadastro[].ide.hSaiEnttextoHora de Saída ou da Entrada da Mercadoria/Produto.
nfCadastro[].ide.indPagtextoIndicador da forma de pagamento: 0 - pagamento à vista; 1 - pagamento à prazo; 2 - outros.
nfCadastro[].ide.modtextoCódigo do Modelo do Documento Fiscal: Utilizar o código 55 para identificação da NF-e, emitida em substituição ao modelo 1 ou 1A.
nfCadastro[].ide.nNFtextoNúmero do Documento Fiscal.
nfCadastro[].ide.serietextoSérie do Documento Fiscal.
nfCadastro[].ide.tpAmbtextoTipo de Ambiente = 1-Produção / 2-Homologação.
nfCadastro[].ide.tpNFtextoTipo de Operação: 0-entrada / 1-saída.
nfCadastro[].infoobjetoInformações complementares.
nfCadastro[].info.cImpAPItextoImportado pela API.
nfCadastro[].info.dAlttextoData da Alteração.
nfCadastro[].info.dInctextoData da Inclusão.
nfCadastro[].info.hAlttextoHora da Alteração.
nfCadastro[].info.hInctextoHora da Inclusão.
nfCadastro[].info.uAlttextoUsuário da Alteração.
nfCadastro[].info.uInctextoUsuário da Inclusão.
nfCadastro[].nfDestIntobjeto
nfCadastro[].nfDestInt.cCodCliInttextoCódigo de integração do cliente Fornecedor.
nfCadastro[].nfDestInt.cRazaotexto
nfCadastro[].nfDestInt.cnpj_cpftexto
nfCadastro[].nfDestInt.nCodClinúmero inteiroCódigo do cliente.
nfCadastro[].nfEmitIntobjeto
nfCadastro[].nfEmitInt.cCodEmpInttextoCódigo de integração da empresa.
nfCadastro[].nfEmitInt.nCodEmpnúmero inteiroCódigo da Empresa.
nfCadastro[].pedidoobjetoDados do pedido.
nfCadastro[].pedido.Categoriaslista de objetosDistribuição por Categorias.
nfCadastro[].pedido.Categorias[].cCodigoCategoriatextoCódigo do Categoria.
nfCadastro[].pedido.Categorias[].nPercentualDistribuicaodecimalPercentual da distribuição.
nfCadastro[].pedido.Categorias[].nValorDistribuicaodecimalValor da distribuição.
nfCadastro[].pedido.Categorias[].nValorFixotextoIndica que o valor foi fixado na distribuição (S/N).
nfCadastro[].pedido.Departamentoslista de objetosDistribuição por Departamentos.
nfCadastro[].pedido.Departamentos[].cCodigoDepartamentotextoCódigo do Departamento.
nfCadastro[].pedido.Departamentos[].nPercentualDistribuicaodecimalPercentual da distribuição.
nfCadastro[].pedido.Departamentos[].nValorDistribuicaodecimalValor da distribuição.
nfCadastro[].pedido.Departamentos[].nValorFixotextoIndica que o valor foi fixado na distribuição (S/N).
nfCadastro[].pedido.cCanceladotextoIndica que o Pedido de Venda foi cancelado.
nfCadastro[].pedido.cDevParcialtextoIndica que o Pedido de Venda se foi uma devolução parcial.
nfCadastro[].pedido.cDevolvidotextoIndica que o Pedido de Venda foi devolvido.
nfCadastro[].pedido.cNumPedidotextoNúmero do Pedido do Venda.
nfCadastro[].pedido.dAltPedidotextoData da Alteração do Pedido de Venda.
nfCadastro[].pedido.dCanPedidotextoData de Cancelamento do Pedido de Venda.
nfCadastro[].pedido.dDevPedidotextoData de Cancelamento do Pedido de Venda.
nfCadastro[].pedido.dIncPedidotextoData da Inclusão do Pedido de Venda.
nfCadastro[].pedido.hAltPedidotextoHora da Alteração do Pedido de Venda.
nfCadastro[].pedido.hCanPedidotextoHora de Cancelamento do Pedido de Venda.
nfCadastro[].pedido.hDevPedidotextoHora de Cancelamento do Pedido de Venda.
nfCadastro[].pedido.hIncPedidotextoHora da Inclusão do Pedido de Venda.
nfCadastro[].pedido.nIdPedDevnúmero inteiroId do Pedido de venda devolvido.
nfCadastro[].pedido.nIdProjetonúmero inteiroCódigo do Projeto no Pedido.
nfCadastro[].pedido.nIdVendedornúmero inteiroCódigo do Vendedor no Pedido.
nfCadastro[].pedido.opPedidotextoOperação do Pedido de venda que originou a NF. Pode ser: Vendas 01 Venda de Serviço 11 Venda de Produto 12 Venda de Produto pelo PDV 13 Devolução de Venda 14 Remessa de Produto 16 Nota Complementar de Saída Compras 21 Compra de Produto 23 Devolução ao Fornecedor 24 Retorno de Remessa 26 Nota Complementar de Entrada 22 Compra de Produto (Importação) 28 Ordem de Produção.
nfCadastro[].pedido.uAltPedidotextoUsuário da Alteração do Pedido de Venda.
nfCadastro[].pedido.uCanPedidotextoUsuário de Cancelamento do Pedido de Venda.
nfCadastro[].pedido.uDevPedidotextoUsuário de Cancelamento do Pedido de Venda.
nfCadastro[].pedido.uIncPedidotextoUsuário da Inclusão do Pedido de Venda.
nfCadastro[].tituloslista de objetosTitulos gerados para a nota fiscal.
nfCadastro[].titulos[].cCodCategtextoCódigo da Categoria.
nfCadastro[].titulos[].cCodIntTitulotextoCódigo de integração do título. (Utilizado em títulos criados via API, não é visualizado na tela).
nfCadastro[].titulos[].cDoctexto
nfCadastro[].titulos[].cNumTitulotextoNúmero do título. (Informado pelo usuário / visualizado na tela).
nfCadastro[].titulos[].cPagFormatexto
nfCadastro[].titulos[].dDtEmissaotextoData de emissão do título.
nfCadastro[].titulos[].dDtPrevisaotextoData de previsão de Pagamento/Recebimento.
nfCadastro[].titulos[].dDtVenctextoData de vencimento do título.
nfCadastro[].titulos[].dRegtextoData de Registro.
nfCadastro[].titulos[].nCodCompradornúmero inteiroNúmero do Comprador.
nfCadastro[].titulos[].nCodProjetonúmero inteiroCódigo do Projeto.
nfCadastro[].titulos[].nCodTitRepetnúmero inteiroCódigo do título da repetição.
nfCadastro[].titulos[].nCodTitulonúmero inteiroCódigo do titulo. (Gerado internamente, não é visualizado na tela).
nfCadastro[].titulos[].nCodVendedornúmero inteiroCódigo do Vendedor.
nfCadastro[].titulos[].nParcelanúmero inteiroNúmero da parcela.
nfCadastro[].titulos[].nTotParcnúmero inteiroNúmero total de parcelas.
nfCadastro[].titulos[].nValorTitulodecimalValor do título.
nfCadastro[].totalobjeto
nfCadastro[].total.CBSTotobjetoGrupo de Valores Totais referentes ao CBS.
nfCadastro[].total.CBSTot.vCBCbsdecimalValor total da base de cálculo da CBS.
nfCadastro[].total.CBSTot.vCbsdecimalValor total da CBS.
nfCadastro[].total.CBSTot.vCbsCreddecimalValor total do crédito presumido.
nfCadastro[].total.CBSTot.vCbsDifdecimalValor total do diferimento da CBS.
nfCadastro[].total.IBSTotobjetoGrupo de Valores Totais referentes ao IBS.
nfCadastro[].total.IBSTot.vBCIbsdecimalValor total da base de cálculo do IBS.
nfCadastro[].total.IBSTot.vIbsdecimalValor total do IBS.
nfCadastro[].total.IBSTot.vIbsCreddecimalValor total do crédito presumido.
nfCadastro[].total.IBSTot.vIbsMundecimalValor total do IBS do município.
nfCadastro[].total.IBSTot.vIbsMunDifdecimalValor total do diferimento do IBS do município.
nfCadastro[].total.IBSTot.vIbsUfdecimalValor total do IBS da UF.
nfCadastro[].total.IBSTot.vIbsUfDifdecimalValor total do diferimento do IBS UF.
nfCadastro[].total.ICMSTotobjetoGrupo de Valores Totais referentes ao ICMS.
nfCadastro[].total.ICMSTot.vBCdecimalBase de Cálculo do ICMS.
nfCadastro[].total.ICMSTot.vBCFCPdecimalBase de Cálculo do Fundo de Combate a Pobreza.
nfCadastro[].total.ICMSTot.vBCFCPSTdecimalBase de Cálculo do Fundo de Combate a Pobreza ST.
nfCadastro[].total.ICMSTot.vBCSTdecimalBase de Cálculo do ICMS ST.
nfCadastro[].total.ICMSTot.vCOFINSdecimalValor do COFINS.
nfCadastro[].total.ICMSTot.vDescdecimalValor Total do Desconto.
nfCadastro[].total.ICMSTot.vFCPdecimalValor do Fundo de Combate a Pobreza.
nfCadastro[].total.ICMSTot.vFCPSTdecimalValor do Fundo de Combate a Pobreza ST.
nfCadastro[].total.ICMSTot.vFretedecimalValor Total do Frete.
nfCadastro[].total.ICMSTot.vICMSdecimalValor Total do ICMS.
nfCadastro[].total.ICMSTot.vICMSDesoneradodecimalValor do ICMS Desonerado.
nfCadastro[].total.ICMSTot.vIIdecimalValor Total do II.
nfCadastro[].total.ICMSTot.vIPIdecimalValor Total do IPI.
nfCadastro[].total.ICMSTot.vNFdecimalValor Total da NF-e.
nfCadastro[].total.ICMSTot.vOutrodecimalOutras Despesas acessórias.
nfCadastro[].total.ICMSTot.vPISdecimalValor do PIS.
nfCadastro[].total.ICMSTot.vProddecimalValor Total dos produtos e serviços.
nfCadastro[].total.ICMSTot.vSTdecimalValor Total do ICMS ST.
nfCadastro[].total.ICMSTot.vSegdecimalValor Total do Seguro.
nfCadastro[].total.ICMSTot.vTotTribdecimalValor aproximado total de tributos federais, estaduais e municipais.
nfCadastro[].total.ISSQNtotobjetoGrupo de Valores Totais referentes ao ISSQN.
nfCadastro[].total.ISSQNtot.vBCdecimalBase de Cálculo do ISS.
nfCadastro[].total.ISSQNtot.vCOFINSdecimalValor do COFINS sobre serviços.
nfCadastro[].total.ISSQNtot.vISSdecimalValor Total do ISS.
nfCadastro[].total.ISSQNtot.vPISdecimalValor do PIS sobre serviços.
nfCadastro[].total.ISSQNtot.vServdecimalValor Total dos Serviços sob não-incidência ou não tributados pelo ICMS.
nfCadastro[].total.retTribobjetoGrupo de Retenções de Tributos.
nfCadastro[].total.retTrib.vBCIRRFdecimalBase de Cálculo do IRRF.
nfCadastro[].total.retTrib.vBCRetPrevdecimalBase de Cálculo da Retenção da Previdência Social.
nfCadastro[].total.retTrib.vIRRFdecimalValor Retido do IRRF.
nfCadastro[].total.retTrib.vRetCOFINSdecimalValor Retido de COFINS.
nfCadastro[].total.retTrib.vRetCSLLdecimalValor Retido de CSLL.
nfCadastro[].total.retTrib.vRetPISdecimalValor Retido de PIS.
nfCadastro[].total.retTrib.vRetPrevdecimalValor da Retenção da Previdência Social.
paginanúmero inteiro
registrosnúmero inteiro
total_de_paginasnúmero inteiro
total_de_registrosnúmero inteiro
POST /api/v1/produtos/nfconsultar/
curl -s https://app.omie.com.br/api/v1/produtos/nfconsultar/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "ListarNF", "param": [{"pagina": 1, "registros_por_pagina": 20, "ordenar_por": "CODIGO"}]}'