Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Expandir
titleRecebimento de Acordo
HTML
<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

Bloco de código
languagec#
titleRaw
[
  {
    "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",
        "valor": 1050.0
      }]
}

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: Chave da negociação do Protheus utilizada para identificar o registro no Log do Processo (pode concatenar vários valores neste campo). O valor enviado não é gravado no Acordo gerado no SGE. 
  • NumParcelas
  • CodCCusto
  • TipoJuros
  • TaxaJuros
  • 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: 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
  • ValorLiquido: Valor líquido do Acordo gerado.
  • ValorAcordo: Valor total do Acordo gerado.
  • ValorDesconto: Valor do desconto do Acordo.
  • ValorAcrescimo: Valor do acréscimo do Acordo.
  • RA: número do RA do aluno 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
  • 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).
    • xnumpro: Número do XNumPro gerado pelo Protheus, será armazenado no campo SEGUNDONUMERO do lançamento (FLAN).
    • nossoNumero: Nosso Número do boleto gerado no Protheus, é gravado no boleto associado ao lançamento no RM.
    • dataVencimento: Data de vencimento do lançamento/boleto.
    • valor: Valor total do boleto/lançamento.
    ValorJurosDia

Retorno

Bloco de código
languagec#
titleConsole
{
"Message": "Sucesso ao incluir o Acordo: 22\r\n",
"Status": "Sucesso",  
"IdAcordoStatusCode": 20200,  
"StatusCodeIdAcordo": 20020,   
"idAcordoData": "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": 
}

Content

  • Message: Mensagem de retorno do consumo da requisição;
  • Status: Situação do processamento da requisição;
  • IdAcordo: Identificador do Acordo gerado no SGE;
  • StatusCode: Código de status do processamento da requisição;
  • Data: lista com informações do acordo gerado no SGE, juntamente com a lista 
Expandir
titleCancelamento de Acordo
HTML
<div class="post">POST</div>
<div class="endereco">/rm/api/TOTVSCustomizacao/CstIntegracaoProtheus/Acordo/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. 

Authorization - Basic Auth

Username <username>

Password <password>

Body

Bloco de código
languagec#
titleRaw
[
    {
		"codColigada": "3",
  		"idAcordo": "22",
  		"DataCancelamento": "01/01/2000"
	}
]

Content

  • codColigada: Código da Coligada. Enviar 2 para SESI e 3 para SENAI (primary key).
  • idAcordo: Id do acordo do SGE (obrigatório). Tal informação é devolvida para o Protheus pela API de inclusão de acordo. 
  • DataCancelamento: Data do Cancelamento do acordo (obrigatório).


Retorno

Bloco de código
languagec#
titleConsole
{
  "Message": "Sucesso ao cancelar o acordo identificador: 22Acordo 21 (Negociaçã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;


...