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">/rm/api/TOTVSCustomizacao/IntegracaoSALESFORCE/AtualizarServicoCRM

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

[
    {
		"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 (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

{
   "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;

<div class="post">POST</div>
<div class="endereco">/rm/api/TOTVSCustomizacao/IntegracaoSALESFORCE/MatricularAluno

Realiza a matricula do aluno no SGE, conforme passados as informações pela API.

Authorization - Basic Auth

Username <username>

Password <password>

Body

{
  "Nome": "Paulo de Assis Moreira",
  "EstadoNatal": "MG",
  "Naturalidade": "Belo Horizonte",
  "DataNascimento": "25/12/1990",
  "Cpf": "00278666027",
  "Cep": "123456",
  "Logradouro": "Teste",
  "Numero": 10,
  "Complemento": "101",
  "Bairro": "Teste",
  "Estado": "MG",
  "Cidade": "Belo Horizonte",
  "Pais": "Brasil",
  "Tel_Residencial": "03189898989",
  "Tel_Celular": "0314545454545",
  "Tel_3": "0314545454545",
  "Fax": "0314545454545",
  "SitOcupacional": 1,
  "TipoEscola": 3,
  "NomeMae": "Maria Aparecida Novais",
  "RespFinanceiro": {
    "CodCFO": "396986260-0001",
    "Nome": "Marcos Aparecido de Assis Novais",
    "Cpf": "39698626042",
    "Email": "[email protected]",
    "Cep": "123456",
    "Logradouro": "Teste",
    "Numero": 20,
    "Complemento": "101",
    "Bairro": "Teste",
    "Estado": "MG",
    "Cidade": "Belo Horizonte",
    "Pais": "Brasil",
    "Telefone": "03189898989",
    "Celular": "0314545454545",
    "Tel_Comercial": "0314545454545",
    "Fax": "0314545454545"
  },
  "MatriculaAluno": {
    "IdMatrizAplicada": 24,
    "RA": "000035",
    "Turma": "APB.008.009",
    "DataMatricula": "20/12/2021",
    "DataPrevSaida": "01/01/2022",
    "CondicaoAluno": 0,
    "CodFinSCAE": 1,
    "Articulacao": 2
  },
  "Disciplina":[
    "APB.020.0049"
  ],
  "Contrato": {
    "ValorTotal": 210,
    "QuantidadeParc": 1,
    "DataVencimento": "21/12/2021",
    "DiaVencimento": 21,
    "DescontoInstitucional": 8,
    "DescontoAdicional": 1,
    "Motivo": "Teste",
    "DataVenda": "25/12/2021",
    "IdOportunidade": 1,
    "FormaPagtoPrimeiraParc": "CACCAC",
    "FormaPagtoDemaisParc": "CAC",
    "ReceberBoletoEmail": "Sim"
	"PedidoFiscal": "PF123456"
  },
  "CodColigada": 3
}

Content

Nome: Nome do Aluno no SGE (primary key);
EstadoNatal: Estado Natal do Aluno no SGE (primary key);
Naturalidade: Naturalidade do Aluno no SGE (primary key);
DataNascimento: Data de Nascimento do Aluno no SGE (primary key);
Cpf: CPF do Aluno no SGE (primary key);
Cep: CEP do Aluno no SGE;
Logradouro: Logradouro do Aluno no SGE;
Numero: Número do Aluno no SGE;
Complemento: Complemento do Aluno no SGE;
Bairro: Bairro do Aluno no SGE;
Estado: Estado do Aluno no SGE;
Cidade: Cidade do Aluno no SGE;
Pais: País do Aluno no SGE;
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
5 = Profissional Liberal
6 = 1º Emprego
7 = Aposentado

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

NomeMae: Nome da mãe do Aluno no SGE;
RespFinanceiro: Dados Responsável Financeiro;
- CodCFO: Código identificador do cliente Salesforce/Protheus (primary key);
- Nome: Nome do responsável financeiro no SGE (primary key);
- Cpf: CPF do responsável financeiro no SGE (primary key);
- Email: E-mail do responsável financeiro no SGE (primary key);
- Cep: CEP do endereço do aluno no SGE (primary key);
- Logradouro: Nome da rua (primary key);
- Numero: Numero da residencia (Enviar apenas números)(primary key);
- Complemento: Complemento se houver (primary key);
- Bairro: Nome do bairro (primary key);
- Estado: Enviar Sigla do Estado (primary key);
- Cidade: Enviar Nome da Cidade (primary key);
- Pais: Enviar Nome do país (primary key);
- Telefone: Número telefone fixo (Enviar apenas números com DDD)(primary key);
- Celular: Número telefone celular (Enviar apenas números com DDD) (primary key);
- Tel_Comercial: Numero telefone comercial(Enviar apenas números com DDD);
- Fax: Número fax(Enviar apenas números com DDD);
MatriculaAluno: Dados de Matrícula;
- IdMatrizAplicada: Identificador da Matriz Aplicada (Curso/Habilitação e Período Letivo) (primary key);
- RA: Registro acadêmico do aluno no SGE (primary key);
- Turma: Código da Turma do SGE onde o aluno será matriculado (primary key);
- DataMatricula: Data da Matrícula do aluno (primary key);
- DataPrevSaida: Data final do Curso;
- CondicaoAluno: Condição do Aluno (SENAI);
  Valores possíveis:
  0 = Não Gratuita.
  1 = Gratuidade regimental
  2 = Bolsa de estudos
  3 = Convênio
- CodFinSCAE: Código Financiamento SCAE;

Valores possíveis:
0 = Não Gratuita
2 = Gratuidade Regulamentar
3 = Gratuidade Não Regulamentar

- Articulacao: Código de Articulação.
Valores possíveis:
1 = Há Articulação Sesi/Senai
2 = Não há Articulação Sesi/Senai
3 = Há Articulação entre outras instituições

Disciplinas: Código da Disciplinas (Pode ser inserido mais de uma disciplina) (primary key);
Contrato: Dados Contrato;
- ValorTotal: Valor total da venda (sem descontos de bolsas) (primary key);
- QuantidadeParc: Quantidade de parcelas da venda (primary key);
- DataVencimento: Data do vencimento da primeira parcela do contrato (primary key);
- DiaVencimento: Dia fixo do vencimento que será utilizado na geração da segunda parcela em diante. A data será gerada com o dia fixo informado do mês subsequente do início da turma, até atingir a quantidade de parcelas (primary key);
- DescontoInstitucional: Valor do desconto institucional calculado, com base no valor total do contrato;
- DescontoAdicional: Valor do desconto adicional calculado, com base no valor total do contrato;
- Motivo: Descrição do Motivo do desconto adicional (obrigatório no caso de desconto concedido);
- DataVenda: Data corrente do recebimento da matrícula (primary key);
- IdOportunidade: Identificador da oportunidade fechada no SALESFORCE (primary key);
- FormaPagtoPrimeiraParc: Forma De pagamento - Primeira parcela (primary key);

Valores possíveis:
BOLETO: BOL (Mensalidade Boleto)
Cartão crédito: CAC (Mensalidade Cartão de crédito)
Cartão débito: CAR (Mensalidade Cartão de débito)
Dinheiro: ESP (Mensalidade dinheiro)

- FormaPagtoDemaisParc: Forma De pagamento - Demais parcelas (primary key);
Valores possíveis:
BOLETO: BOL (Mensalidade Boleto)
Cartão crédito: CAC (Mensalidade Cartão de crédito)
Cartão débito: CAR (Mensalidade Cartão de débito)
Dinheiro: ESP (Mensalidade dinheiro)
- ReceberBoletoEmail: Recebe Boleto por E-mail (primary key);
Valores possíveis: Sim ou Não - se o boleto foi enviado por e-mail
PedidoFiscal: Identificação do Pedido Fiscal
CodColigada: Código da Coligada no SGE (primary key);

Retorno

{
   "Message": "Matrícula realizada 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;

<div class="post">POST</div>
<div class="endereco">/rm/api/TOTVSCustomizacao/CstIntegracaoProtheus/ItemContabil</div>

Insere e/ou atualiza itens contábeis no RM, para uso no projeto Integração Protheus FIEC.

Authorization - Basic Auth

Username <username>

Password <password>

Body

[
    {
		"codColigada": "3",
		"idItemContabil": "1253",
		"itemContabil": "0001253",
        "codFilial": null,
		"descricao": "teste Exemplo 0",
		"status": "T"
	}
]

Content

codColigada: Código da Coligada (primary key);
idItemContabil: Id do item Contábil (primary key);
itemContabil: Código do Item Contábil Protheus;
codFilial: Código da Filial;
descricao: Descrição do item contábil;
status: Status do item contábil;
- T = Ativo
- F = Inativo

Retorno

{
"Message": "Sucesso ao criar o item 123\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;

<div class="post">POST</div>
<div class="endereco">/rm/api/TOTVSCustomizacao/CstIntegracaoProtheus/InclusaoLancamento</div>

Cancela os lançamentos no RM, para uso no projeto Integração Protheus FIEC.

Authorization - Basic Auth

Username <username>

Password <password>

Body

[
    {
        "codColigada": "3",
        "xnumpro": "TESTE1",
        "contaCaixaBanco": "001",
        "contaCaixaAgencia": "01",
        "contaCaixaContaCorrente": "111111",
        "parcelas": [
            {
                "pedidoVendaGerencial": "TESTE2",
                "nossoNumero": "TESTE2",
                "dataEmissao": "01/01/2000",
                "dataVencimento": "05/01/2000"
            }
        ]
    }
]

Content

codColigada: Código da Coligada (primary key);
xnumpro: Utilizado para identificar o contrato/parcela referente ao lançamento;
contaCaixaBanco: Código do Banco da Conta Caixa/Convênio;
contaCaixaAgencia: Agência da Conta Caixa/Convênio;
contaCaixaContaCorrente: Conta Corrente da Conta Caixa/Convênio, com o dígito;
parcelas: Código do Banco da Conta Caixa/Convênio;
- pedidoVendaGerencial: Número do Pedido de Venda Gerencial gerado no Protheus referente à parcela;
- nossoNumero: Nosso número do boleto;
- dataEmissao: Data de Emissão do lançamento;
- dataVencimento: Data de vencimento do lançamento;

Retorno

{
"Message": "Sucesso ao incluir o Id. Lançamento 142\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;

<div class="post">POST</div>
<div class="endereco">/rm/api/TOTVSCustomizacao/CstIntegracaoProtheus/CancelamentoLancamento</div>

Cancela os lançamentos no RM, para uso no projeto Integração Protheus FIEC.

Authorization - Basic Auth

Username <username>

Password <password>

Body

[
    {
		"codColigada": "3",
  		"idLan": "142",
  		"DataCancelamento": "01/01/2000"
	}
]

Content

codColigada: Código da Coligada (primary key);
idLan: Id do Lançamento (primary key);
DataCancelamento: Data do Cancelamento do Lançamento (primary key);

Retorno

{
"Message": "Sucesso ao excluir o Id. Lançamento 142\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;

<div class="post">POST</div>
<div class="endereco">/rm/api/TOTVSCustomizacao/CstIntegracaoProtheus/CancelamentoBaixa</div>

Cancela as baixas dd lançamento no RM, para uso no projeto Integração Protheus FIEC.

Authorization - Basic Auth

Username <username>

Password <password>

Body

[
    {
		"codColigada": "3",
  		"idLan": "142",
  		"DataCancelamento": "01/01/2000"
	}
]

Content

codColigada: Código da Coligada (primary key);
idLan: Id do Lançamento (primary key);
DataCancelamento: Data do Cancelamento do Lançamento (primary key);

Retorno

{
"Message": "Sucesso ao cancelar baixa do Id. Lançamento 142\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;

<div class="post">POST</div>
<div class="endereco">/rm/api/TOTVSCustomizacao/CstIntegracaoProtheus/BaixaTitulo</div>

Insere e/ou atualiza itens contábeis no RM, para uso no projeto Integração Protheus FIEC.

Authorization - Basic Auth

Username <username>

Password <password>

Body

[{
    "codColigada": "3",
    "idLan": "143",
    "ValorBaixa": 311.26,
    "DataBaixa": "16/12/2021",
    "ContaCaixa_Banco": "002",
    "ContaCaixa_AG": "9598",
    "ContaCaixa_CC": "1234",
    "Juros": 30.76,
    "Multa": 5.50,
    "Desconto": 0.0
}]

Content

codColigada: Código da Coligada (primary key);
idLan: Id do Lançamento (primary key);
ValorBaixa: Valor da Baixa do Título (primary key);
DataBaixa: Data da Baixa do Título (primary key);
ContaCaixa_Banco: Código do banco da Conta para realização da Baixa;
ContaCaixa_AG: Código da agencia do banco da Conta para realização da Baixa;
ContaCaixa_CC: Codigo da Conta corrente para rea\lização da Baixa;
Juros: Taxa de Juros da Baixa;
Multa: Valor da Multa da Baixa;
Desconto: Valor de Desconto da Baixa;

Retorno

{
    "Message": "Sucesso ao baixar o titulo do Id. Lançamento 143\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;

<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>
-->