Histórico da Página

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

Realiza a gravação do aluno no SGE, conforme dados enviados pela API.

Tabela AfetadaTabelas Afetadas: SALUNO, PPESSOA, SALUNOCOMPL

Interface RM: TOTVS Educacional | Educacional | Currículo e Oferta | Alunos

Authorization - Basic Auth

Username <username>

Password <password>

Body

{
  "Nome": "Teste Api 2 ",
  "EstadoNatal": "MG",
  "Naturalidade": "Belo Horizonte",
  "DataNascimento": "05/07/1978",
  "Cpf": "85763425022",
  "Cep": "38700412",
  "Rua": "Pascoal Soares",
  "Numero": 10,
  "Complemento": "102",
  "Bairro": "Savassi",
  "Estado": "SP",
  "Cidade": "São Paulo",
  "Pais": "Brasil",
  "Tel_Residencial": "3333333333333",
  "Tel_Celular": "2312321312",
  "Tel_3": "13123132313",
  "Fax": "312321313131",
  "SitOcupacional": 1,
  "TipoEscola": 3,
  "CodColigada": 3,
  "IdMatrizAplicada": 4,
  "Email": "[email protected]",
  "NomeMae": "Nome da mãe do Aluno"
}

Content

• Nome: Nome do Aluno no SGE (Campo Obrigatório);

• EstadoNatal: Estado Natal do Aluno no SGE (Campo Obrigatório);

• Naturalidade: Naturalidade do Aluno no SGE (Campo Obrigatório);
• DataNascimento: Data de Nascimento do Aluno no SGE (Campo Obrigatório);
• Cpf: CPF do Aluno no SGE (Campo Obrigatório);
• Cep: CEP do Aluno no SGE;
• Rua: Rua do Aluno no SGE;
• Numero: Número do Aluno no SGE;
• Complemento: Complemento do Aluno no SGE;
• Bairro: Nome do bairro do Aluno;
• Estado: Sigla do Estado do Aluno;
• Cidade: Nome da Cidade do Aluno;
• Pais: Nome do País do Aluno;
• Tel_Residencial: Telefone Residencial do Aluno no SGE;
• Tel_Celular: Telefone Celular do Aluno no SGE;
• Tel_3: Telefone 3 do Aluno no SGE;
• Fax: Fax do Aluno no SGE;
• SitOcupacional: Situação ocupacional do Aluno no SGE;

       Valores possíveis:
               1 = Empregado
               2 = Desempregado
               3 = Empregador
               4 = Autônomo/Conta Própria
               5 = Profissional Liberal
               6 = 1º Emprego
               7 = Aposentado
               8 = Microempreendedor Individual - MEI
               9 = Aprendiz com contrato   

• TipoEscola: Tipo de escola de Origem do Aluno no SGE;

             Valores possíveis:
               1 = Particular
               2 = Pública - Municipal
               3 = Pública - Estadual
               4 = Pública - Federal
               9 = Não Declarado

• CodColigada: Código da Coligada no SGE (Campo Obrigatório);
• IdMatrizAplicada: Identificador da Matriz Aplicada (Curso/Habilitação e Período Letivo) (Campo Obrigatório);
• NomeMae:  Nome da mãe do aluno, que será gravado em campo complementar do cadastro do aluno (não obrigatório na API).
• Email: Endereço de e-mail do Aluno, que será gravado no campo do cadastro da Pessoa.

Retorno

