Histórico da Página

...

Expandir

title	inserirPreMatricula

HTML
<div class="post">POST</div> <div class="endereco">/api/cst/v1/integracaocrm/matricula/inserirPreMatricula</div>

Ao executar a chamada da API, serão realizadas as seguintes operações:

Criação/Atualização do Pai do Aluno;

Criação/Atualização da Mãe do Aluno;

Criação/Atualização do Responsável Acadêmico do Aluno;

Criação/Atualização do Responsável Financeiro do Aluno;

Criação/Atualização do Aluno;

Criação da Matricula do Aluno (Habilitação, Período Letivo e Disciplinas);

Criação do Pré Contrato CRM no SGE;

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

Interfaces RM:

TOTVS BackOffice | Gestão Financeira | Cadastros | Cliente/Fornecedor

TOTVS Educacional | Educacional | Currículo e Oferta | Alunos

Bloco de código

language	c#
title	Raw

{
    "Pai": {
        "Bairro": "Centro",
        "CartIdentidade": "7849",
        "Cep": "83840000",
        "Cidade": "QUITANDINHA",
        "CodNaturalidade": "4106902",
        "CodProfissao": 49,
        "CodTipoBairro": 1,
        "CodTipoRua": 1,
        "Complemento": "Mansão",
        "CorRaca": 8,
        "Cpf": "49704304382",
        "CpfMotivo": null,
        "DeficienteAuditivo": false,
        "DeficienteFala": false,
        "DeficienteFisico": false,
        "DeficienteMental": false,
        "DeficienteVisual": false,
        "DtEmissaoIdent": "2020-07-14T00:00:00-03:00",
        "DtNascimento": "1959-07-14T00:00:00-03:00",
        "Email": "[email protected]",
        "Estado": "PR",
        "EstadoCivil": "S",
        "EstadoNatal": "PR",
        "GrauInstrucao": "7",
        "IdPais": 10,
        "Nacionalidade": "10",
        "Nome": "PAI TOTVS YCEHZUD FUAIEVS",
        "Numero": "1",
        "OrgEmissorIdent": "SSP",
        "Rua": "Horácio Gonsalves do Vale",
        "Sexo": "M",
        "Telefone1": "41196734000",
        "Telefone2": "41196734001",
        "UfCartIdent": "PR"
    },
    "Mae": {
        "Bairro": "Centro",
        "CartIdentidade": "4553",
        "Cep": "83840000",
        "Cidade": "QUITANDINHA",
        "CodNaturalidade": "4106902",
        "CodProfissao": 49,
        "CodTipoBairro": 1,
        "CodTipoRua": 1,
        "Complemento": "Mansão",
        "CorRaca": 8,
        "Cpf": "65492227963",
        "CpfMotivo": null,
        "DeficienteAuditivo": false,
        "DeficienteFala": false,
        "DeficienteFisico": false,
        "DeficienteMental": false,
        "DeficienteVisual": false,
        "DtEmissaoIdent": "2020-07-14T00:00:00-03:00",
        "DtNascimento": "1952-02-22T00:00:00-03:00",
        "Email": "[email protected]",
        "Estado": "PR",
        "EstadoCivil": "S",
        "EstadoNatal": "PR",
        "GrauInstrucao": "7",
        "IdPais": 10,
        "Nacionalidade": "10",
        "Nome": "MAE TOTVS GCYSJZH QHKXEEJ",
        "Numero": "1",
        "OrgEmissorIdent": "SSP",
        "Rua": "Horácio Gonsalves do Vale",
        "Sexo": "F",
        "Telefone1": "41196734000",
        "Telefone2": "41196734001",
        "UfCartIdent": "PR"
    },
    "RespAcademico": {
        "Bairro": "Centro",
        "CartIdentidade": "4553",
        "Cep": "83840000",
        "Cidade": "QUITANDINHA",
        "CodNaturalidade": "4106902",
        "CodProfissao": 49,
        "CodTipoBairro": 1,
        "CodTipoRua": 1,
        "Complemento": "Mansão",
        "CorRaca": 8,
        "Cpf": "65492227963",
        "CpfMotivo": null,
        "DeficienteAuditivo": false,
        "DeficienteFala": false,
        "DeficienteFisico": false,
        "DeficienteMental": false,
        "DeficienteVisual": false,
        "DtEmissaoIdent": "2020-07-14T00:00:00-03:00",
        "DtNascimento": "1952-02-22T00:00:00-03:00",
        "Email": "[email protected]",
        "Estado": "PR",
        "EstadoCivil": "S",
        "EstadoNatal": "PR",
        "GrauInstrucao": "7",
        "IdPais": 10,
        "Nacionalidade": "10",
        "Nome": "MAE TOTVS GCYSJZH QHKXEEJ",
        "Numero": "1",
        "OrgEmissorIdent": "SSP",
        "Rua": "Horácio Gonsalves do Vale",
        "Sexo": "F",
        "Telefone1": "41196734000",
        "Telefone2": "41196734001",
        "UfCartIdent": "PR"
    },
    "RespFinanceiro": {
        "Bairro": "Centro",
        "Cep": "83840000",
        "CgcCfo": "65492227963",
        "CI_Orgao": "SSP",
        "CI_UF": "PR",
        "CIdentidade": "4553",
        "CodColigada": 2,
        "CodEtd": "PR",
        "CodMunicipio": "4106902",
        "Complemento": "Mansão",
        "DtNascimento": "1952-02-22T00:00:00-03:00",
        "Email": "[email protected]",
        "EstadoCivil": "S",
        "IdPais": 1,
        "Nacionalidade": 0,
        "Nome": "MAE TOTVS GCYSJZH QHKXEEJ",
        "Numero": "1",
        "PagRec": 1,
        "PessoaFisOuJur": "F",
        "Rua": "Horácio Gonsalves do Vale",
        "Telefone": "41196734000",
        "Telex": null,
        "CodTipoBairro": 1,
        "CodTipoRua": 1
    },
    "Aluno": {
        "Bairro": "Centro",
        "CartIdentidade": "6874",
        "Cep": "83840000",
        "Cidade": "QUITANDINHA",
        "CodNaturalidade": "4106902",
        "CodProfissao": 49,
        "CodTipoBairro": 1,
        "CodTipoRua": 1,
        "Complemento": "Mansão",
        "CorRaca": 8,
        "Cpf": "52856401805",
        "CpfMotivo": null,
        "DeficienteAuditivo": false,
        "DeficienteFala": false,
        "DeficienteFisico": false,
        "DeficienteMental": false,
        "DeficienteVisual": false,
        "DtEmissaoIdent": "2020-07-14T00:00:00-03:00",
        "DtNascimento": "2012-08-20T00:00:00-03:00",
        "Email": "[email protected]",
        "Estado": "PR",
        "EstadoCivil": "S",
        "EstadoNatal": "PR",
        "GrauInstrucao": "7",
        "IdPais": 10,
        "Nacionalidade": "10",
        "Nome": "ALUNO TOTVS BILIEFW ALWNBVA",
        "Numero": "1",
        "OrgEmissorIdent": "SSP",
        "Rua": "Horácio Gonsalves do Vale",
        "Sexo": "M",
        "Telefone1": "41196734000",
        "Telefone2": "41196734001",
        "UfCartIdent": "PR"
    },
    "Turma": {
        "Codcoligada": 2,
        "CodFilial": 2013,
        "CodTurma": "FSW_SESI_0001",
        "IdPerlet": 893,
        "CodTipoMatricula": 1,
        "Periodo": 1
    },
    "PreContratoCRM": {
        "NumPreContrato": "NWXCCWS",
        "TipoContrato": "7",
        "ModContrato": "543",
        "DesContrato": "Contrato teste TOTVS",
        "ValorTotal": 1200.0,
        "QtdeParcelas": 3,
        "ValorDesconto": 300.0,
        "TipoDesconto": "V",
        "ObsDesconto": "Observação teste",
        "Workload": null,
        "DtInicioContrato": "2023-07-14T00:00:00-03:00",
        "DtFimContrato": "2024-01-30T00:00:00-03:00",
        "ValorAplicadoCurso": 900.0,
        "AdesaoOdonto": false,
        "ItemVendaOdonto": null,
        "ValorItemOdonto": 0.0,
        "ItemVendaOfertada": "SS000687"
    }
}

