Agora no Bluesoft ERP, é possível informar e consultar a forma de atualização do saldo do convênio diretamente através da API de Convênios.

Como Irá Funcionar a Partir de Agora?

Os endpoints da API de Convênios v2 foram otimizados com a introdução do novo campo formaAtualizacaoSaldo (do tipo ENUM).

O comportamento do novo campo varia de acordo com as seguintes regras de negócio estruturadas:

• Valores Aceitos: O campo aceita estritamente os valores BAIXA ou QUITACAO. O envio de qualquer valor diferente resultará em um erro funcional na validação da requisição.
• Comportamento Padrão (Default): Caso o campo formaAtualizacaoSaldo não seja enviado no payload de criação (POST), o sistema assumirá e gravará automaticamente o valor BAIXA.
• Vínculo com a Rotatividade de Saldo:
  • Quando o campo rotatividadeSaldo for igual a ACUMULATIVO (que representa a opção Nenhum da tela do ERP), a API permitirá escolher livremente entre BAIXA ou QUITACAO.
  • Quando o campo rotatividadeSaldo for igual a MENSAL, o sistema bloqueará a criação caso o usuário informe o valor QUITACAO. Para rotatividade mensal, o campo não precisa ser enviado, pois a atualização ocorre por virada de mês.

Exemplos de Integração (Payloads)

1. Criação de Convênio Acumulativo com Atualização por Quitação (POST /api/v2/convenios):

JSON

{
  "convenio": {
    "status": "ATIVO",
    "codigoDeIntegracao": "CONV-EXTERNO-100",
    "limiteCredito": 5000,
    "rotatividadeSaldo": "ACUMULATIVO",
    "formaAtualizacaoSaldo": "QUITACAO",
    "participantesDoConvenio": [
      {
        "cpfCnpj": "415228408009",
        "limiteCredito": 1000,
        "status": "ATIVO"
      }
    ]
  }
}

2. Retorno da Consulta / Detalhe do Convênio (GET /api/v2/convenios/{convenioKey}):

JSON

{
  "convenioKey": 12345,
  "codigoDeIntegracao": "CONV-EXTERNO-100",
  "status": "ATIVO",
  "limiteCredito": 5000,
  "rotatividadeSaldo": "ACUMULATIVO",
  "formaAtualizacaoSaldo": "QUITACAO"
}

Observações Importantes!

• Bloqueio de Alteração Pós-Movimentação: Assim como ocorre na tela do ERP, se o convênio já possuir histórico de movimentações ou saldos associados aos participantes, o sistema bloqueará qualquer tentativa de alteração do campo formaAtualizacaoSaldo.
• Atualização do Swagger: Toda a documentação técnica dos endpoints de POST, PUT e GET foi atualizada no Swagger/OpenAPI detalhando a obrigatoriedade, valores aceitos e comportamentos padrões para facilitar a implementação pelos desenvolvedores.

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.