Histórico da Página

<div class="post">POST</div>
<div class="endereco">/rm/api/TOTVSCustomizacao/IntegracaoSALESFORCE/GravarResponsavelFinanceiro</div>

Realiza a gravação do responsável financeiro no SGE, conforme dados enviados pela API.

Authorization - Basic Auth

Username <username>

Password <password>

Body

{
 "CodCFO": "7604288600001",
 "Nome": "responsaveltesteapi",
 "Cpf": "42302908023",
 "Email": "[email protected]",
 "Cep": "31810365",
 "Logradouro": "Logradouro",
 "Numero": 20,
 "Complemento": "101",
 "Bairro": "Bairro",
 "Estado": "MG",
 "Cidade": "Belo Horizonte",
 "Pais": "Brasil",
 "Telefone": "03189898989",
 "Celular": "77777777777",
 "Tel_Comercial": "0314545454545",
 "Fax": "0314545454545",
 "CodColigada": 3,
 "Global": true
}

Content

• CodCFO: Código identificador do cliente Salesforce/Protheus.

Deve ser enviado no seguinte formato: 9 primeiros dígitos do CPF ou 8 primeiros  primeiros dígitos do CNPJ + código da loja. Exemplo: 0101251250001

• Nome: Nome do responsável financeiro no SGE (Campo Obrigatório);

• Cpf: CPF do responsável financeiro no SGE (Campo Obrigatório);
• Email: E-mail do responsável financeiro no SGE (Campo Obrigatório);
• Cep: CEP do endereço do aluno no SGE (Campo Obrigatório);

• Logradouro: Nome da rua (Campo Obrigatório);

• Numero: Numero da residencia (Enviar apenas números)(Campo Obrigatório);

• Complemento: Complemento se houver (Campo Obrigatório);
• Bairro: Nome do bairro (Campo Obrigatório);
• Estado: Enviar Sigla do Estado (Campo Obrigatório);

• Cidade: Enviar Nome da Cidade (Campo Obrigatório);

• Pais: Enviar Nome do país (Campo Obrigatório);

• Telefone: Número telefone fixo (Enviar apenas números com DDD)(Campo Obrigatório);

• Celular: Número telefone celular (Enviar apenas números com DDD) (Campo Obrigatório);

• Tel_Comercial: Numero telefone comercial(Enviar apenas números com DDD);

• Fax: Número fax (Enviar apenas números com DDD);

• CodColigada: Código da Coligada no SGE. Enviar 2 para SESI e 3 para SENAI (Campo obrigatório).
• Global: informar se o registro do cliente será compartilhado entre as coligadas. Enviar true para Global e false para registro por coligada. 

Retorno

{
   "Message": "Responsavel: 00000005, criado com Sucesso!\r\n",
   "Status": "Sucesso",
   "StatusCode": 200
}

Content

• Message: Mensagem de retorno do consumo da requisição;
• Status: Situação do processamento da requisição;
• StatusCode: Código de status do processamento da requisição;

<div class="post">POST</div>
<div class="endereco">/rm/api/TOTVSCustomizacao/IntegracaoSALESFORCE/RealizarMatricula</div>

Realiza a matrícula do aluno no SGE, conforme dados enviados pela API.

Authorization - Basic Auth

Username <username>

Password <password>

Body

{
    "IdMatrizAplicada": 5,
    "RA": "00000018",
    "Turma": "123|TEC.001.006",
    "DataMatricula": "20/12/2021",
    "DataPrevSaida": "01/01/2022",
    "CondicaoAluno": 0,
    "CodFinSCAE": 1,
    "Articulacao": 2,
    "CodColigada": 3,
    "Contrato": {
        "CodCFO": "9688653800001",
        "NomeRespFin": "RTeste1",
        "ValorTotal": 210,
        "QuantidadeParc": 12,
        "DataVencimento": "20/02/2022",
        "DiaVencimento": 21,
        "DescontoInstitucional": 8,
        "DescontoAdicional": 1,
        "Motivo": "Teste matricula aluno",
        "DataVenda": "25/12/2021",
        "IdOportunidade": 1,
        "FormaPagtoPrimeiraParc": "CACCAR",
        "FormaPagtoDemaisParc": "BOL",
        "ReceberBoletoEmail": "Sim",
        "ECommerce": "Sim"
     }
    }
 "Disciplinas": [ "0001|0001|123456", "0001|0001|789101" ]
   }