Content

Pai

Bairro: Bairro do endereço da Pessoa no SGE (Campo Obrigatório);
CartIdentidade: Numero da identidade da Pessoa no SGE;
Cep: CEP do endereço da Pessoa no SGE (Campo Obrigatório);
Cidade: Nome da Cidade do endereço da Pessoa (Campo Obrigatório); Valores possíveis: Campo CODMUNICIPIO da tabela GMUNICIPIO
CodNaturalidade: Naturalidade da Pessoa no SGE (Campo Obrigatório); Valores possíveis: Campo CODMUNICIPIO da tabela GMUNICIPIO
CodProfissao: Campo Tipo da Pessoa no SGE (Campo Obrigatório); Valores possíveis:
CodTipoBairro: Tipo de Bairro do endereço da Pessoa (Campo Obrigatório); Valores possíveis: Campo CODIGO da tabela DTIPOBAIRRO
CodTipoRua: Tipo de Rua do endereço da Pessoa (Campo Obrigatório); Valores possíveis: Campo CODIGO da tabela DTIPORUA
Complemento: Complemento do endereço da Pessoa no SGE;
CorRaca: Cor/Raça da Pessoa no SGE; Valores possíveis: Campo CODCLIENTE da tabela PCORRACA
Cpf: CPF da Pessoa no SGE (Campo Obrigatório);
CpfMotivo: Campo complementar Grupos Vulneráveis da Pessoa no SGE; Valores possíveis: Campo CODCLIENTE da tabela dinâmica MOTIVOCPF
DeficienteAuditivo: Indicativo se a pessoa possui deficiência auditiva; Valores possíveis: true ou false;
DeficienteFala: Indicativo se a pessoa possui deficiência de fala; Valores possíveis: true ou false;
DeficienteFisico: Indicativo se a pessoa possui deficiência física; Valores possíveis: true ou false;
DeficienteMental: Indicativo se a pessoa possui deficiência mental; Valores possíveis: true ou false;
DeficienteVisual: Indicativo se a pessoa possui deficiência visual; Valores possíveis: true ou false;
DtEmissaoIdent: Data de emissão da identidade da Pessoa no SGE;
DtNascimento: Data de Nascimento da Pessoa no SGE (Campo Obrigatório);
Email: Email da Pessoa no SGE (Campo Obrigatório);
Estado: Estado do endereço da Pessoa (Campo Obrigatório); Valores possíveis: Campo CODETD da tabela GETD;
EstadoCivil: Estado Civil do da Pessoa; Valores possíveis: C= Casado; D = Desquitado; E = União Estável; I = Divorciado; O = Outros; P = Separado; S = Solteiro; V = Viúvo;
EstadoNatal: Estado natal da Pessoa; (Campo Obrigatório); Valores possíveis: Campo CODETD da tabela GETD;
GrauInstrucao: Grau de Instrução da Pessoa no SGE (Campo Obrigatório); Valores possíveis: Campo CODCLIENTE da tabela PCODINSTRUCAO;
IdPais: Id. do Pais do endereço da Pessoa (Campo Obrigatório); Valores possíveis: Campo IDPAIS da tabela GPAIS;
Nacionalidade: Nacionalidade da Pessoa no SGE (Campo Obrigatório); Valores possíveis: Campo CODCLIENTE da tabela PCODNACAO;
Nome: Nome completo da Pessoa no SGE (Campo Obrigatório);
Numero: Numero do endereço da Pessoa no SGE (Campo Obrigatório);
OrgEmissorIdent: Órgão emissor da identidade da Pessoa no SGE;
Rua: Rua do endereço da Pessoa no SGE (Campo Obrigatório);
Sexo: Sexo da Pessoa no SGE (Campo Obrigatório); Valores possíveis: M = Masculino; F = Feminino
Telefone1: Telefone residencial da Pessoa no SGE;
Telefone2: Celular da Pessoa no SGE (Campo Obrigatório);
UfCartIdent: Estado emissor da identidade da Pessoa no SGE;

