Produtos ·
nfeImportação de NF-e
1consulta
3alterações
Claude · MCPpelos assistentes de IA
JSON · XMLformato
Exclui uma NF-e importada via integração.
Obrigatórios 0
Nenhum campo obrigatório.
Opcionais 3Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
cChaveNFe | texto · até 44 | Chave da NF-e. |
nIdImportacao | número inteiro | ID da Importação da NF-e. |
nIdNFe | número inteiro | ID do NF-e. |
Retorno 5O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
cChaveNFe | texto | Chave da NF-e. |
cCodStatus | texto | Código do Status do processamento. |
cDesStatus | texto | Descrição do status de processamento. |
nIdImportacao | número inteiro | ID da Importação da NF-e. |
nIdNFe | número inteiro | ID do NF-e. |
POST /api/v1/produtos/nfe/
curl -s https://app.omie.com.br/api/v1/produtos/nfe/ \
-H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
-H 'Content-Type: application/json' \
-d '{"call": "ExcluirNFe", "param": [{"cChaveNFe": "", "nIdImportacao": 0, "nIdNFe": 0}]}'import os
import requests
corpo = {'call': 'ExcluirNFe', 'param': [{'cChaveNFe': '', 'nIdImportacao': 0, 'nIdNFe': 0}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/produtos/nfe/",
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/nfe/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "ExcluirNFe",
"param": [
{
"cChaveNFe": "",
"nIdImportacao": 0,
"nIdNFe": 0
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/produtos/nfe/");
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": "ExcluirNFe",
"param": [
{
"cChaveNFe": "",
"nIdImportacao": 0,
"nIdNFe": 0
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/produtos/nfe/")
corpo = <<~'JSON'
{
"call": "ExcluirNFe",
"param": [
{
"cChaveNFe": "",
"nIdImportacao": 0,
"nIdNFe": 0
}
]
}
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": "ExcluirNFe",
"param": [
{
"cChaveNFe": "",
"nIdImportacao": 0,
"nIdNFe": 0
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/produtos/nfe/"))
.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/nfe/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""ExcluirNFe"", ""param"": [{""cChaveNFe"": """", ""nIdImportacao"": 0, ""nIdNFe"": 0}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosImporta o XML de cancelamento de uma Nota Fiscal Eletrônica.
Obrigatórios 6
| Campo | Tipo | Descrição |
|---|---|---|
cAppId | texto · até 100 | Identificação do aplicativo que emitiu a NF-e. Exemplo: ID001 PS: Informe o código que identifica a instalação do aplicativo. Caso o cliente tenha 2 Emissores de NF-e, indique: "01" e "02" ou "10" e "20" e assim por diante. |
cAppNome | texto · até 20 | Nome do Aplicativo que emitiu a NF-e. Exemplo: GeradorNF-e. |
cAppVersao | texto · até 20 | Versão do Aplicativo que emitiu a NF-e. Exemplo: 1.02.01. |
cChaveNfe | texto · até 44 | Chave da NF-e a ser importada. Apenas números com 44 digitos. |
cMd5NFeCanc | texto · até 32 | MD5 do arquivo XML importado. Aplique o MD5 sobre o XML antes de realizar o consumo. |
cXmlNFeCanc | texto | Xml de Cancelamento do CT-e. Preechimento obrigatório. Antes de enviar, converta os seus seguintes caracteres: & para &amp; > para &gt; < para &lt; " para &quot; " para &apos; | para &#124; Após essa conversão aplique o MD5 para enviar no campo "cMd5CteCanc". Observação: Para requisições SOAP usar CDATA como demonstra o exemplo abaixo: <![CDATA[Conteúdo do campo convertido]]>. |
Opcionais 2Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
nIdImportacao | número inteiro | ID da Importação da NF-e. |
nIdNFe | número inteiro | ID do NF-e. |
Retorno 5O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
cChaveNFe | texto | Chave da NF-e. |
cCodStatus | texto | Código do Status do processamento. |
cDesStatus | texto | Descrição do status de processamento. |
nIdImportacao | número inteiro | ID da Importação da NF-e. |
nIdNFe | número inteiro | ID do NF-e. |
POST /api/v1/produtos/nfe/
curl -s https://app.omie.com.br/api/v1/produtos/nfe/ \
-H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
-H 'Content-Type: application/json' \
-d '{"call": "ImportarCancNFe", "param": [{"cAppNome": "GeradorNFe", "cAppVersao": "1.01.02", "cAppId": "NFe01", "cChaveNFe": "", "cXmlNFeCanc": "", "cMd5NFeCanc": ""}]}'import os
import requests
corpo = {'call': 'ImportarCancNFe',
'param': [{'cAppNome': 'GeradorNFe',
'cAppVersao': '1.01.02',
'cAppId': 'NFe01',
'cChaveNFe': '',
'cXmlNFeCanc': '',
'cMd5NFeCanc': ''}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/produtos/nfe/",
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/nfe/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "ImportarCancNFe",
"param": [
{
"cAppNome": "GeradorNFe",
"cAppVersao": "1.01.02",
"cAppId": "NFe01",
"cChaveNFe": "",
"cXmlNFeCanc": "",
"cMd5NFeCanc": ""
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/produtos/nfe/");
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": "ImportarCancNFe",
"param": [
{
"cAppNome": "GeradorNFe",
"cAppVersao": "1.01.02",
"cAppId": "NFe01",
"cChaveNFe": "",
"cXmlNFeCanc": "",
"cMd5NFeCanc": ""
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/produtos/nfe/")
corpo = <<~'JSON'
{
"call": "ImportarCancNFe",
"param": [
{
"cAppNome": "GeradorNFe",
"cAppVersao": "1.01.02",
"cAppId": "NFe01",
"cChaveNFe": "",
"cXmlNFeCanc": "",
"cMd5NFeCanc": ""
}
]
}
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": "ImportarCancNFe",
"param": [
{
"cAppNome": "GeradorNFe",
"cAppVersao": "1.01.02",
"cAppId": "NFe01",
"cChaveNFe": "",
"cXmlNFeCanc": "",
"cMd5NFeCanc": ""
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/produtos/nfe/"))
.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/nfe/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""ImportarCancNFe"", ""param"": [{""cAppNome"": ""GeradorNFe"", ""cAppVersao"": ""1.01.02"", ""cAppId"": ""NFe01"", ""cChaveNFe"": """", ""cXmlNFeCanc"": """", ""cMd5NFeCanc"": """"}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosImporta o XML de uma Nota Fiscal Eletrônica.
Obrigatórios 8
| Campo | Tipo | Descrição |
|---|---|---|
cAppId | texto · até 100 | Identificação do aplicativo que emitiu a NF-e. Exemplo: ID001 PS: Informe o código que identifica a instalação do aplicativo. Caso o cliente tenha 2 Emissores de NF-e, indique: "01" e "02" ou "10" e "20" e assim por diante. |
cAppNome | texto · até 20 | Nome do Aplicativo que emitiu a NF-e. Exemplo: GeradorNF-e. |
cAppVersao | texto · até 20 | Versão do Aplicativo que emitiu a NF-e. Exemplo: 1.02.01. |
cChaveNFe | texto · até 44 | Chave da NF-e a ser importada. Apenas números com 44 digitos. |
cMd5NFe | texto · até 32 | MD5 do arquivo XML importado. Aplique o MD5 sobre o XML antes de realizar o consumo. |
cOperacao | texto · até 2 | Tipo de Operação da Nota Fiscal. Códigos Disponíveis: 11 - Venda de produtos 21 - Compra de produtos. |
cXmlNFe | texto | Xml da NF-e a ser importada. Antes de enviar, converta os seus seguintes caracteres: & para &amp; > para &gt; < para &lt; " para &quot; " para &apos; | para &#124; Após essa conversão aplique o MD5 para enviar no campo "cMd5NFe". |
dDataPrevisao | texto · até 10 | Data de Previsão do título de contas a pagar/receber. Formato: dd/mm/aaaa. |
Opcionais 16Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
cCategoria | texto · até 20 | Código da Categoria. |
cNumeroPedidoCliente | texto · até 30 | |
cOrigem | texto · até 3 | Origem da Nota Fiscal. Códigos Disponíveis: API - Importado via API. |
codigo_local_estoque | número inteiro | Código do local do estoque. Assumirá o local padrão de estoque caso não informado. |
itens | lista de objetos | Itens da Nota Fiscal. |
itens[].cCategoria | texto · até 20 | Código da Categoria. |
itens[].codigo_local_estoque | número inteiro | Código do local do estoque. Assumirá o local padrão de estoque caso não informado. |
itens[].lNaoGerarTitulo | sim/não | Não gerar título de contas a pagar ou receber para a NF-e. Pode ser: true - inibe a geração do título de Contas a Pagar ou Receber no financeiro. false - Gera o ítulo de Contas a Pagar ou Receber no financeiro. O padrão é true. |
itens[].lNaoMovEstoque | sim/não | Não movimenta o estoque para o item. Pode ser: true - inibe a movimentação do estoque. false - Gera o movimentação do estoque. O padrão é false. |
itens[].lote_validade | lista de objetos | Informações referentes ao lote e validade do produto. A tag só deve ser informada se o produto possuir controle de lote e se a intenção é informar os lotes "manualmente" por API. |
itens[].lote_validade[].cCodAgreg | texto · até 20 | Código de agregação do lote do produto. (Opcional). |
itens[].lote_validade[].cNumLote | texto · até 60 | Número do lote do produto. Deve ser informado apenas quando a tag [nIdLote] não for informada, com isso, será criado um novo lote a partir do número informado. |
itens[].lote_validade[].dDataFab | texto | Data de fabricação do lote. Deve ser informado apenas quando a tag [nIdLote] não for informada. Como default é utilizado a data atual. |
itens[].lote_validade[].dDataVal | texto | Data de validade do lote. Deve ser informado apenas quando a tag [nIdLote] não for informada. |
itens[].lote_validade[].nIdLote | número inteiro | Id do lote do produto. (Opcional) Se não informado iremos cadastrar um novo lote. |
itens[].lote_validade[].nQtdLoteobrigatório | número | Informe aqui a quantidade do lote para o produto. |
itens[].nIdProduto | número inteiro | ID do produto. Caso não informado, fará a pesquisa do produto de acordo com os dados do XML da NF-e. |
itens[].nSequenciaobrigatório | número inteiro | Número da Sequencia. Para os itens da NF identifica qual o item do XML se refere. Para as parcelas da NF identifica o número da parcela. Para os lançamentos no Conta Corrente indentifica o lançamento que será gerado. Permite sequencial de 1 a 999. |
itensXml | lista de objetos | Dados dos Itens da NF-e. Informe aqui a relação dos produtos contidos no XML com o respectivo produto no Omie ERP. Caso a tag "itens" seja preenchida esta tag não deve ser utilizada. |
itensXml[].cProdXmlobrigatório | texto · até 60 | Código do produto no XML da NF-e. Essa informação está localizada na tag "cProd" do XML da NF-e, ela é utilizada para identificar o produto no XML. |
itensXml[].lote_validade | lista de objetos | Informações referentes ao lote e validade do produto. A tag só deve ser informada se o produto possuir controle de lote e se a intenção é informar os lotes "manualmente" por API. |
itensXml[].lote_validade[].cCodAgreg | texto · até 20 | Código de agregação do lote do produto. (Opcional). |
itensXml[].lote_validade[].cNumLote | texto · até 60 | Número do lote do produto. Deve ser informado apenas quando a tag [nIdLote] não for informada, com isso, será criado um novo lote a partir do número informado. |
itensXml[].lote_validade[].dDataFab | texto | Data de fabricação do lote. Deve ser informado apenas quando a tag [nIdLote] não for informada. Como default é utilizado a data atual. |
itensXml[].lote_validade[].dDataVal | texto | Data de validade do lote. Deve ser informado apenas quando a tag [nIdLote] não for informada. |
itensXml[].lote_validade[].nIdLote | número inteiro | Id do lote do produto. (Opcional) Se não informado iremos cadastrar um novo lote. |
itensXml[].lote_validade[].nQtdLoteobrigatório | número | Informe aqui a quantidade do lote para o produto. |
itensXml[].nIdProdutoXmlobrigatório | número inteiro | ID do produto no Omie que será vinculado ao produto informado na tag "cProdXml". |
itensXml[].nSequencia | número inteiro | Número da Sequencia. Para os itens da NF identifica qual o item do XML se refere. Para as parcelas da NF identifica o número da parcela. Para os lançamentos no Conta Corrente indentifica o lançamento que será gerado. Permite sequencial de 1 a 999. |
lNaoGerarTitulo | sim/não | Não gerar título de contas a pagar ou receber para a NF-e. Pode ser: true - inibe a geração do título de Contas a Pagar ou Receber no financeiro. false - Gera o ítulo de Contas a Pagar ou Receber no financeiro. O padrão é true. |
lNaoIncluirCliente | sim/não | Não adicionar o cliente caso não encontre no Omie. Pode ser: true - inibe a inclusão do cliente. false - Inclui o cliente caso não encontre. O padrão é true. |
lNaoIncluirProduto | sim/não | Não adicionar o produto caso não encontre no Omie. Pode ser: true - inibe a inclusão do produto. false - Inclui o produto caso não encontre. O padrão é true. |
lNaoMovEstoque | sim/não | Não movimentar o estoque. Pode ser: true - inibe a movimentação do estoque. false - Gera o movimentação do estoque. O padrão é true. |
lancamentos | lista de objetos | Lançamentos no Conta Corrente relacionados a Nota Fiscal. (Tarifas,taxas,entre outros). |
lancamentos[].cCategoria | texto · até 20 | Código da Categoria. |
lancamentos[].cNaturezaDocumentoobrigatório | texto · até 1 | Natureza do Documento. Pode ser: P - Pagar R - Receber. |
lancamentos[].cObs | texto | Observações. |
lancamentos[].cOrigem | texto · até 3 | Origem da Nota Fiscal. Códigos Disponíveis: API - Importado via API. |
lancamentos[].cTipoDocumento | texto · até 5 | Tipo de Documento. Lista de tipos de documentos em: /api/v1/geral/tiposdoc. |
lancamentos[].dDataDocumentoobrigatório | texto · até 10 | Data do documento. |
lancamentos[].nContaCorrente | número inteiro | Id da Conta Corrente. |
lancamentos[].nProjeto | número inteiro | Id do projeto. |
lancamentos[].nSequencia | número inteiro | Número da Sequencia. Para os itens da NF identifica qual o item do XML se refere. Para as parcelas da NF identifica o número da parcela. Para os lançamentos no Conta Corrente indentifica o lançamento que será gerado. Permite sequencial de 1 a 999. |
lancamentos[].nValorDocumentoobrigatório | número | Valor do Documento. |
lancamentos[].nVendedor | número inteiro | Id do Vendedor. |
nCliente | número inteiro | Id do cliente. |
nContaCorrente | número inteiro | Id da Conta Corrente. |
nProjeto | número inteiro | Id do projeto. |
nVendedor | número inteiro | Id do Vendedor. |
parcelas | lista de objetos | Informações complementares das Parcelas da NF-e. Nessa tag é recebido informações para complemento das parcelas já existentes no XML da NF-e enviada. |
parcelas[].cCategoria | texto · até 20 | Código da Categoria. |
parcelas[].cObs | texto | Observações. |
parcelas[].cTipoDocumento | texto · até 5 | Tipo de Documento. |
parcelas[].dDataEntrada | texto · até 10 | Data de Entrada da Nota Fiscal. Formato: dd/mm/aaaa. |
parcelas[].dDataPrevisao | texto · até 10 | Data de Previsão do título de contas a pagar/receber. Formato: dd/mm/aaaa. |
parcelas[].dDataVencimentoobrigatório | texto · até 10 | Data de Vencimento da Parcela. Formato: dd/mm/aaaa. |
parcelas[].nContaCorrente | número inteiro | Id da Conta Corrente. |
parcelas[].nProjeto | número inteiro | Id do projeto. |
parcelas[].nSequenciaobrigatório | número inteiro | Número da Sequencia. Para os itens da NF identifica qual o item do XML se refere. Para as parcelas da NF identifica o número da parcela. Para os lançamentos no Conta Corrente indentifica o lançamento que será gerado. Permite sequencial de 1 a 999. |
parcelas[].nValorParcelaobrigatório | número | Valor da Parcela. |
parcelas[].nVendedor | número inteiro | Id do Vendedor. |
parcelas[].nsu | texto · até 100 | Número Sequencial Único - NSU Para identificar vendas por cartões ou TransactionID TID - Para identificar vendas de comercio eletrônico. |
Retorno 5O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
cChaveNFe | texto | Chave da NF-e. |
cCodStatus | texto | Código do Status do processamento. |
cDesStatus | texto | Descrição do status de processamento. |
nIdImportacao | número inteiro | ID da Importação da NF-e. |
nIdNFe | número inteiro | ID do NF-e. |
POST /api/v1/produtos/nfe/
curl -s https://app.omie.com.br/api/v1/produtos/nfe/ \
-H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
-H 'Content-Type: application/json' \
-d '{"call": "ImportarNFe", "param": [{"cAppNome": "GeradorNFe", "cAppVersao": "1.01.02", "cAppId": "NFe01", "cChaveNFe": "", "cXmlNFe": "", "cMd5NFe": "", "cOperacao": "11", "cOrigem": "API", "nCliente": 0, "cCategoria": "1.01.02", "nContaCorrente": 0, "codigo_local_estoque": 0, "lNaoMovEstoque": true, "lNaoGerarTitulo": false, "lNaoIncluirCliente": false, "lNaoIncluirProduto": true}]}'import os
import requests
corpo = {'call': 'ImportarNFe',
'param': [{'cAppNome': 'GeradorNFe',
'cAppVersao': '1.01.02',
'cAppId': 'NFe01',
'cChaveNFe': '',
'cXmlNFe': '',
'cMd5NFe': '',
'cOperacao': '11',
'cOrigem': 'API',
'nCliente': 0,
'cCategoria': '1.01.02',
'nContaCorrente': 0,
'codigo_local_estoque': 0,
'lNaoMovEstoque': True,
'lNaoGerarTitulo': False,
'lNaoIncluirCliente': False,
'lNaoIncluirProduto': True}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/produtos/nfe/",
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/nfe/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "ImportarNFe",
"param": [
{
"cAppNome": "GeradorNFe",
"cAppVersao": "1.01.02",
"cAppId": "NFe01",
"cChaveNFe": "",
"cXmlNFe": "",
"cMd5NFe": "",
"cOperacao": "11",
"cOrigem": "API",
"nCliente": 0,
"cCategoria": "1.01.02",
"nContaCorrente": 0,
"codigo_local_estoque": 0,
"lNaoMovEstoque": true,
"lNaoGerarTitulo": false,
"lNaoIncluirCliente": false,
"lNaoIncluirProduto": true
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/produtos/nfe/");
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": "ImportarNFe",
"param": [
{
"cAppNome": "GeradorNFe",
"cAppVersao": "1.01.02",
"cAppId": "NFe01",
"cChaveNFe": "",
"cXmlNFe": "",
"cMd5NFe": "",
"cOperacao": "11",
"cOrigem": "API",
"nCliente": 0,
"cCategoria": "1.01.02",
"nContaCorrente": 0,
"codigo_local_estoque": 0,
"lNaoMovEstoque": true,
"lNaoGerarTitulo": false,
"lNaoIncluirCliente": false,
"lNaoIncluirProduto": true
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/produtos/nfe/")
corpo = <<~'JSON'
{
"call": "ImportarNFe",
"param": [
{
"cAppNome": "GeradorNFe",
"cAppVersao": "1.01.02",
"cAppId": "NFe01",
"cChaveNFe": "",
"cXmlNFe": "",
"cMd5NFe": "",
"cOperacao": "11",
"cOrigem": "API",
"nCliente": 0,
"cCategoria": "1.01.02",
"nContaCorrente": 0,
"codigo_local_estoque": 0,
"lNaoMovEstoque": true,
"lNaoGerarTitulo": false,
"lNaoIncluirCliente": false,
"lNaoIncluirProduto": true
}
]
}
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": "ImportarNFe",
"param": [
{
"cAppNome": "GeradorNFe",
"cAppVersao": "1.01.02",
"cAppId": "NFe01",
"cChaveNFe": "",
"cXmlNFe": "",
"cMd5NFe": "",
"cOperacao": "11",
"cOrigem": "API",
"nCliente": 0,
"cCategoria": "1.01.02",
"nContaCorrente": 0,
"codigo_local_estoque": 0,
"lNaoMovEstoque": true,
"lNaoGerarTitulo": false,
"lNaoIncluirCliente": false,
"lNaoIncluirProduto": true
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/produtos/nfe/"))
.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/nfe/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""ImportarNFe"", ""param"": [{""cAppNome"": ""GeradorNFe"", ""cAppVersao"": ""1.01.02"", ""cAppId"": ""NFe01"", ""cChaveNFe"": """", ""cXmlNFe"": """", ""cMd5NFe"": """", ""cOperacao"": ""11"", ""cOrigem"": ""API"", ""nCliente"": 0, ""cCategoria"": ""1.01.02"", ""nContaCorrente"": 0, ""codigo_local_estoque"": 0, ""lNaoMovEstoque"": true, ""lNaoGerarTitulo"": false, ""lNaoIncluirCliente"": false, ""lNaoIncluirProduto"": true}]}")
]
),
Dados = Json.Document(Resposta)
in
DadosLista as NFes importadas.
Obrigatórios 0
Nenhum campo obrigatório.
Opcionais 9Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
cChaveNFe | texto · até 44 | Chave da NF-e. |
dDataEmissaoFinal | texto · até 10 | Data de emissão final. No formato dd/mm/aaaa. |
dDataEmissaoInicial | texto · até 10 | Data de emissão inicial. No formato dd/mm/aaaa. |
dDataInclusaoFinal | texto · até 10 | Data de Inclusão Final. No formato dd/mm/aaaa. |
dDataInclusaoInicial | texto · até 10 | Data de Inclusão Inicial. No formato dd/mm/aaaa. |
nIdImportacao | número inteiro | ID da Importação da NF-e. |
nIdNFe | número inteiro | ID do NF-e. |
nPagina | número inteiro | Número da página que se deseja resgatar. O padrão é "1". |
nRegPorPagina | número inteiro | Número de registros retornados por página. O padrão é 20. O limite máximo é 500 por página. |
Retorno 5O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
listagemNfe | lista de objetos | Lista de NFes importadas. |
listagemNfe[].cAppId | texto | Identificação do aplicativo que emitiu a NF-e. Exemplo: ID001 PS: Informe o código que identifica a instalação do aplicativo. Caso o cliente tenha 2 Emissores de NF-e, indique: "01" e "02" ou "10" e "20" e assim por diante. |
listagemNfe[].cAppNome | texto | Nome do Aplicativo que emitiu a NF-e. Exemplo: GeradorNF-e. |
listagemNfe[].cAppVersao | texto | Versão do Aplicativo que emitiu a NF-e. Exemplo: 1.02.01. |
listagemNfe[].cChaveNFe | texto | Chave da NF-e a ser importada. Apenas números com 44 digitos. |
listagemNfe[].cExcluido | texto | Indica se o registro foi excluído (S ou N). |
listagemNfe[].cHoraExclusao | texto | Hora de exclusão. |
listagemNfe[].cHoraImportacao | texto | Hora da importação. |
listagemNfe[].cNumeroNFe | texto | Número da NF-e. |
listagemNfe[].cOperacao | texto | Tipo de Operação da Nota Fiscal. Códigos Disponíveis: 11 - Venda de produtos 21 - Compra de produtos. |
listagemNfe[].cOrigem | texto | Origem da Nota Fiscal. Códigos Disponíveis: API - Importado via API. |
listagemNfe[].cStatus | texto | Status da importação. Pode ser: 1 - Em processamento. 4 - Importada com sucesso. 9 - Erro na importação. |
listagemNfe[].dDataEmissao | texto | Data de emissão da NF-e. |
listagemNfe[].dDataExclusao | texto | Data de exclusão. |
listagemNfe[].dDataImportacao | texto | Data da importação. |
listagemNfe[].nCliente | número inteiro | Id do cliente. |
listagemNfe[].nIdExcusao | número inteiro | ID da exclusão. |
listagemNfe[].nIdImportacao | número inteiro | ID da Importação da NF-e. |
listagemNfe[].nIdNFe | número inteiro | ID do NF-e. |
listagemNfe[].nValorNFe | decimal | Valor da NF-e. |
nPagina | número inteiro | Número da página resgatada. |
nRegistros | número inteiro | Número de registros retornados na página. |
nTotPaginas | número inteiro | Número total de páginas encontradas. |
nTotRegistros | número inteiro | Número total de registros encontrados. |
POST /api/v1/produtos/nfe/
curl -s https://app.omie.com.br/api/v1/produtos/nfe/ \
-H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
-H 'Content-Type: application/json' \
-d '{"call": "ListarNFe", "param": [{"nPagina": 1, "nRegPorPagina": 50, "dDataEmissaoInicial": "30/09/2026", "dDataEmissaoFinal": "30/09/2026"}]}'import os
import requests
corpo = {'call': 'ListarNFe',
'param': [{'nPagina': 1,
'nRegPorPagina': 50,
'dDataEmissaoInicial': '30/09/2026',
'dDataEmissaoFinal': '30/09/2026'}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/produtos/nfe/",
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/nfe/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "ListarNFe",
"param": [
{
"nPagina": 1,
"nRegPorPagina": 50,
"dDataEmissaoInicial": "30/09/2026",
"dDataEmissaoFinal": "30/09/2026"
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/produtos/nfe/");
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": "ListarNFe",
"param": [
{
"nPagina": 1,
"nRegPorPagina": 50,
"dDataEmissaoInicial": "30/09/2026",
"dDataEmissaoFinal": "30/09/2026"
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/produtos/nfe/")
corpo = <<~'JSON'
{
"call": "ListarNFe",
"param": [
{
"nPagina": 1,
"nRegPorPagina": 50,
"dDataEmissaoInicial": "30/09/2026",
"dDataEmissaoFinal": "30/09/2026"
}
]
}
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": "ListarNFe",
"param": [
{
"nPagina": 1,
"nRegPorPagina": 50,
"dDataEmissaoInicial": "30/09/2026",
"dDataEmissaoFinal": "30/09/2026"
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/produtos/nfe/"))
.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/nfe/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""ListarNFe"", ""param"": [{""nPagina"": 1, ""nRegPorPagina"": 50, ""dDataEmissaoInicial"": ""30/09/2026"", ""dDataEmissaoFinal"": ""30/09/2026""}]}")
]
),
Dados = Json.Document(Resposta)
in
Dados