Produtos ·
NFConsultarRealiza as consultas na Nota Fiscal
2consultas
0alterações
Claude 2 de 2 · ChatGPT 1 de 2 · MCP 2 de 2pelos assistentes de IA
JSON · XMLformato
Consulta uma Nota Fiscal.
Obrigatórios 0
Nenhum campo obrigatório.
Opcionais 12Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
cChaveNFe | texto · até 44 | Chave da NF-e. |
cCodNFInt | texto · até 20 | Código de Integração da NF (DEPRECATED). |
cDetalhesPedido | texto · até 1 | Exibe os detalhes do pedido que originou a Nota Fiscal. Preecher com "S" ou "N". |
cnpj_cpf | texto · até 100 | CNPJ / CPF. |
dEmi | texto · até 10 | Data de emissão. |
nCodNF | número inteiro | Código de Identificação da NF. É o nIdNF devolvido no grupo compl por ListarNF e ConsultarNF. |
nIdCliente | número inteiro | ID do Cliente. |
nIdPedido | número inteiro | Código de identificação do pedido. Interno, utilizando apenas nas APIs. |
nNF | texto · até 10 | Número do Documento Fiscal. |
serie | texto · até 5 | Série do Documento Fiscal. |
tpAmb | texto · até 1 | Tipo de Ambiente. Pode Ser: 1 - Produção 2 - Homologação. |
tpNF | texto · até 1 | Tipo de Operação: 0-entrada / 1-saída. |
Retorno 9O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
compl | objeto | Dados complementares da NF. |
compl.cChaveNFe | texto | Chave da NF-e. |
compl.cCodCateg | texto | Código da categoria. |
compl.cModFrete | texto | Código da modalidade do frete. |
compl.nIdNF | número inteiro | Código da Nota Fiscal. Interno, utilizando apenas nas APIs. |
compl.nIdPedido | número inteiro | Código de identificação do pedido. Interno, utilizando apenas nas APIs. |
compl.nIdReceb | número inteiro | Identificação do Recebimento. Interno, utilizando apenas nas APIs. |
compl.nIdTransp | número inteiro | Identificação da Transportadora. Interno, utilizando apenas nas APIs. |
det | lista de objetos | |
det[].itemPedido | objeto | Dados do Item do Pedido de Venda. |
det[].itemPedido.cItemDevolvido | texto | Indica se o Item do Pedido de Vendas foi devolvido (S/N). |
det[].itemPedido.nIdItemPedido | número inteiro | Id do item do Pedido de Venda. |
det[].itemPedido.nItemQtdDevolvida | decimal | Quantidade devolvida do Item do Pedido de Vendas. |
det[].nfProdInt | objeto | |
det[].nfProdInt.cCodItemInt | texto | Código de Integração do Item. |
det[].nfProdInt.cCodProdInt | texto | Código de Integração do produto. |
det[].nfProdInt.nCodItem | número inteiro | Código do item. |
det[].nfProdInt.nCodProd | número inteiro | Código do Produto. |
det[].prod | objeto | |
det[].prod.CFOP | texto | Código Fiscal de Operações e Prestações. |
det[].prod.EXTIPI | texto | DEPRECATED. |
det[].prod.NCM | texto | |
det[].prod.cCOFINSRetido | texto | Indica se houve retenção de COFINS Possíveis valores: S = Sim N = Não. |
det[].prod.cCSLLRetido | texto | Indica se houve retenção de CSLL Possíveis valores: S = Sim N = Não. |
det[].prod.cEAN | texto | GTIN (Global Trade Item Number) do produto, antigo código EAN ou código de barras. |
det[].prod.cEANTrib | texto | GTIN (Global Trade Item Number) da unidade tributável, antigo código EAN ou código de barras. |
det[].prod.cICMSRetido | texto | Indica se houve retenção de ICMS Possíveis valores: S = Sim N = Não. |
det[].prod.cINSSRetido | texto | Indica se houve retenção de INSS Possíveis valores: S = Sim N = Não. |
det[].prod.cIRRetido | texto | Indica se houve retenção de IR Possíveis valores: S = Sim N = Não. |
det[].prod.cISSRetido | texto | Indica se houve retenção de ISS Possíveis valores: S = Sim N = Não. |
det[].prod.cOrigem | texto | |
det[].prod.cPISRetido | texto | Indica se houve retenção de PIS Possíveis valores: S = Sim N = Não. |
det[].prod.cProd | texto | Código do produto ou serviço. |
det[].prod.cProdOrig | texto | Código do produto conforme informado na Nota Fiscal. |
det[].prod.codigo_local_estoque | número inteiro | Código do local do estoque. |
det[].prod.indTot | decimal | Indica se valor do Item (vProd) entra no valor total da NF-e (vProd). |
det[].prod.nCMCTotal | decimal | CMC Total. |
det[].prod.nCMCUnitario | decimal | CMC Unitário. |
det[].prod.pAliqCbs | decimal | Alíquota da CBS. |
det[].prod.pAliqIBSMun | decimal | Alíquota do IBS de competência do Município. |
det[].prod.pAliqIBSUF | decimal | Alíquota do IBS de competência das UF. |
det[].prod.pCOFINS | decimal | Alíquota de COFINS. |
det[].prod.pCSLL | decimal | Alíquota de Contribuição Social sobre Lucro Líquido. |
det[].prod.pFCP | decimal | Alíquota de FCP. |
det[].prod.pFCPST | decimal | Alíquota de FCPST. |
det[].prod.pICMS | decimal | Alíquota de ICMS. |
det[].prod.pICMSST | decimal | Alíquota de ICMSST. |
det[].prod.pINSS | decimal | Alíquota de INSS. |
det[].prod.pIPI | decimal | Alíquota de IPI. |
det[].prod.pIR | decimal | Alíquota de IR. |
det[].prod.pISS | decimal | Alíquota de ISS. |
det[].prod.pIcmsInterest | decimal | Alíquota Interestadual das UF envolvidas. |
det[].prod.pIcmsUfDest | decimal | Alíquota interna da UF de Destino. |
det[].prod.pMVAST | decimal | Percentual da margem do valor adicionado da base de cálculo do ICMS ST. |
det[].prod.pPIS | decimal | Alíquota de PIS. |
det[].prod.pRedBC | decimal | Percentual de Redução da Base de Cálculo do ICMS. |
det[].prod.pRedBcICMDest | decimal | Percentual de Redução da Base de Cálculo do ICMS Destino. |
det[].prod.pReducaoCbs | decimal | Percentual da redução de alíquota do cClassTrib. |
det[].prod.pReducaoIbsMun | decimal | Percentual da redução de alíquota do cClassTrib - IBS UF. |
det[].prod.pReducaoIbsUf | decimal | Percentual da redução de alíquota do cClassTrib - IBS UF. |
det[].prod.qCom | decimal | Quantidade Comercial. |
det[].prod.qTrib | decimal | Quantidade Tributável. |
det[].prod.uCom | texto | Unidade Comercial. |
det[].prod.uTrib | texto | Unidade Tributável. |
det[].prod.vAliqCbs | decimal | Valor da alíquota da CBS. |
det[].prod.vAliqIbsMun | decimal | Valor da alíquota do IBS do Município. |
det[].prod.vAliqIbsUf | decimal | Valor da alíquota do IBS da UF. |
det[].prod.vBC | decimal | Base de Cálculo do ICMS. |
det[].prod.vBCCOFINS | decimal | Base de Cálculo do COFINS. |
det[].prod.vBCIPI | decimal | Base de Cálculo do IPI. |
det[].prod.vBCISS | decimal | Base de Cálculo do ISS. |
det[].prod.vBCIbsCbs | decimal | Base de cálculo do IBS e CBS. |
det[].prod.vBCPIS | decimal | Base de Cálculo do PIS. |
det[].prod.vBCST | decimal | Base de Cálculo do ICMS ST. |
det[].prod.vBCUFDest | decimal | Base de Cálculo do ICMS na UF de Destino. |
det[].prod.vCOFINS | decimal | Valor de COFINS. |
det[].prod.vCSLL | decimal | Valor da Contribuição Social sobre Lucro Líquido. |
det[].prod.vCbs | decimal | Valor da CBS. |
det[].prod.vDesc | decimal | Valor do Desconto. |
det[].prod.vFCP | decimal | Valor do ICMS relativo ao Fundo de Combate à Pobreza (FCP) da UF de Destino. |
det[].prod.vFCPST | decimal | Valor do FCPST. |
det[].prod.vFrete | decimal | Valor Total do Frete. |
det[].prod.vICMDest | decimal | Valor do ICMS Interestadual para a UF de Destino. |
det[].prod.vICMRemet | decimal | Valor do ICMS Interestadual para a UF do Remetente. |
det[].prod.vICMS | decimal | Valor de ICMS. |
det[].prod.vICMSST | decimal | Valor de ICMSST. |
det[].prod.vII | decimal | Valor de Impostos de Importação. |
det[].prod.vINSS | decimal | Valor de INSS. |
det[].prod.vIPI | decimal | Valor de IPI. |
det[].prod.vIR | decimal | Valor de IR. |
det[].prod.vISS | decimal | Valor de ISS. |
det[].prod.vIbs | decimal | Valor do IBS. |
det[].prod.vIbsMun | decimal | Valor do IBS de competência do Município. |
det[].prod.vIbsUf | decimal | Valor do IBS de competência da UF. |
det[].prod.vOutro | decimal | Outras despesas acessórias. |
det[].prod.vPIS | decimal | Valor do PIS. |
det[].prod.vProd | decimal | Valor Total Bruto dos Produtos. |
det[].prod.vSeg | decimal | Valor Total do Seguro. |
det[].prod.vTotItem | decimal | Valor total do item. |
det[].prod.vUnCom | decimal | Valor Unitário de Comercialização. |
det[].prod.vUnTrib | decimal | Valor Unitário de tributação. |
det[].prod.xProd | texto | Descrição do produto ou serviço. |
det[].prod.xProdOrig | texto | Descrição original do produto conforme informado na Nota Fiscal. |
det[].rastreabilidade | objeto | Dados específicos para rastreabilidade do produto. |
det[].rastreabilidade.codigoAgregacaoLote | texto | Código de Agregação. |
det[].rastreabilidade.dataFabricacaoLote | texto | Data de Fabricação/Produção. |
det[].rastreabilidade.dataValidadeLote | texto | Data de Validade. |
det[].rastreabilidade.numeroLote | texto | Número do Lote. |
det[].rastreabilidade.qtdeProdutoLote | decimal | Quantidade de Produto. |
ide | objeto | |
ide.cDeneg | texto | |
ide.dCan | texto | Data de cancelamento. |
ide.dEmi | texto | Data de emissão. |
ide.dInut | texto | Data de Inutilização. |
ide.dReg | texto | Data de Registro. |
ide.dSaiEnt | texto | Data de saida. |
ide.finNFe | texto | Finalidade 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.hEmi | texto | Hora de Emissão. |
ide.hSaiEnt | texto | Hora de Saída ou da Entrada da Mercadoria/Produto. |
ide.indPag | texto | Indicador da forma de pagamento: 0 - pagamento à vista; 1 - pagamento à prazo; 2 - outros. |
ide.mod | texto | Có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.nNF | texto | Número do Documento Fiscal. |
ide.serie | texto | Série do Documento Fiscal. |
ide.tpAmb | texto | Tipo de Ambiente = 1-Produção / 2-Homologação. |
ide.tpNF | texto | Tipo de Operação: 0-entrada / 1-saída. |
info | objeto | Informações complementares. |
info.cImpAPI | texto | Importado pela API. |
info.dAlt | texto | Data da Alteração. |
info.dInc | texto | Data da Inclusão. |
info.hAlt | texto | Hora da Alteração. |
info.hInc | texto | Hora da Inclusão. |
info.uAlt | texto | Usuário da Alteração. |
info.uInc | texto | Usuário da Inclusão. |
nfDestInt | objeto | |
nfDestInt.cCodCliInt | texto | Código de integração do cliente Fornecedor. |
nfDestInt.cRazao | texto | |
nfDestInt.cnpj_cpf | texto | |
nfDestInt.nCodCli | número inteiro | Código do cliente. |
nfEmitInt | objeto | |
nfEmitInt.cCodEmpInt | texto | Código de integração da empresa. |
nfEmitInt.nCodEmp | número inteiro | Código da Empresa. |
pedido | objeto | Dados do pedido. |
pedido.Categorias | lista de objetos | Distribuição por Categorias. |
pedido.Categorias[].cCodigoCategoria | texto | Código do Categoria. |
pedido.Categorias[].nPercentualDistribuicao | decimal | Percentual da distribuição. |
pedido.Categorias[].nValorDistribuicao | decimal | Valor da distribuição. |
pedido.Categorias[].nValorFixo | texto | Indica que o valor foi fixado na distribuição (S/N). |
pedido.Departamentos | lista de objetos | Distribuição por Departamentos. |
pedido.Departamentos[].cCodigoDepartamento | texto | Código do Departamento. |
pedido.Departamentos[].nPercentualDistribuicao | decimal | Percentual da distribuição. |
pedido.Departamentos[].nValorDistribuicao | decimal | Valor da distribuição. |
pedido.Departamentos[].nValorFixo | texto | Indica que o valor foi fixado na distribuição (S/N). |
pedido.cCancelado | texto | Indica que o Pedido de Venda foi cancelado. |
pedido.cDevParcial | texto | Indica que o Pedido de Venda se foi uma devolução parcial. |
pedido.cDevolvido | texto | Indica que o Pedido de Venda foi devolvido. |
pedido.cNumPedido | texto | Número do Pedido do Venda. |
pedido.dAltPedido | texto | Data da Alteração do Pedido de Venda. |
pedido.dCanPedido | texto | Data de Cancelamento do Pedido de Venda. |
pedido.dDevPedido | texto | Data de Cancelamento do Pedido de Venda. |
pedido.dIncPedido | texto | Data da Inclusão do Pedido de Venda. |
pedido.hAltPedido | texto | Hora da Alteração do Pedido de Venda. |
pedido.hCanPedido | texto | Hora de Cancelamento do Pedido de Venda. |
pedido.hDevPedido | texto | Hora de Cancelamento do Pedido de Venda. |
pedido.hIncPedido | texto | Hora da Inclusão do Pedido de Venda. |
pedido.nIdPedDev | número inteiro | Id do Pedido de venda devolvido. |
pedido.nIdProjeto | número inteiro | Código do Projeto no Pedido. |
pedido.nIdVendedor | número inteiro | Código do Vendedor no Pedido. |
pedido.opPedido | texto | Operaçã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.uAltPedido | texto | Usuário da Alteração do Pedido de Venda. |
pedido.uCanPedido | texto | Usuário de Cancelamento do Pedido de Venda. |
pedido.uDevPedido | texto | Usuário de Cancelamento do Pedido de Venda. |
pedido.uIncPedido | texto | Usuário da Inclusão do Pedido de Venda. |
titulos | lista de objetos | Titulos gerados para a nota fiscal. |
titulos[].cCodCateg | texto | Código da Categoria. |
titulos[].cCodIntTitulo | texto | Código de integração do título. (Utilizado em títulos criados via API, não é visualizado na tela). |
titulos[].cDoc | texto | |
titulos[].cNumTitulo | texto | Número do título. (Informado pelo usuário / visualizado na tela). |
titulos[].cPagForma | texto | |
titulos[].dDtEmissao | texto | Data de emissão do título. |
titulos[].dDtPrevisao | texto | Data de previsão de Pagamento/Recebimento. |
titulos[].dDtVenc | texto | Data de vencimento do título. |
titulos[].dReg | texto | Data de Registro. |
titulos[].nCodComprador | número inteiro | Número do Comprador. |
titulos[].nCodProjeto | número inteiro | Código do Projeto. |
titulos[].nCodTitRepet | número inteiro | Código do título da repetição. |
titulos[].nCodTitulo | número inteiro | Código do titulo. (Gerado internamente, não é visualizado na tela). |
titulos[].nCodVendedor | número inteiro | Código do Vendedor. |
titulos[].nParcela | número inteiro | Número da parcela. |
titulos[].nTotParc | número inteiro | Número total de parcelas. |
titulos[].nValorTitulo | decimal | Valor do título. |
total | objeto | |
total.CBSTot | objeto | Grupo de Valores Totais referentes ao CBS. |
total.CBSTot.vCBCbs | decimal | Valor total da base de cálculo da CBS. |
total.CBSTot.vCbs | decimal | Valor total da CBS. |
total.CBSTot.vCbsCred | decimal | Valor total do crédito presumido. |
total.CBSTot.vCbsDif | decimal | Valor total do diferimento da CBS. |
total.IBSTot | objeto | Grupo de Valores Totais referentes ao IBS. |
total.IBSTot.vBCIbs | decimal | Valor total da base de cálculo do IBS. |
total.IBSTot.vIbs | decimal | Valor total do IBS. |
total.IBSTot.vIbsCred | decimal | Valor total do crédito presumido. |
total.IBSTot.vIbsMun | decimal | Valor total do IBS do município. |
total.IBSTot.vIbsMunDif | decimal | Valor total do diferimento do IBS do município. |
total.IBSTot.vIbsUf | decimal | Valor total do IBS da UF. |
total.IBSTot.vIbsUfDif | decimal | Valor total do diferimento do IBS UF. |
total.ICMSTot | objeto | Grupo de Valores Totais referentes ao ICMS. |
total.ICMSTot.vBC | decimal | Base de Cálculo do ICMS. |
total.ICMSTot.vBCFCP | decimal | Base de Cálculo do Fundo de Combate a Pobreza. |
total.ICMSTot.vBCFCPST | decimal | Base de Cálculo do Fundo de Combate a Pobreza ST. |
total.ICMSTot.vBCST | decimal | Base de Cálculo do ICMS ST. |
total.ICMSTot.vCOFINS | decimal | Valor do COFINS. |
total.ICMSTot.vDesc | decimal | Valor Total do Desconto. |
total.ICMSTot.vFCP | decimal | Valor do Fundo de Combate a Pobreza. |
total.ICMSTot.vFCPST | decimal | Valor do Fundo de Combate a Pobreza ST. |
total.ICMSTot.vFrete | decimal | Valor Total do Frete. |
total.ICMSTot.vICMS | decimal | Valor Total do ICMS. |
total.ICMSTot.vICMSDesonerado | decimal | Valor do ICMS Desonerado. |
total.ICMSTot.vII | decimal | Valor Total do II. |
total.ICMSTot.vIPI | decimal | Valor Total do IPI. |
total.ICMSTot.vNF | decimal | Valor Total da NF-e. |
total.ICMSTot.vOutro | decimal | Outras Despesas acessórias. |
total.ICMSTot.vPIS | decimal | Valor do PIS. |
total.ICMSTot.vProd | decimal | Valor Total dos produtos e serviços. |
total.ICMSTot.vST | decimal | Valor Total do ICMS ST. |
total.ICMSTot.vSeg | decimal | Valor Total do Seguro. |
total.ICMSTot.vTotTrib | decimal | Valor aproximado total de tributos federais, estaduais e municipais. |
total.ISSQNtot | objeto | Grupo de Valores Totais referentes ao ISSQN. |
total.ISSQNtot.vBC | decimal | Base de Cálculo do ISS. |
total.ISSQNtot.vCOFINS | decimal | Valor do COFINS sobre serviços. |
total.ISSQNtot.vISS | decimal | Valor Total do ISS. |
total.ISSQNtot.vPIS | decimal | Valor do PIS sobre serviços. |
total.ISSQNtot.vServ | decimal | Valor Total dos Serviços sob não-incidência ou não tributados pelo ICMS. |
total.retTrib | objeto | Grupo de Retenções de Tributos. |
total.retTrib.vBCIRRF | decimal | Base de Cálculo do IRRF. |
total.retTrib.vBCRetPrev | decimal | Base de Cálculo da Retenção da Previdência Social. |
total.retTrib.vIRRF | decimal | Valor Retido do IRRF. |
total.retTrib.vRetCOFINS | decimal | Valor Retido de COFINS. |
total.retTrib.vRetCSLL | decimal | Valor Retido de CSLL. |
total.retTrib.vRetPIS | decimal | Valor Retido de PIS. |
total.retTrib.vRetPrev | decimal | Valor 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"}]}'import os
import requests
corpo = {'call': 'ConsultarNF', 'param': [{'nCodNF': 0, 'nNF': '1'}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/produtos/nfconsultar/",
headers={"Authorization": f"Bearer {os.environ['TOKEN_DO_APLICATIVO']}"},
json=corpo,
timeout=60,
)
print(resp.json())const resp = await fetch("https://app.omie.com.br/api/v1/produtos/nfconsultar/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "ConsultarNF",
"param": [
{
"nCodNF": 0,
"nNF": "1"
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/produtos/nfconsultar/");
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("TOKEN_DO_APLICATIVO"),
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => <<<'JSON'
{
"call": "ConsultarNF",
"param": [
{
"nCodNF": 0,
"nNF": "1"
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/produtos/nfconsultar/")
corpo = <<~'JSON'
{
"call": "ConsultarNF",
"param": [
{
"nCodNF": 0,
"nNF": "1"
}
]
}
JSON
resp = Net::HTTP.post(uri, corpo,
"Authorization" => "Bearer #{ENV.fetch('TOKEN_DO_APLICATIVO')}",
"Content-Type" => "application/json")
puts resp.bodyimport java.net.URI;
import java.net.http.*;
var corpo = """
{
"call": "ConsultarNF",
"param": [
{
"nCodNF": 0,
"nNF": "1"
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/produtos/nfconsultar/"))
.header("Authorization", "Bearer " + System.getenv("TOKEN_DO_APLICATIVO"))
.header("Content-Type", "application/json")
.POST(HttpRequest.BodyPublishers.ofString(corpo))
.build();
var resp = HttpClient.newHttpClient().send(pedido, HttpResponse.BodyHandlers.ofString());
System.out.println(resp.body());// TokenDoAplicativo: parâmetro do Power BI (Página Inicial > Gerenciar parâmetros)
let
Resposta = Web.Contents(
"https://app.omie.com.br/api/v1/produtos/nfconsultar/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""ConsultarNF"", ""param"": [{""nCodNF"": 0, ""nNF"": ""1""}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosListar as Notas Fiscais cadastradas.
Obrigatórios 0
Nenhum campo obrigatório.
Opcionais 33Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
apenas_importado_api | texto · até 1 | |
cApenasResumo | texto · até 1 | Exibe apenas a resumo da Nota Fiscal. Preencher com "S" ou "N". |
cDetalhesPedido | texto · até 1 | Exibe os detalhes do pedido que originou a Nota Fiscal. Preecher com "S" ou "N". |
cNumeroPedidoCliente | texto · até 30 | Pesquisa pelo numero do Pedido do Cliente. |
cSerie | texto · até 5 | Série da NF-e. |
cnpj_cpf | texto · até 100 | CNPJ / CPF. |
dCanFinal | texto · até 10 | Data de Cancelamento final. |
dCanInicial | texto · até 10 | Data de Cancelamento inicial. |
dEmiFinal | texto · até 10 | Data de Emissão final. |
dEmiInicial | texto · até 10 | Data de Emissão inicial. |
dInutFinal | texto · até 10 | Data de Inutilização final. |
dInutInicial | texto · até 10 | Data de Inutilização inicial. |
dRegFinal | texto · até 10 | Data de Registro final. |
dRegInicial | texto · até 10 | Data de Registro inicial. |
dSaiEntFinal | texto · até 10 | Data de Saida final. |
dSaiEntInicial | texto · até 10 | Data de Saida inicial. |
filtrar_apenas_alteracao | texto · até 1 | |
filtrar_apenas_inclusao | texto · até 1 | |
filtrar_por_data_ate | texto · até 10 | |
filtrar_por_data_de | texto · até 10 | |
filtrar_por_status | texto · até 1 | Status da NF: N-Não cancelada C-Cancelada. |
hEmiFinal | texto · até 8 | Hora de Emissão final. |
hEmiInicial | texto · até 8 | Hora de Emissão inicial. |
nIdCliente | número inteiro | ID do Cliente. |
nNFFinal | número inteiro | Número da Nota Fiscal final. |
nNFInicial | número inteiro | Número da Nota Fiscal inicial. |
opPedido | texto · até 2 | Operaçã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_decrescente | texto · até 1 | Ordem decrescente. |
ordenar_por | texto · até 100 | |
pagina | número inteiro | |
registros_por_pagina | número inteiro | |
tpAmb | texto · até 1 | Tipo de Ambiente. Pode Ser: 1 - Produção 2 - Homologação. |
tpNF | texto · até 1 | Tipo de Operação. Pode ser: 0 - Entrada 1 - Saída. |
Descontinuados 1Ainda aceitos, fora do fluxo principal
| Campo | Tipo | Descrição |
|---|---|---|
ordem_descrescentedescontinuado | texto · até 1 | DEPRECATED. |
Retorno 5O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
nfCadastro | lista de objetos | |
nfCadastro[].compl | objeto | Dados complementares da NF. |
nfCadastro[].compl.cChaveNFe | texto | Chave da NF-e. |
nfCadastro[].compl.cCodCateg | texto | Código da categoria. |
nfCadastro[].compl.cModFrete | texto | Código da modalidade do frete. |
nfCadastro[].compl.nIdNF | número inteiro | Código da Nota Fiscal. Interno, utilizando apenas nas APIs. |
nfCadastro[].compl.nIdPedido | número inteiro | Código de identificação do pedido. Interno, utilizando apenas nas APIs. |
nfCadastro[].compl.nIdReceb | número inteiro | Identificação do Recebimento. Interno, utilizando apenas nas APIs. |
nfCadastro[].compl.nIdTransp | número inteiro | Identificação da Transportadora. Interno, utilizando apenas nas APIs. |
nfCadastro[].det | lista de objetos | |
nfCadastro[].det[].itemPedido | objeto | Dados do Item do Pedido de Venda. |
nfCadastro[].det[].itemPedido.cItemDevolvido | texto | Indica se o Item do Pedido de Vendas foi devolvido (S/N). |
nfCadastro[].det[].itemPedido.nIdItemPedido | número inteiro | Id do item do Pedido de Venda. |
nfCadastro[].det[].itemPedido.nItemQtdDevolvida | decimal | Quantidade devolvida do Item do Pedido de Vendas. |
nfCadastro[].det[].nfProdInt | objeto | |
nfCadastro[].det[].nfProdInt.cCodItemInt | texto | Código de Integração do Item. |
nfCadastro[].det[].nfProdInt.cCodProdInt | texto | Código de Integração do produto. |
nfCadastro[].det[].nfProdInt.nCodItem | número inteiro | Código do item. |
nfCadastro[].det[].nfProdInt.nCodProd | número inteiro | Código do Produto. |
nfCadastro[].det[].prod | objeto | |
nfCadastro[].det[].prod.CFOP | texto | Código Fiscal de Operações e Prestações. |
nfCadastro[].det[].prod.EXTIPI | texto | DEPRECATED. |
nfCadastro[].det[].prod.NCM | texto | |
nfCadastro[].det[].prod.cCOFINSRetido | texto | Indica se houve retenção de COFINS Possíveis valores: S = Sim N = Não. |
nfCadastro[].det[].prod.cCSLLRetido | texto | Indica se houve retenção de CSLL Possíveis valores: S = Sim N = Não. |
nfCadastro[].det[].prod.cEAN | texto | GTIN (Global Trade Item Number) do produto, antigo código EAN ou código de barras. |
nfCadastro[].det[].prod.cEANTrib | texto | GTIN (Global Trade Item Number) da unidade tributável, antigo código EAN ou código de barras. |
nfCadastro[].det[].prod.cICMSRetido | texto | Indica se houve retenção de ICMS Possíveis valores: S = Sim N = Não. |
nfCadastro[].det[].prod.cINSSRetido | texto | Indica se houve retenção de INSS Possíveis valores: S = Sim N = Não. |
nfCadastro[].det[].prod.cIRRetido | texto | Indica se houve retenção de IR Possíveis valores: S = Sim N = Não. |
nfCadastro[].det[].prod.cISSRetido | texto | Indica se houve retenção de ISS Possíveis valores: S = Sim N = Não. |
nfCadastro[].det[].prod.cOrigem | texto | |
nfCadastro[].det[].prod.cPISRetido | texto | Indica se houve retenção de PIS Possíveis valores: S = Sim N = Não. |
nfCadastro[].det[].prod.cProd | texto | Código do produto ou serviço. |
nfCadastro[].det[].prod.cProdOrig | texto | Código do produto conforme informado na Nota Fiscal. |
nfCadastro[].det[].prod.codigo_local_estoque | número inteiro | Código do local do estoque. |
nfCadastro[].det[].prod.indTot | decimal | Indica se valor do Item (vProd) entra no valor total da NF-e (vProd). |
nfCadastro[].det[].prod.nCMCTotal | decimal | CMC Total. |
nfCadastro[].det[].prod.nCMCUnitario | decimal | CMC Unitário. |
nfCadastro[].det[].prod.pAliqCbs | decimal | Alíquota da CBS. |
nfCadastro[].det[].prod.pAliqIBSMun | decimal | Alíquota do IBS de competência do Município. |
nfCadastro[].det[].prod.pAliqIBSUF | decimal | Alíquota do IBS de competência das UF. |
nfCadastro[].det[].prod.pCOFINS | decimal | Alíquota de COFINS. |
nfCadastro[].det[].prod.pCSLL | decimal | Alíquota de Contribuição Social sobre Lucro Líquido. |
nfCadastro[].det[].prod.pFCP | decimal | Alíquota de FCP. |
nfCadastro[].det[].prod.pFCPST | decimal | Alíquota de FCPST. |
nfCadastro[].det[].prod.pICMS | decimal | Alíquota de ICMS. |
nfCadastro[].det[].prod.pICMSST | decimal | Alíquota de ICMSST. |
nfCadastro[].det[].prod.pINSS | decimal | Alíquota de INSS. |
nfCadastro[].det[].prod.pIPI | decimal | Alíquota de IPI. |
nfCadastro[].det[].prod.pIR | decimal | Alíquota de IR. |
nfCadastro[].det[].prod.pISS | decimal | Alíquota de ISS. |
nfCadastro[].det[].prod.pIcmsInterest | decimal | Alíquota Interestadual das UF envolvidas. |
nfCadastro[].det[].prod.pIcmsUfDest | decimal | Alíquota interna da UF de Destino. |
nfCadastro[].det[].prod.pMVAST | decimal | Percentual da margem do valor adicionado da base de cálculo do ICMS ST. |
nfCadastro[].det[].prod.pPIS | decimal | Alíquota de PIS. |
nfCadastro[].det[].prod.pRedBC | decimal | Percentual de Redução da Base de Cálculo do ICMS. |
nfCadastro[].det[].prod.pRedBcICMDest | decimal | Percentual de Redução da Base de Cálculo do ICMS Destino. |
nfCadastro[].det[].prod.pReducaoCbs | decimal | Percentual da redução de alíquota do cClassTrib. |
nfCadastro[].det[].prod.pReducaoIbsMun | decimal | Percentual da redução de alíquota do cClassTrib - IBS UF. |
nfCadastro[].det[].prod.pReducaoIbsUf | decimal | Percentual da redução de alíquota do cClassTrib - IBS UF. |
nfCadastro[].det[].prod.qCom | decimal | Quantidade Comercial. |
nfCadastro[].det[].prod.qTrib | decimal | Quantidade Tributável. |
nfCadastro[].det[].prod.uCom | texto | Unidade Comercial. |
nfCadastro[].det[].prod.uTrib | texto | Unidade Tributável. |
nfCadastro[].det[].prod.vAliqCbs | decimal | Valor da alíquota da CBS. |
nfCadastro[].det[].prod.vAliqIbsMun | decimal | Valor da alíquota do IBS do Município. |
nfCadastro[].det[].prod.vAliqIbsUf | decimal | Valor da alíquota do IBS da UF. |
nfCadastro[].det[].prod.vBC | decimal | Base de Cálculo do ICMS. |
nfCadastro[].det[].prod.vBCCOFINS | decimal | Base de Cálculo do COFINS. |
nfCadastro[].det[].prod.vBCIPI | decimal | Base de Cálculo do IPI. |
nfCadastro[].det[].prod.vBCISS | decimal | Base de Cálculo do ISS. |
nfCadastro[].det[].prod.vBCIbsCbs | decimal | Base de cálculo do IBS e CBS. |
nfCadastro[].det[].prod.vBCPIS | decimal | Base de Cálculo do PIS. |
nfCadastro[].det[].prod.vBCST | decimal | Base de Cálculo do ICMS ST. |
nfCadastro[].det[].prod.vBCUFDest | decimal | Base de Cálculo do ICMS na UF de Destino. |
nfCadastro[].det[].prod.vCOFINS | decimal | Valor de COFINS. |
nfCadastro[].det[].prod.vCSLL | decimal | Valor da Contribuição Social sobre Lucro Líquido. |
nfCadastro[].det[].prod.vCbs | decimal | Valor da CBS. |
nfCadastro[].det[].prod.vDesc | decimal | Valor do Desconto. |
nfCadastro[].det[].prod.vFCP | decimal | Valor do ICMS relativo ao Fundo de Combate à Pobreza (FCP) da UF de Destino. |
nfCadastro[].det[].prod.vFCPST | decimal | Valor do FCPST. |
nfCadastro[].det[].prod.vFrete | decimal | Valor Total do Frete. |
nfCadastro[].det[].prod.vICMDest | decimal | Valor do ICMS Interestadual para a UF de Destino. |
nfCadastro[].det[].prod.vICMRemet | decimal | Valor do ICMS Interestadual para a UF do Remetente. |
nfCadastro[].det[].prod.vICMS | decimal | Valor de ICMS. |
nfCadastro[].det[].prod.vICMSST | decimal | Valor de ICMSST. |
nfCadastro[].det[].prod.vII | decimal | Valor de Impostos de Importação. |
nfCadastro[].det[].prod.vINSS | decimal | Valor de INSS. |
nfCadastro[].det[].prod.vIPI | decimal | Valor de IPI. |
nfCadastro[].det[].prod.vIR | decimal | Valor de IR. |
nfCadastro[].det[].prod.vISS | decimal | Valor de ISS. |
nfCadastro[].det[].prod.vIbs | decimal | Valor do IBS. |
nfCadastro[].det[].prod.vIbsMun | decimal | Valor do IBS de competência do Município. |
nfCadastro[].det[].prod.vIbsUf | decimal | Valor do IBS de competência da UF. |
nfCadastro[].det[].prod.vOutro | decimal | Outras despesas acessórias. |
nfCadastro[].det[].prod.vPIS | decimal | Valor do PIS. |
nfCadastro[].det[].prod.vProd | decimal | Valor Total Bruto dos Produtos. |
nfCadastro[].det[].prod.vSeg | decimal | Valor Total do Seguro. |
nfCadastro[].det[].prod.vTotItem | decimal | Valor total do item. |
nfCadastro[].det[].prod.vUnCom | decimal | Valor Unitário de Comercialização. |
nfCadastro[].det[].prod.vUnTrib | decimal | Valor Unitário de tributação. |
nfCadastro[].det[].prod.xProd | texto | Descrição do produto ou serviço. |
nfCadastro[].det[].prod.xProdOrig | texto | Descrição original do produto conforme informado na Nota Fiscal. |
nfCadastro[].det[].rastreabilidade | objeto | Dados específicos para rastreabilidade do produto. |
nfCadastro[].det[].rastreabilidade.codigoAgregacaoLote | texto | Código de Agregação. |
nfCadastro[].det[].rastreabilidade.dataFabricacaoLote | texto | Data de Fabricação/Produção. |
nfCadastro[].det[].rastreabilidade.dataValidadeLote | texto | Data de Validade. |
nfCadastro[].det[].rastreabilidade.numeroLote | texto | Número do Lote. |
nfCadastro[].det[].rastreabilidade.qtdeProdutoLote | decimal | Quantidade de Produto. |
nfCadastro[].ide | objeto | |
nfCadastro[].ide.cDeneg | texto | |
nfCadastro[].ide.dCan | texto | Data de cancelamento. |
nfCadastro[].ide.dEmi | texto | Data de emissão. |
nfCadastro[].ide.dInut | texto | Data de Inutilização. |
nfCadastro[].ide.dReg | texto | Data de Registro. |
nfCadastro[].ide.dSaiEnt | texto | Data de saida. |
nfCadastro[].ide.finNFe | texto | Finalidade 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.hEmi | texto | Hora de Emissão. |
nfCadastro[].ide.hSaiEnt | texto | Hora de Saída ou da Entrada da Mercadoria/Produto. |
nfCadastro[].ide.indPag | texto | Indicador da forma de pagamento: 0 - pagamento à vista; 1 - pagamento à prazo; 2 - outros. |
nfCadastro[].ide.mod | texto | Có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.nNF | texto | Número do Documento Fiscal. |
nfCadastro[].ide.serie | texto | Série do Documento Fiscal. |
nfCadastro[].ide.tpAmb | texto | Tipo de Ambiente = 1-Produção / 2-Homologação. |
nfCadastro[].ide.tpNF | texto | Tipo de Operação: 0-entrada / 1-saída. |
nfCadastro[].info | objeto | Informações complementares. |
nfCadastro[].info.cImpAPI | texto | Importado pela API. |
nfCadastro[].info.dAlt | texto | Data da Alteração. |
nfCadastro[].info.dInc | texto | Data da Inclusão. |
nfCadastro[].info.hAlt | texto | Hora da Alteração. |
nfCadastro[].info.hInc | texto | Hora da Inclusão. |
nfCadastro[].info.uAlt | texto | Usuário da Alteração. |
nfCadastro[].info.uInc | texto | Usuário da Inclusão. |
nfCadastro[].nfDestInt | objeto | |
nfCadastro[].nfDestInt.cCodCliInt | texto | Código de integração do cliente Fornecedor. |
nfCadastro[].nfDestInt.cRazao | texto | |
nfCadastro[].nfDestInt.cnpj_cpf | texto | |
nfCadastro[].nfDestInt.nCodCli | número inteiro | Código do cliente. |
nfCadastro[].nfEmitInt | objeto | |
nfCadastro[].nfEmitInt.cCodEmpInt | texto | Código de integração da empresa. |
nfCadastro[].nfEmitInt.nCodEmp | número inteiro | Código da Empresa. |
nfCadastro[].pedido | objeto | Dados do pedido. |
nfCadastro[].pedido.Categorias | lista de objetos | Distribuição por Categorias. |
nfCadastro[].pedido.Categorias[].cCodigoCategoria | texto | Código do Categoria. |
nfCadastro[].pedido.Categorias[].nPercentualDistribuicao | decimal | Percentual da distribuição. |
nfCadastro[].pedido.Categorias[].nValorDistribuicao | decimal | Valor da distribuição. |
nfCadastro[].pedido.Categorias[].nValorFixo | texto | Indica que o valor foi fixado na distribuição (S/N). |
nfCadastro[].pedido.Departamentos | lista de objetos | Distribuição por Departamentos. |
nfCadastro[].pedido.Departamentos[].cCodigoDepartamento | texto | Código do Departamento. |
nfCadastro[].pedido.Departamentos[].nPercentualDistribuicao | decimal | Percentual da distribuição. |
nfCadastro[].pedido.Departamentos[].nValorDistribuicao | decimal | Valor da distribuição. |
nfCadastro[].pedido.Departamentos[].nValorFixo | texto | Indica que o valor foi fixado na distribuição (S/N). |
nfCadastro[].pedido.cCancelado | texto | Indica que o Pedido de Venda foi cancelado. |
nfCadastro[].pedido.cDevParcial | texto | Indica que o Pedido de Venda se foi uma devolução parcial. |
nfCadastro[].pedido.cDevolvido | texto | Indica que o Pedido de Venda foi devolvido. |
nfCadastro[].pedido.cNumPedido | texto | Número do Pedido do Venda. |
nfCadastro[].pedido.dAltPedido | texto | Data da Alteração do Pedido de Venda. |
nfCadastro[].pedido.dCanPedido | texto | Data de Cancelamento do Pedido de Venda. |
nfCadastro[].pedido.dDevPedido | texto | Data de Cancelamento do Pedido de Venda. |
nfCadastro[].pedido.dIncPedido | texto | Data da Inclusão do Pedido de Venda. |
nfCadastro[].pedido.hAltPedido | texto | Hora da Alteração do Pedido de Venda. |
nfCadastro[].pedido.hCanPedido | texto | Hora de Cancelamento do Pedido de Venda. |
nfCadastro[].pedido.hDevPedido | texto | Hora de Cancelamento do Pedido de Venda. |
nfCadastro[].pedido.hIncPedido | texto | Hora da Inclusão do Pedido de Venda. |
nfCadastro[].pedido.nIdPedDev | número inteiro | Id do Pedido de venda devolvido. |
nfCadastro[].pedido.nIdProjeto | número inteiro | Código do Projeto no Pedido. |
nfCadastro[].pedido.nIdVendedor | número inteiro | Código do Vendedor no Pedido. |
nfCadastro[].pedido.opPedido | texto | Operaçã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.uAltPedido | texto | Usuário da Alteração do Pedido de Venda. |
nfCadastro[].pedido.uCanPedido | texto | Usuário de Cancelamento do Pedido de Venda. |
nfCadastro[].pedido.uDevPedido | texto | Usuário de Cancelamento do Pedido de Venda. |
nfCadastro[].pedido.uIncPedido | texto | Usuário da Inclusão do Pedido de Venda. |
nfCadastro[].titulos | lista de objetos | Titulos gerados para a nota fiscal. |
nfCadastro[].titulos[].cCodCateg | texto | Código da Categoria. |
nfCadastro[].titulos[].cCodIntTitulo | texto | Código de integração do título. (Utilizado em títulos criados via API, não é visualizado na tela). |
nfCadastro[].titulos[].cDoc | texto | |
nfCadastro[].titulos[].cNumTitulo | texto | Número do título. (Informado pelo usuário / visualizado na tela). |
nfCadastro[].titulos[].cPagForma | texto | |
nfCadastro[].titulos[].dDtEmissao | texto | Data de emissão do título. |
nfCadastro[].titulos[].dDtPrevisao | texto | Data de previsão de Pagamento/Recebimento. |
nfCadastro[].titulos[].dDtVenc | texto | Data de vencimento do título. |
nfCadastro[].titulos[].dReg | texto | Data de Registro. |
nfCadastro[].titulos[].nCodComprador | número inteiro | Número do Comprador. |
nfCadastro[].titulos[].nCodProjeto | número inteiro | Código do Projeto. |
nfCadastro[].titulos[].nCodTitRepet | número inteiro | Código do título da repetição. |
nfCadastro[].titulos[].nCodTitulo | número inteiro | Código do titulo. (Gerado internamente, não é visualizado na tela). |
nfCadastro[].titulos[].nCodVendedor | número inteiro | Código do Vendedor. |
nfCadastro[].titulos[].nParcela | número inteiro | Número da parcela. |
nfCadastro[].titulos[].nTotParc | número inteiro | Número total de parcelas. |
nfCadastro[].titulos[].nValorTitulo | decimal | Valor do título. |
nfCadastro[].total | objeto | |
nfCadastro[].total.CBSTot | objeto | Grupo de Valores Totais referentes ao CBS. |
nfCadastro[].total.CBSTot.vCBCbs | decimal | Valor total da base de cálculo da CBS. |
nfCadastro[].total.CBSTot.vCbs | decimal | Valor total da CBS. |
nfCadastro[].total.CBSTot.vCbsCred | decimal | Valor total do crédito presumido. |
nfCadastro[].total.CBSTot.vCbsDif | decimal | Valor total do diferimento da CBS. |
nfCadastro[].total.IBSTot | objeto | Grupo de Valores Totais referentes ao IBS. |
nfCadastro[].total.IBSTot.vBCIbs | decimal | Valor total da base de cálculo do IBS. |
nfCadastro[].total.IBSTot.vIbs | decimal | Valor total do IBS. |
nfCadastro[].total.IBSTot.vIbsCred | decimal | Valor total do crédito presumido. |
nfCadastro[].total.IBSTot.vIbsMun | decimal | Valor total do IBS do município. |
nfCadastro[].total.IBSTot.vIbsMunDif | decimal | Valor total do diferimento do IBS do município. |
nfCadastro[].total.IBSTot.vIbsUf | decimal | Valor total do IBS da UF. |
nfCadastro[].total.IBSTot.vIbsUfDif | decimal | Valor total do diferimento do IBS UF. |
nfCadastro[].total.ICMSTot | objeto | Grupo de Valores Totais referentes ao ICMS. |
nfCadastro[].total.ICMSTot.vBC | decimal | Base de Cálculo do ICMS. |
nfCadastro[].total.ICMSTot.vBCFCP | decimal | Base de Cálculo do Fundo de Combate a Pobreza. |
nfCadastro[].total.ICMSTot.vBCFCPST | decimal | Base de Cálculo do Fundo de Combate a Pobreza ST. |
nfCadastro[].total.ICMSTot.vBCST | decimal | Base de Cálculo do ICMS ST. |
nfCadastro[].total.ICMSTot.vCOFINS | decimal | Valor do COFINS. |
nfCadastro[].total.ICMSTot.vDesc | decimal | Valor Total do Desconto. |
nfCadastro[].total.ICMSTot.vFCP | decimal | Valor do Fundo de Combate a Pobreza. |
nfCadastro[].total.ICMSTot.vFCPST | decimal | Valor do Fundo de Combate a Pobreza ST. |
nfCadastro[].total.ICMSTot.vFrete | decimal | Valor Total do Frete. |
nfCadastro[].total.ICMSTot.vICMS | decimal | Valor Total do ICMS. |
nfCadastro[].total.ICMSTot.vICMSDesonerado | decimal | Valor do ICMS Desonerado. |
nfCadastro[].total.ICMSTot.vII | decimal | Valor Total do II. |
nfCadastro[].total.ICMSTot.vIPI | decimal | Valor Total do IPI. |
nfCadastro[].total.ICMSTot.vNF | decimal | Valor Total da NF-e. |
nfCadastro[].total.ICMSTot.vOutro | decimal | Outras Despesas acessórias. |
nfCadastro[].total.ICMSTot.vPIS | decimal | Valor do PIS. |
nfCadastro[].total.ICMSTot.vProd | decimal | Valor Total dos produtos e serviços. |
nfCadastro[].total.ICMSTot.vST | decimal | Valor Total do ICMS ST. |
nfCadastro[].total.ICMSTot.vSeg | decimal | Valor Total do Seguro. |
nfCadastro[].total.ICMSTot.vTotTrib | decimal | Valor aproximado total de tributos federais, estaduais e municipais. |
nfCadastro[].total.ISSQNtot | objeto | Grupo de Valores Totais referentes ao ISSQN. |
nfCadastro[].total.ISSQNtot.vBC | decimal | Base de Cálculo do ISS. |
nfCadastro[].total.ISSQNtot.vCOFINS | decimal | Valor do COFINS sobre serviços. |
nfCadastro[].total.ISSQNtot.vISS | decimal | Valor Total do ISS. |
nfCadastro[].total.ISSQNtot.vPIS | decimal | Valor do PIS sobre serviços. |
nfCadastro[].total.ISSQNtot.vServ | decimal | Valor Total dos Serviços sob não-incidência ou não tributados pelo ICMS. |
nfCadastro[].total.retTrib | objeto | Grupo de Retenções de Tributos. |
nfCadastro[].total.retTrib.vBCIRRF | decimal | Base de Cálculo do IRRF. |
nfCadastro[].total.retTrib.vBCRetPrev | decimal | Base de Cálculo da Retenção da Previdência Social. |
nfCadastro[].total.retTrib.vIRRF | decimal | Valor Retido do IRRF. |
nfCadastro[].total.retTrib.vRetCOFINS | decimal | Valor Retido de COFINS. |
nfCadastro[].total.retTrib.vRetCSLL | decimal | Valor Retido de CSLL. |
nfCadastro[].total.retTrib.vRetPIS | decimal | Valor Retido de PIS. |
nfCadastro[].total.retTrib.vRetPrev | decimal | Valor da Retenção da Previdência Social. |
pagina | número inteiro | |
registros | número inteiro | |
total_de_paginas | número inteiro | |
total_de_registros | nú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"}]}'import os
import requests
corpo = {'call': 'ListarNF',
'param': [{'pagina': 1, 'registros_por_pagina': 20, 'ordenar_por': 'CODIGO'}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/produtos/nfconsultar/",
headers={"Authorization": f"Bearer {os.environ['TOKEN_DO_APLICATIVO']}"},
json=corpo,
timeout=60,
)
print(resp.json())const resp = await fetch("https://app.omie.com.br/api/v1/produtos/nfconsultar/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "ListarNF",
"param": [
{
"pagina": 1,
"registros_por_pagina": 20,
"ordenar_por": "CODIGO"
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/produtos/nfconsultar/");
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("TOKEN_DO_APLICATIVO"),
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => <<<'JSON'
{
"call": "ListarNF",
"param": [
{
"pagina": 1,
"registros_por_pagina": 20,
"ordenar_por": "CODIGO"
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/produtos/nfconsultar/")
corpo = <<~'JSON'
{
"call": "ListarNF",
"param": [
{
"pagina": 1,
"registros_por_pagina": 20,
"ordenar_por": "CODIGO"
}
]
}
JSON
resp = Net::HTTP.post(uri, corpo,
"Authorization" => "Bearer #{ENV.fetch('TOKEN_DO_APLICATIVO')}",
"Content-Type" => "application/json")
puts resp.bodyimport java.net.URI;
import java.net.http.*;
var corpo = """
{
"call": "ListarNF",
"param": [
{
"pagina": 1,
"registros_por_pagina": 20,
"ordenar_por": "CODIGO"
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/produtos/nfconsultar/"))
.header("Authorization", "Bearer " + System.getenv("TOKEN_DO_APLICATIVO"))
.header("Content-Type", "application/json")
.POST(HttpRequest.BodyPublishers.ofString(corpo))
.build();
var resp = HttpClient.newHttpClient().send(pedido, HttpResponse.BodyHandlers.ofString());
System.out.println(resp.body());// TokenDoAplicativo: parâmetro do Power BI (Página Inicial > Gerenciar parâmetros)
let
Resposta = Web.Contents(
"https://app.omie.com.br/api/v1/produtos/nfconsultar/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""ListarNF"", ""param"": [{""pagina"": 1, ""registros_por_pagina"": 20, ""ordenar_por"": ""CODIGO""}]}")
]
),
Dados = Json.Document(Resposta)
in
Dados