Versões comparadas

Chave

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

...

Expandir
titleGeraçã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:

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

Bloco de código
languagec#
titleRaw
[
    {
        "codColigada": "3",
        "xnumpro": "TESTE1",
        "contaCaixaBanco": "001",
        "contaCaixaAgencia": "01",
        "contaCaixaContaCorrente": "111111",
        "parcela": 
            {   "pedidoVendaGerencial": "TESTE2",
                "nossoNumero": "TESTE2",
                "dataEmissao": "01/01/2000",
                "dataVencimento": "0513/0106/20002022"
            }          "dataPrevisaoBaixa": "13/06/2022"              
    }
]

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 real (dia útil) do lançamento/boleto (obrigatórioFLAN.DTVENCIMENTO).
    • dataPrevisaoBaixa: Data de previsão de vencimento do lançamento/boleto calculada pelo Protheus. Informação gravada em FLAN.DATAPREVBAIXA.

Retorno

Bloco de código
languagec#
titleConsole
{
"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
titleRecebimento 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

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

Bloco de código
languagec#
titleRaw
{
    "IdNegociacao": "100",
    "Codcoligada": "2",
    "NumParcelas": 10,
    "CodCCusto": "123456789",
    "TipoJuros": 0,
    "TaxaJuros": 0,
    "ValorJurosDia": 0.0,
    "DataAcordo": "2022-01-01",
    "ValorLiquido": 1500.00,
    "ValorAcordo": 1500.00,
    "ValorDesconto": 0.0,
    "ValorAcrescimo": 0.0,
    "RA": "00000247",
    "LancamentosOriginais": 
     [{
        "idlan": 22
      }],
    "LancamentosAcordo": 
     [{
        "xnumproidentificador": "SGE31000",
        "nossoNumero": "898001212154",
        "dataVencimento": "2022-0106-0113",
        "valordataPrevisaoBaixa": 1050.0"2022-06-12",
        "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/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: Indica 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
  • 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).
    • xnumproidentificador: Número identificador do título do XNumPro gerado pelo Protheus (chave única, será armazenado composta por E1_FILIAL + E1_PREFIXO + E1_NUM + E1_PARCELA + E1_TIPO). A informação será armazenada 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 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.

Retorno

Bloco de código
languagec#
titleConsole
{
"Message": "Sucesso ao incluir o Acordo: 22\r\n",
"Status": "Sucesso",  
"StatusCode": 200,  
"IdAcordo": 20,   
"Data": "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;
  • DataDados: 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
    , juntamente com a lista 
    • .
Expandir
titleCancelamento 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

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

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

Content

  • codColigada: Código da Coligada. Enviar 2 para SESI e 3 para SENAI (primary key). 
  • idAcordoidNegociacao: Id do acordo do SGE (obrigatório). Tal informação é devolvida para o Protheus pela API de inclusão de acordoda negociação/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
languagec#
titleConsole
{
  "Message": "Acordo 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;


...