Pular para o conteúdo principal

Criar Configurações Financeiras (Financial Settings)

As Configurações Financeiras permitem configurar parâmetros financeiros que serão atribuídos ao Corban, possibilitando o pagamento direto ao Corban conforme suas vendas, sem a necessidade de intermediários, como promotoras.

Endpoint para Criar Configurações Financeiras​

  • Método: POST
  • URL: https://bff-dev.granatech.com.br/api/financial-settings

Estrutura de Dados para Financial Settings​

O objeto FinancialSettings define detalhes bancários e parâmetros de gestão financeira que viabilizam o recebimento de pagamentos para o Corban. Estes dados devem ser configurados antes de associar as Configurações Financeiras ao Corban.

Campos do Objeto FinancialSettings​

  • commissionEmail (string, obrigatório): E-mail de contato para recebimento de comissões.
  • commercialManager (string, obrigatório): Nome do gestor comercial associado ao Corban.
  • externalCommercialManager (string, opcional): Nome do gestor comercial externo, se aplicável.
  • bankAccount (string, obrigatório): Conta bancária para o recebimento.
  • agency (string, obrigatório): Agência bancária.
  • accountDigit (string, obrigatório): Dígito da conta bancária.
  • sourceIncomeTax (number, obrigatório): Percentual de imposto de renda aplicado sobre a fonte pagadora.
  • kaminoId (string, obrigatório): Identificador do sistema Kamino.
  • bluepayId (string, obrigatório): Identificador do sistema Bluepay.
  • bank (string, obrigatório): Nome do banco associado ao Corban. Veja a lista completa de Bancos Disponíveis aqui.

Exemplo de Dados para Criar Configurações Financeiras​

{
  "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 para Criar Configurações Financeiras​

curl -X POST https://bff-dev.granatech.com.br/api/financial-settings \
  -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."
  }'

Observações​

  1. Configuração Prévia para Corban: Este endpoint deve ser usado para definir as Configurações Financeiras antes da criação de um Corban que necessite de recebimento direto.
  2. Pagamentos Diretos (Pagamento em Y): Este recurso permite o pagamento direto ao Corban, com base em suas próprias vendas e regras fiscais definidas.
  3. Bancos Disponíveis: Certifique-se de selecionar um banco da lista de Bancos Disponíveis aqui para garantir o processamento correto dos pagamentos.

Configurar corretamente as FinancialSettings é essencial para que o Corban possa receber os pagamentos de maneira direta e eficiente.