Finanças ·
ConsultaAgingOperações de consultas de aging (faixas ou carteira)
1consulta
0alterações
Claude · MCPpelos assistentes de IA
JSON · XMLformato
Retorna a aging de Contas a Pagar e a Receber atrasadas e aging completo de contas. Aging também é conhecido como faixa e carteira.
Obrigatórios 2
| Campo | Tipo | Descrição |
|---|---|---|
dias_atraso | número inteiro | Quantidade máxima de dias de atraso considerada na consulta. Utilize obrigatoriamente um dos valores abaixo, conforme a expressão informada pelo usuário:
- SE usuário disser 'todas as contas' ENTÃO dias_atraso = -1
- SE usuário disser 'até 3 dias' ENTÃO dias_atraso = 3
- SE usuário disser 'até 5 dias' ENTÃO dias_atraso = 5
- SE usuário disser 'até 7 dias' ENTÃO dias_atraso = 7
- SE usuário disser 'até 10 dias' ENTÃO dias_atraso = 10
- SE usuário disser 'até 15 dias' ENTÃO dias_atraso = 15
- SE usuário disser 'até 30 dias' ENTÃO dias_atraso = 30
- SE usuário disser 'até 60 dias' ENTÃO dias_atraso = 60
- SE usuário disser 'até 90 dias' ENTÃO dias_atraso = 90
- SE usuário disser 'até 120 dias' ENTÃO dias_atraso = 120
- SE usuário disser 'até 6 meses' ENTÃO dias_atraso = 180
- SE usuário disser 'até 1 ano' ENTÃO dias_atraso = 365
- SE usuário disser 'até 2 anos' ENTÃO dias_atraso = 730
- SE usuário disser 'até 3 anos' ENTÃO dias_atraso = 1095
- SE usuário disser 'até 5 anos' ENTÃO dias_atraso = 1825
- SE usuário disser 'não exibir contas atrasadas' ENTÃO dias_atraso = 0
O valor -1 significa que não deve ser aplicado limite máximo de dias de atraso. As conversões de meses e anos acima são fixas; nunca recalcule esses períodos com base no calendário. Caso o usuário não informe nenhuma quantidade ou faixa de atraso, envie obrigatoriamente dias_atraso = -1. Nunca omita dias_atraso e nunca envie o objeto de request vazio, pois a API rejeita a requisição.Ex.: -1 |
tipo_conta | texto | Tipo de conta para consulta sendo 'P' para contas a pagar e 'R' para contas a receber. Caso o usuário não informe nenhum tipo de conta, envie obrigatoriamente tipo_conta = "" (string vazia)Ex.: |
Opcionais 2Campos e estruturas que você pode enviar
| Campo | Tipo | Descrição |
|---|---|---|
documento_cliente | texto | Documento do Cliente fornecedor para consultaEx.: |
nome_cliente | texto | Nome do Cliente fornecedor para consultaEx.: |
Retorno 2O que volta numa chamada bem-sucedida
| Campo | Tipo | Descrição |
|---|---|---|
dados | lista de objetos | |
dados[].cliente | texto | Nome do Cliente ou Fornecedor. |
dados[].cliente_documento | texto | CPF ou CNPJ do Cliente ou Fornecedor. |
dados[].dados_baixa | lista de objetos | |
dados[].dados_baixa[].valores | objeto | |
dados[].dados_baixa[].valores.valor_liq | decimal | Valor líquido do título. |
dados[].dados_baixa[].valores.vl_pagar | decimal | Saldo atual em aberto do título. Este é o valor oficial utilizado para cálculos de aging. |
dados[].dados_baixa[].valores.vl_pago | decimal | Valor já recebido ou pago do título. |
dados[].dados_lancamento | lista de objetos | |
dados[].dados_lancamento[].valores | objeto | |
dados[].dados_lancamento[].valores.valor_liq | decimal | Valor líquido original do lançamento. |
dados[].detalhes | objeto | |
dados[].detalhes.tip | texto | Tipo da conta. 'R' representa Contas a Receber e 'P' representa Contas a Pagar. |
dados[].faixa_vencimento | texto | Faixa oficial de aging calculada. |
dados[].pagamento | objeto | |
dados[].pagamento.valor_doc | decimal | Valor a pagar ou receber. |
success | sim/não |
POST /api/v1/financas/consultaaging/
curl -s https://app.omie.com.br/api/v1/financas/consultaaging/ \
-H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
-H 'Content-Type: application/json' \
-d '{"call": "ListarContasAging", "param": [{}]}'import os
import requests
corpo = {'call': 'ListarContasAging', 'param': [{}]}
resp = requests.post(
"https://app.omie.com.br/api/v1/financas/consultaaging/",
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/financas/consultaaging/", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.TOKEN_DO_APLICATIVO}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"call": "ListarContasAging",
"param": [
{}
]
}),
});
console.log(await resp.json());<?php
$ch = curl_init("https://app.omie.com.br/api/v1/financas/consultaaging/");
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": "ListarContasAging",
"param": [
{}
]
}
JSON,
]);
echo curl_exec($ch);require "net/http"
uri = URI("https://app.omie.com.br/api/v1/financas/consultaaging/")
corpo = <<~'JSON'
{
"call": "ListarContasAging",
"param": [
{}
]
}
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": "ListarContasAging",
"param": [
{}
]
}
""";
var pedido = HttpRequest.newBuilder()
.uri(URI.create("https://app.omie.com.br/api/v1/financas/consultaaging/"))
.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/financas/consultaaging/",
[
Headers = [Authorization = "Bearer " & TokenDoAplicativo, #"Content-Type" = "application/json"],
Content = Text.ToBinary("{""call"": ""ListarContasAging"", ""param"": [{}]}")
]
),
Dados = Json.Document(Resposta)
in
Dados