Histórico da Página

...

Expandir

title	Geração do lançamento no Contrato

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

Authorization - Basic Auth

Username <username>

Password <password>

Body

Bloco de código

language	c#
title	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

Bloco de código

language	c#
title	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.

Expandir

title	Cancelamento do lançamento

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

Authorization - Basic Auth

Username <username>

Password <password>

Body

Bloco de código

language	c#
title	Raw

[
    {
		"codColigada": "3",
  		"idLan": "142",
        "Filial": "03CE0001",
        "Prefixo": "001",
   		"Num": "000804",
    	"Parcela": "1",
    	"Tipo": "P",     
        "Filial": "03CE0001",
        "Prefixo": "001",
        "Num": "000806",
        "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 codColigada: Código da Coligada (primary key);
idLanTipo: Id Tipo do Lançamento Título (primary key);
DataCancelamento: Data do Cancelamento do Lançamento (primary key);

Obs: Quando o idLan esta vazio é considerado os seguintes campos Filial, Prefixo, Num, Parcela e Tipo.

Retorno

Bloco de código

language	c#
title	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;

Expandir

title	Cancelamento de baixas do lançamento

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

Authorization - Basic Auth

Username <username>

Password <password>

Body

Bloco de código

language	c#
title	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 codColigada: Código da Coligada (primary key);
idLanTipo: Id Tipo do Lançamento 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.

Obs: Quando o idLan esta vazio é considerado os seguintes campos Filial, Prefixo, Num, Parcela e Tipo.

Retorno

Bloco de código

language	c#
title	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;

Expandir

title	Baixa do Título

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

Authorization - Basic Auth

Username <username>

Password <password>

Body

Bloco de código

language	c#
title	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 codColigada: Código da Coligada. Enviar 2 para SESI e 3 para SENAI (primary key).;
idLanTipo: Id Tipo do Lançamento Título (primary key);
ValorBaixa: Valor da Baixa do Título (primary key);
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 esta vazio é considerado os seguintes campos 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;

Expandir

title	Alteração NossoNumero

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

Authorization - Basic Auth

Username <username>

Password <password>

Body

Bloco de código

language	c#
title	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).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: Quando o idLan esta vazio é considerado os seguintes campos Filial, Prefixo, Num, Parcela e Tipo.

Retorno

Bloco de código

language	c#
title	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;

...

Expandir

title	Recebimento de Acordo

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

Authorization - Basic Auth

Username <username>

Password <password>

Body

Bloco de código

language	c#
title	Raw

{
  "IdLiquidadao": "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",
      "DataVencimento": "2022-07-10",
      "DataPrevisaoBaixa": "2022-07-10",
      "Valor": 1050.11
    },
    {
      "Identificador": "002",
      "DataVencimento": "2022-08-10",
      "DataPrevisaoBaixa": "2022-08-11",
      "Valor": 1248.89
    },
    {
      "Identificador": "003",
      "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 total do Acordo gerado: Soma do valor dos lançamentos financeiros gerados, considerando valor de desconto e acréscimo.
ValorDesconto: Valor do desconto do Acordo.
ValorAcrescimo: Valor do acréscimo do Acordo

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). A informação será armazenada no campo SEGUNDONUMERO do lançamento (FLAN).
- 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
- valor: Valor total do boleto/lançamento.

Obs: Quando o idLan esta vazio é considerado os seguintes campos Filial, Prefixo, Num, Parcela e Tipo.

Retorno

Bloco de código

language	c#
title	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.

Obs: Quando o idLan esta vazio é considerado os seguintes campos Filial, Prefixo, Num, Parcela e Tipo.

Expandir

title	Cancelamento de Acordo

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

Authorization - Basic Auth

Username <username>

Password <password>

Body

Bloco de código

language	c#
title	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

Bloco de código

language	c#
title	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;

...

Atalhos

Páginas filhas

Versões comparadas

Versão antiga 82

Nova versão 83

Chave

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