Histórico da Página

<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. O status do lançamento (FLAN.STATUS) é alterado para 2-Cancelado.

Tabela Afetada: FLAN

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

Authorization - Basic Auth

Username <username>

Password <password>

Body

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

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

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

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

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

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

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 da Baixa do Título (primary key). Ver observação 2 ao final;
• 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: Taxa de Juros da Baixa;
• Multa: Valor da Multa da Baixa;
• Desconto: Valor de Desconto da Baixa;

        Obs:  Quando o idLan estiver vazio será considerado os seguintes campos: Filial, Prefixo, Num, Parcela e Tipo.

        Obs 2:  Quando

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

  sejá

  • • seja maior que o valor da bolsa a diferença

  sera

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

  Bloco de código
  language c# title 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;

  
  

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

       Obs Importante:  Quando o idLan estiver vazio será considerado , 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.

                ObsImportante:  Quando Quando o idLan estiver vazio será considerado , 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.

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