API query DInvoiceBankByPayFormatType (optimised)

Description

This query lists all DInvoiceBank records based on payment format type and debtor invoice id.

query filter (table tFilter)

tcBusinessFieldName	tcDataType	tcOperator
iiDInvoiceID	i	=
icPayFormatTypeCode	c	=
iiCompanyId	i
iiBankNumberID	i	=
tCurrency.CurrencyCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tDebtor.DebtorCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tDInvoiceBankPayCode.DInvoiceBankPayCodeValue	c	=,>=,>,<>,<=,<,begins,can-do,matches
tDInvoice.DInvoiceType	c	=,>=,>,<>,<=,<,begins,can-do,matches
tPayFormatGroup.PayFormatGroupLevel	c	=,>=,>,<>,<=,<,begins,can-do,matches
tPayFormatGroup.PayFormatTypeCode	c	=,>=,>,<>,<=,<,begins,can-do,matches

Parameters (internal)

iiDInvoiceID	integer	Debtor Invoice ID
icPayFormatTypeCode	character	Code of Payment Format Type
iiCompanyId	integer	Company id
iiBankNumberID	integer

query condition

each DInvoiceBank where

DInvoiceBank.DInvoice_ID = iiDInvoiceID AND
DInvoiceBank.BankNumber_ID = iiBankNumberID

first DInvoice (inner-join) where

DInvoice.Company_Id = iiCompanyId AND
DInvoice.DInvoice_ID = DInvoiceBank.DInvoice_ID AND

first Currency (inner-join) where

Currency.Currency_ID = DInvoice.DInvoiceCurrency_ID AND

first Debtor (inner-join) where

Debtor.SharedSet_Id = vi_DEBTOR_sharedset(iiCompanyId) AND
Debtor.Debtor_ID = DInvoice.SoldToDebtor_ID AND

each DInvoiceBankPayCode (conditional-join) where

DInvoiceBankPayCode.DInvoiceBank_ID = DInvoiceBank.DInvoiceBank_ID AND

first PayFormatGroup (conditional-join) where

PayFormatGroup.PayFormatGroup_ID = DInvoiceBankPayCode.PayFormatGroup_ID AND
PayFormatGroup.PayFormatTypeCode = icPayFormatTypeCode

query resultset tqDInvoiceBankByPayFormatType

field name	data type	db field	description
tiBankNumber_ID	integer	DInvoiceBank.BankNumber_ID	Formatted Bank Account No
tiCurrency_ID	integer	Currency.Currency_ID	Record ID
tcCurrencyCode	character	Currency.CurrencyCode	Currency Code
tiDebtor_ID	integer	Debtor.Debtor_ID	Record ID
tcDebtorCode	character	Debtor.DebtorCode	A code (maximum eight characters) that identifies a customer. If the code you specify matches an existing supplier code, a warning message displays. You can choose to ignore the warning, and create the record. However, when a supplier and customer share the same code, they must reference the same business relation.
	api annotation:		If you leave the Customer Code field blank, the system automatically generates a number for the record based on the sequence defined in Customer Autonumber Create.
tiDInvoice_ID	integer	DInvoiceBank.DInvoice_ID	Link to DInvoice
tiDInvoiceBank_ID	integer	DInvoiceBank.DInvoiceBank_ID	Record ID
tcDInvoiceBankPayCodeValue	character	DInvoiceBankPayCode.DInvoiceBankPayCodeValue	Attribute Value.The value of 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.
tcDInvoiceType	character	DInvoice.DInvoiceType	Invoice Type. This field displays the invoice type. Invoice Correction and Credit Note Correction display as choices only when the appropriate daybook types have already been defined.
	api annotation:		PartialUpdate = yes - defaults to Invoice
tiPayFormatCode_ID	integer	DInvoiceBankPayCode.PayFormatCode_ID	Link to PayFormatCode
tcPayFormatGroupLevel	character	PayFormatGroup.PayFormatGroupLevel	Level
tcPayFormatTypeCode	character	PayFormatGroup.PayFormatTypeCode	Payment Format Type
DInvoiceBankCustom	character	calculated	custom fields
DInvoiceCustom	character	calculated	custom fields
CurrencyCustom	character	calculated	custom fields
DebtorCustom	character	calculated	custom fields
DInvoiceBankPayCodeCustom	character	calculated	custom fields
PayFormatGroupCustom	character	calculated	custom fields
ti_sequence	integer	calculated	primary index
tc_rowid	character	calculated	= rowid(DInvoiceBank),rowid(DInvoice),rowid(Currency),rowid(Debtor),rowid(DInvoiceBankPayCode),rowid(PayFormatGroup)

Internal usage

QadFinancials

method BPaymentSelection.GetInvWithCommonPayAttributes

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 = "BDInvoice".
create ttContext.
assign ttContext.propertyName = "methodName"
       ttContext.propertyValue = "DInvoiceBankByPayFormatType".
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/bdinvoice.dinvoicebankbypayformattype.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.