Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Expandir
titleMatricular Aluno
HTML
<div class="post">POST</div>
<div class="endereco">/rm/api/TOTVSCustomizacao/IntegracaoSALESFORCE/RealizarMatricula</div>

Realiza a Matrícula do aluno no SGE, geração do Contrato Educacional e suas parcelas e preenche o anexo de dados complementares do contrato, conforme dados enviados pela API.

Tabelas Afetadas: SMATRICPL, SMATRICULA, SHABILITACAOALUNO, SCONTRATO, SPARCELA, ZINTSFDADOSCONTRATO e ZINTSFDADOSCONTRATOPARCELA

Interfaces RM:

TOTVS Educacional | Educacional | Currículo e Oferta | Alunos |  Anexo | Matricula no Período Letivo | Anexo | Matriculas em disciplinas

TOTVS Educacional | Educacional | Matricula e Avaliação | Matricula no Período Letivo | Aluno | Anexo | Matriculas em disciplinas

TOTVS Educacional | Educacional | Financeiro Contábil | Contratos | Alunos | Dados complementares do Contrato

TOTVS Educacional | Educacional | Financeiro Contábil | Contratos | Anexo | Dados complementares do Contrato


Authorization - Basic Auth

Username <username>

Password <password>

Body

Bloco de código
languagec#
titleRaw
{
    "CodColigada": 3,
    "IdMatrizAplicada": 5"3|22",
     "RA": "0000000382",
    "Turma": "11|TEC.001.017",
    "DataMatricula": "30/05/2022",
    "DataPrevSaida": "30/05/2023",
    "CondicaoAluno": 0,
    "CodFinSCAE": 1,
    "Articulacao": 2,
    "Contrato": {
        "NomeRespFin": "NOME DO CLIENTE FORNECEDOR",
        "CodColCfo": 0,
        "CodCFO": "0564404200001",
        "ValorTotal": 240.0,
        "QuantidadeParc": 1,
        "ParcelasCartaoParcelaUm": 0,
        "DataVencimento": "20/06/2022",
        "DiaVencimento": 20,
        "DescontoInstitucional": 0,
        "DescontoAdicional": 0,
        "Motivo": "Teste matricula aluno",
        "DataVenda": "26/04/2022",
        "IdOportunidade": 1,
        "FormaPagtoPrimeiraParc": "CAC",
        "FormaPagtoDemaisParc": "CAC",
        "ReceberBoletoEmail": "Sim",
        "Ecommerce": "SIM",
        "DadosCartao": {
            "Cod_Loja": 0001,
            "Agencia": "1369",
            "Cod_Banco": "001",
            "Conta": "2002",
            "Motivo": "CAC",
            "AdquirenteCartao": "999999999",
            "BandeiraCartao": "MASTERCARD",
            "NSU": "9999999999",
            "MeioPagamento": "Crédito",
            "ValorTotalCartao": 240.0,
            "ParcelasCartao": 5
        }
    },
    "Disciplinas": []
}

Content

  • IdMatrizAplicada: Código da Coligada seguido do Identificador da Matriz Aplicada (Curso/Habilitação e Período Letivo) (Campo Obrigatório); Mesma informação enviada pelo SGE na exportação da matriz.
  • 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 no RM/Salesforce/Protheus (Campo Obrigatório);
    • CodColCfo: Código da Coligada do cliente Fornecedor. Se for global, enviar 0 - zero (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 do contrato de venda (referente à quantidade de pedidos gerenciais);
    • ParcelasCartaoParcelaUm: Quantidade de parcelas do financiamento com pagamento em algum tipo de cartão (débito ou crédito);
    • DataVencimento: Data do vencimento da primeira parcela do contrato (Campo obrigatório);
    • 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 (Campo obrigatório);
    • 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). Este valor corresponde ao valor total de desconto a ser distribuído entre as parcelas;
    • 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). Este valor corresponde ao valor total de desconto a ser distribuído entre as parcelas;
    • MotivoDesconto: Descrição do Motivo do desconto adicional ou institucional (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


    • Dados Cartão:  
      • Esse bloco só deve ser enviado para pagamento com cartão através do E-commerce. Só é permitido enviar dados de um cartão de crédito. Essas informações são enviadas no complemento do pedido de venda do Protheus;
      • Cod_Loja: Código da loja;
      • Agência, Cod_Banco e Conta: Dados bancários relacionados ao pagamento e-commerce;. 
      • Motivo: informar um dos valores abaixo
      • 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)
      • AdquirenteCartao: Código do adquirente
      • BandeiraCartao: Informar uma das bandeira definidas para integração. Exemplo: MASTERCARD;
      • NSU: Código do NSU;
      • MeioPagamento: Opções disponíveis: "Crédito" ou "Débito"; 
      • ValorTotalCartao: Valor total da venda;
      • ParcelasCartao: Quantidade de Parcelas junto a operadora do cartão. Informação enviada para Protheus para geração de títulos a receber para operadora do cartão. 


