Páginas filhas
  • Documentação API - Integração CRM

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

Este documento tem por objetivo a documentar as API's disponíveis no projeto Integração Loja Click SESI - SENAI - FIEP.CRM


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


Expandir
titleAutenticação
Deck of Cards
idAutenticacaoAPI
Card
idBasic
labelBasic

Authorization - Basic Auth

Username <username>

Password <password>


Card
idBearer
labelBearer

Abaixo estão as instruções de como buscar um bearer token, tanto com base em um certificado embutido automaticamente na aplicação quanto um inserido manualmente.

Exemplo de utilização - Sucesso:

  1. Realize uma requisição POST ao endpoint http(s)://{dominio}:{porta}/api/connect/token/ via Postman, SoapUi, ou outro programa que realize requisições HTTP REST.
  2. No corpo da requisição envie um JSON explicitando usuário e senha do RM para qual a autenticação está sendo direcionada:

 username
• password 

A requisição deve parecer com a abaixo

Image Modified


O token de segurança será gerado e já poderá ser utilizado no cabeçalho das requisições subsequentes às API's disponibilizadas pela TOTVS.

Exemplo de Token de Segurança gerado com sucesso e pronto para ser utilizado:

Image Modified


Utilize o token gerado incluindo-o no cabeçalho da requisição através da diretiva:

• Authorization: Bearer {token}

Inclusão do token no cabeçalho da requisição:

Image Modified


Após a inclusão do cabeçalho de autorização, realize uma requisição HTTP em uma das API's disponibilizadas pela TOTVS e verifique o resultado.

Requisição realizada na API de Usuário utilizando o token gerado:

Image Modified

Verifique que a requisição foi realizada com sucesso e os dados foram apresentados corretamente.


Expandir
titleinserirPreMatricula
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, ZPRECONTRATOCRM

Interfaces RM:

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

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

TOTVS Educacional | Educacional | Currículo e Oferta | Alunos | Aba | Responsáveis

TOTVS Educacional | Educacional | Currículo e Oferta | Alunos |  Anexo | Cursos / Habilitações

TOTVS Educacional | Educacional | Currículo e Oferta | Alunos |  Anexo | Matricula no Período Letivo | Anexo | Matriculas em disciplinas

TOTVS Educacional | Educacional | Matricula e Avaliação | Matricula no Período Letivo | Anexo | Matriculas em disciplinas

TOTVS Educacional | Educacional | Matricula e Avaliação | Matricula no Período Letivo | Anexo | Pré Contratos CRM



Bloco de código
languagec#
titleRaw
{
    "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": "BILIEFW.[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: Código da profissão da Pessoa no SGE (Campo Obrigatório); Valores possíveis: Campo CODCLIENTE da tabela EPROFISS
  • 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: Código da profissão da Pessoa no SGE (Campo Obrigatório); Valores possíveis: Campo CODCLIENTE da tabela EPROFISS
  • 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: Código da profissão da Pessoa no SGE (Campo Obrigatório); Valores possíveis: Campo CODCLIENTE da tabela EPROFISS
  • 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

  • Bairro: Bairro do endereço do Responsável Financeiro no SGE (Campo Obrigatório)
  • Cep: 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= Casado; D = Desquitado; E = União Estável; I = Divorciado; O = Outros; P = Separado; S = Solteiro; V = Viúvo;
  • IdPais: Id. do Pais do endereço do Responsável Financeiro (Campo Obrigatório); Valores possíveis: Campo IDPAIS da tabela GPAIS;
  • Nacionalidade: Nacionalidade do Responsável Financeiro no SGE (Campo Obrigatório); 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 (Campo Obrigatório)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 (Campo Obrigatório); Valores possíveis: Campo CODIGO da tabela DTIPOBAIRRO
  • CodTipoRua: Tipo de Rua do endereço do Responsável Financeiro (Campo Obrigatório); Valores possíveis: Campo CODIGO da tabela DTIPORUA


Aluno

  • 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: Código da profissão da Pessoa no SGE (Campo Obrigatório); Valores possíveis: Campo CODCLIENTE da tabela EPROFISS
  • 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;


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

  • NumPreContrato: Número do Pré Contrato (Campo Obrigatório);
  • TipoContrato: Tipo do contrato (Campo Obrigatório); Valores possíveis
  • ModContrato: Modelo do contrato (Campo Obrigatório); Valores possíveis: Campo CODCLIENTE da tabela dinâmica ZMODCONTRATOSETRMOAX
  • DesContrato: Descrição do contrato (Campo Obrigatório);
  • ValorTotal: Valor total do contrato considerando os descontos (Campo Obrigatório);
  • QtDeParcelas: Quantidade de parcelas que será gerada para o pagamento (Campo Obrigatório);
  • ValorDesconto: Valor desconto, caso exista (Campo Obrigatório);
  • TipoDesconto: Tipo de desconto utilizado, caso exista (Campo Obrigatório); Valores possíveis: P = Percentual; V = Valor
  • ObsDesconto: Motivo da concessão do desconto (Campo Obrigatório);
  • Worload: Carga horária (Campo Obrigatório);
  • DtInicioContrato: 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ório);
  • DtFimContrato: Data final do contrato. (Campo Obrigatório);
  • ValorAplicadoCurso: Valor aplicado ao curso (Campo Obrigatório);
  • AdesaoOdonto: Caso o haja adesão ao plano escolar de odonto. (Campo Obrigatório); Valores possíveis: 1 = true;
  • ItemVendaodonto: Caso o haja adesão ao plano escolar de odonto deverá ser enviado o código do item odonto ofertado. (Campo Obrigatório);
  • ValorItemOdonto: Caso Adesão Odonto seja 1 (verdadeiro) deverá ser enviado o valor do item odonto. (Campo Obrigatório);
  • ItemVendaOfertada: Item de venda foi utilizado para geração do contrato. (Campo Obrigatório);


