Versões comparadas

Chave

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

...

Expandir
titleResponsável Financeiro
HTML
<div class="post">POST</div>
<div class="endereco">/rm/api/TOTVSCustomizacao/IntegracaoSALESFORCE/GravarResponsavelFinanceiro</div>

Realiza a gravação do Responsável Financeiro (Cliente/Fornecedor) no SGE, conforme dados enviados pela API.

Importante: Caso o CPF/CNPJ enviado já exista no SGE, o registro é localizado e o cadastro é atualizado com os dados enviados.

Tabela Afetada: FCFO

Interface RM: TOTVS BackOffice | Gestão Financeira | Cadastros | Cliente/Fornecedor


Authorization - Basic Auth

Username <username>

Password <password>

Body

Bloco de código
languagec#
titleRaw
{
 "CodCFO": "7604288600001",
 "Nome": "responsaveltesteapi",
 "Cpf": "42302908023",
 "Email": "[email protected]",
 "Cep": "31810365",
 "Logradouro": "Logradouro",
 "Numero": 20,
 "Complemento": "101",
 "Bairro": "Bairro",
 "Estado": "MG",
 "Cidade": "Belo Horizonte",
 "Pais": "Brasil",
 "Telefone": "03189898989",
 "Celular": "77777777777",
 "Tel_Comercial": "0314545454545",
 "Fax": "0314545454545",
 "CodColigada": 3,
 "Global": true
}

Content

  • CodCFO: Código identificador do cliente RM/Salesforce/Protheus.

Deve ser enviado no seguinte formato: 9 primeiros dígitos do CPF ou 8 primeiros  primeiros dígitos do CNPJ + código da loja. Exemplo: 0101251250001

  • Nome: Nome do responsável financeiro no SGE (Campo Obrigatório);

  • Cpf: CPF do responsável financeiro no SGE (Campo Obrigatório);
  • Email: E-mail do responsável financeiro no SGE (Campo Obrigatório);
  • Cep: CEP do endereço do aluno no SGE (Campo Obrigatório);
  • Logradouro: Nome da rua (Campo Obrigatório);

  • Numero: Numero da residencia (Enviar apenas números)(Campo Obrigatório);

  • Complemento: Complemento se houver (Campo Obrigatório);
  • Bairro: Nome do bairro (Campo Obrigatório);
  • Estado: Enviar Sigla do Estado (Campo Obrigatório);
  • Cidade: Enviar Nome da Cidade (Campo Obrigatório);

  • Pais: Enviar Nome do país (Campo Obrigatório);

  • Telefone: Número telefone fixo (Enviar apenas números com DDD)(Campo Obrigatório);

  • Celular: Número telefone celular (Enviar apenas números com DDD) (Campo Obrigatório);

  • Tel_Comercial: Numero telefone comercial(Enviar apenas números com DDD);
  • Fax: Número fax (Enviar apenas números com DDD);

  • CodColigada: Código da Coligada no SGE. Enviar 2 para SESI e 3 para SENAI (Campo obrigatório).
  • Global: informar se o registro do cliente será compartilhado entre as coligadas. Enviar true para Global e false para registro por coligada. 

Retorno

Bloco de código
languagec#
titleConsole
{
   "Message": "Responsavel: 00000005, criado 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;
Expandir
titleGravar Aluno
HTML
<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.

Importante: Caso o CPF enviado já exista no SGE, a API identifica a pessoa e o RA, e atualiza o cadastro com os dados enviados.

Tabelas Afetadas: SALUNO, PPESSOA, SALUNOCOMPL

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

Authorization - Basic Auth

Username <username>

Password <password>

Body

Bloco de código
languagec#
titleRaw
{
  "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

Bloco de código
languagec#
titleConsole
{
   "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;

...