| 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 Parcelas 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 | Matrículas no Período Letivo TOTVS Educacional | Educacional | Currículo e Oferta | Alunos | Matrículas no Período Letivo | Matrícula em Disciplinas TOTVS Educacional | Educacional | Currículo e Oferta | Alunos | Matrículas no Período Letivo | Contratos| Financeiro Contábil | Contratos TOTVS Educacional | Educacional | Financeiro Contábil | Contratos | Anexo | Dados complementares do Contrato
Authorization - Basic AuthUsername <username> Password <password> Body| Bloco de código |
|---|
| {
"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": {
"NomeRespFin": "Responsavel Rafaela",
"CodColCfo": 2,
"CodCFO": "9989098600001",
"ValorTotal": 600.0,
"QuantidadeParc": 5,
"DataVencimento": "12/02/2022",
"DiaVencimento": 12,
"DescontoInstitucional": 8.0,
"DescontoAdicional": 1.0,
"MotivoDesconto": "Desconto funcionário da indústria",
"DataVenda": "30/12/2021",
"IdOportunidade": 1,
"FormaPagtoPrimeiraParc": "CACCAR",
"FormaPagtoDemaisParc": "BOL",
"ReceberBoletoEmail": "Sim",
"PedidoFiscal": null,
"Ecommerce": "SIM",
"DadosCartao": {
"Cod_Loja": 0,
"Agencia": "TESTE",
"Cod_Banco": "158",
"Conta": "000001",
"AdquirenteCartao": null,
"MeioPagamento": "Crédito",
"BandeiraCartao": "Elo",
"NSU": "123",
"ValorTotalCartao": 120.0,
"ParcelasCartao": 1
}
},
"Disciplinas": [],
"CodColigada": 2,
"CamposValoresChaveGrupo": null
} |
Content
- 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.
- 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.
- 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 |
|---|
| {
"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;
|
