Agora no Bluesoft ERP, é possível consultar, habilitar ou desabilitar o atributo Regra Fiscal de Saída do cadastro de clientes via API

Como Era o Processo Antes?

  • Embora o campo “Usa Regra Fiscal” já existisse na interface gráfica do ERP (aba Clientes – Dados Gerais), ele não era retornado nas consultas via API e nem podia ser preenchido ou alterado por integrações.

Como Irá Funcionar a Partir de Agora?

Foi adicionado o novo campo regraFiscalDeSaidaAtivada (do tipo booleano) nos principais endpoints de clientes.

Confira o comportamento em cada operação:

  • Consulta (GET):
    • GET /api/clientes: O objeto de retorno agora inclui o atributo, indicando true (Ativada) ou false (Desativada).
    • GET /api/clientes/{clienteKey}: Retorna o valor fidedigno ao que está gravado no banco de dados para o cliente específico.
  • Inclusão (POST):
    • POST /api/clientes: Permite enviar o campo na criação do registro.
    • Regra de Omissão: Caso o atributo não seja enviado, o sistema assumirá o valor padrão false no banco de dados.
  • Atualização (PUT):
    • PUT /api/clientes/{cpfCnpj}: Permite alterar o estado do campo.
    • Manutenção de Valor: Se o atributo for omitido no payload do PUT, o valor atual já existente no banco de dados será mantido sem alterações.

Observações / Validações

  • Tratamento de Erro: Caso o valor enviado para o campo não seja um booleano (ex: enviar uma string ou número), o sistema retornará erro 400 – Bad Request.
  • Sincronização: Qualquer alteração feita manualmente pela interface gráfica do ERP será refletida imediatamente nas consultas via API.
  • Documentação: O novo campo já está disponível e documentado no Swagger da API de Clientes para consulta técnica de tipagem e modelos.

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