Mãe

Bairro: Bairro do endereço da Pessoa no SGE (Campo Obrigatório);
CartIdentidade: Numero da identidade da Pessoa no SGE;
Cep: CEP do endereço da Pessoa no SGE (Campo Obrigatório);
Cidade: Nome da Cidade do endereço da Pessoa (Campo Obrigatório); Valores possíveis: Campo CODMUNICIPIO da tabela GMUNICIPIO
CodNaturalidade: Naturalidade da Pessoa no SGE (Campo Obrigatório); Valores possíveis: Campo CODMUNICIPIO da tabela GMUNICIPIO
CodProfissao: Campo Tipo da Pessoa no SGE (Campo Obrigatório); Valores possíveis:
CodTipoBairro: Tipo de Bairro do endereço da Pessoa (Campo Obrigatório); Valores possíveis: Campo CODIGO da tabela DTIPOBAIRRO
CodTipoRua: Tipo de Rua do endereço da Pessoa (Campo Obrigatório); Valores possíveis: Campo CODIGO da tabela DTIPORUA
Complemento: Complemento do endereço da Pessoa no SGE;
CorRaca: Cor/Raça da Pessoa no SGE; Valores possíveis: Campo CODCLIENTE da tabela PCORRACA
Cpf: CPF da Pessoa no SGE (Campo Obrigatório);
CpfMotivo: Campo complementar Grupos Vulneráveis da Pessoa no SGE; Valores possíveis: Campo CODCLIENTE da tabela dinâmica MOTIVOCPF
DeficienteAuditivo: Indicativo se a pessoa possui deficiência auditiva; Valores possíveis: true ou false;
DeficienteFala: Indicativo se a pessoa possui deficiência de fala; Valores possíveis: true ou false;
DeficienteFisico: Indicativo se a pessoa possui deficiência física; Valores possíveis: true ou false;
DeficienteMental: Indicativo se a pessoa possui deficiência mental; Valores possíveis: true ou false;
DeficienteVisual: Indicativo se a pessoa possui deficiência visual; Valores possíveis: true ou false;
DtEmissaoIdent: Data de emissão da identidade da Pessoa no SGE;
DtNascimento: Data de Nascimento da Pessoa no SGE (Campo Obrigatório);
Email: Email da Pessoa no SGE (Campo Obrigatório);
Estado: Estado do endereço da Pessoa (Campo Obrigatório); Valores possíveis: Campo CODETD da tabela GETD;
EstadoCivil: Estado Civil do da Pessoa; Valores possíveis: C= Casado; D = Desquitado; E = União Estável; I = Divorciado; O = Outros; P = Separado; S = Solteiro; V = Viúvo;
EstadoNatal: Estado natal da Pessoa; (Campo Obrigatório); Valores possíveis: Campo CODETD da tabela GETD;
GrauInstrucao: Grau de Instrução da Pessoa no SGE (Campo Obrigatório); Valores possíveis: Campo CODCLIENTE da tabela PCODINSTRUCAO;
IdPais: Id. do Pais do endereço da Pessoa (Campo Obrigatório); Valores possíveis: Campo IDPAIS da tabela GPAIS;
Nacionalidade: Nacionalidade da Pessoa no SGE (Campo Obrigatório); Valores possíveis: Campo CODCLIENTE da tabela PCODNACAO;
Nome: Nome completo da Pessoa no SGE (Campo Obrigatório);
Numero: Numero do endereço da Pessoa no SGE (Campo Obrigatório);
OrgEmissorIdent: Órgão emissor da identidade da Pessoa no SGE;
Rua: Rua do endereço da Pessoa no SGE (Campo Obrigatório);
Sexo: Sexo da Pessoa no SGE (Campo Obrigatório); Valores possíveis: M = Masculino; F = Feminino
Telefone1: Telefone residencial da Pessoa no SGE;
Telefone2: Celular da Pessoa no SGE (Campo Obrigatório);
UfCartIdent: Estado emissor da identidade da Pessoa no SGE;

