Agora no Bluesoft ERP, o endpoint de atualização de convênios (PUT) foi expandido para permitir a alteração de diversos campos que antes eram restritos à criação (POST), incluindo os novos parâmetros mesSubsequente e emitirDuplicataNomeParticipante.

Objetivo: Padronizar a estrutura de dados entre os métodos de inclusão e edição da API V2, conferindo maior flexibilidade às integrações para manter os dados dos convênios sempre atualizados sem depender de ajustes manuais no ERP.

O Que Mudou?

  • Agora: A estrutura de atualização foi equalizada. Agora, quase os campos enviados no POST podem ser atualizados via PUT. Além disso, o sistema passa a suportar:
    • mesSubsequente: Define se o faturamento é projetado para o mês seguinte.
    • emitirDuplicataNomeParticipante: Habilita a geração de títulos individuais por CPF.
  • Benefícios: Autonomia total para sistemas externos gerenciarem o ciclo de vida dos convênios e garantia de que as regras de faturamento (como faturamento no mês subsequente) estejam sempre corretas.

Como Irá Funcionar a Partir de Agora? Ao utilizar os endpoints da API V2 de Convênios, os desenvolvedores devem se atentar às novas regras de comportamento:

Exemplo de JSON (PUT):

{
  "status": "ATIVO",
  "codigoDeIntegracao": "CONV-EXTERNO-001",
  "limiteCredito": 5000,
  "saldoConvenio": 1000,
  "limiteTotalCompartilhado": false,
  "habilitarConvenioCompra": true,
  "habilitarConvenioVenda": true,
  "vendaViaTerceiros": false,
  "diaBase": 5,
  "valorTolerancia": 0,
  "geracaoAutomaticaDuplicata": true,
  "periodicidadeDuplicata": "MENSAL",
  "diaViradaMes": 30,
  "referenciaEmissao": "MES_ANTERIOR",
  "rotatividadeSaldo": "MENSAL",
  "convenioParcelado": false,
  "numeroParcelas": 2,
  "tipoFormaPagamentoKey": 3,
  "diaVencimentoDuplicata": 10,
  "diaViradaGeracaoDuplicata": 1,
  "diaCorteApuracao": 1,
  "participantesDoConvenio": [
    {
      "cpfCnpj": "##########",
      "limiteCredito": 1000,
      "status": "ATIVO"
    }
  ],
  "mesSubsequente": true,
  "emitirDuplicataNomeParticipante": true
}
  1. Atualização Seletiva: Ao utilizar o método PUT, caso um campo opcional seja omitido no JSON da requisição, o sistema manterá o valor anterior cadastrado, evitando a perda acidental de dados.
  2. Campos Editáveis: Agora é possível alterar via API campos como: status, limiteCredito, codigoDeIntegracao, mesSubsequente, emitirDuplicataNomeParticipante, entre outros.
  3. Restrições de Integridade: Por questões de segurança e consistência do ERP, os campos abaixo permanecem imutáveis e não podem ser alterados via PUT:
    • cpfCnpj: O documento de identificação do convênio não pode ser alterado após a criação.
    • tipoConvenio: A classificação do convênio é fixa para o registro.

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 r368.01