Retorno

Bloco de código
languagec#
titleConsole
{
  "Retorno": "Integração com CRM realizada com sucesso.",
  "Status": true,
  "Pessoa": {
    "Codigo": 2048034
  },
  "Aluno": {
    "Codcoligada": 3,
    "RA": "00959015"
  },
  "Fcfo": {
    "Codcoligada": 2,
    "CodCfo": "01786265",
    "CGCCFO": "67115983003"
  },
  "Turma": {
    "Codcoligada": 3,
    "CodFilial": 3057,
    "CodTurma": "APP-V-000337/2023",
    "IdPerlet": 3887,
    "IdPreMatricula": null
  },
  "PreContrato": {
    "Codcoligada": 3,
    "CodFilial": 3057,
    "CodTurma": "APP-V-000337/2023",
    "IdPerlet": 3887,
    "IdPreMatricula": null,
    "IdPreContrato": 18549
  }
}


Content

  • Retorno: Mensagem do resultado da requisição; 
  • Status: Status da requisição; Valores possíveis: true = Requisição realizada com sucesso; false = Requisição realizada com erro;

Pessoa

  • Codigo: Código da tabela PPESSOA (CODIGO) do aluno criado;

Aluno

  • Codcoligada: Código da Coligada em que o aluno foi cadastrado;
  • RA: Ra criado para o aluno enviado;

Fcfo

  • Codcoligada: Código da Coligada utilizado no registro;
  • CodCfo: FCFO.CODCFO criado para o responsável financeiro enviado;
  • CGCCFO: CPF ou CNPJ do responsável financeiro enviado;

Turma

  • Codcoligada: Código da Coligada da turma da matricula do aluno;
  • CodFilial: Código da Filial da turma da matricula do aluno;
  • CodTurma: Código da turma da matricula do aluno;
  • IdPerlet: Id do Período Letivo da turma da matricula do aluno
  • IdPreMatricula: nulo;

PreContrato

  • Codcoligada: Código da Coligada da turma da matricula do aluno;
  • CodFilial: Código da Filial da turma da matricula do aluno;
  • CodTurma: Código da turma da matricula do aluno;
  • IdPerlet: Id do Período Letivo da turma da matricula do aluno
  • IdPreMatricula: nulo;
  • IdPreContrato: Id do Pré Contrato CRM;



HTML
<style>
	.expand-control {
    	cursor: pointer;
    	text-decoration: none;
	    margin-bottom: 10px;
	    background-color: #ededed;
	    height: 30px;
	    font-size: 20px;
	    padding: 5px;
	}
	.expand-control-text {
    	vertical-align: top;
	    font-weight: bold;
		color: #242424;
	}
	.post {
    	background-color: #378000;
	    color: #ffffff;
	    display: inline-block;
	    padding: 5px;
	    border-radius: 5px;
		font-weight: bold;
	}
	.get {
    	background-color: #004fd6;
	    color: #ffffff;
	    display: inline-block;
	    padding: 5px;
	    border-radius: 5px;
		font-weight: bold;
	}
	.put {
    	background-color: #ffa200;
	    color: #ffffff;
	    display: inline-block;
	    padding: 5px;
	    border-radius: 5px;
		font-weight: bold;
	}
	.delete {
    	background-color: #cf0000;
	    color: #ffffff;
	    display: inline-block;
	    padding: 5px;
	    border-radius: 5px;
		font-weight: bold;
	}
	.endereco{
		display: inline-block;
		padding: 5px;
		font-weight: bold;
	}
</style>
<!-- 
EXEMPLO DE MARCAÇÃO PARA TIPO DE REQUEST:
<div class="post">POST</div>
<div class="get">GET</div>
<div class="put">PUT</div>
<div class="delete">DELETE</div>

O ENDEREÇO DEVE SER INSERIDO COM A SEGUINTE MARCAÇÃO:
<div class="endereco">/rm/api/TOTVSCustomizacao/CstIntegracaoProtheus/ItemContabil</div>
-->