Fábrica de Software TOTVS BH

Atalhos

Páginas filhas
  • Documentação API - FIEC

Versões comparadas

Versão antiga 37

changes.mady.by.user Pedro Henrique Rosa de Souza

Gravado em

comparado com

Nova versão 38

changes.mady.by.user Ana Carolina Eleuterio Abras

Gravado em

Chave

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

...

Expandir
titleServiço CRM
HTML
<div class="post">POST</div>
<div class="endereco">/rm/api/TOTVSCustomizacao/IntegracaoSALESFORCE/AtualizarServicoCRM</div>


Inclui ou altera um Serviço originado do CRM no cadastro customizado de Serviços do SGE, vinculando o serviço ao curso informado.

Authorization - Basic Auth

Username <username>

Password <password>

Body

Bloco de código
languagec#
titleRaw
[
    {
		"CodColigada: "3",
		"Codigo: "10",
		"Descricao: "Mensalidade - Curso Técnico Mecânica",
		"ProdutoProtheus": "121551",
  		"Natureza": "1100103",
  		"Ativo": true,
  		"CodCurso": "APT.00011",
	}
]

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;
  • Ativo: true ou false, indica se o serviço está ativo ou não;
  • CodCurso: Código do Curso no SGE, no qual deverá ser vinculado o serviço que está sendo criado (anexo customizado do Curso SGE).


Retorno

Bloco de código
languagec#
titleConsole
{
   "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;
Expandir
titleResponsável Financeiro
HTML
<div class="post">POST</div>
<div class="endereco">/rm/api/TOTVSCustomizacao/IntegracaoSALESFORCE/GravarResponsavelFinanceiro</div>

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

Authorization - Basic Auth

Username <username>

Password <password>

Body

Bloco de código
languagec#
titleRaw
{
 "CodCFO": "760428860-0004",
 "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
}

Content

  • 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órioobrigatório);.

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;

...