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": "13/06/2022"
                "dataPrevisaoBaixa": "1312/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, 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.

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
{
  "codColigadaIdLiquidadao": "3|CSI|TESTE|CNI418Parc1&5", 
  "IdLiquidadaocodColigada": "3|CSI|TESTE|CNI418Parc1&1",
  "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": [
    {
      "identificadorIdentificador": "001", 
      "dataPrevisaoBaixaDataVencimento": "2022-07-10", 
      "dataVencimentoDataPrevisaoBaixa": "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",
      "ValorDataPrevisaoBaixa": 200.00"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.
  • 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
  • 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": "SucessoAcordo ao33 incluirgerado o Acordo: 22com sucesso\r\n",
  "Status": "Sucesso",
  
"StatusCode": 200,
  
"IdAcordoData": 20,"{
     
"Data": "IdNegociacao": 100, "Codcoligada": 2, "NumParcelas": 10, "CodCCusto": null, "TipoJuros": 0, "TaxaJurosIdAcordo": 033,
 "ValorJurosDia": 0.0, "DataAcordo": "29/01/2022", "ValorLiquido": 1500.00, "ValorAcordo": 1500.00, "ValorDesconto": 0.0, "ValorAcrescimo": 0.0, "RA": "00000247", "LancamentosOriginais": 
}
             "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;IdAcordo: Identificador do Acordo gerado no SGE;
  • StatusCode: Código de status do processamento da requisição;
  • DadosData: 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.
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",
  		"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
languagec#
titleConsole
{
  "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;


Expandir
titleContrato PJ - Recebimento Contrato
HTML
<div class="post">POST</div>
<div class="endereco">/rm/api/TOTVSCustomizacao/ContratoPJ/SetContract</div>


Inclui ou altera um Contrato Pessoa Jurídica no SGE, para permitir que matrículas geradas no SGE sejam vinculadas aos contratos.

Tabela Afetada: ZPJFIECCONTRATO

Interface RM: TOTVS Educacional | Educacional | Customizações | Contrato PJ | Contratos

Authorization - Basic Auth

Username <username>

Password <password>

Body

Bloco de código
languagec#
titleRaw
[    
  {
     		"CodColigada": 3,
		        "Filial": "03CE0001",
        "NumeroContrato": "Contrato teste",
		        "CNPJ": "88999777000152",
		        "NomeEmpresa": "Empresa teste",
		"Empresa teste",
        "ValorContrato": 10000.00,
 		"CodFilial": "49", 
		       "CodCurso": "00013|TEC-001",
		        "VagasOfertadas": 10,
		        "VagasUtilizadas": 1
  }   
]

Content

  • CodColigada: Código da Coligada no SGE. Enviar 2 para SESI e 3 para SENAI (primary key).
  • Filial:  Código da Filial do Salesforce, formato do SGE (sem sigla 'UN').
  • NumeroContrato: Número do Contrato PJ no CRM (primary key);
  • CNPJ: CNPJ da empresa responsável pelo Contrato PJ (obrigatório).
  • NomeEmpresa: CNPJ da empresa responsável pelo Contrato PJ (obrigatório).
  • ValorContrato: Valor total do Contrato PJ,
  • CodFilial:  Código da Filial do Salesforce, formato do SGE (sem sigla 'UN');
  • .
  • CodCurso: Código do curso referente ao Contrato PJ, no mesmo formato enviado na exportação de Curso. 
  • VagasOfertadas: Número total de vagas ofertadas para o Contrato PJ;.
  • VagasUtilizadas: Número de vagas já utilizadas do Contrato PJ;.
    • Observação: O número de vagas disponíveis deverá ser calculado a partir do total de vagas ofertadas e as vagas utilizadas de cada Contrato PJ.

Retorno

Bloco de código
languagec#
titleConsole
{
  "Message": "Registro integrado com sucesso",
  "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;

...