Histórico da Página

...

Expandir

title	Matricular 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:

Authorization - Basic Auth

Username <username>

Password <password>

Body

Bloco de código

language	c#
title	Raw

{
    "CodColigada": 3,
    "IdMatrizAplicada": 5,
    "RA": "000000180000000382",
    "Turma": "12311|TEC.001.006017",
    "DataMatricula": "2030/1205/20212022",
    "DataPrevSaida": "0130/0105/20222023",
    "CondicaoAluno": 0,
    "CodFinSCAE": 1,
    "Articulacao": 2,
    "CodColigada": 3,        
    "Contrato": {
        "NomeRespFin": "Responsavel RafaelaNOME DO CLIENTE FORNECEDOR",
        "CodColCfo": 20,
        "CodCFO": "99890986000010564404200001",
        "ValorTotal": 600240.0,
        "QuantidadeParc": 1,
        "ParcelasCartaoParcelaUm": 50,
        "DataVencimento": "1220/0206/2022",
        "DiaVencimento": 1220,
        "DescontoInstitucional": 8.0,
        "DescontoAdicional": 1.0,
        "MotivoDescontoMotivo": "DescontoTeste funcionáriomatricula da indústriaaluno",
        "DataVenda": "3026/1204/20212022",
        "IdOportunidade": 1,
        "FormaPagtoPrimeiraParc": "CACCARCAC",
        "FormaPagtoDemaisParc": "BOLCAC",
        "ReceberBoletoEmail": "Sim",
        "PedidoFiscal": null,
        "Ecommerce": "SIM",
        "DadosCartao": {
            "Cod_Loja": 00001,
            "Agencia": "TESTE1369",
            "Cod_Banco": "158001",
            "Conta": "0000012002",
            "AdquirenteCartaoMotivo": null"CAC",
            "MeioPagamentoAdquirenteCartao": "Crédito999999999",
            "BandeiraCartao": "EloMASTERCARD",
            "NSU": "1239999999999",
            "ValorTotalCartaoMeioPagamento": 120.0"Crédito",
            "ParcelasCartaoValorTotalCartao": 1240.0,
         }
    },
"ParcelasCartao": 5
       "Disciplinas": [], }
    "CodColigada": 2},
    "CamposValoresChaveGrupoDisciplinas": null[]
}

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 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;
- 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).
- 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 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

language	c#
title	Console

{
   "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;

...

Atalhos

Páginas filhas

Versões comparadas

Versão antiga 68

Nova versão 69

Chave

Authorization - Basic Auth

Body