{
   "Message": "Aluno: 205, existente em base, atualizado 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 Matrícula do aluno no SGE, geração do Contrato Educacional e Parcelas conforme dados enviados pela API.

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

Interfaces Interface 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

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

• 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.  
    • 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

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

<div class="post">POST</div>
<div class="endereco">/rm/api/TOTVSCustomizacao/CstIntegracaoProtheus/InclusaoLancamento</div>

Realiza a inclusão dos lançamentos no Contrato Educacional do SGE para uso no projeto Integração Protheus FIEC.

A API efetua a execução do processo de "Geração de Lançamentos".

Tabela Afetada: FLAN, SLAN, FBOLETO 

Interface Interfaces RM:

TOTVS Educacional | Educacional | Financeiro/Contábil | Contratos | Parcelas | Lançamentos Financeiros

TOTVS Educacional | Educacional | Financeiro/Contábil | Contratos | Parcelas | Lançamentos Financeiros | Boletos

Authorization - Basic Auth

Username <username>

Password <password>

Body

[
    {
        "codColigada": "3",
        "xnumpro": "TESTE1",
        "contaCaixaBanco": "001",
        "contaCaixaAgencia": "01",
        "contaCaixaContaCorrente": "111111",
        "parcela": 
            {   "pedidoVendaGerencial": "TESTE2",
                "nossoNumero": "TESTE2",
                "dataEmissao": "01/01/2000",
                "dataVencimento": "05/01/2000"
            }       
    }
]

Content

• codColigada: Código da Coligada (obrigatório).
• xnumpro: Utilizado para identificar o contrato/parcela referente ao lançamento (obrigatório).
• contaCaixaBanco: Código do Banco da Conta Caixa/Convênio.
• contaCaixaAgencia: Agência da Conta Caixa/Convênio.
• contaCaixaContaCorrente: Conta Corrente da Conta Caixa/Convênio, com o dígito.
• parcela: Dados da Parcela do SGE
  • pedidoVendaGerencial: Número do Pedido de Venda Gerencial gerado no Protheus referente à parcela (obrigatório).
  • nossoNumero: Nosso número do boleto.
  • dataEmissao: Data de Emissão do lançamento (obrigatório).
  • dataVencimento: Data de vencimento do lançamento (obrigatório).

Retorno

{
"Message": "Sucesso ao incluir o Id. Lançamento 142.\r\n",
"Status": "Sucesso",
"StatusCode": 200,
"IdLan": 142
}

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;
• IdLan: Identificador do lançamento gerado pelo SGE.

<div class="post">POST</div>
<div class="endereco">/rm/api/TOTVSCustomizacao/CstIntegracaoProtheus/CancelamentoLancamento</div>

Cancela os lançamentos no RM, para uso no projeto Integração Protheus FIEC. O status do lançamento (FLAN.STATUS) é alterado para 2-Cancelado.

Tabela Afetada: FLAN

Interface RM: TOTVS Educacional | Educacional | Financeiro/Contábil | Contratos | Parcelas | Lançamentos Financeiros

Authorization - Basic Auth

Username <username>

Password <password>

Body

[
    {
		"codColigada": "3",
  		"idLan": "142",
  		"DataCancelamento": "01/01/2000"
	}
]

Content

• codColigada: Código da Coligada (primary key);
• idLan: Id do Lançamento (primary key);
• DataCancelamento: Data do Cancelamento do Lançamento (primary key);

Retorno

{
"Message": "Sucesso ao excluir o Id. Lançamento 142\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/CstIntegracaoProtheus/CancelamentoBaixa</div>

Cancela as baixas dos lançamento no RM, para uso no projeto Integração Protheus FIEC. O status do lançamento (FLAN.STATUS) é alterado de 1-Baixado para 0-Em aberto.

Tabela Afetada: FLAN, FLANBAIXA

Interface RM: TOTVS Educacional | Educacional | Financeiro/Contábil | Contratos | Parcelas | Lançamentos Financeiros (editar o lançamento e acessar o anexo "Baixas do Lançamento")

Authorization - Basic Auth

Username <username>

Password <password>

Body

[
    {
		"codColigada": "3",
  		"idLan": "142",
  		"DataCancelamento": "01/01/2000"
	}
]

Content

• codColigada: Código da Coligada (primary key);
• idLan: Id do Lançamento (primary key);
• DataCancelamento: Data do Cancelamento do Lançamento (primary key);

Retorno

{
"Message": "Sucesso ao cancelar baixa do Id. Lançamento 142\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/CstIntegracaoProtheus/BaixaTitulo</div>

Efetua a baixa do lançamento financeiro do SGE. O status do lançamento (FLAN.STATUS) é alterado para 1-Baixado.

Tabelas AfetadasTabela Afetada: FLAN, FLANBAIXA

Interface RM: TOTVS Educacional | Educacional | Financeiro/Contábil | Contratos | Parcelas | Lançamentos Financeiros (editar o lançamento e acessar o anexo "Baixas do Lançamento")

Authorization - Basic Auth

Username <username>

Password <password>

Body

[{
    "codColigada": "3",
    "idLan": "143",
    "ValorBaixa": 311.26,
    "DataBaixa": "16/12/2021",
    "ContaCaixa_Banco": "002",
    "ContaCaixa_AG": "9598",
    "ContaCaixa_CC": "1234",
    em análise pela FIEC: "ContaCaixa_SEMMOVIMENTACAO": "00001", 
    "Juros": 30.76,
    "Multa": 5.50,
    "Desconto": 0.0
}]

Content

• codColigada: Código da Coligada. Enviar 2 para SESI e 3 para SENAI (primary key).
• idLan: Id do Lançamento (primary key);
• ValorBaixa: Valor da Baixa do Título (primary key);
• DataBaixa: Data da Baixa do Título (primary key);
• Baixas com movimentação bancária:
  • ContaCaixa_Banco: Código do banco da Conta para realização da Baixa;
  • ContaCaixa_AG: Código da agencia do banco da Conta para realização da Baixa;
  • ContaCaixa_CC: Codigo da Conta corrente para rea\lização da Baixa;Baixas com movimentação bancária:
• Baixas sem movimentação bancária:
  • ContaCaixa_SemMovimentação: Código da Conta caixa do SGE utilizada para baixas de cartão e NCC que não efetuam movimentação bancária. 
• Juros: Taxa de Juros da Baixa;
• Multa: Valor da Multa da Baixa;
• Desconto: Valor de Desconto da Baixa;

Retorno

{
    "Message": "Sucesso ao baixar o titulo do Id. Lançamento 143\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/CstIntegracaoProtheus/AlteracaoNossoNumero</div>

Insere e/ou atualiza o NossoNumero do lançamento financeiro Lançamento Financeiro e Boleto do SGE.

Tabela Afetada: FLAN, FBOLETO

Interface Interfaces RM:

TOTVS Educacional | Educacional | Financeiro/Contábil | Contratos | Parcelas | Lançamentos Financeiros

TOTVS Educacional | Educacional | Financeiro/Contábil | Contratos | Parcelas | Lançamentos Financeiros | Boleto

Authorization - Basic Auth

Username <username>

Password <password>

Body

{
  "codColigada" : "1",
  "NossoNumero" : "123", 
  "IDLan" : 123,
  "NumeroPedido" : null,
  "CodFilial" : null
}

Content

• codColigada: Código da Coligada. Enviar 2 para SESI e 3 para SENAI (primary key).
• NossoNumero: Numero do NossoNumero (obrigatório).
• IDLan: Id do Lançamento (opcional) (Caso não seja possível preencher o campo IdLan, deverão ser enviados os parâmetros NumeroPedido e CodFilial).
• NumeroPedido: Numero do Pedido Gerencial (opcional).
• CodFilial: Código da Filial (opcional).

Retorno

{
    "Message": "Sucesso ao fazer a Alteração do Nosso Numero (IDLan/Numero Pedido : 172, NossoNumero: 123).\r\n\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;