Histórico da Página

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

Tabela Afetada: ZINTPROTHEUSITEMCONTABILPROTHEUS

Interface RM: TOTVS Educacional | Educacional | Customização | Integração Protheus | Cadastros | Item contábil

Authorization - Basic Auth

Username <username>

Password <password>

Body

[
    {
		"codColigada": "3",
		"itemContabil": "0001253

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

Realiza a inclusão dos 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",
        "contaCaixaAgenciacodFilial": "01"null,
        "contaCaixaContaCorrente		"descricao": "111111",
teste        "parcela": 
            {   "pedidoVendaGerencialExemplo 0",
		"status": "TESTE2T",
                "nossoNumero": "TESTE2",
                "dataEmissao": "01/01/2000",
                "dataVencimento": "05/01/2000"
            }       
    }
]

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.
  • dataEmissao: Data de Emissão do lançamento (obrigatório).
  • dataVencimento: Data de vencimento do lançamento (obrigatório).

	}
]

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

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

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:

TOTVS Educacional | Educacional | Financeiro/Contábil | Contratos | Parcelas | Lançamentos Financeiros

TOTVS Educacional | Educacional | Financeiro/Contábil | Contratos | Parcelas | Lançamentos Financeiros | Boletos

Authorization - Basic Auth

Username <username>

Password <password>

Body

{[
"Message": "Sucesso ao incluir o Id. Lançamento 142.\r\n",
"Status   {
        "codColigada": "3",
        "xnumpro": "SucessoTESTE1",
"StatusCode        "contaCaixaBanco": 200"001",
"IdLan        "contaCaixaAgencia": 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.

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

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

Tabelas Afetadas: FLAN, FLANBAIXA

Interface RM: TOTVS Educacional | Educacional | Financeiro/Contábil | Contratos | Parcelas | Lançamentos Financeiros (editar o lançamento e acessar o anexo "Baixas do Lançamento")

Authorization - Basic Auth

Username <username>

Password <password>

Body

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

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

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

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

Tabela Afetada: FLAN, FBOLETO

Interfaces RM:

TOTVS Educacional | Educacional | Financeiro/Contábil | Contratos | Parcelas | Lançamentos Financeiros

TOTVS Educacional | Educacional | Financeiro/Contábil | Contratos | Parcelas | Lançamentos Financeiros | Boleto

Authorization - Basic Auth

Username <username>

Password <password>

Body

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

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

<div class="post">POST</div>
<div class="endereco">/rm/api/TOTVSCustomizacao/CstIntegracaoProtheusAcordo/Inclusao</div>

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

Interface RM: TOTVS Educacional | Educacional | Financeiro/Contábil | Contratos | Parcelas | Lançamentos Financeiros (editar o lançamento e acessar o anexo "Acordo")

Authorization - Basic Auth

Username <username>

Password <password>

Body

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

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

<div class="post">POST</div>
<div class="endereco">/rm/api/TOTVSCustomizacao/CstIntegracaoProtheusAcordo/Cancelamento</div>

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

Interface RM: TOTVS Educacional | Educacional | Financeiro/Contábil | Contratos | Parcelas | Lançamentos Financeiros (editar o lançamento e acessar o anexo "Acordo")

Authorization - Basic Auth

Username <username>

Password <password>

Body

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

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

<div class="post">POST</div>
<div class="endereco">/rm/api/TOTVSCustomizacao/ContratoPJ/SetContract</div>

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

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

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

<div class="get">GET</div>
<div class="endereco">/rm/api/TOTVSCustomizacao/ContratoPJ/ConsultContract</div>

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

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

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