Responsável Acadêmico

Bairro: Bairro do endereço da Pessoa no SGE (Campo Obrigatório);
CartIdentidade: Numero da identidade da Pessoa no SGE;
Cep: CEP do endereço da Pessoa no SGE (Campo Obrigatório);
Cidade: Nome da Cidade do endereço da Pessoa (Campo Obrigatório); Valores possíveis: Campo CODMUNICIPIO da tabela GMUNICIPIO
CodNaturalidade: Naturalidade da Pessoa no SGE (Campo Obrigatório); Valores possíveis: Campo CODMUNICIPIO da tabela GMUNICIPIO
CodProfissao: Campo Tipo da Pessoa no SGE (Campo Obrigatório); Valores possíveis:
CodTipoBairro: Tipo de Bairro do endereço da Pessoa (Campo Obrigatório); Valores possíveis: Campo CODIGO da tabela DTIPOBAIRRO
CodTipoRua: Tipo de Rua do endereço da Pessoa (Campo Obrigatório); Valores possíveis: Campo CODIGO da tabela DTIPORUA
Complemento: Complemento do endereço da Pessoa no SGE;
CorRaca: Cor/Raça da Pessoa no SGE; Valores possíveis: Campo CODCLIENTE da tabela PCORRACA
Cpf: CPF da Pessoa no SGE (Campo Obrigatório);
CpfMotivo: Campo complementar Grupos Vulneráveis da Pessoa no SGE; Valores possíveis: Campo CODCLIENTE da tabela dinâmica MOTIVOCPF
DeficienteAuditivo: Indicativo se a pessoa possui deficiência auditiva; Valores possíveis: true ou false;
DeficienteFala: Indicativo se a pessoa possui deficiência de fala; Valores possíveis: true ou false;
DeficienteFisico: Indicativo se a pessoa possui deficiência física; Valores possíveis: true ou false;
DeficienteMental: Indicativo se a pessoa possui deficiência mental; Valores possíveis: true ou false;
DeficienteVisual: Indicativo se a pessoa possui deficiência visual; Valores possíveis: true ou false;
DtEmissaoIdent: Data de emissão da identidade da Pessoa no SGE;
DtNascimento: Data de Nascimento da Pessoa no SGE (Campo Obrigatório);
Email: Email da Pessoa no SGE (Campo Obrigatório);
Estado: Estado do endereço da Pessoa (Campo Obrigatório); Valores possíveis: Campo CODETD da tabela GETD;
EstadoCivil: Estado Civil do da Pessoa; Valores possíveis: C= Casado; D = Desquitado; E = União Estável; I = Divorciado; O = Outros; P = Separado; S = Solteiro; V = Viúvo;
EstadoNatal: Estado natal da Pessoa; (Campo Obrigatório); Valores possíveis: Campo CODETD da tabela GETD;
GrauInstrucao: Grau de Instrução da Pessoa no SGE (Campo Obrigatório); Valores possíveis: Campo CODCLIENTE da tabela PCODINSTRUCAO;
IdPais: Id. do Pais do endereço da Pessoa (Campo Obrigatório); Valores possíveis: Campo IDPAIS da tabela GPAIS;
Nacionalidade: Nacionalidade da Pessoa no SGE (Campo Obrigatório); Valores possíveis: Campo CODCLIENTE da tabela PCODNACAO;
Nome: Nome completo da Pessoa no SGE (Campo Obrigatório);
Numero: Numero do endereço da Pessoa no SGE (Campo Obrigatório);
OrgEmissorIdent: Órgão emissor da identidade da Pessoa no SGE;
Rua: Rua do endereço da Pessoa no SGE (Campo Obrigatório);
Sexo: Sexo da Pessoa no SGE (Campo Obrigatório); Valores possíveis: M = Masculino; F = Feminino
Telefone1: Telefone residencial da Pessoa no SGE;
Telefone2: Celular da Pessoa no SGE (Campo Obrigatório);
UfCartIdent: Estado emissor da identidade da Pessoa no SGE;

Responsável Financeiro

