API query BankPayFormatByGL

Description

This query returns the BankNumber,Currency,Payment Format and Business Relation of the GL Account

query filter (table tFilter)

tcBusinessFieldName	tcDataType	tcOperator
icGLCode	c	=
iiCompanyId	i
tBankNumber.BankNumber	c	=,>=,>,<>,<=,<,begins,can-do,matches
tBankNumber.BankNumberIsBankCharge	l	=,<>
tBankNumber.BankNumberParentType	c	=,>=,>,<>,<=,<,begins,can-do,matches
tBankNumber.BankNumberValidation	c	=,>=,>,<>,<=,<,begins,can-do,matches
tBankPayFormat.BankPayFormatIsActive	l	=,<>
tBusinessRelation.BusinessRelationCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tCompany.CompanyCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tCurrency.CurrencyCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tGL.GLCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tBankPayFormat.PayFormatTypeCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tPayFormatType.PayFormatTypeIsActive	l	=,<>
tPayFormatType.PayFormatTypeLinesPerPage	i	=,>=,>,<>,<=,<
tPayFormatType.PayFormatTypeModule	c	=,>=,>,<>,<=,<,begins,can-do,matches
tPayFormatType.PayFormatTypePayInstrument	c	=,>=,>,<>,<=,<,begins,can-do,matches
tPayFormatType.PayFormatTypePayType	c	=,>=,>,<>,<=,<,begins,can-do,matches

Parameters (internal)

icGLCode	character
iiCompanyId	integer	Company id

query condition

each BankPayFormat where

first BankNumber (inner-join) where

BankNumber.BankNumber_ID = BankPayFormat.BankNumber_ID AND
BankNumber.BankNumberParentType = 'GL'

first BusinessRelation (outer-join) where

BusinessRelation.BusinessRelation_ID = BankNumber.BankBusinessRelation_ID AND

first CompanySharedSet (inner-join) where

CompanySharedSet.CompanySharedSet_ID = BankNumber.CompanySharedSet_ID AND
CompanySharedSet.Company_ID <> ?

first Company (inner-join) where

Company.Company_Id = iiCompanyId AND
Company.Company_ID = CompanySharedSet.Company_ID AND

first GL (inner-join) where

GL.SharedSet_Id = vi_GL_sharedset(iiCompanyId) AND
GL.GL_ID = BankNumber.ParentObject_ID AND
GL.GLCode = icGLCode

first Currency (outer-join) where

Currency.Currency_ID = GL.Currency_ID AND

first PayFormatType (inner-join) where

PayFormatType.PayFormatTypeCode = BankPayFormat.PayFormatTypeCode AND

query resultset tqBankPayFormatByGL

field name	data type	db field	description
tcBankNumber	character	BankNumber.BankNumber	Bank Number
tiBankNumber_ID	integer	BankPayFormat.BankNumber_ID	Bank Number
tlBankNumberIsBankCharge	logical	BankNumber.BankNumberIsBankCharge	Bank Charge
tcBankNumberParentType	character	BankNumber.BankNumberParentType	Type
tcBankNumberValidation	character	BankNumber.BankNumberValidation	Validation
tiBankPayFormat_ID	integer	BankPayFormat.BankPayFormat_ID	Record ID
tlBankPayFormatIsActive	logical	BankPayFormat.BankPayFormatIsActive	Active
tiBusinessRelation_ID	integer	BusinessRelation.BusinessRelation_ID	Record ID
tcBusinessRelationCode	character	BusinessRelation.BusinessRelationCode	Business Relation. A code to identify the business relation. If this field does not have a input from the user, the system automatically generates a number for the record based on the sequence defined in Business Relation Autonumber Create.
tiCompany_ID	integer	Company.Company_ID	Record ID
tiCompany_ID1	integer	CompanySharedSet.Company_ID	Entity
tcCompanyCode	character	Company.CompanyCode	Entity Code
tcCurrencyCode	character	Currency.CurrencyCode	Currency Code
tiGL_ID	integer	GL.GL_ID	Record ID
tcGLCode	character	GL.GLCode	A code identifying the GL account.
tcPayFormatTypeCode	character	BankPayFormat.PayFormatTypeCode	Payment Format
tlPayFormatTypeIsActive	logical	PayFormatType.PayFormatTypeIsActive	Active
tiPayFormatTypeLinesPerPage	integer	PayFormatType.PayFormatTypeLinesPerPage	Invoices per check
tcPayFormatTypeModule	character	PayFormatType.PayFormatTypeModule	Module
tcPayFormatTypePayInstrument	character	PayFormatType.PayFormatTypePayInstrument	Payment Instrument
tcPayFormatTypePayType	character	PayFormatType.PayFormatTypePayType	Payment Type
BankPayFormatCustom	character	calculated	custom fields
BankNumberCustom	character	calculated	custom fields
BusinessRelationCustom	character	calculated	custom fields
CompanySharedSetCustom	character	calculated	custom fields
CompanyCustom	character	calculated	custom fields
GLCustom	character	calculated	custom fields
CurrencyCustom	character	calculated	custom fields
PayFormatTypeCustom	character	calculated	custom fields
ti_sequence	integer	calculated	primary index
tc_rowid	character	calculated	= rowid(BankPayFormat),rowid(BankNumber),rowid(BusinessRelation),rowid(CompanySharedSet),rowid(Company),rowid(GL),rowid(Currency),rowid(PayFormatType)

