Histórico da Página

<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",
        "contaCaixaAgencia": "01",
        "contaCaixaContaCorrente": "111111",
        "parcela": 
            {   "pedidoVendaGerencial": "TESTE2",
                "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).

Retorno

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

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

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

Authorization - Basic Auth

Username <username>

Password <password>

Body

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

Content

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

<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",
        "contaCaixaAgencia": "01",
        "contaCaixaContaCorrente": "111111",
        "parcela": 
            {   "pedidoVendaGerencial": "TESTE2",
                "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).

Retorno

{
"Message": "Sucesso ao incluirexcluir 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.

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

Insere e/ou atualiza o NossoNumero do lançamento financeiro do SGE.

Authorization - Basic Auth

Username <username>

Password <password>

Body

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

Efetua a baixa do lançamento financeiro do SGE.

Authorization - Basic Auth

Username <username>

Password <password>

Body

[{
    "codColigada": "3",
    "idLan": "143",
    "ValorBaixa": 311.26,
    "DataBaixa": "16/12/2021",
    "ContaCaixa_Banco": "002",
    "ContaCaixa_AG": "9598",
    "ContaCaixa_CC": "1234",
    em análise pela FIEC: "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);
• 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: Codigo da Conta corrente para rea\lização da Baixa;Baixas com movimentação bancária:
• Baixas sem movimentação bancária:
  • 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;

Bloco de código
language c# title ConsoleRaw
{ "Message": "Sucesso ao baixar o titulo do Id. Lançamento 143\r\n"codColigada" : "1", "NossoNumero" : "Status":123", "SucessoIDLan" : 123, "NumeroPedido" : null, "StatusCodeCodFilial" : 200null }

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;

• 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).
• NumeroPedido: Numero do Pedido Gerencial (opcional).
• CodFilial: Código da Filial (opcional).

Retorno

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

Insere e/ou atualiza o NossoNumero do lançamento financeiro do SGE.

Authorization - Basic Auth

Username <username>

Password <password>

Bloco de código
language c# title RawConsole
{ "codColigadaMessage" : "1", "NossoNumero" : "123", "IDLan" : 123Sucesso ao fazer a Alteração do Nosso Numero (IDLan/Numero Pedido : 172, NossoNumero: 123).\r\n\r\n", "NumeroPedidoStatus" : null"Sucesso", "CodFilialStatusCode" : null200 }

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).
• NumeroPedido: Numero do Pedido Gerencial (opcional).
• CodFilial: Código da Filial (opcional).

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;

• Message: Mensagem de retorno do consumo da requisição;
• Status: Situação do processamento da requisição;
• StatusCode: Código de status do processamento da requisição;

<style>
	.expand-control {
    	cursor: pointer;
    	text-decoration: none;
	    margin-bottom: 10px;
	    background-color: #ededed;
	    height: 30px;
	    font-size: 20px;
	    padding: 5px;
	}
	.expand-control-text {
    	vertical-align: top;
	    font-weight: bold;
		color: #242424;
	}
	.post

<style>
	.expand-control {
    	cursorbackground-color: pointer#378000;
	    	text-decoration: nonecolor: #ffffff;
	    display: inline-block;
	    padding: 5px;
	    margin-bottom: 10px;
	border-radius: 5px;
		font-weight: bold;
	}
	.get {
    	background-color: #ededed#004fd6;
	    heightcolor: 30px#ffffff;
	    font-sizedisplay: 20pxinline-block;
	    padding: 5px;
	}
	.expand-control-text {
    	verticalborder-alignradius: top5px;
	    	font-weight: bold;
		color: #242424;
	}
	.postput {
    	background-color: #378000#ffa200;
	    color: #ffffff;
	    display: inline-block;
	    padding: 5px;
	    border-radius: 5px;
		font-weight: bold;
	}
	.getdelete {
    	background-color: #004fd6#cf0000;
	    color: #ffffff;
	    display: inline-block;
	    padding: 5px;
	    border-radius: 5px;
		font-weight: bold;
	}
	.put {
    	background-color: #ffa200;
	    color: #ffffff;
	    endereco{
		display: inline-block;
	    padding: 5px;
	    border-radius	padding: 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>
--></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>
-->

<div class="post">POST</div>
<div class="endereco">/rm/api/TOTVSCustomizacao/CstIntegracaoProtheus/Acordo/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.

Authorization - Basic Auth

Username <username>

Password <password>

Body

[
  {
    "IdNegociacao": 100,
    "Codcoligada": 2,
    "NumParcelas": 10,
    "CodCCusto": null,
    "TipoJuros": 0,
    "TaxaJuros": 0,
    "ValorJurosDia": 0.0,
    "DataAcordo": "29/01/2022",
    "ValorLiquido": 1500.00,
    "ValorAcordo": 1500.00,
    "ValorDesconto": 0.0,
    "ValorAcrescimo": 0.0,
    "RA": "00000247",
    "LancamentosOriginais": 
     [{
        "idlan": 22
      }],
    "LancamentosAcordo": 
     [{
        "xnumpro": null,
        "nossoNumero": "898001212154",
        "dataVencimento": "2022-01-01",

<div class="post">POST</div>
<div class="endereco">/rm/api/TOTVSCustomizacao/CstIntegracaoProtheus/Acordo/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.

Authorization - Basic Auth

Username <username>

Password <password>

Body

[
  {
    "IdNegociacao": 100,
    "Codcoligada": 2,
    "NumParcelas": 10,
    "CodCCusto": null,
    "TipoJuros": 0,
    "TaxaJuros": 0,
    "ValorJurosDia": 0.0,
    "DataAcordo": "29/01/2022",
    "ValorLiquido": 1500.00,
    "ValorAcordo": 1500.00,
    "ValorDesconto": 0.0,
    "ValorAcrescimo": 0.0,
    "RA": null,
    "LancamentosOriginais": 
     [{
        "idlanvalor": 221050.0
      }],
    "LancamentosAcordo": 
     [{
        "xnumpro": null,
        "idlan": 0,
        "nossoNumero": null,
        "dataVencimento": "0001-01-01T00:00:00",
        "valor": 0.0
      }]
}

Content

}

Content

• codColigada: Código da Coligada. Enviar 2 para SESI e 3 para SENAI (primary key).
• idLan: Id do Lançamento gerado no SGE (primary key);
• idNegociacao
• NumParcelas
• CodCCusto
• TipoJuros
• TaxaJuros
• ValorJurosDia

"IdNegociacao": 100, "Codcoligada": 2, "NumParcelas": 10, "CodCCusto": null, "TipoJuros": 0, "TaxaJuros": 0, "ValorJurosDia": 0.0, "DataAcordo": "29/01/2022", "ValorLiquido": 1500.00, "ValorAcordo": 1500.00, "ValorDesconto": 0.0, "ValorAcrescimo": 0.0, "RA": "00000247", "LancamentosOriginais":

Retorno

{
"Message": "Sucesso ao incluir o Acordo: 22\r\n",
"Status": "Sucesso",
"StatusCode": 200, 
"idAcordo": 22
}

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;