Produtos ·
ecf_blocoXDados da exportação do bloco X
1consulta
0alterações
Claude · MCPpelos assistentes de IA
JSON · XMLformato
Lista as NFs para o Bloco X (ECF)
Obrigatórios 0
Nenhum campo obrigatório.
Opcionais 16Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
cOrdenarPor | texto · até 100 | Ordem dos resultados: CODIGO - código da nota (padrão). DATA_EMISSAO - data de emissão. DATA_ENTRADA - data de saída informada pelo fornecedor. DATA_REGISTRO - data do registro do recebimento. |
cSerie | texto · até 5 | Série da NF-e (comparação exata). |
dAltFinal | texto · até 10 | Data de alteração do recebimento, final, no formato dd/mm/aaaa. |
dAltInicial | texto · até 10 | Data de alteração do recebimento, inicial, no formato dd/mm/aaaa. |
dEmiFinal | texto · até 10 | Data de emissão final, no formato dd/mm/aaaa. |
dEmiInicial | texto · até 10 | Data de emissão inicial, no formato dd/mm/aaaa. |
dIncFinal | texto · até 10 | Data de inclusão do recebimento, final, no formato dd/mm/aaaa. |
dIncInicial | texto · até 10 | Data de inclusão do recebimento, inicial, no formato dd/mm/aaaa. |
dRegFinal | texto · até 10 | Data de registro do recebimento na Omie, final, no formato dd/mm/aaaa. |
dRegInicial | texto · até 10 | Data de registro do recebimento na Omie, inicial, no formato dd/mm/aaaa. |
dSaiEntFinal | texto · até 10 | Data de saída informada pelo fornecedor, final, no formato dd/mm/aaaa. |
dSaiEntInicial | texto · até 10 | Data de saída informada pelo fornecedor, inicial, no formato dd/mm/aaaa. |
nNFFinal | número inteiro | Número final da NF-e. |
nNFInicial | número inteiro | Número inicial da NF-e. |
nPagina | número inteiro | Número da página. Padrão 1. A paginação conta itens de nota, não notas. |
nRegPorPagina | número inteiro | Itens por página. Padrão 100, máximo 100 (valor maior volta a 100). |
Retorno 5O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
listaNFs | lista de objetos | Notas de entrada encontradas, cada uma com o cabeçalho (ide) e os itens da página. |
listaNFs[].ide | objeto | Cabeçalho da NF-e de entrada. |
listaNFs[].ide.IdForn | número inteiro | Código interno do fornecedor (cadastro de clientes e fornecedores). |
listaNFs[].ide.chNFe | texto | Chave da NF-e. |
listaNFs[].ide.cnpjForn | texto | CNPJ do fornecedor. |
listaNFs[].ide.dAlt | texto | Data de alteração do recebimento, no formato dd/mm/aaaa. |
listaNFs[].ide.dEmi | texto | Data de emissão da NF-e, no formato dd/mm/aaaa. |
listaNFs[].ide.dInc | texto | Data de inclusão do recebimento, no formato dd/mm/aaaa. |
listaNFs[].ide.dReg | texto | Data de saída informada pelo fornecedor, no formato dd/mm/aaaa (apesar do nome, não é a data de registro). |
listaNFs[].ide.dSaiEnt | texto | Data do registro do recebimento na Omie, no formato dd/mm/aaaa (apesar do nome, não é a data de saída do fornecedor). |
listaNFs[].ide.idNF | número inteiro | Código interno da nota fiscal na Omie. |
listaNFs[].ide.lAjuste | sim/não | Indica se é uma NF-e de ajuste (finalidade 3). |
listaNFs[].ide.lCancelada | sim/não | Indica se a NF-e foi cancelada. |
listaNFs[].ide.lComplementar | sim/não | Indica se é uma NF-e complementar (finalidade 2). |
listaNFs[].ide.lDenegada | sim/não | Indica se a NF-e foi denegada. |
listaNFs[].ide.modelo | texto | Modelo do documento fiscal. Sempre 55. |
listaNFs[].ide.nNF | texto | Número do Documento Fiscal. |
listaNFs[].ide.razaoForn | texto | Razão Social do Fornecedor. |
listaNFs[].ide.serie | texto | Série do Documento Fiscal |
listaNFs[].itens | lista de objetos | Itens de produto da nota marcados para cupom fiscal. |
listaNFs[].itens[].EAN | texto | Código de barras (EAN) do produto informado no item da nota. |
listaNFs[].itens[].cProd | texto | Código do produto na Omie (ou o código da nota, se o produto não estiver vinculado). |
listaNFs[].itens[].nIdProd | número inteiro | Código interno do produto na Omie. |
listaNFs[].itens[].nItem | número inteiro | Número sequencial do item na nota. |
listaNFs[].itens[].pICMS | decimal | Alíquota de ICMS (zerada quando não há crédito). |
listaNFs[].itens[].pICMSST | decimal | Alíquota do ICMS ST (só para indústria ou equiparada). |
listaNFs[].itens[].qTrib | decimal | Quantidade do item. |
listaNFs[].itens[].uTrib | texto | Unidade Tributável. |
listaNFs[].itens[].vBC | decimal | Base de cálculo do ICMS (zerada quando não há crédito). |
listaNFs[].itens[].vBCST | decimal | Base de cálculo do ICMS ST (só para indústria ou equiparada). |
listaNFs[].itens[].vDesc | decimal | Valor do desconto do item. |
listaNFs[].itens[].vICMS | decimal | Valor do ICMS (zerado quando não há crédito). |
listaNFs[].itens[].vNF | decimal | Valor total do item na nota. |
listaNFs[].itens[].vProd | decimal | Valor da mercadoria no recebimento. |
listaNFs[].itens[].vST | decimal | Valor do ICMS ST (só para indústria ou equiparada). |
listaNFs[].itens[].vUnTrib | decimal | Valor unitário do item. |
nPagina | número inteiro | Número da página devolvida. |
nRegistros | número inteiro | Itens devolvidos nesta página. |
nTotPaginas | número inteiro | Total de páginas (de itens). |
nTotRegistros | número inteiro | Total de itens encontrados. |
POST /api/v1/produtos/blocox/
curl -s https://app.omie.com.br/api/v1/produtos/blocox/ \
-H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
-H 'Content-Type: application/json' \
-d '{"call": "ListarNFsBlocoX", "param": [{"nPagina": 1, "nRegPorPagina": 100, "cOrdenarPor": "DATA_REGISTRO", "dRegInicial": "01/09/2026", "dRegFinal": "30/09/2026"}]}'import os
import requests
corpo = {'call': 'ListarNFsBlocoX',
'param': [{'nPagina': 1,
'nRegPorPagina': 100,
'cOrdenarPor': 'DATA_REGISTRO',
'dRegInicial': '01/09/2026',
'dRegFinal': '30/09/2026'}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/produtos/blocox/",
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/blocox/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "ListarNFsBlocoX",
"param": [
{
"nPagina": 1,
"nRegPorPagina": 100,
"cOrdenarPor": "DATA_REGISTRO",
"dRegInicial": "01/09/2026",
"dRegFinal": "30/09/2026"
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/produtos/blocox/");
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": "ListarNFsBlocoX",
"param": [
{
"nPagina": 1,
"nRegPorPagina": 100,
"cOrdenarPor": "DATA_REGISTRO",
"dRegInicial": "01/09/2026",
"dRegFinal": "30/09/2026"
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/produtos/blocox/")
corpo = <<~'JSON'
{
"call": "ListarNFsBlocoX",
"param": [
{
"nPagina": 1,
"nRegPorPagina": 100,
"cOrdenarPor": "DATA_REGISTRO",
"dRegInicial": "01/09/2026",
"dRegFinal": "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": "ListarNFsBlocoX",
"param": [
{
"nPagina": 1,
"nRegPorPagina": 100,
"cOrdenarPor": "DATA_REGISTRO",
"dRegInicial": "01/09/2026",
"dRegFinal": "30/09/2026"
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/produtos/blocox/"))
.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/blocox/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""ListarNFsBlocoX"", ""param"": [{""nPagina"": 1, ""nRegPorPagina"": 100, ""cOrdenarPor"": ""DATA_REGISTRO"", ""dRegInicial"": ""01/09/2026"", ""dRegFinal"": ""30/09/2026""}]}")
]
),
Dados = Json.Document(Resposta)
in
Dados