codColigada: Código da Coligada Bairro: Bairro do endereço do Responsável Financeiro no SGE (Campo ObrigatórioObrigatório); classificacao
Cep: Classificação do Cliente/Fornecedor (Campo Obrigatório); Valores possíveis: 1 = Cliente; 2 = Fornecedor; 3 = Ambos;
categoria: Categoria do Cliente/Fornecedor (Campo Obrigatório); Valores possíveis: F = Pessoa Física; J = Pessoa Jurídica
nome Nome do Cliente/Fornecedor (Campo Obrigatório);
dataNascimento: Data de Nascimento do Cliente/Fornecedor;
email: Email do Cliente/Fornecedor (Campo Obrigatório);
CEP do endereço do Responsável Financeiro no SGE (Campo Obrigatório);
CgcCfo: CPF ou CNPJ do Responsável Financeiro no SGE (Campo Obrigatório);
CI_Orgao: Órgão emissor da identidade do Responsável Financeiro no SGE;
CI_UF: Estado emissor da identidade do Responsável Financeiro no SGE;
CIdentidade: Numero da identidade do Responsável Financeiro no SGE;
CodColigada: Coligada em que o Responsável Financeiro será inserido no SGE;
CodEtd: Estado do endereço do Responsável Financeiro (Campo Obrigatório); Valores possíveis: Campo CODETD da tabela GETD;
CodMunicipio: Nome da Cidade do endereço do Responsável Financeiro (Campo Obrigatório); Valores possíveis: Campo CODMUNICIPIO da tabela GMUNICIPIO
Complemento: Complemento do endereço do Responsável Financeiro no SGE;
DtNascimento: Data de Nascimento do Responsável Financeiro no SGE (Campo Obrigatório);
Email: Email do Responsável Financeiro no SGE (Campo Obrigatório);
EstadoCivil: Estado Civil do do Responsável Financeiro; Valores possíveis: C= estadoCivil: Estado Civil do Cliente/Fornecedor; Valores possíveis: C= Casado; D = Desquitado; E = União Estável; I = Divorciado; O = Outros; P = Separado; S = Solteiro; V = Viúvo;
nacionalidade: Nacionalidade do Cliente/Fornecedor IdPais: Id. do Pais do endereço do Responsável Financeiro (Campo Obrigatório); Valores possíveis: 0 = Brasileira; 1 = EstrangeiracgcCfo: CPF ou CNPJ do Cliente/Fornecedor Campo IDPAIS da tabela GPAIS;
Nacionalidade: Nacionalidade do Responsável Financeiro no SGE (Campo Obrigatório);
cI_Orgao: Orgão emissor da carteira de identidade do Cliente/Fornecedor;
cI_UF: Estado emissor do Cliente/Fornecedir.
cI_numero: Numero da identidade do Cliente/Fornecedor.
Valores possíveis: Campo CODCLIENTE da tabela PCODNACAO;
Nome: Nome completo do Responsável Financeiro no SGE (Campo Obrigatório);
Numero: Numero do endereço do Responsável Financeiro no SGE (Campo Obrigatório);
PagRec: Classificação do Responsável Financeiro no SGE telefone: Telefone do Cliente/Fornecedor (Campo Obrigatório);
celular: Celular do Cliente/Fornecedor;
telefoneComercial: Telefone comercial do Cliente/Fornecedor;
Valores possíveis: 1 = Cliente; 2 = Fornecedor; 3 = Ambos;
PessoaFisOuJur: Categoria do Responsável Financeiro no SGE (Campo Obrigatório); Valores possíveis: F = Pessoa Física; J = Pessoa Jurídica;
Rua: Rua do endereço do Responsável Financeiro no SGE (Campo Obrigatório);
Telefone1: Telefone residencial do Responsável Financeiro no SGE;
Telefone2: Celular do Responsável Financeiro no SGE (Campo Obrigatório);
CodTipoBairro: Tipo de Bairro do endereço do Responsável Financeiro tipoBairro: Tipo de Bairro do Cliente/Fornecedor (Campo Obrigatório); Valores possíveis: Campo CODIGO da tabela DTIPOBAIRRO
tipoRuaCodTipoRua: Tipo de Rua do Cliente/Fornecedor do endereço do Responsável Financeiro (Campo Obrigatório); Valores possíveis: Campo CODIGO da tabela DTIPORUA

Aluno

Bairrobairro: Bairro do Endereço Principal Cliente/Fornecedor endereço da Pessoa no SGE (Campo Obrigatório);
logradouro: Rua do Endereço Principal do Cliente/Fornecedor (Campo Obrigatório);
numero: Numero do Endereço Principal do Cliente/Fornecedor (Campo Obrigatório);
complemento: Complemento do Endereço Principal do Cliente/Fornecedor;
CartIdentidade: Numero da identidade da Pessoa no SGE;
Cep: CEP do endereço da Pessoa no SGE cep: CEP do Endereço Principal do Cliente/Fornecedor (Campo Obrigatório);
estadoCidade: Estado do Endereço Principal do Cliente/Fornecedor Nome da Cidade do endereço da Pessoa (Campo Obrigatório); Valores possíveis: Campo CODETD CODMUNICIPIO da tabela GETDGMUNICIPIOcodMunicipio
CodNaturalidade: Código da Cidade do Endereço Principal do Cliente/Fornecedor Naturalidade da Pessoa no SGE (Campo Obrigatório); Valores possíveis: Campo CODMUNICIPIO da tabela GMUNICIPIOidPais: Id. do Pais do Endereço Principal do Cliente/Fornecedor
CodProfissao: Campo Tipo da Pessoa no SGE (Campo Obrigatório); Valores possíveis: Campo IDPAIS da tabela GPAIS