Internal usage

QadFinancials

method BCDocument.DefaultValuesGLCode
method BCreditor.ValBankNumberAndPayCodeRef

Sample code: how to call this query through RPCRequestService (QXtend Inbound)

define temp-table ttContext no-undo
    field propertyQualifier as character
    field propertyName as character
    field propertyValue as character
    index entityContext is primary unique
        propertyQualifier
        propertyName
    index propertyQualifier
        propertyQualifier.

define dataset dsContext for ttContext.

define variable vhContextDS as handle no-undo.
define variable vhExceptionDS as handle no-undo.
define variable vhServer as handle no-undo.
define variable vhInputDS as handle no-undo.
define variable vhInputOutputDS as handle no-undo.
define variable vhOutputDS as handle no-undo.
define variable vhParameter as handle no-undo.

/* Create context */
create ttContext.
assign ttContext.propertyName = "programName"
       ttContext.propertyValue = "BBankPayFormat".
create ttContext.
assign ttContext.propertyName = "methodName"
       ttContext.propertyValue = "BankPayFormatByGL".
create ttContext.
assign ttContext.propertyName = "applicationId"
       ttContext.propertyValue = "fin".
create ttContext.
assign ttContext.propertyName = "entity"
       ttContext.propertyValue = "1000".
create ttContext.
assign ttContext.propertyName = "userName"
       ttContext.propertyValue = "mfg".
create ttContext.
assign ttContext.propertyName = "password"
       ttContext.propertyValue = "".

/* Create input dataset */
create dataset vhInputDS.
vhInputDS:read-xmlschema("file", "xml/bbankpayformat.bankpayformatbygl.i.xsd", ?).
vhParameter = vhInputDS:get-buffer-handle("tParameterI").
vhParameter:buffer-create().

assign vhParameter::icRange = "A"
       vhParameter::icRowid = ""
       vhParameter::iiRownum = 0
       vhParameter::iiNumber = 5 /* Number of records to read */
       vhParameter::icSortColumns = ""
       vhParameter::ilCountOnly = false
       vhParameter::ilForwardRead = true
       vhParameter::iiMaximumBrowseRecordsToCount = 0.

vhParameter = vhInputDS:get-buffer-handle("tFilter").
vhParameter:buffer-create().

assign vhParameter::<field-name-1> = <field-value-1>
       vhParameter::<field-name-2> = <field-value-2>
       ...

/* Connect the AppServer */
create server vhServer.
vhServer:connect("-URL <appserver-url>").

if not vhServer:connected()
then do:
    message "Could not connect AppServer" view-as alert-box error title "Error".
    return.
end.

/* Run */
assign vhContextDS = dataset dsContext:handle.

run program/rpcrequestservice.p on vhServer
    (input-output dataset-handle vhContextDS by-reference,
           output dataset-handle vhExceptionDS,
     input        dataset-handle vhInputDS by-reference,
     input-output dataset-handle vhInputOutputDS by-reference,
           output dataset-handle vhOutputDS).

/* Handle output however you want, in this example, we dump it to xml */
if valid-handle(vhExceptionDS)
then vhExceptionDS:write-xml("file", "Exceptions.xml", true).

if valid-handle(vhOutputDS)
then vhOutputDS:write-xml("file", "Output.xml", true).

/* Cleanup */
vhServer:disconnect().
assign vhServer = ?.

if valid-handle(vhInputDS)
then delete object vhInputDS.

if valid-handle(vhOutputDS)
then delete object vhOutputDS.

if valid-handle(vhExceptionDS)
then delete object vhExceptionDS.