Documentação API - FIEC

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.

Serviço CRM

POST

/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 aos cursos informados.

Ao executar a chamada do webservice, se for inclusão de um serviço novo, o método irá:

Incluir o Serviço CRM no SGE (cadastro customizado).
Preencher todos os dados do serviço:

Código do Serviço/Produto
Descrição do Serviço/Produto
Código do produto do Protheus (obrigatório),
Código da Natureza Financeira do Protheus
Item Contábil
Conta Contábil
Status

Vincular o Serviço CRM no anexo customizado dos Cursos informados

Ao executar a chamada do webservice, se for atualização de um serviço existente será permitido alterar o status e o processo deverá identificar o serviço CRM no SGE através do código e atualizar seu status no cadastro customizado.

Tabela Afetada: ZINTSFSERVICOCRM

Authorization - Basic Auth

Username <username>

Password <password>

Body

Raw

[
    {
		"CodColigada: 3,
		"Codigo: "10",
		"Descricao: "Mensalidade - Curso Técnico Mecânica",
		"ProdutoProtheus": "121551",
  		"Natureza": "1100103",
		"ItemContabil": "123",
		"ContaContabil": "090090009",
  		"Ativo": true,
        "CodCursos": [ "APT.00011", "TEC.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;
Item Contabil: (Id do protheus);
Conta Contabil: (Conta Contabil)
Ativo: true ou false, indica se o serviço está ativo ou não;
CodCurso: Lista de códigos de curso no SGE que serão vinculados, através do anexo customizado do Curso SGE, ao serviço que está sendo criado.

Retorno

Console

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

Responsável Financeiro

POST

/rm/api/TOTVSCustomizacao/IntegracaoSALESFORCE/GravarResponsavelFinanceiro

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

Raw

{
 "CodCFO": "172104210001",
 "Nome": "Template Json API ",
 "CPFCNPJ": "17210421000140",
 "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);
CPFCNPJ: CPF ou CNPJ 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

Console

{
  "Message": "Responsavel: 0172104210001, criado com Sucesso!",
  "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;

Gravar Aluno

POST

/rm/api/TOTVSCustomizacao/IntegracaoSALESFORCE/GravarAluno

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

Raw

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

Console

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

Matricular Aluno

POST

/rm/api/TOTVSCustomizacao/IntegracaoSALESFORCE/RealizarMatricula

Realiza a Matrícula do aluno no SGE, geração do Contrato Educacional e suas parcelas e preenche o anexo de dados complementares do contrato, conforme dados enviados pela API.

Tabelas Afetadas: SMATRICPL, SMATRICULA, SHABILITACAOALUNO, SCONTRATO, SPARCELA, ZINTSFDADOSCONTRATO e ZINTSFDADOSCONTRATOPARCELA

Interfaces RM:

Authorization - Basic Auth

Username <username>

Password <password>

Body

Raw

{
    "CodColigada": 3,
    "IdMatrizAplicada": "3|22",
    "RA": "0000000382",
    "Turma": "11|TEC.001.017",
    "DataMatricula": "30/05/2022",
    "DataPrevSaida": "30/05/2023",
    "CondicaoAluno": 0,
    "CodFinSCAE": 1,
    "Articulacao": 2,
    "Contrato": {
        "NomeRespFin": "NOME DO CLIENTE FORNECEDOR",
        "CodColCfo": 0,
        "CodCFO": "0564404200001",
        "ValorTotal": 240.0,
        "QuantidadeParc": 1,
        "ParcelasCartaoParcelaUm": 0,
        "DataVencimento": "20/06/2022",
        "DiaVencimento": 20,
        "DescontoInstitucional": 0,
        "DescontoAdicional": 0,
        "Motivo": "Teste matricula aluno",
        "DataVenda": "26/04/2022",
        "IdOportunidade": 1,
        "FormaPagtoPrimeiraParc": "CAC",
        "FormaPagtoDemaisParc": "CAC",
        "ReceberBoletoEmail": "Sim",
        "Ecommerce": "SIM",
        "DadosCartao": {
            "Cod_Loja": 0001,
            "Agencia": "1369",
            "Cod_Banco": "001",
            "Conta": "2002",
            "Motivo": "CAC",
            "AdquirenteCartao": "999999999",
            "BandeiraCartao": "MASTERCARD",
            "NSU": "9999999999",
            "MeioPagamento": "Crédito",
            "ValorTotalCartao": 240.0,
            "ParcelasCartao": 5
        }
    },
    "Disciplinas": []
}

Content

IdMatrizAplicada: Código da Coligada seguido do Identificador da Matriz Aplicada (Curso/Habilitação e Período Letivo) (Campo Obrigatório); Mesma informação enviada pelo SGE na exportação da matriz.
RA: Registro acadêmico do aluno no SGE (Campo Obrigatório);
Turma: Código da Turma do SGE onde o aluno será matriculado (Campo Obrigatório). O código da turma enviado contém o identificador do período letivo seguido do código da turma do SGE, concatenados por '|'.
DataMatricula: Data da Matrícula do aluno (Campo Obrigatório);
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

CodColigada: Código da Coligada no SGE (Campo Obrigatório);
Contrato:
- CodCFO: Código identificador do cliente no RM/Salesforce/Protheus (Campo Obrigatório);
- CodColCfo: Código da Coligada do cliente Fornecedor. Se for global, enviar 0 - zero (Campo obrigatório);
- NomeRespFin: Nome do responsável financeiro no SGE (Campo Obrigatório);
- ValorTotal: Valor total da venda (sem descontos de bolsas);
- QuantidadeParc: Quantidade de parcelas do contrato de venda (referente à quantidade de pedidos gerenciais);
- ParcelasCartaoParcelaUm: Quantidade de parcelas do financiamento com pagamento em algum tipo de cartão (débito ou crédito);
- DataVencimento: Data do vencimento da primeira parcela do contrato (Campo obrigatório);
- 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 (Campo obrigatório);
- DescontoInstitucional: Valor do desconto institucional, com base no valor total do contrato. Quando informado, será criada uma bolsa Institucional ao contrato (conforme código de bolsa informado nos parâmetros da customização). Este valor corresponde ao valor total de desconto a ser distribuído entre as parcelas;
- DescontoAdicional: Valor do desconto adicional, com base no valor total do contrato. Quando informado, será criada uma bolsa Adicional ao contrato (conforme código de bolsa informado nos parâmetros da customização). Este valor corresponde ao valor total de desconto a ser distribuído entre as parcelas;
- MotivoDesconto: Descrição do Motivo do desconto adicional ou institucional (obrigatório no caso de desconto concedido);
- DataVenda: Data corrente do recebimento da matrícula;
- IdOportunidade: Identificador da oportunidade fechada no SALESFORCE ;
- FormaPagtoPrimeiraParc: Forma De pagamento - Primeira parcela (Campo Obrigatório);

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 (Campo Obrigatório);
- 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 (Campo Obrigatório);
- Valores possíveis: Sim ou Não - se o boleto foi enviado por e-mail
- ECommerce: Identificação de E-Commerce

Valores possíveis: Sim ou Não

- Dados Cartão:
  - Esse bloco só deve ser enviado para pagamento com cartão através do E-commerce. Só é permitido enviar dados de um cartão de crédito. Essas informações são enviadas no complemento do pedido de venda do Protheus;
  - Cod_Loja: Código da loja;
  - Agência, Cod_Banco e Conta: Dados bancários relacionados ao pagamento e-commerce;.
  - Motivo: informar um dos valores abaixo
  - 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)
  - AdquirenteCartao: Código do adquirente
  - BandeiraCartao: Informar uma das bandeira definidas para integração. Exemplo: MASTERCARD;
  - NSU: Código do NSU;
  - MeioPagamento: Opções disponíveis: "Crédito" ou "Débito";
  - ValorTotalCartao: Valor total da venda;
  - ParcelasCartao: Quantidade de Parcelas junto a operadora do cartão. Informação enviada para Protheus para geração de títulos a receber para operadora do cartão.

Informação sobre o envio de pagamento via e-commerce:

Quando for enviado pagamento via e-commerce o campo QuantidadeParc do contrato deve ser igual a 1 (um), pois será considerada apenas uma parcela no SGE. A quantidade de vezes que o pagamento foi parcelado no cartão deve ser enviado no campo ParcelasCartao dos dados do pagamento com cartão.

Disciplinas: Lista de códigos da Disciplinas onde o aluno deverá ser matriculado no SGE. Caso este campo não seja informado, o aluno será matriculado em todas as disciplinas da turma/matriz aplicada.

Retorno

Console

{
    "Matricula": {
        "Matricula": "0000000001",
        "XNumPro": "SGE3F20C100",
        "CodFilial": "UN20",
        "FilialProtheus": "03CE0001",
        "CodColigada": 3,
        "CodContrato": "100",
        "StatusContrato": "Vigente",
        "DataInicio": "2022-07-08T00:00:00",
        "DuracaoEmMeses": 4,
        "SituacaoMatricula": "Pré-Matriculado"
    },
    "Message": "Matrícula realizada com sucesso!",
    "Status": "Sucesso",
    "StatusCode": 200
}

Content

Matricula: Registro acadêmico do aluno;
XNumPro: Identificador do contrato integrado com o Protheus e SalesForce;
CodFilial: Código da filial;
FilialProtheus: Código da filial no Protheus (retornado do cadastro de filial do SGE, campo IdIntegracao);
CodColigada: Código de status da coligada;
StatusContrato: Status do contrato (texto fixo);
DataInicio: Data de início do contrato;
DuracaoEmMeses: Duração do contrato com base das datas das Turmas/Disciplinas;
SituacaoMatricula: Descrição da situação de matrícula no SGE;
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;

Item Contábil

POST

/rm/api/TOTVSCustomizacao/CstIntegracaoProtheus/ItemContabil

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

Tabela Afetada: ZINTPROTHEUSITEMCONTABILPROTHEUS

Authorization - Basic Auth

Username <username>

Password <password>

Body

Raw

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

Content

codColigada: Código da Coligada (obrigatório).
itemContabil: Código do Item Contábil Protheus (obrigatório). Para alterações, o SGE irá localizar o registro através deste código e do número da coligada.
codFilial: Código da Filial.
descricao: Descrição do item contábil.
status: Status do item contábil.
- T = Ativo
- F = Inativo

Retorno

Console

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

Geração do lançamento no Contrato

POST

/rm/api/TOTVSCustomizacao/CstIntegracaoProtheus/InclusaoLancamento

Realiza a inclusão dos lançamentos no Contrato Educacional do SGE para uso no projeto Integração Protheus FIEC.

A API efetua a execução do processo de "Geração de Lançamentos".

Tabela Afetada: FLAN, SLAN, FBOLETO

Interfaces RM:

Authorization - Basic Auth

Username <username>

Password <password>

Body

Raw

[
    {
        "codColigada": "3",
        "xnumpro": "TESTE1",
        "contaCaixaBanco": "001",
        "contaCaixaAgencia": "01",
        "contaCaixaContaCorrente": "111111",
        "parcela": 
            {   "pedidoVendaGerencial": "TESTE2",
                "nossoNumero": "",
                "dataEmissao": "01/01/2000",
                "dataVencimento": "13/06/2022",
                "dataPrevisaoBaixa": "12/06/2022",
			    "Filial": "03CE0001",
    			"Prefixo": "001",
                "Num": "000804",
                "Parcela": "1",
                "Tipo": "P"
            }            
    }
]

Content

codColigada: Código da Coligada (obrigatório).
xnumpro: Utilizado para identificar o contrato/parcela referente ao lançamento (obrigatório).
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.
parcela: Dados da Parcela do SGE
- pedidoVendaGerencial: Número do Pedido de Venda Gerencial gerado no Protheus referente à parcela (obrigatório).
- nossoNumero: Nosso número do boleto, quando existente.
- dataEmissao: Data de Emissão do lançamento (obrigatório).
- dataVencimento: Data de vencimento real (dia útil) do lançamento/boleto (FLAN.DTVENCIMENTO).
- dataPrevisaoBaixa: Data de previsão de vencimento do lançamento/boleto calculada pelo Protheus. Informação gravada em FLAN.DATAPREVBAIXA.
- Filial: Filial do Título (primary key) ;
- Prefixo: Prefixo do Título (primary key);
- Num: Número do Título (primary key);
- Parcela: Parcela do Título (primary key);
- Tipo: Tipo do Título (primary key);

Retorno

Console

{
"Message": "Sucesso ao incluir o Id. Lançamento 142.\r\n",
"Status": "Sucesso",
"StatusCode": 200,
"IdLan": 142
}

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;
IdLan: Identificador do lançamento gerado pelo SGE.

Cancelamento do lançamento

POST

/rm/api/TOTVSCustomizacao/CstIntegracaoProtheus/CancelamentoLancamento

Cancela os lançamentos no RM, para uso no projeto Integração Protheus FIEC. O status do lançamento (FLAN.STATUS) é alterado para 2-Cancelado.

Tabela Afetada: FLAN

Authorization - Basic Auth

Username <username>

Password <password>

Body

Raw

[
    {
		"codColigada": "3",
  		"idLan": "142",
        "Filial": "03CE0001",
        "Prefixo": "001",
   		"Num": "000804",
    	"Parcela": "1",
    	"Tipo": "P",     
  		"DataCancelamento": "01/01/2000"
	}
]

Content

codColigada: Código da Coligada (primary key);
idLan: Id do Lançamento (primary key);
Filial: Filial do Título (primary key) ;
Prefixo: Prefixo do Título (primary key);
Num: Número do Título (primary key);
Parcela: Parcela do Título (primary key);
Tipo: Tipo do Título (primary key);
DataCancelamento: Data do Cancelamento do Lançamento (primary key);

Importante: Quando o idLan estiver vazio, serão considerados os seguintes campos como chave: Filial, Prefixo, Num, Parcela e Tipo.

Retorno

Console

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

Cancelamento de baixas do lançamento

POST

/rm/api/TOTVSCustomizacao/CstIntegracaoProtheus/CancelamentoBaixa

Cancela as baixas dos lançamento no RM, para uso no projeto Integração Protheus FIEC. O status do lançamento (FLAN.STATUS) é alterado de 1-Baixado para 0-Em aberto.

Tabela Afetada: FLAN, FLANBAIXA

Authorization - Basic Auth

Username <username>

Password <password>

Body

Raw

[
  {
    "IdLan": "334",
    "Filial": "03CE0001",
    "Prefixo": "001",
    "Num": "000804",
    "Parcela": "1",
    "Tipo": "P",     
    "DataCancelamento": "06/07/2022",
    "DataBaixa": "06/07/2022",
    "ContaCaixaBanco": "002",
    "ContaCaixaAgencia": "9598",
    "ContaCaixaContaCorrente": "1234",
    "ValorBaixa": 2000,
    "codColigada": "3",
    "ContaCaixa_SEMMOVIMENTACAO": ""
  }
]

Content

codColigada: Código da Coligada (primary key);
idLan: Id do Lançamento (primary key);
Filial: Filial do Título (primary key) ;
Prefixo: Prefixo do Título (primary key);
Num: Número do Título (primary key);
Parcela: Parcela do Título (primary key);
Tipo: Tipo do Título (primary key);
DataCancelamento: Data do Cancelamento do Lançamento (primary key);
DataBaixa: Data dde realização da baixa;
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;
ValorBaixa: Valor da baixa;
ContaCaixa_SEMMOVIMENTACAO: Código da conta/caixa sem movimentação.

Importante: Quando o idLan estiver vazio, serão considerados os seguintes campos como chave: Filial, Prefixo, Num, Parcela e Tipo.

Retorno

Console

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

Baixa do Título

POST

/rm/api/TOTVSCustomizacao/CstIntegracaoProtheus/BaixaTitulo

Efetua a baixa do lançamento financeiro do SGE. O status do lançamento (FLAN.STATUS) é alterado para 1-Baixado.

Tabelas Afetadas: FLAN, FLANBAIXA

Authorization - Basic Auth

Username <username>

Password <password>

Body

Raw

[{
    "codColigada": "3",
    "idLan": "143",
    "Filial": "03CE0001",
    "Prefixo": "001",
    "Num": "000804",
    "Parcela": "1",
    "Tipo": "P",
    "ValorBaixa": 311.26,
    "DataBaixa": "16/12/2021",
    "ContaCaixa_Banco": "002",
    "ContaCaixa_AG": "9598",
    "ContaCaixa_CC": "1234",
    "ContaCaixa_SEMMOVIMENTACAO": "00001", 
    "Juros": 30.76,
    "Multa": 5.50,
    "Desconto": 0.0
}]

Content

codColigada: Código da Coligada. Enviar 2 para SESI e 3 para SENAI (primary key).
idLan: Id do Lançamento (primary key);
Filial: Filial do Título (primary key) ;
Prefixo: Prefixo do Título (primary key);
Num: Número do Título (primary key);
Parcela: Parcela do Título (primary key);
Tipo: Tipo do Título (primary key);
ValorBaixa: Valor Total da Baixa do Título (primary key), somando juros e multa e descontando o valor de desconto, se existir.
- Exemplo:
  - Valor original: R$ 300,00
  - Valor do Juros: R$ 30,00
  - Valor da Multa: R$ 6,00
  - Valor a ser informado no campo "ValorBaixa": R$ 336,00
DataBaixa: Data da Baixa do Título (primary key);
Baixas com movimentação bancária:
- 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: Código da Conta corrente para realização da Baixa;
- Será utilizada a Filial do lançamento financeiro enviado para localizar a Conta Caixa correta no SGE, já que podem existir vários cadastros de conta caixa com o mesmo número do banco, agência e conta.
Baixas sem movimentação bancária (só deve ser enviada se os dados de baixa com movimentação não for informado):
- ContaCaixa_SemMovimentação: Código da Conta caixa do SGE utilizada para baixas de cartão e NCC que não efetuam movimentação bancária.
Juros: Valor dos Juros da Baixa;
Multa: Valor da Multa da Baixa;
Desconto: Valor de Desconto da Baixa;
- Observação: Quando for informado um valor de desconto (campo "Desconto") este deverá representar o valor total do desconto (Bolsa permanente + outros descontos). Caso este valor seja maior que o valor da bolsa a diferença será gravada na baixa, no campo "Desconto". O valor informado no campo "ValorBaixa" deve contemplar este desconto.
  Exemplo:
  - Valor original: R$ 458,33
  - Valor da bolsa permanente: R$ 45,83
  - Valor do desconto: R$ 10,00
  - Valor a ser informado no campo "ValorBaixa": R$ 402,50
  - Valor a ser informado no campo "Desconto": R$ 55,83 (Soma do valor da bolsa + algum outro desconto adicional)

Importante: Quando o idLan estiver vazio, serão considerados os seguintes campos como chave: Filial, Prefixo, Num, Parcela e Tipo.

Retorno

Console

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

Alteração NossoNumero

POST

/rm/api/TOTVSCustomizacao/CstIntegracaoProtheus/AlteracaoNossoNumero

Insere e/ou atualiza o NossoNumero do Lançamento Financeiro e Boleto do SGE.

Tabela Afetada: FLAN, FBOLETO

Interfaces RM:

Authorization - Basic Auth

Username <username>

Password <password>

Body

Raw

{
  "codColigada" : "1",
  "NossoNumero" : "123",
  "Idlan": 232,
  "Filial": "03CE0001",
  "Prefixo": "001",
  "Num": "000805",
  "Parcela": "1",
  "Tipo": "P",   
  "NumeroPedido" : null,
  "CodFilial" : null
}

Content

codColigada: Código da Coligada. Enviar 2 para SESI e 3 para SENAI (primary key).
NossoNumero: Numero do NossoNumero (obrigatório).
IDLan: Id do Lançamento (opcional) (Caso não seja possível preencher o campo IdLan, deverão ser enviados os parâmetros NumeroPedido e CodFilial).
Filial: Filial do Título (primary key) ;
Prefixo: Prefixo do Título (primary key);
Num: Número do Título (primary key);
Parcela: Parcela do Título (primary key);
Tipo: Tipo do Título (primary key);
NumeroPedido: Numero do Pedido Gerencial (opcional).
CodFilial: Código da Filial (opcional).

Importante: Quando o idLan estiver vazio, serão considerados os seguintes campos como chave: Filial, Prefixo, Num, Parcela e Tipo.

Retorno

Console

{
    "Message": "Sucesso ao fazer a Alteração do Nosso Numero (IDLan/Numero Pedido : 172, NossoNumero: 123).\r\n\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;

Recebimento de Acordo

POST

/rm/api/TOTVSCustomizacao/CstIntegracaoProtheusAcordo/Inclusao

Efetiva no SGE os acordos efetuados no Protheus.

A API efetua a criação do acordo, a baixa dos lançamentos originais e a criação dos novos lançamentos gerados pelo acordo, conforme negociação gerada no Protheus.

Tabela Afetada: FLAN, FLANBAIXA, FACORDO, FACORDOREL

Authorization - Basic Auth

Username <username>

Password <password>

Body

Raw

{
  "IdLiquidacao": "3|CSI|TESTE|CNI418Parc1&5",
  "codColigada": "3",
  "NumParcelas": 3,
  "CodCCusto": "3.03.01.03.01",
  "TipoJuros": 0,
  "TaxaJuros": 0,
  "ValorJurosDia": 0,
  "DataAcordo": "2022-06-14",
  "ValorAcordo": 2499.0,
  "ValorDesconto": 1,
  "ValorAcrescimo": 100,
  "LancamentosOriginais": [
    {
      "Idlan": 232,
      "Filial": "03CE0001",
      "Prefixo": "001",
      "Num": "000805",
      "Parcela": "1",
      "Tipo": "P"
    },
    {
      "Idlan": 233,
      "Filial": "03CE0001",
      "Prefixo": "001",
      "Num": "000805",
      "Parcela": "1",
      "Tipo": "P"   
  }
  ],
  "LancamentosAcordo": [
    {
      "Identificador": "001",
      "Filial": "03CE0001",
      "Prefixo": "001",
      "Num": "000804",
      "Parcela": "1",
      "Tipo": "P",  
      "DataVencimento": "2022-07-10",
      "DataPrevisaoBaixa": "2022-07-10",
      "Valor": 1050.11
    },
    {
      "Identificador": "002",
	  "Filial": "03CE0001",
      "Prefixo": "001",
      "Num": "000804",
      "Parcela": "1",
      "Tipo": "P",         
      "DataVencimento": "2022-08-10",
      "DataPrevisaoBaixa": "2022-08-11",
      "Valor": 1248.89
    },
    {
      "Identificador": "003",
      "Filial": "03CE0001",
      "Prefixo": "001",
      "Num": "000804",
      "Parcela": "1",
      "Tipo": "P",         
      "DataVencimento": "2022-09-10",
      "DataPrevisaoBaixa": "2022-09-12",
      "Valor": 200.00
    }
  ]
}

Content

CodColigada: Código da Coligada. Enviar 2 para SESI e 3 para SENAI (primary key).
IdLiquidacao: Chave da liquidação do Protheus utilizada para identificar o registro no Log do Processo (pode concatenar vários valores neste campo). O valor enviado será gravado no campo "Observação" do Acordo gerado no SGE.
NumParcelas: Número de Parcelas que devem ser geradas pelo Acordo no SGE.
CodCCusto: Código do Centro de Custo do Acordo
TipoJuros: Juros Futuros - indica se será informado o percentual ou o valor dos juros. Enviar 0 para informar Taxa e 1 para informar Valor. De acordo com o preenchimento, apenas um campo abaixo deve ser informado:
- TaxaJuros: Percentual de taxa de juros ao dia do Acordo
- ValorJurosDia: Valor da taxa de juros ao dia do Acordo
DataAcordo: Data em que o acordo foi gerado no Protheus.
ValorAcordo: Valor Final do Acordo gerado: Soma do valor dos lançamentos financeiros gerados pelo acordo, considerando valor de desconto e acréscimo.
ValorDesconto: Valor do desconto do Acordo. Esse valor é informativo e fica gravado na capa do acordo. Não interfere no cálculo do acordo no SGE.
ValorAcrescimo: Valor do acréscimo do Acordo. Esse valor é informativo e fica gravado na capa do acordo. Não interfere no cálculo do acordo no SGE.

LancamentosOriginais: lista de lançamentos que darão origem ao acordo. Os lançamentos enviados aqui serão baixados no SGE (tipo de baixa = Por Acordo).
- Idlan: Identificador do lançamento original do acordo
- Filial: Filial do Título (primary key) ;
- Prefixo: Prefixo do Título (primary key);
- Num: Número do Título (primary key);
- Parcela: Parcela do Título (primary key);
- Tipo: Tipo do Título (primary key);
LancamentosAcordo: lista de lançamentos que serão gerados pelo Acordo. O número de itens desta lista deve ser igual ao campo NumParcelas. Os lançamentos enviados aqui serão gerados no SGE com status Em Aberto (tabela FLAN).
- Identificador: Número identificador do título do Protheus (chave única, composta por E1_FILIAL + E1_PREFIXO + E1_NUM + E1_PARCELA + E1_TIPO).
- Filial: Filial do Título (primary key) ;
- Prefixo: Prefixo do Título (primary key);
- Num: Número do Título (primary key);
- Parcela: Parcela do Título (primary key);
- Tipo: Tipo do Título (primary key);
- DataVencimento: Data de vencimento real (dia útil) do lançamento/boleto (FLAN.DTVENCIMENTO).
- DataPrevisaoBaixa: Data de previsão de vencimento do lançamento/boleto calculada pelo Protheus. Informação gravada em FLAN.DATAPREVBAIXA.
- Valor: Valor total do boleto/lançamento que será gerado.

Importante: Quando o idLan estiver vazio, serão considerados os seguintes campos como chave: Filial, Prefixo, Num, Parcela e Tipo.

Retorno

Console

{
  "Message": "Acordo 33 gerado com sucesso\r\n",
  "Status": "Sucesso",
  "StatusCode": 200,
  "Data": "{
                "IdAcordo":33,
                "LancamentosAcordo":[
                    {
                        "Identificador":"001",
                        "Idlan":300,
                        "DataVencimento":"2022-07-10T00:00:00"
                    },
                    {
                        "Identificador":"002",
                        "Idlan":301,
                        "DataVencimento":"2022-08-10T00:00:00"
                    },
                    {
                        "Identificador":"003",
                        "Idlan":302,
                        "DataVencimento":"2022-09-10T00:00:00"
                    }
                ]
            }"
}

Content

Message: Mensagem de retorno do consumo da requisição, com identificador do Acordo gerado.
Status: Situação do processamento da requisição;
StatusCode: Código de status do processamento da requisição;
Data: lista com informações do acordo gerado no SGE
- Identificador: chave do título do Protheus, enviado na requisição.
- Idlan: identificador do lançamento gerado no SGE.
- Filial: Filial do Título (primary key) ;
- Prefixo: Prefixo do Título (primary key);
- Num: Número do Título (primary key);
- Parcela: Parcela do Título (primary key);
- Tipo: Tipo do Título (primary key);
- DataVencimento: data de vencimento do lançamento gerado.

Importante: Quando o idLan estiver vazio, serão considerados os seguintes campos como chave: Filial, Prefixo, Num, Parcela e Tipo.

Cancelamento de Acordo

POST

/rm/api/TOTVSCustomizacao/CstIntegracaoProtheusAcordo/Cancelamento

Cancela o acordo financeiro gerado pelo Protheus importado para o SGE. Necessário enviar o identificador do acordo do SGE.

O cancelamento do acordo implica na reabertura dos títulos originais do acordo.

Permitido apenas para acordos sem nenhuma parcela paga. Se necessário, deverá chamar antes a API de cancelamento de baixa para os títulos do acordo.

Tabela Afetada: FLAN, FLANBAIXA, FACORDO, FACORDOREL

Authorization - Basic Auth

Username <username>

Password <password>

Body

Raw

    {
		"codColigada": "3",
  		"idLiquidacao": "22",
  		"DataCancelamento": "01/01/2000"
	}

Content

codColigada: Código da Coligada. Enviar 2 para SESI e 3 para SENAI (primary key).
idLiquidacao: Id da liquidação do Protheus, armazenado no campo Observação do Acordo do SGE no momento do envio.
DataCancelamento: Data do Cancelamento do acordo (obrigatório).

Retorno

Console

{
  "Message": "Acordo 21 (Liquidação Protheus: 3|CSI|TESTE|CNO418Parc4&5), cancelado 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;

Contrato PJ - Recebimento Contrato

POST

/rm/api/TOTVSCustomizacao/ContratoPJ/SetContract

Inclui ou altera um Contrato Pessoa Jurídica no SGE, para permitir que matrículas geradas no SGE sejam vinculadas aos contratos.

Tabela Afetada: ZPJFIECCONTRATO

Interface RM: TOTVS Educacional | Educacional | Customizações | Contrato PJ | Contratos

Authorization - Basic Auth

Username <username>

Password <password>

Body

Raw

{
  "CodColigada": 3,
  "Filial": "03CE0001",
  "NumeroContrato": "123456",
  "NumProposta": "123",
  "CNPJ": "58069568000149",
  "NomeEmpresa": "Entrega Contrato PJ",
  "ValorContrato": 1000,
  "CodTurma": "APB.001.001",
  "IdPerlet": 4,
  "VagasOfertadas": 10,
  "VagasUtilizadas": 2
}

Content

CodColigada: Código da Coligada no SGE. Enviar 2 para SESI e 3 para SENAI (primary key).
Filial: Código da Filial do Salesforce, formato do SGE (sem sigla 'UN').
NumeroContrato: Número do Contrato PJ no CRM (primary key);
NumProposta Número da Proposta do Contrato PJ no CRM (primary key);
CNPJ: CNPJ da empresa responsável pelo Contrato PJ (obrigatório).
NomeEmpresa: CNPJ da empresa responsável pelo Contrato PJ (obrigatório).
ValorContrato: Valor total do Contrato PJ.
CodTurma: Código da turma referente ao Contrato PJ.
IdPerlet: Código do Período Letivo da Turma.
VagasOfertadas: Número total de vagas ofertadas para o Contrato PJ.
VagasUtilizadas: Número de vagas já utilizadas do Contrato PJ.
- Observação: O número de vagas disponíveis deverá ser calculado a partir do total de vagas ofertadas e as vagas utilizadas de cada Contrato PJ.

Retorno

Console

{
  "Message": "Registro integrado com sucesso",
  "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;

Contrato PJ - Consulta Contrato

GET

/rm/api/TOTVSCustomizacao/ContratoPJ/ConsultContract

Consulta um Contrato Pessoa Jurídica no SGE

Tabela Afetada: Nenhuma

Interface RM: TOTVS Educacional | Educacional | Customizações | Contrato PJ | Contratos

Authorization - Basic Auth

Username <username>

Password <password>

Parameters

numeroContrato: Numero do contrato no CRM a ser consultado.
numProposta: Numero da proposta no CRM a ser consultada.

Retorno

Console

[
  {
    "NumeroContrato": "123456",
    "NumProposta": "123",
    "DataInicioTurma": "2022-09-27T00:00:00",
    "DataFimTurma": "2022-11-29T00:00:00",
    "TotalVagas": 10,
    "VagasDisponiveis": 8,
    "VagasUtilizadas": 2,
    "AlunosVinculados": 4,
    "StatusContrato": "Não iniciado",
    "Clientefornecedor": "005959790001"
  }
]

Content

NumeroContrato: Número do Contrato no CRM;
NumProposta: Número da Proposta no CRM;
DataInicioTurma: Data de início da turma associada ao contrato;
DataFimTurma: Data final da turma associada ao contrato;
TotalVagas: Quantidade Total de Vagas do Contrato;
VagasDisponiveis: Quantidade de Vagas disponíveis no Contrato;
VagasUtilizadas: Quantidade de Vagas utilizadas;
AlunosVinculados: Quantidade de Alunos vinculados ao contrato;
StatusContrato: Situação do Contrato;
Clientefornecedor: Responsavel Financeiro do Contrato.

Atalhos

Páginas filhas

Documentação API - FIEC

Authorization - Basic Auth

Body

Retorno

Authorization - Basic Auth

Body

Retorno

Authorization - Basic Auth

Body

Retorno

Authorization - Basic Auth

Body

Authorization - Basic Auth

Body

Retorno

Authorization - Basic Auth

Body

Retorno

Authorization - Basic Auth

Body

Retorno

Authorization - Basic Auth

Body

Retorno

Authorization - Basic Auth

Body

Retorno

Authorization - Basic Auth

Body

Retorno

Authorization - Basic Auth

Body

Retorno

Authorization - Basic Auth

Body

Retorno

Authorization - Basic Auth

Body

Retorno

Authorization - Basic Auth

Parameters

Retorno