Painel do Contador ·
DocumentosFiscaisListagem de XMLs de Documentos Fiscais
1consulta
0alterações
Claude · ChatGPT · MCPpelos assistentes de IA
JSON · XMLformato
Lista de XMLs de Documentos Fiscais.
Obrigatórios 1
| Campo | Tipo | Descrição |
|---|---|---|
cModelo | texto · até 2 | Modelo do Documento Fiscal: Pode ser: 00 - ECF 65 - NFC-e 59 - CF-e SAT 55 - NF-e 57 - CT-e 67 - CT-e OS 99 - NFS-e |
Opcionais 22Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
cAmbiente | texto · até 1 | Ambiente do Documento Fiscal. Pode ser: H - Homologação. P - Produção (Default). |
cHrIncFinal | texto · até 8 | Hora de Inclusão final do Documento Fiscal. |
cHrIncInicial | texto · até 8 | Hora de Inclusão inicial do Documento Fiscal. |
cOperacao | texto · até 1 | Tipo de Operação do Documento Fiscal. Pode ser: 0 - Entrada. 1 - Saída (Default). |
cSerie | texto · até 5 | Série do Documento Fiscal. |
dDtIncFinal | texto · até 10 | Data de Inclusão final do Documento Fiscal. |
dDtIncInicial | texto · até 10 | Data de Inclusão inicial do Documento Fiscal. |
dEmiFinal | texto · até 10 | Data de emissão final do Documento Fiscal. |
dEmiInicial | texto · até 10 | Data de emissão inicial do Documento Fiscal. |
hEmiFinal | texto · até 8 | Hora de emissão final do Documento Fiscal. |
hEmiInicial | texto · até 8 | Hora de emissão inicial do Documento Fiscal. |
nChave | texto · até 44 | Chave da Documento Fiscal. |
nDocFinal | número inteiro | Número do Documento Final do Documento Fiscal. |
nDocInicial | número inteiro | Número do Documento Inicial do Documento Fiscal. |
nIdCT | número inteiro | ID do Conhecimento de Transporte (Para CT-e / CT-e OS). |
nIdCupom | número inteiro | ID do Cupom Fiscal (Para NFC-e / CF-e SAT e ECF). |
nIdNF | número inteiro | ID da Nota Fiscal (para NF-e / NFS-e). |
nIdOS | número inteiro | ID da Ordem de Serviço. |
nIdPedido | número inteiro | ID do Pedido de Compra/Venda. |
nIdReceb | número inteiro | Id do Recebimento da Nota. |
nPagina | número inteiro | |
nRegPorPagina | número inteiro |
Retorno 6O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
documentosEncontrados | lista de objetos | Lista de XMLs dos documentos encontrados. |
documentosEncontrados[].cSerie | texto | Série do Documento Fiscal. |
documentosEncontrados[].cStatus | texto | Status do Documento Fiscal. Pode ser: 00 - Autorizado 10 - Cancelado 20 - Denegado 30 - Devolvido 40 - Pendente (Documento em processo de faturamento) |
documentosEncontrados[].cXml | texto | XML do Documento Fiscal. |
documentosEncontrados[].dEmissao | texto | Data de emissão do Documento Fiscal. |
documentosEncontrados[].hEmissao | texto | Hora de emissão do Documento Fiscal. |
documentosEncontrados[].nChave | texto | Chave da Documento Fiscal. |
documentosEncontrados[].nIdCT | número inteiro | ID do Conhecimento de Transporte (Para CT-e / CT-e OS). |
documentosEncontrados[].nIdCupom | número inteiro | ID do Cupom Fiscal (Para NFC-e / CF-e SAT e ECF). |
documentosEncontrados[].nIdNF | número inteiro | ID da Nota Fiscal (para NF-e / NFS-e). |
documentosEncontrados[].nIdOS | número inteiro | ID da Ordem de Serviço. |
documentosEncontrados[].nIdPedido | número inteiro | ID do Pedido de Compra/Venda. |
documentosEncontrados[].nIdReceb | número inteiro | Id do Recebimento da Nota. |
documentosEncontrados[].nNumero | texto | Número do Documento Fiscal. |
documentosEncontrados[].nValor | decimal | Valor do Documento Fiscal. |
nIdProduto | número inteiro | |
nPagina | número inteiro | |
nRegPorPagina | número inteiro | |
nRegistros | número inteiro | |
nTotRegistros | número inteiro |
POST /api/v1/contador/xml/
curl -s https://app.omie.com.br/api/v1/contador/xml/ \
-H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
-H 'Content-Type: application/json' \
-d '{"call": "ListarDocumentos", "param": [{"nPagina": 1, "nRegPorPagina": 20, "cModelo": "55", "dEmiInicial": "", "dEmiFinal": ""}]}'import os
import requests
corpo = {'call': 'ListarDocumentos',
'param': [{'nPagina': 1,
'nRegPorPagina': 20,
'cModelo': '55',
'dEmiInicial': '',
'dEmiFinal': ''}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/contador/xml/",
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/contador/xml/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "ListarDocumentos",
"param": [
{
"nPagina": 1,
"nRegPorPagina": 20,
"cModelo": "55",
"dEmiInicial": "",
"dEmiFinal": ""
}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/contador/xml/");
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": "ListarDocumentos",
"param": [
{
"nPagina": 1,
"nRegPorPagina": 20,
"cModelo": "55",
"dEmiInicial": "",
"dEmiFinal": ""
}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/contador/xml/")
corpo = <<~'JSON'
{
"call": "ListarDocumentos",
"param": [
{
"nPagina": 1,
"nRegPorPagina": 20,
"cModelo": "55",
"dEmiInicial": "",
"dEmiFinal": ""
}
]
}
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": "ListarDocumentos",
"param": [
{
"nPagina": 1,
"nRegPorPagina": 20,
"cModelo": "55",
"dEmiInicial": "",
"dEmiFinal": ""
}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/contador/xml/"))
.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/contador/xml/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""ListarDocumentos"", ""param"": [{""nPagina"": 1, ""nRegPorPagina"": 20, ""cModelo"": ""55"", ""dEmiInicial"": """", ""dEmiFinal"": """"}]}")
]
),
Dados = Json.Document(Resposta)
in
Dados