API query CInvoiceBankByPayFormatType (optimised)

Description

This query lists all CInvoiceBank records based on payment format type and creditor invoice id.

query filter (table tFilter)

tcBusinessFieldName	tcDataType	tcOperator
iiCompanyId	i
icPayFormatTypeCode	c	=
iiInvoiceID	i	=
iiBankNumberID	i	=
tCInvoiceBankPayCode.CInvoiceBankPayCodeValue	c	=,>=,>,<>,<=,<,begins,can-do,matches
tCInvoiceBank.CInvoiceBankToPayTC	d	=,>=,>,<>,<=,<
tCInvoice.CInvoiceType	c	=,>=,>,<>,<=,<,begins,can-do,matches
tPayFormatGroup.PayFormatGroupCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tPayFormatGroup.PayFormatGroupLevel	c	=,>=,>,<>,<=,<,begins,can-do,matches
tPayFormatGroup.PayFormatTypeCode	c	=,>=,>,<>,<=,<,begins,can-do,matches

Parameters (internal)

iiCompanyId	integer	Company id
icPayFormatTypeCode	character	Payment Format Type
iiInvoiceID	integer	Invoice ID
iiBankNumberID	integer

query condition

each CInvoiceBank where

CInvoiceBank.CInvoice_ID = iiInvoiceID AND
CInvoiceBank.BankNumber_ID = iiBankNumberID

first CInvoice (inner-join) where

CInvoice.Company_Id = iiCompanyId AND
CInvoice.CInvoice_ID = CInvoiceBank.CInvoice_ID AND

each CInvoiceBankPayCode (conditional-join) where

CInvoiceBankPayCode.CInvoiceBank_ID = CInvoiceBank.CInvoiceBank_ID AND

first PayFormatGroup (conditional-join) where

PayFormatGroup.PayFormatGroup_ID = CInvoiceBankPayCode.PayFormatGroup_ID AND
PayFormatGroup.PayFormatTypeCode = icPayFormatTypeCode

query resultset tqCInvoiceBankByPayFormatType

field name	data type	db field	description
tiBankNumber_ID	integer	CInvoiceBank.BankNumber_ID	Bank Number
tiCInvoice_ID	integer	CInvoiceBank.CInvoice_ID	Link to CInvoice
tiCInvoiceBank_ID	integer	CInvoiceBank.CInvoiceBank_ID	Record ID
tcCInvoiceBankPayCodeValue	character	CInvoiceBankPayCode.CInvoiceBankPayCodeValue	Attribute Value. A new attribute of the payment Format. This field is added by the user for bank payment.
	api annotation:		This field defaults from the value user set in the payment maintance.
tdCInvoiceBankToPayTC	decimal	CInvoiceBank.CInvoiceBankToPayTC	TC Payment Amount. This field displays the payment amount in the transaction currency.
tcCInvoiceType	character	CInvoice.CInvoiceType	Invoice Type. This field identifies the invoice type. The value can be Invoice Correction and Credit Note Correction type only when the appropriate daybook types have already been defined.
tiPayFormatCode_ID	integer	CInvoiceBankPayCode.PayFormatCode_ID	Link to PayFormatCode
tcPayFormatGroupCode	character	PayFormatGroup.PayFormatGroupCode	Attribute Name
tcPayFormatGroupLevel	character	PayFormatGroup.PayFormatGroupLevel	Level
tcPayFormatTypeCode	character	PayFormatGroup.PayFormatTypeCode	Payment Format Type
CInvoiceBankCustom	character	calculated	custom fields
CInvoiceCustom	character	calculated	custom fields
CInvoiceBankPayCodeCustom	character	calculated	custom fields
PayFormatGroupCustom	character	calculated	custom fields
ti_sequence	integer	calculated	primary index
tc_rowid	character	calculated	= rowid(CInvoiceBank),rowid(CInvoice),rowid(CInvoiceBankPayCode),rowid(PayFormatGroup)

Internal usage

QadFinancials

method BPaymentSelection.GetInvWithCommonPayAttributes
method BPaymentSelection.GetToPayObjectsInitLoadFromInst

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 = "BCInvoice".
create ttContext.
assign ttContext.propertyName = "methodName"
       ttContext.propertyValue = "CInvoiceBankByPayFormatType".
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/bcinvoice.cinvoicebankbypayformattype.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.