Informação sobre o envio de pagamento via e-commerce:

Quando for enviado pagamento via e-commerce o campo QuantidadeParc do contrato deve ser igual a 1 (um), pois será considerada apenas uma parcela no SGE. A quantidade de vezes que o pagamento foi parcelado no cartão deve ser enviado no campo ParcelasCartao dos dados do pagamento com cartã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

Bloco de código
languagec#
titleConsole
{
    "Matricula": {
        "Matricula": "0000000001",
        "XNumPro": "SGE3F20C100",
        "CodFilial": "UN20",
        "FilialProtheus": "03CE0001",
        "CodColigada": 3,
        "CodContrato": "100",
        "StatusContrato": "Vigente",
        "DataInicio": "2022-07-08T00:00:00",
        "DuracaoEmMeses": 4,
        "SituacaoMatricula": "Pré-Matriculado"
    },
    "Message": "Matrícula realizada com sucesso!",
    "Status": "Sucesso",
    "StatusCode": 200
} 

Content

  • Matricula: Registro acadêmico do aluno;
  • XNumPro: Identificador do contrato integrado com o Protheus e SalesForce;
  • CodFilial: Código da filial;
  • FilialProtheus: Código da filial no Protheus (retornado do cadastro de filial do SGE, campo IdIntegracao);
  • CodColigada: Código de status da coligada;
  • StatusContrato: Status do contrato (texto fixo);
  • DataInicio: Data de início do contrato;
  • DuracaoEmMeses: Duração do contrato com base das datas das Turmas/Disciplinas;
  • SituacaoMatricula: Descrição da situação de matrícula no SGE;
  • 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;

...

Expandir
titleContrato PJ - Recebimento Contrato
HTML
<div class="post">POST</div>
<div class="endereco">/rm/api/TOTVSCustomizacao/ContratoPJ/SetContract</div>


Inclui ou altera um Contrato Pessoa Jurídica no SGE, para permitir que matrículas geradas no SGE sejam vinculadas aos contratos.

Tabela Afetada: ZPJFIECCONTRATO

Interface RM: TOTVS Educacional | Educacional | Customizações | Contrato PJ | Contratos

Authorization - Basic Auth

Username <username>

Password <password>

Body

Bloco de código
languagec#
titleRaw
{
  "CodColigada": 3,
  "Filial": "03CE0001",
  "NumeroContrato": "123456",
  "NumProposta": "123",
  "CNPJ": "58069568000149",
  "NomeEmpresa": "Entrega Contrato PJ",
  "ValorContrato": 1000,
  "CodTurma": "APB.001.001",
  "IdPerlet": 4,
  "VagasOfertadas": 10,
  "VagasUtilizadas": 2,
  "StatusContrato": true
}

Content

  • CodColigada: Código da Coligada no SGE. Enviar 2 para SESI e 3 para SENAI (primary key).
  • Filial:  Código da Filial do Salesforce, formato do SGE (sem sigla 'UN').
  • NumeroContrato: Número do Contrato PJ no CRM (primary key);
  • NumProposta Número da Proposta do Contrato PJ no CRM (primary key);
  • CNPJ: CNPJ da empresa responsável pelo Contrato PJ (obrigatório).
  • NomeEmpresa: CNPJ da empresa responsável pelo Contrato PJ (obrigatório).
  • ValorContrato: Valor total do Contrato PJ.
  • CoTurma: Código da turma referente ao Contrato PJ, no mesmo formato enviado na exportação de Turmas. 
  • VagasOfertadas: Número total de vagas ofertadas para o Contrato PJ.
  • VagasUtilizadas: Número de vagas já utilizadas do Contrato PJ.
    • Observação: O número de vagas disponíveis deverá ser calculado a partir do total de vagas ofertadas e as vagas utilizadas de cada Contrato PJ.
    StatusContrato

Retorno

Bloco de código
languagec#
titleConsole
{
  "Message": "Registro integrado com sucesso",
  "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;

...