Ajuda & Documentação — GRU-UFRB

Guia prático de utilização das funcionalidades de consulta, sincronização e integração API.

🔑 Acesso ao Sistema

Acesse a aplicação utilizando suas credenciais institucionais da UFRB (autenticação integrada via LDAP / Active Directory) ou com o usuário administrador local configurado.
Após o login, você terá acesso imediato ao painel de Consulta de pagamentos.
Para encerrar a sessão com segurança, clique em Sair 🚪 no canto superior direito da barra de navegação.

Os filtros abaixo permitem realizar buscas específicas ou combinadas sobre todos os registros armazenados:

Campo de Filtro	Descrição e Funcionamento
UG	Código numérico da Unidade Gestora (ex.: `170500`).
Recolhimento	Código de recolhimento da receita.
Serviço	Código do serviço da GRU (ex.: `20902`).
Referência	Número de referência atribuído à GRU.
Contribuinte	Busca parcial ou exata por CPF, CNPJ ou Nome do pagador.
Situação	Estado da GRU: `CR` (Criado), `IN` (Iniciado), `SU` (Submetido), `CO` (Concluído), `ER` (Erro), `CA` (Cancelado), `RE` (Rejeitado).
Origem	Origem do lançamento: `sisgru` (sincronizado via webservice), `xml` (importação de arquivo) ou `api` (push via API REST).
Período	Datas inicial (De) e final (Até) de pagamento.
Busca Livre	Pesquisa textual em múltiplos campos simultaneamente.

Exportação CSV: Clique em Exportar CSV para baixar a planilha formatada em UTF-8 com BOM, pronta para abertura no Excel.
Detalhes completos: Clique sobre o código de qualquer pagamento para visualizar a ficha técnica e a estrutura JSON/XML original.

A sincronização consome diretamente a API oficial do Tesouro Nacional (SISGRU):

Sincronizar Período: Consulta janelas personalizadas de até 30 dias por requisição.
Sincronizar Tudo: Executa a varredura histórica completa desde a data configurada até o momento atual.

Permite carregar arquivos XML exportados do portal oficial do SISGRU (botão Exportar → XML):

Códigos de Recolhimento: A aplicação aceita e importa apenas recolhimentos iniciados por 2 (códigos iniciados por 1 e 6 são ignorados).
Formato: Apenas arquivos no formato .xml são aceitos (arquivos .xls/.xlsx são rejeitados).
Atualização Idempotente: Registros já existentes são atualizados automaticamente sem duplicidade.

Os endpoints requerem o cabeçalho Authorization: Bearer <token>:

GET /api/v1/gru?referencia=...&ug=170500 — Consulta direta e instantânea de GRUs pagas.
GET /api/v1/pagamentos — Lista paginada dos registros com filtros.
POST /api/v1/pagamentos — Recebimento em lote (push JSON) de pagamentos efetuados.