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/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
{
  "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",
  "ValorLiquido": 0,
  "ValorAcordo": 2499.0,
  "ValorDesconto": 1,
  "ValorAcrescimo": 100,
  "LancamentosOriginais": [
    {
      "Idlan": 232
    },
    {
      "Idlan": 233
    }
  ],
  "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.
  • ValorLiquidoValorAcordo: Valor líquido total do Acordo gerado.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
  • 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.

Retorno

Bloco de código
languagec#
titleConsole
{
  "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.
    • dataVencimento: data de vencimento do lançamento gerado.

...