Aluno

CodTipoBairro: Tipo de Bairro do endereço da Pessoa (Campo Obrigatório); Valores possíveis: Campo CODIGO da tabela DTIPOBAIRRO
CodTipoRua: Tipo de Rua do endereço da Pessoa
codColigada: Código da Coligada no SGE (Campo Obrigatório);
codTipoAluno: Campo Tipo do Aluno no SGE (Campo Obrigatório); Valores possíveis: Campo CODTIPOALUNO CODIGO da tabela STIPOALUNODTIPORUA
codFilialComplemento: Código da Filial em que o Aluno será inserido no SGE (Campo Obrigatório);
codTipoCurso: Nível de Ensino em que o Aluno será inserido no SGE (Campo Obrigatório);
Complemento do endereço da Pessoa no SGE;
CorRaca: Cor/Raça da Pessoa no SGE; Valores possíveis: Campo CODCLIENTE da tabela PCORRACA
Cpf: CPF da Pessoa nome: Nome completo do Aluno no SGE (Campo Obrigatório); nomeSocial: Nome social do Aluno
CpfMotivo: Campo complementar Grupos Vulneráveis da Pessoa no SGE; Valores possíveis: Campo CODCLIENTE da tabela dinâmica MOTIVOCPF
DeficienteAuditivo: Indicativo se a pessoa possui deficiência auditiva sexo: Sexo do Aluno no SGE (Campo Obrigatório); Valores possíveis: M = Masculino; F = FemininodataNascimento: Data de Nascimento do Aluno no SGE (Campo Obrigatório) true ou false;
DeficienteFala: Indicativo se a pessoa possui deficiência de fala; Valores possíveis: true ou false;
DeficienteFisico: Indicativo se a pessoa possui deficiência físicacorRaca: Cor/Raça do Aluno no SGE; Valores possíveis: Campo CODCLIENTE da tabela PCORRACAnacionalidade: Nacionalidade do Aluno no SGE (Campo Obrigatório) true ou false;
DeficienteMental: Indicativo se a pessoa possui deficiência mental; Valores possíveis: Campo CODCLIENTE da tabela PCODNACAO
email: Email do Aluno no SGE (Campo Obrigatório); Valores possíveis:
true ou false;
DeficienteVisual: Indicativo se a pessoa possui deficiência visual; Valores possíveis: true ou false;
DtEmissaoIdent: Data de emissão da identidade da Pessoa no SGE;
DtNascimento: Data de Nascimento da Pessoa no SGE (Campo Obrigatório);
Email: Email da Pessoa no SGE (Campo Obrigatório);
Estado: Estado do endereço da Pessoa (Campo Obrigatório); Valores possíveis: Campo CODETD da tabela GETD;
EstadoCivil: Estado Civil do da PessoaestadoCivil: Estado Civil do Cliente/Fornecedor; Valores possíveis: C= Casado; D = Desquitado; E = União Estável; I = Divorciado; O = Outros; P = Separado; S = Solteiro; V = Viúvo;
naturalidade: Naturalidade do Aluno no SGE (Campo Obrigatório); Valores possíveis: Campo CODMUNICIPIO da tabela GMUNICIPIO
telefone1: Telefone residencial do Aluno no SGE;
telefone2: Celular do Aluno no SGE (Campo Obrigatório);
telefone3: Telefone comercial do Aluno no SGE;
ci_numero: Numero da identidade do Aluno no SGE;
ci_uf: Estado emissor da identidade do Aluno no SGE;
ci_dtemissao: Data de emissão da identidade do Aluno no SGE;
ci_emissor:Orgão emissor da identidade do Aluno no SGE;
cpf: CPF do Aluno no SGE (Campo Obrigatório);
tipoBairro: Tipo de Bairro do Cliente/Fornecedor (Campo Obrigatório); Valores possíveis: Campo CODIGO da tabela DTIPOBAIRRO
tipoRua: Tipo de Rua do Cliente/Fornecedor (Campo Obrigatório); Valores possíveis: Campo CODIGO da tabela DTIPORUA
bairro: Bairro do endereço do Aluno no SGE (Campo Obrigatório);
logradouro: Rua do endereço do Aluno no SGE (Campo Obrigatório);
numero: Numero do endereço do Aluno no SGE (Campo Obrigatório);
complemento: Complemento do endereço do Aluno no SGE;
cep: CEP do endereço do Aluno no SGE (Campo Obrigatório);
codMunicipio: Código da Cidade do Endereço Principal do Cliente/Fornecedor (Campo Obrigatório); Valores possíveis: Campo CODMUNICIPIO da tabela GMUNICIPIO
estado: Estado do Endereço Principal do Cliente/Fornecedor (Campo Obrigatório); Valores possíveis: Campo CODETD da tabela GETD
idPais: Id. do Pais do Endereço Principal do Cliente/Fornecedor (Campo Obrigatório); Valores possíveis: Campo IDPAIS da tabela GPAIS
codProfissao: Campo Tipo do Aluno no SGE (Campo Obrigatório); Valores possíveis:
grauInstrucao: Grau de Instrução do Aluno no SGE (Campo Obrigatório); Valores possíveis: Campo CODCLIENTE da tabela PCODINSTRUCAO
situacaoOcupacional: Campo complementar de Situação Ocupacional do Aluno no SGE (Campo Obrigatório Somente SENAI/IEL); Valores possíveis: Campo CODCLIENTE da tabela dinâmica SITOCUP
tipoEscolaOrigem: Campo complementar de Tipo de Escola Origem Tipo do Aluno no SGE (Campo Obrigatório); Valores possíveis: Campo CODCLIENTE da tabela dinâmica TIPOESCOLA
pai: Dados do pai do aluno no SGE (Não implementado);
mãe: Dados da mãe do aluno no SGE (Não implementado);

