compras_arp_saldo_item
Check the remaining balance per item in a Brazilian government procurement agreement (ARP). Aggregates registered, committed, and available quantities by item to determine if a valid balance exists for adherence.
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).
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 | |||