Exibir origem

Este documento tem por objetivo a documentar as API's disponíveis no projeto Integração Protheus FIEC.

Orientações gerais, autenticação e exemplos de consumo das API's.

<div class="post">POST</div>
<div class="endereco">/api/cst/v1/lojaclick/matricula/inserirMatricula</div>

Ao executar a chamada do webservice, se for inclusão de um serviço novo, o método irá:

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

Tabelas Afetadas: FCFO, PPESSOA, SALUNO, SHABILITACAOALUNO, SMATRICPL, SMATRICULA

Interfaces RM:

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.

Autenticação

Authorization - Basic Auth

Username <username>

Password <password>

ou

Authorization - Bearer Token

Username <username>

Password <password>

Body

[
   {
      "respFinanceiro":{
         "codColigada": 3,
         "classificacao": 1,
         "categoria":"F",
         "nome":"Braian Veloz De Mais",
         "dataNascimento":"2000-08-20",
         "email":"[email protected]",
         "estadoCivil":null,
         "nacionalidade": 0,
         "cgcCfo":"30780320000",
         "cI_Orgao":null,
         "cI_UF":"PR",
         "cI_numero":null,
         "telefone":"41985742365",
         "celular":"000000",
		 "telefoneComercial": "000000",
         "tipoBairro":1,
         "tipoRua":1,
         "bairro":"Conjunto Habitacional Boa Vista",
         "logradouro":"Rua Mário Cardoso Júnior",
         "numero":"12",
         "complemento":null,
         "cep":"38180733",
         "estado":"PR",
         "codMunicipio":"02109",
         "idPais":1
      },
      "aluno":{
		 "codColigada": 3,
         "codTipoAluno": 1,
         "codFilial": 3016,
         "codTipoCurso": 1,
         "nome":"Vei Do Rio",
		 "nomeSocial": "Veio",
         "sexo":"F",
         "dataNascimento":"1988-05-23T00:00:00",
         "corRaca": "2",
         "nacionalidade":"10",
         "email": "[email protected]",
         "estadoCivil": "S",
         "estadoNatal":"PR",
         "naturalidade":"01903",
		 "telefone1":"42999377381",
         "telefone2": "31993424866",
         "telefone3": null,
         "ci_numero":"13.379.055-1",
         "ci_uf":null,
         "ci_dtemissao":null,
         "ci_emissor":"SSP",
         "cpf": "50784804044",
         "tipoBairro":1,
         "tipoRua":1,
         "bairro":"Birim Birim",
         "logradouro":"Rua Ze Cardoso Júnior",
         "numero": "1158",
         "complemento": null,
         "cep": "38180733",
         "codMunicipio": "01903",
         "estado": "PR",
         "idPais": 1,
         "codProfissao": 1,
         "grauInstrucao": "5",
		 "situacaoOcupacional": "1",
		 "tipoEscolaOrigem": "1",
		"pai": {
         "nome":"TESTE PAI",
		 "nomeSocial": "PAPA",
         "sexo":"M",
         "dataNascimento":"1988-05-19T00:00:00",
         "corRaca":null,
         "nacionalidade":"10",
         "email":null,
         "estadoCivil":null,
         "estadoNatal": "PR",
         "naturalidade": "4120705",
		 "telefone1":"42999377381",
         "telefone2":null,
         "cI_numero":"13.379.055-1",
         "cI_UF":null,
         "cI_dtEmissao":null,
         "cI_Orgao":"SSP",
         "cpf":"455.351.820-10",
         "tipoBairro":1,
         "tipoRua":1,
         "bairro":"Conjunto Habitacional Boa Vista",
         "logradouro":"Rua Mário Cardoso Júnior",
         "numero":1158,
         "complemento":null,
         "cep":"38180733",
         "codMunicipio":"4120705",
         "estado":"PR",
         "idPais":55,
         "codProfissao":null,
         "grauInstrucao":null,
      },
      "mae": {
         "nome":"MAE TESTE",
		 "nomeSocial": "MAMA",
         "sexo":"F",
         "dataNascimento":"1988-05-19T00:00:00",
         "corRaca":null,
         "nacionalidade":"10",
         "email":null,
         "estadoCivil":null,
         "estadoNatal":"PR",
         "naturalidade":"4120705",
		 "telefone1":"42999377381",
         "telefone2":null,
         "cI_numero":"13.379.055-1",
         "cI_UF":null,
         "cI_dtEmissao":null,
         "cI_Orgao":"SSP",
         "cpf":"455.351.820-10",
         "tipoBairro":1,
         "tipoRua":1,
         "bairro":"Conjunto Habitacional Boa Vista",
         "logradouro":"Rua Mário Cardoso Júnior",
         "numero":1158,
         "complemento":null,
         "cep":"38180733",
         "codMunicipio":"4120705",
         "estado": "PR",
         "idPais":55,
         "codProfissao":null,
         "grauInstrucao":null,
		 "situacaoOcupacional": "1",
		 "tipoEscolaOrigem": "1"
      } 
      },
      "matricula":[
         {
            "codcoligada":3,
            "codFilial": 3016,
            "codTipoCurso": 1,
            "idHabilitacaoFilial":66620,
            "codTurma":"APP-I-G00455/2022",
            "idPerlet":3658,
			"periodo": "1",
			"campusPolo": "1",
			"tipoMatricula": 1,
			"dataMatricula": "2022-08-08",
			"camposComplementares":{
				"dataPrevistaSaida": "2022-12-20",
				"tipoGrat": "0",		
				"codFinanc": "1",
				"categoria": "5",
				"viraVida": "0",
				"seloOds": "0",
				"ebep": "0",
				"tempoIntegral": "0",
				"gratuidade": "0",
				"baixaRenda": "0",
				"portalTransp": "0"
			},
            "preContratoCrm":{
               "tipoContrato":"7",
               "modContrato":"002",
               "desContrato":"Descrição Modelo Contrato",
               "valorTotal":1150.00,
               "qtDeParcelas":1,
               "valorDesconto":234.00,
               "tipoDesconto":"V",
               "obsDesconto":"Obs. Desconto",
               "workload":"180",
               "valorAplicadoCurso":0,
               "dtInicioContrato":"2022-05-30T00:00:00",
               "dtFimContrato":"2022-11-30T00:00:00",
               "adesaoOdonto":true,
               "itemVendaodonto":"Item Venda Odonto",
               "valorItemOdonto":150,
               "itemVendaOfertada":"Item Venda Ofertada",
               "numPreContrato":"9876543999"
            }
         }
      ]
   }
]

Content

CodColigada: Código da Coligada no SGE. Enviar 2 para SESI e 3 para SENAI (primary key).
Codigo: Código do Serviço CRM (primary key);
Descricao: Nome do Serviço CRM;
Produto Protheus: Código do Produto no Protheus, associado ao serviço/curso. Utilizado no envio do Pedido de Venda do SGE para o Protheus (obrigatório);
Natureza: Código da Natureza Financeira, associado ao serviço/curso. Utilizado no envio do Pedido de Venda do SGE para o Protheus;
Item Contabil: (Id do protheus);
Conta Contabil: (Conta Contabil)
Ativo: true ou false, indica se o serviço está ativo ou não;
CodCurso: Lista de códigos de curso no SGE que serão vinculados, através do anexo customizado do Curso SGE, ao serviço que está sendo criado.

Retorno

{
   "Message": "Serviço incluído 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;