Matricula

codColigada: Código da Coligada no SGE (Campo Obrigatório);
codFilial: Código da filial da matricula do aluno no SGE (Campo Obrigatório);
codTipoCurso: Nível de ensino da matricula do aluno no SGE (Campo Obrigatório);
idHabiltiacaoFilial: Id da Matriz Aplicada da matricula do aluno no SGE (Campo Obrigatório);
codTurma: Código da Turma da matricula do aluno no SGE (Campo Obrigatório);
idPerlet: Id do Período Letivo da matricula do aluno no SGE (Campo Obrigatório);
periodo: Campo Período da Matricula no Período Letivo do aluno no SGE (Campo Obrigatório SOMENTE SENAI/IEL);
campusPolo: Campus Polo no SGE (Campo Obrigatório SOMENTE SENAI/IEL);
tipoMatricula: Tipo da Matricula no Período Letivo do Aluno no SGE (Campo Obrigatório); Valores possíveis: Campo CODTIPOMAT da tabela STIPOMATRICULA
dataMatricula: Data da matricula da matricula do aluno no SGE (Campo Obrigatório);
camposComplementares: Dados dos campos complementares da matricula do aluno no SGE (Campo Obrigatório);
preContratoCrm: Dados do pré contrato crm da matrícula do aluno no SGE (Campo Obrigatório);

Campos Complementares

