PCTITQRY – Query personalizada para listagem de títulos do Portal do Cliente.

01. DADOS GERAIS

Linha de Produto:	Microsiga Protheus®
Segmento:	Backoffice
Módulo:	Financeiro
Idiomas:	Português
Função:	Portal do Cliente

02. DESCRIÇÃO

O ponto de entrada PCTITQRY permite informar uma query personalizada para listagem de títulos no Portal do Cliente - SIGAFIN.

Parâmetros disponibilizados no ponto de entrada:

PARAMIXB	Tipo	Descrição
1º Posição	Caractere	Query padrão utilizada para listagem dos títulos no Portal do Cliente.
2º Posição	Array	Contém um Array com as chaves (FILIAL+CODIGO+LOJA) dos clientes selecionados no portal. Cada posição do Array contém um objeto Json com as propriedades: filial, codigo e loja.

Retorno do ponto de entrada:

O ponto de entrada deve retornar a query personalizada respeitando os campos definidos por padrão:

Tipo	Obrigatoriedade	Descrição
Caractere	Obrigatório	Query personalizada para listagem de títulos do Portal do Cliente (A query deve obrigatoriamente retornar os campos descritos abaixo).

Campos obrigatórios:

Campos que devem ser obrigatoriamente devolvidos na query personalizada:

Campo	Tabela	Descrição
E1_FILORIG	SE1	Filial de Origem.
E1_FILIAL	SE1	Filial do Sistema.
E1_PREFIXO	SE1	Prefixo do titulo.
E1_NUM	SE1	Numero do Titulo.
E1_PARCELA	SE1	Parcela do Titulo.
E1_TIPO	SE1	Tipo do titulo.
E1_CLIENTE	SE1	Código do Cliente.
E1_LOJA	SE1	Loja do Cliente.
E1_MOEDA	SE1	Moeda do Titulo.
E1_EMISSAO	SE1	Data de Emissão do Titulo.
E1_VENCREA	SE1	Vencimento real do Titulo.
E1_VALOR	SE1	Valor do Titulo.
E1_SALDO	SE1	Saldo a Receber.
E1_CODBAR	SE1	Código de Barras.
E1_NUMBOR	SE1	Numero do Borderô.
E1_BAIXA	SE1	Data de Baixa do Titulo.
EA_BORAPI	SEA	Borderô por API.
EA_TRANSF	SEA	Status de Transferência.

03. EXEMPLO DE UTILIZAÇÃO

PCTITQRY

#include 'Protheus.ch'
 
 /*/{Protheus.doc} User Function PCTITQRY
    Utilizado para alteração da query responsável pela listagem
    dos títulos no Portal do Cliente - FIN.

    Parâmetros:
     - Paramixb[1] (Character) = Query criada até o momento para listagem.
     - Paramixb[2] (Array) = Lista contendo a chave dos clientes selecionados no portal.

    Retorno:
     - cNewQuery (Character) = Query com os filtros aplicados.

    Obs: A query do ponto de entrada deve obrigatoriamente
    retornar os campos descritos na documentação.
   
    @type Function
    @author Totvs
    @since 10/10/2023
    @version 1.0
    @see https://tdn.totvs.com/pages/viewpage.action?pageId=794384769
 /*/
User Function PCTITQRY() As Character
    Local cOriginQry := Paramixb[1] As Array
    Local aCustomers := Paramixb[2] As Array
    Local cStartQry  := "" As Character
    Local cCustomQry := "" As Character
    Local cEndQry    := "" As Character
    Local cNewQuery  := "" As Character

    // Guarda a parte de inicio da query
    cStartQry := Substr(cOriginQry, 1, AT("ORDER BY", cOriginQry) -1 )

    // Logica para customização da query (Condicional WHERE)
    cCustomQry := " AND SE1.E1_MOTIVO <> 'CMP' "

    // Guarda a parte final da query
    cEndQry := Substr(cOriginQry, AT("ORDER BY", cOriginQry))

    // Aplica a parte customizada na query principal
    cNewQuery := cStartQry + cCustomQry + cEndQry

Return cNewQuery

Árvore de páginas