Pular para o conteúdo principal

Atualizar Configurações Financeiras (Financial Settings)

Este serviço permite atualizar as configurações financeiras de um Corban, especificando o ID das Configurações Financeiras e os dados a serem modificados. A atualização é essencial para ajustar informações bancárias, de gestão de comissão, ou outros dados relevantes para o pagamento direto ao Corban.

Endpoint para Atualizar Configurações Financeiras

  • Método: PUT
  • URL: https://bff-dev.granatech.com.br/api/financial-settings/{financialSettingsId}

Parâmetros de URL

  • financialSettingsId (string, obrigatório): O ID das Configurações Financeiras que deseja atualizar.

Corpo da Requisição

Inclua os campos das configurações financeiras a serem atualizados. Todos os campos do objeto FinancialSettings estão disponíveis para modificação. Segue um exemplo de estrutura:

{
"commissionEmail": "comissao@empresa.com",
"commercialManager": "João Silva",
"externalCommercialManager": "Maria Oliveira",
"bankAccount": "987654321",
"agency": "1234",
"accountDigit": "1",
"sourceIncomeTax": 0.15,
"kaminoId": "67890",
"bluepayId": "12345",
"bank": "Banco Bradesco S.A."
}

Exemplo de Requisição com curl

curl -X PUT https://bff-dev.granatech.com.br/api/financial-settings/12345 \
-H "Content-Type: application/json" \
-d '{
"commissionEmail": "comissao@empresa.com",
"commercialManager": "João Silva",
"externalCommercialManager": "Maria Oliveira",
"bankAccount": "987654321",
"agency": "1234",
"accountDigit": "1",
"sourceIncomeTax": 0.15,
"kaminoId": "67890",
"bluepayId": "12345",
"bank": "Banco Bradesco S.A."
}'

Exemplo de Resposta

A resposta traz o status da atualização confirmando as alterações realizadas.

{
"message": "Configurações financeiras atualizadas com sucesso",
"financialSettingsId": "12345"
}

Observações

  1. Atualização de Campos Específicos: Somente os campos especificados no corpo da requisição serão atualizados. Os demais dados permanecerão inalterados.
  2. Revisão dos Dados Atualizados: Utilize o serviço de consulta de Configurações Financeiras para verificar as atualizações realizadas.

Este endpoint facilita a manutenção das configurações financeiras, garantindo que as informações de pagamento e gestão estejam sempre atualizadas e corretas.