Boletos SGA

Consultar boletos do SGA

Lista, paginados, os boletos que a integração com o SGA da Hinova espelhou para a central de quem pergunta. É uma leitura do espelho: nenhuma chamada sai para a Hinova, nada aqui muda situação, dá baixa ou bloqueia cliente.

Todos os filtros são opcionais e se estreitam uns aos outros. O link do boleto não vem na lista porque nenhuma listagem do SGA o traz: peça-o um a um em /manager/sga/boletos/{nossoNumero}/link.

get/manager/sga/boletos/search

Request

  • Base URL: https://api.mapper.net.br/api
  • URL: https://api.mapper.net.br/api/manager/sga/boletos/search
  • Auth: HTTP bearer

Query parameters

statusstring

O código de uma situação que a associação declarou (1, 2, 3, 999…), -1 para todas, PAID para o que ela considera quitado, UPCOMING para o que ainda se deve e não venceu, OVERDUE para o que ainda se deve e já venceu. OPEN é o nome antigo de UPCOMING.

"Em aberto" não é "não pago": uma situação como CANCELADO responde NÃO a pago sem que ninguém deva nada, e não entra em UPCOMING nem em OVERDUE.

client_idinteger

Grupo do cliente dono do boleto.

fromstring date

Vencimento a partir de (aaaa-mm-dd).

tostring date

Vencimento até (aaaa-mm-dd).

searchstring

Procura no nosso número e no nome do cliente.

pageinteger
per_pageinteger

Response

Success

totalRecordsinteger
currentPageinteger

Zero quando nenhum boleto atende aos filtros.

totalPagesinteger

Changes

No recorded changes to this operation across all 1 revision of this API.