Financeiro
consultar_financeiroContas a pagar e a receber, saldo e extrato bancário. Somente consulta: não dá baixa nem lança título. Estrutura: TÍTULO (o compromisso, com quem e de onde veio) > PARCELAS (vencimento e valor) > BAIXA (parcela paga ou recebida, sempre inteira) > CONTA BANCÁRIA. Valores: VALOR_LIQUIDO é o que se paga de fato (bruto - desconto + juros); VALOR_EM_ABERTO é o que falta, já pronto — nunca subtraia colunas. VALOR_DOCUMENTO_ORIGEM é o valor da nota ou do contrato, não o valor a pagar. MOEDA: todo valor está na moeda do título. Nunca some moedas diferentes; mostre um total por moeda, sempre com o símbolo junto. Os agrupamentos já separam por moeda. Vencimento: use o filtro "situacao", nunca compare datas. O período das visões de parcela usa a data prevista, que é a que vale para vencimento. Pagar x receber: "devo", "fornecedor", "boleto" = Pagar; "receber", "cliente" = Receber. Sem indicação, traga os dois e mostre separados. Nome de fornecedor, conta ou documento: filtre por trecho; se vierem nomes diferentes, pergunte qual e siga pelo identificador (id_entidade, id_conta_gerencial, id_titulo). Volume: para a fazenda inteira use "agrupar_por" em vez de listar parcela a parcela. Totais por mês estão em resumo_mes; por conta gerencial, centro de custo ou safra, em resumo_conta. "Quanto paguei/recebi" vem de baixas ou de resumo_mes — nunca da soma do extrato, que tem estornos.
Visões disponíveis (parâmetro "visao"):
parcelas: Uma linha por parcela, com vencimento, valores, situação e a baixa quando houver. Período pela data prevista de vencimento. "O que vence essa semana": situacao ["Vence hoje", "Vence em até 7 dias"]; vencidos: situacao ["Vencido"]. Filtros: tipo (valor exato), situacao (lista de valores exatos), pago, entidade, id_entidade (valor exato), funcionario, conta_gerencial, conta_gerencial_grupo, id_conta_gerencial (valor exato), centro_custo, safra, origem, titulo, documento, id_titulo (valor exato), moeda (valor exato), mes_previsto (valor exato), mes_pagamento (valor exato), conta_bancaria, id_conta_bancaria (valor exato), meio_pagamento, aceita período. Agrupa por: tipo, situacao, entidade, conta_gerencial, conta_gerencial_grupo, centro_custo, safra, origem, mes_previsto, mes_pagamento, conta_bancaria, meio_pagamento.
baixas: Só as parcelas já pagas ou recebidas, com o período pela data do pagamento. É a visão de "quanto paguei entre tal e tal dia" e de "pagamos em dia?" (DIAS_ATRASO_NO_PAGAMENTO). Filtros: tipo (valor exato), situacao (lista de valores exatos), pago, entidade, id_entidade (valor exato), funcionario, conta_gerencial, conta_gerencial_grupo, id_conta_gerencial (valor exato), centro_custo, safra, origem, titulo, documento, id_titulo (valor exato), moeda (valor exato), mes_previsto (valor exato), mes_pagamento (valor exato), conta_bancaria, id_conta_bancaria (valor exato), meio_pagamento, aceita período. Agrupa por: tipo, situacao, entidade, conta_gerencial, conta_gerencial_grupo, centro_custo, safra, origem, mes_previsto, mes_pagamento, conta_bancaria, meio_pagamento.
titulos: Uma linha por conta a pagar ou a receber, com os totais das parcelas, a situação da próxima parcela em aberto e a QUITACAO ("Quitado", "Parcialmente quitado", "Nada quitado"). "Quanto devo ao fornecedor X": tipo Pagar, em_aberto true, agrupar_por entidade. Período pelo próximo vencimento. Filtros: tipo (valor exato), situacao (lista de valores exatos), quitacao (valor exato), em_aberto, entidade, id_entidade (valor exato), conta_gerencial, conta_gerencial_grupo, id_conta_gerencial (valor exato), centro_custo, safra, origem, titulo, documento, id_titulo (valor exato), moeda (valor exato), aceita período. Agrupa por: tipo, situacao, quitacao, entidade, conta_gerencial, conta_gerencial_grupo, centro_custo, safra, origem.
resumo_mes: Uma linha por tipo, mês e moeda: PREVISTO (vence no mês), REALIZADO (pago no mês), EM_ABERTO e VENCIDO. É a visão do fluxo de caixa e de "quanto paguei em agosto". O período compara o primeiro dia do mês: para outubro a dezembro, use 01/10 a 31/12. O saldo do mês (receber - pagar) é da mesma moeda e deve ser calculado com cuidado, nunca misturando moedas. Filtros: tipo (valor exato), moeda (valor exato), mes (valor exato), aceita período. Agrupa por: tipo, mes.
resumo_conta: Totais por tipo, conta gerencial, centro de custo, safra e moeda, somando a vida inteira dos títulos — não aceita período. Para um período, use parcelas com agrupar_por conta_gerencial. Para uma dimensão só, use agrupar_por. Filtros: tipo (valor exato), moeda (valor exato), conta_gerencial, conta_gerencial_grupo, id_conta_gerencial (valor exato), centro_custo, safra. Agrupa por: tipo, conta_gerencial, conta_gerencial_grupo, centro_custo, safra.
contas_bancarias: Contas bancárias da fazenda com o SALDO_ATUAL mantido pelo sistema — nunca recalcule somando o extrato. Por padrão, peça ativa true. Contas de moedas diferentes não se somam. Filtros: conta_bancaria, banco, ativa, moeda (valor exato).
extrato: Movimentos de UMA conta bancária, do mais recente ao mais antigo, com o saldo após cada um. Exige id_conta_bancaria: sem a conta, consulte contas_bancarias e pergunte qual. Sem período, traz os últimos 30 dias — diga isso na resposta. Mostra estornos: alterar uma parcela paga gera "Estorno de pagamento" seguido de novo "Pagamento". Filtros: id_conta_bancaria (valor exato), direcao (valor exato), natureza, entidade, titulo, aceita período. Agrupa por: direcao, natureza, entidade.
notas: Notas fiscais ligadas a um título (principal e adicionais), com a situação e a quitação do título. "A nota 4512 já foi paga?": filtre nota e leia QUITACAO_TITULO. Nota que não aparece aqui não tem conta a pagar ou receber lançada. Período pela emissão da nota. Filtros: nota, entidade, tipo (valor exato), quitacao (valor exato), id_titulo (valor exato), moeda (valor exato), aceita período.
Quando "visao" não é informada, usa "parcelas". Filtro de texto casa por trecho, sem diferenciar maiúsculas nem acento ("aplicacao" acha "Aplicação") — exceto os marcados "(valor exato)", que exigem o valor inteiro, como código, placa e número. A resposta traz "total_disponivel": quantas linhas o filtro encontra ao todo. Chame uma vez só, já com o limite que a resposta vai usar — nunca repita a consulta mudando só o limite; se só o número interessa e o total pode ser grande, um limite baixo basta. Para totais e contagens use "agrupar_por"; a listagem é limitada e serve para ver itens. Com "agrupar_por", a resposta vem somada pelo banco: uma linha por grupo, com QTDE_LINHAS, as somas e os maiores e menores valores (MAIOR_*, MENOR_*). Use isso em vez de somar linhas por conta própria.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| mes | No | Mês no formato "AAAA-MM". Vale nas visões: resumo_mes. | |
| nota | No | Número da nota fiscal (casa por trecho). Vale nas visões: notas. | |
| pago | No | true: já paga/recebida. false: em aberto. Vale nas visões: parcelas, baixas. | |
| tipo | No | "Pagar" ou "Receber". Omita para trazer os dois. Vale nas visões: parcelas, baixas, titulos, resumo_mes, resumo_conta, notas. | |
| ativa | No | true traz só as contas ativas. Vale nas visões: contas_bancarias. | |
| banco | No | Banco. Vale nas visões: contas_bancarias. | |
| moeda | No | Símbolo da moeda do título, como está no cadastro: "R$", "$", "G". Vale nas visões: parcelas, baixas, titulos, resumo_mes, resumo_conta, contas_bancarias, notas. | |
| pular | No | Linhas a pular, para ler um resultado grande em partes. Use com limite quando total_disponivel for maior que o que veio. | |
| safra | No | Nome da safra, ex.: "2025/2026". Use listar_safras para ver as disponíveis. Vale nas visões: parcelas, baixas, titulos, resumo_conta. | |
| visao | No | Qual recorte consultar. Padrão: parcelas. | |
| limite | No | Máximo de linhas devolvidas. Padrão 100, teto 500. | |
| origem | No | De onde o título veio: "Nota fiscal", "Contrato de terceiros", "Contrato de venda", "Adiantamento", "Avulso", "Salário". Vale nas visões: parcelas, baixas, titulos. | |
| titulo | No | Número do título (casa por trecho). Vale nas visões: parcelas, baixas, titulos, extrato. | |
| direcao | No | "Entrada" ou "Saída". Vale nas visões: extrato. | |
| fazenda | No | Nome da fazenda. Omita para usar a fazenda corrente do usuário — é o padrão, e é o que o usuário espera quando não cita nenhuma. Informe apenas quando ele nomear outra fazenda. Cada consulta trata de uma fazenda por vez. | |
| entidade | No | Fornecedor (a pagar) ou cliente (a receber). Vale nas visões: parcelas, baixas, titulos, extrato, notas. | |
| natureza | No | "Pagamento", "Recebimento", "Estorno de pagamento", "Estorno de recebimento", "Transferência entre contas" ou "Outro". Vale nas visões: extrato. | |
| quitacao | No | "Quitado", "Parcialmente quitado", "Nada quitado" ou "Sem parcela". Vale nas visões: titulos, notas. | |
| situacao | No | Um ou mais valores exatos, já calculados no fuso da fazenda: "Vencido", "Vence hoje", "Vence em até 7 dias", "A vencer", "Sem vencimento", "Pago" (a pagar), "Recebido" (a receber); nos títulos, também "Sem parcela". Nunca deduza vencido comparando datas — filtre por aqui. Vale nas visões: parcelas, baixas, titulos. | |
| documento | No | Número da nota ou do contrato de origem (casa por trecho). Vale nas visões: parcelas, baixas, titulos. | |
| em_aberto | No | true: só títulos com valor em aberto. false: só os sem nada em aberto. Vale nas visões: titulos. | |
| id_titulo | No | Identificador do título, tirado de uma consulta anterior. Vale nas visões: parcelas, baixas, titulos, notas. | |
| data_final | No | Fim do período, inclusive, em dd/mm/aaaa ou aaaa-mm-dd. | |
| agrupar_por | No | Dimensões para somar no banco, em vez de listar linha a linha. Cada visão aceita só as dimensões listadas nela; a moeda entra sempre no agrupamento. | |
| funcionario | No | Pessoa do título de salário. Vale nas visões: parcelas, baixas. | |
| id_entidade | No | Identificador do fornecedor ou cliente, tirado de uma consulta anterior. Vale nas visões: parcelas, baixas, titulos. | |
| centro_custo | No | Centro de custo. Vale nas visões: parcelas, baixas, titulos, resumo_conta. | |
| data_inicial | No | Início do período, em dd/mm/aaaa ou aaaa-mm-dd. | |
| mes_previsto | No | Mês de vencimento, no formato "AAAA-MM". Vale nas visões: parcelas, baixas. | |
| mes_pagamento | No | Mês do pagamento, no formato "AAAA-MM". Vale nas visões: parcelas, baixas. | |
| conta_bancaria | No | Conta bancária da baixa. Vale nas visões: parcelas, baixas, contas_bancarias. | |
| meio_pagamento | No | Meio de pagamento da baixa. Vale nas visões: parcelas, baixas. | |
| conta_gerencial | No | Conta gerencial: a categoria da despesa ou da receita. Vale nas visões: parcelas, baixas, titulos, resumo_conta. | |
| id_conta_bancaria | No | Identificador da conta bancária, tirado da visão contas_bancarias. Vale nas visões: parcelas, baixas, extrato. | |
| id_conta_gerencial | No | Identificador da conta gerencial, tirado de uma consulta anterior. Vale nas visões: parcelas, baixas, titulos, resumo_conta. | |
| conta_gerencial_grupo | No | Grupo da conta gerencial. Vale nas visões: parcelas, baixas, titulos, resumo_conta. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| total | Yes | Linhas devolvidas nesta resposta. | |
| visao | Yes | ||
| avisos | No | O que o servidor aplicou sem ser pedido, como um período padrão. | |
| linhas | Yes | ||
| fazenda | Yes | ||
| truncado | Yes | true quando há mais linhas além das devolvidas. | |
| total_disponivel | Yes | Quantas linhas o filtro encontra ao todo, qualquer que seja o limite pedido. | |
| filtros_ignorados | Yes | Filtros que não existem na visão escolhida e por isso não foram aplicados. |