compras_arp_saldo_item
Retrieve available balance per item in a Brazilian ARP to verify if quantity remains for new adhesion. Aggregates results by item for adhesion decisions.
Instructions
Devolve o saldo (quantidade ainda disponível) por item da ARP.
Endpoint Dados Abertos /modulo-arp/4_consultarEmpenhosSaldoItem.
Crítico para adesão: a ata pode estar vigente mas com saldo
zerado. Sem saldo, não há como aderir.
Estrutura do payload: o upstream retorna 1 linha por
(numeroItem, unidade, tipo) — onde tipo pode ser GERENCIADORA,
PARTICIPANTE etc. O mesmo numeroItem aparece várias vezes quando
há múltiplas unidades alocadas (carona ou rateio). Não é
duplicação — são alocações distintas dentro da mesma ata.
Para evitar confusão (achado bateria A v0.3.5), além do resultado
cru, anexamos resumo_por_item: dicionário agregando por
numeroItem com soma das quantidades registradas/empenhadas e
saldo total — pronto para decisão de adesão.
Cache 15 min (saldo muda ao longo do dia).
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"numero_ata": "<numero_ata>",
"unidade_gerenciadora": "<unidade_gerenciadora>"
},
"name": "compras_arp_saldo_item"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| pagina | No | Página de resultados (1-based). Padrão 1. | |
| numero_ata | Yes | Número simples da ata (ex.: '00001/2024'). | |
| tamanho_pagina | No | Quantidade de registros por página. Padrão 50, máximo 500. | |
| unidade_gerenciadora | Yes | Código da UASG gerenciadora da ata. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||