dataPrevistaSaida: Campo complementar Data de Previsão de Saída da habilitação do aluno no SGE (Campo Obrigatório SOMENTE SENAI/IEL);
tipoGrat: Campo complementar Condição do Aluno da matricula do período letivo no SGE (Campo Obrigatório SOMENTE SENAI/IELEstadoNatal: Estado natal da Pessoa; (Campo Obrigatório); Valores possíveis: Campo CODCLIENTE CODETD da tabela dinâmica TIPOGRATGETD;codFinanc: Campo complementar Código do Financiamento (SCAE) da matricula do período letivo
GrauInstrucao: Grau de Instrução da Pessoa no SGE (Campo Obrigatório SOMENTE SESIObrigatório); Valores possíveis: Campo CODCLIENTE da tabela dinâmica SCODFINANCPCODINSTRUCAO;
articulacao: Código da Coligada no SGE (Campo Obrigatório); ?!!??!?!?!
IdPais: Id. do Pais do endereço da Pessoa (Campo Obrigatório); Valores possíveis: Campo IDPAIS da tabela GPAIS;
Nacionalidade: Nacionalidade da Pessoa no SGE (Campo Obrigatório); categoria: Campo complementar Categoria da matricula do período letivo no SGE (Campo Obrigatório SOMENTE SESI); Valores possíveis: Campo CODCLIENTE da tabela dinâmica SCATEGORIAPCODNACAO;viraVida: Campo complementar Vira Vida ? da matricula do período letivo
Nome: Nome completo da Pessoa no SGE (Campo Obrigatório);
Numero: Numero do endereço da Pessoa no SGE (Campo Obrigatório SOMENTE SESIObrigatório); Valores possíveis: Campo CODCLIENTE da tabela dinâmica SIMOUNAO
seloOds: Campo complementar Selo EJA da matricula do período letivo no SGE (Campo Obrigatório SOMENTE SESI); Valores possíveis: Campo CODCLIENTE da tabela dinâmica SIMOUNAO
ebep: Campo complementar EBEP ? da matricula do período letivo no SGE (Campo Obrigatório SOMENTE SESI); Valores possíveis: Campo CODCLIENTE da tabela dinâmica SIMOUNAO
tempoIntegral: Campo complementar Tempo Integral ? da matricula do período letivo no SGE (Campo Obrigatório SOMENTE SESI); Valores possíveis: Campo CODCLIENTE da tabela dinâmica SIMOUNAO
gratuidade: Campo complementar Gratuidade da matricula do período letivo no SGE (Campo Obrigatório SOMENTE SESI); Valores possíveis: Campo CODCLIENTE da tabela dinâmica SIMOUNAO
baixaRenda: Campo complementar Portal Transparência da matricula do periodo letivo no SGE (Campo Obrigatório SOMENTE SESI); Valores possíveis: Campo CODCLIENTE da tabela dinâmica SIMOUNAO
portalTransp: Campo complementar Possui comprovação de Gratuidade Reg ? da matricula do período letivo no SGE (Campo Obrigatório SOMENTE SESI); Valores possíveis: Campo CODCLIENTE da tabela dinâmica SIMOUNAO

Pré Contrato CRM

OrgEmissorIdent: Órgão emissor da identidade da Pessoa no SGE;
Rua: Rua do endereço da Pessoa no SGE (Campo Obrigatório);
Sexo: Sexo da Pessoa no SGE (Campo Obrigatório); Valores possíveis: M = Masculino; F = Feminino
Telefone1: Telefone residencial da Pessoa no SGE;
Telefone2: Celular da Pessoa no SGE (Campo Obrigatório);
UfCartIdent: Estado emissor da identidade da Pessoa no SGE;

Turma

CodColigada: Código da coligada no SGE onde a matricula seria inserida (Campo Obrigatório);
CodFilial: Código da filial da matricula do aluno no SGE (Campo Obrigatório);
CodTurma: Código da Turma da matricula do aluno no SGE (Campo Obrigatório);
IdPerlet: Id do Período Letivo da matricula do aluno no SGE (Campo Obrigatório);

PreContratoCRM

NumPreContratonumPreContrato: Número do Pré Contrato (Campo ObrigatórioObrigatório);
tipoContratoTipoContrato: Tipo do contrato (Campo ObrigatórioObrigatório); Valores possíveis:
modContratoModContrato: Modelo do contrato (Campo ObrigatórioObrigatório); Valores possíveis: Campo CODCLIENTE da tabela dinâmica ZMODCONTRATOSETRMOAX
desContratoDesContrato: Descrição do contrato (Campo ObrigatórioObrigatório);
valorTotalValorTotal: Valor total do contrato considerando os descontos (Campo ObrigatórioObrigatório);
qtDeParcelasQtDeParcelas: Quantidade de parcelas que será gerada para o pagamento (Campo ObrigatórioObrigatório);
valorDescontoValorDesconto: Valor desconto, caso exista (Campo ObrigatórioObrigatório);
tipoDescontoTipoDesconto: Tipo de desconto utilizado, caso exista (Campo ObrigatórioObrigatório); Valores possíveis: P = Percentual; V = Valor
obsDescontoObsDesconto: Motivo da concessão do desconto (Campo ObrigatórioObrigatório);
worloadWorload: Carga horária (Campo ObrigatórioObrigatório);
valorAplicadoCurso: Valor aplicado ao curso (Campo Obrigatório);
dtInicioContratoDtInicioContrato: Data de início do contrato, deve estar dentro do período do mês vigente ou no futuro, respeitando o início da prestação do serviço. (Campo ObrigatórioObrigatório);
dtFimContratoDtFimContrato: Data final do contrato. (Campo Obrigatório);
ValorAplicadoCurso: Valor aplicado ao curso (Campo ObrigatórioObrigatório);
adesaoOdontoAdesaoOdonto: Caso o haja adesão ao plano escolar de odonto. (Campo ObrigatórioObrigatório); Valores possíveis: 1 = true;
itemVendaodontoItemVendaodonto: Caso o haja adesão ao plano escolar de odonto deverá ser enviado o código do item odonto ofertado. (Campo ObrigatórioObrigatório);
valorItemOdontoValorItemOdonto: Caso Adesão Odonto seja 1 (verdadeiro) deverá ser enviado o valor do item odonto. (Campo ObrigatórioObrigatório);
itemVendaOfertadaItemVendaOfertada: Item de venda foi utilizado para geração do contrato. (Campo ObrigatórioObrigatório);

Retorno

Bloco de código

language	c#
title	Console

{
        "Status": "Sucesso",
        "Mensagem": "Responsável Financeiro Criado/Atualizado com Sucesso !\r\nAluno Criado/Atualizado com Sucesso !\r\nMatricula Criada/Atualizada com Sucesso !",
        "DadosCriados": {
            "CodColigada": 3,
            "Ra": "00878180",
			"CPF": 123131331,
            "Nome": Rafael da Silva Sauro,
             "CodCFO": "01737437",
            "IdPreContrato": null
        },
        "DetalheErros": {
            "IdErro": null,
            "ExceptionType": null,
            "InnerException": null
        }
}

Content

Status: Situação do processamento da requisição; Valores possíveis: "Sucesso" = Quando todas as etapas foram inseridas com sucesso; "Erro" = Quando ocorre um erro na integração com o SGE até a etapa de Criação de Matricula do Aluno; "Alerta" = Quando ocorre um erro na etapa de Efetivação do Contrato no ERP;
Mensagem: Mensagem de retorno do consumo da requisição;
Dados Criados:
- CodColigada: Código da Coligada utilizado no registro
- Ra: Ra criado ou atualizado para o aluno enviado.
- Nome: Nome do aluno enviado na API.
- CPF: Cpf do aluno enviado na API.
- CodCFO: Código do Cliente/Fornecedor para o responsável financeiro criado ou atualizado.
- IdPreContrato: Id interno no criado para o Pré Contrato CRM.
DetalheErros:
- IdErro: Identificador da região da API que ocorreu o erro. Valores possíveis: 1 = Responsável Financeiro; 2 = Aluno; 3 = Matricula; 4 = Pré Contrato CRM; 5 = Efetivação Contrato ERP
- ExceptionType: Tipo da exceção lançada pela API.
- InnerException: Conteúdo extra da exceção lançada pela API.

...

Atalhos

Páginas filhas

Versões comparadas

Versão antiga 3

Nova versão 4

Chave

Retorno