Agora no Bluesoft ERP, é possível realizar consultas detalhadas e incrementais de convênios via API

Objetivo

O objetivo desta novidade é permitir que sistemas externos obtenham de forma eficiente as alterações e novos cadastros de convênios, utilizando filtros específicos para reduzir o tráfego de dados e otimizar a integração.

Foi disponibilizado o endpoint GET /api/v2/convenios que suporta diversos parâmetros de consulta (Query Parameters) para refinar a busca:

  • convenioKey: Filtro pelo identificador único do convênio.
  • participanteKey: Filtro para localizar o convênio ao qual um participante específico está vinculado.
  • dataUltimaAlteracao: Permite busca incremental, retornando todos os convênios modificados a partir da data e hora informada (Formato: DD/MM/AAAA).
  • Paginação Obrigatória: O endpoint utiliza os parâmetros currentPage (padrão 1) e pageSize (padrão 30, máximo 1000) para garantir a performance do sistema.

A resposta da API retornará um JSON contendo a visão completa do convênio, incluindo campos como limiteCredito, diaBase, diaViradaMes e a data da última alteração.

Observações Importantes!

  • Permissões: É necessário possuir a permissão 603-Convenios Consultar para acessar o endpoint.
  • Segurança: O acesso exige autenticação via token (JWT ou OAUTH).
  • Padrão de Retorno: Caso o convenioKey informado não seja encontrado, o sistema retornará uma lista vazia com status 200.

Para conhecer mais sobre como é a utilização dessa ferramenta, clique aqui.

Para saber mais sobre a utilização das APIs do ERP, clique aqui.

Disponível a partir da versão r367.01