Content

• IdMatrizAplicada: Identificador da Matriz Aplicada (Curso/Habilitação e Período Letivo) (Campo Obrigatório);
• RA: Registro acadêmico do aluno no SGE (Campo Obrigatório);
• Turma: Código da Turma do SGE onde o aluno será matriculado (Campo Obrigatório);. O código da turma enviado contém o identificador do período letivo seguido do código da turma do SGE, concatenados por '|'. 
• DataMatricula: Data da Matrícula do aluno (Campo Obrigatório);
• DataPrevSaida: Data final do Curso;
• CondicaoAluno: Condição do Aluno (SENAI);

    Valores possíveis:
      0 = Não Gratuita.
      1 = Gratuidade regimental
      2 = Bolsa de estudos
      3 = Convênio

• CodFinSCAE: Código Financiamento SCAE;
  • Valorespossíveis:

        0 = Não Gratuita
        2 = Gratuidade Regulamentar
        3 = Gratuidade Não Regulamentar

• Articulacao: Código de Articulação.

• 
  

  Valores possíveis:
       1 = Há Articulação Sesi/Senai
       2 = Não há Articulação Sesi/Senai
       3 = Há Articulação entre outras instituições

• CodColigada: Código da Coligada no SGE (Campo Obrigatório);
• Contrato:  
  • CodCFO: Código identificador do cliente Salesforce/Protheus (Campo Obrigatório);
  • NomeRespFin: Nome do responsável financeiro no SGE (Campo Obrigatório);
  • ValorTotal: Valor total da venda (sem descontos de bolsas);
  • QuantidadeParc: Quantidade de parcelas da venda;
  • DataVencimento: Data do vencimento da primeira parcela do contrato;
  • DiaVencimento: Dia fixo do vencimento que será utilizado na geração da segunda parcela em diante. A data será gerada com o dia fixo informado do mês subsequente do início da turma, até atingir a quantidade de parcelas;
  • DescontoInstitucional: Valor do desconto institucional, com base no valor total do contrato. Quando informado, será criada uma bolsa Institucional ao contrato (conforme código de bolsa informado nos parâmetros da customização).
  • DescontoAdicional: Valor do desconto adicional, com base no valor total do contrato. Quando informado, será criada uma bolsa Adicional ao contrato (conforme código de bolsa informado nos parâmetros da customização).
  • Motivo: Descrição do Motivo do desconto adicional (obrigatório no caso de desconto concedido);
  • DataVenda: Data corrente do recebimento da matrícula;
  • IdOportunidade: Identificador da oportunidade fechada no SALESFORCE ;
  • FormaPagtoPrimeiraParc: Forma De pagamento - Primeira parcela (Campo Obrigatório);

                                  Valores possíveis:;

                                    BOLETO: BOL (Mensalidade Boleto)
                                    Cartão crédito: CAC (Mensalidade Cartão de crédito)
                                    Cartão débito: CAR (Mensalidade Cartão de débito)
                                    Dinheiro: ESP (Mensalidade dinheiro)

• • FormaPagtoDemaisParc: Forma De pagamento - Demais parcelas (Campo Obrigatório);
  •              Valores possíveis:
                   BOLETO: BOL (Mensalidade Boleto)
                   Cartão crédito: CAC (Mensalidade Cartão de crédito)
                   Cartão débito: CAR (Mensalidade Cartão de débito)
                   Dinheiro: ESP (Mensalidade dinheiro)
  • ReceberBoletoEmail: Recebe Boleto por E-mail (Campo Obrigatório);
  •             Valores possíveis: Sim ou Não - se o boleto foi enviado por e-mail
  • ECommerce: Identificação de E-Commerce

                                 Valores possíveis: Sim ou Não

• Disciplinas: Lista de códigos da Disciplinas onde o aluno deverá ser matriculado no SGE. Caso este campo não seja informado, o aluno será matriculado em todas as disciplinas da turma/matriz aplicada.

Retorno

{
   "Message": "Matrícula realizada com sucesso!\r\n",
   "Status": "Sucesso",
   "StatusCode": 200
}

Content

• Message: Mensagem de retorno do consumo da requisição;
• Status: Situação do processamento da requisição;
• StatusCode: Código de status do processamento da requisição;