API query PayFormatCodeByDefault (optimised)

Description

This query returns default payment format codes for selected payment type.

query filter (table tFilter)

tcBusinessFieldName	tcDataType	tcOperator
icPayFormatTypeCode	c	=
iiPayFormatGroupSequence	i	=
ilPayFormatGroupIsActive	l	=
ilPayFormatCodeIsActive	l	=
ilPayFormatCodeIsDefault	l	=
tPayFormatCode.PayFormatCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tPayFormatCode.PayFormatCodeDescription	c	=,>=,>,<>,<=,<,begins,can-do,matches
tPayFormatCode.PayFormatCodeIsActive	l	=,<>
tPayFormatCode.PayFormatCodeIsDefault	l	=,<>
tPayFormatGroup.PayFormatGroupCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tPayFormatGroup.PayFormatGroupDataType	c	=,>=,>,<>,<=,<,begins,can-do,matches
tPayFormatGroup.PayFormatGroupDescription	c	=,>=,>,<>,<=,<,begins,can-do,matches
tPayFormatGroup.PayFormatGroupInputOption	c	=,>=,>,<>,<=,<,begins,can-do,matches
tPayFormatGroup.PayFormatGroupIsActive	l	=,<>
tPayFormatGroup.PayFormatGroupIsMandatory	l	=,<>
tPayFormatGroup.PayFormatGroupLevel	c	=,>=,>,<>,<=,<,begins,can-do,matches
tPayFormatGroup.PayFormatGroupSequence	i	=,>=,>,<>,<=,<
tPayFormatGroup.PayFormatTypeCode	c	=,>=,>,<>,<=,<,begins,can-do,matches

Parameters (internal)

icPayFormatTypeCode	character	Payment Format Type Code
iiPayFormatGroupSequence	integer	Payment Format Group Sequence.
ilPayFormatGroupIsActive	logical	Is the Payment Format Group Active
ilPayFormatCodeIsActive	logical	Is Payment Format Code Active
ilPayFormatCodeIsDefault	logical	Is the Payment Format Code Default

query condition

each PayFormatGroup where

PayFormatGroup.PayFormatTypeCode = icPayFormatTypeCode AND
PayFormatGroup.PayFormatGroupSequence = iiPayFormatGroupSequence AND
PayFormatGroup.PayFormatGroupIsActive = ilPayFormatGroupIsActive

each PayFormatCode (outer-join) where

PayFormatCode.PayFormatGroup_ID = PayFormatGroup.PayFormatGroup_ID AND
PayFormatCode.PayFormatCodeIsActive = ilPayFormatCodeIsActive AND
PayFormatCode.PayFormatCodeIsDefault = ilPayFormatCodeIsDefault

query resultset tqPayFormatCodeByDefault

field name	data type	db field	description
tcPayFormatCode	character	PayFormatCode.PayFormatCode	Attribute Value
tiPayFormatCode_ID	integer	PayFormatCode.PayFormatCode_ID	Record ID
tcPayFormatCodeDescription	character	PayFormatCode.PayFormatCodeDescription	Description
tlPayFormatCodeIsActive	logical	PayFormatCode.PayFormatCodeIsActive	Active
tlPayFormatCodeIsDefault	logical	PayFormatCode.PayFormatCodeIsDefault	Default
tiPayFormatGroup_ID	integer	PayFormatGroup.PayFormatGroup_ID	Record ID
tcPayFormatGroupCode	character	PayFormatGroup.PayFormatGroupCode	Attribute Name
tcPayFormatGroupDataType	character	PayFormatGroup.PayFormatGroupDataType	Data Type
tcPayFormatGroupDescription	character	PayFormatGroup.PayFormatGroupDescription	Description
tcPayFormatGroupInputOption	character	PayFormatGroup.PayFormatGroupInputOption	Input Option
tlPayFormatGroupIsActive	logical	PayFormatGroup.PayFormatGroupIsActive	Active
tlPayFormatGroupIsMandatory	logical	PayFormatGroup.PayFormatGroupIsMandatory	Mandatory
tcPayFormatGroupLevel	character	PayFormatGroup.PayFormatGroupLevel	Level
tiPayFormatGroupSequence	integer	PayFormatGroup.PayFormatGroupSequence	Group Code
tcPayFormatTypeCode	character	PayFormatGroup.PayFormatTypeCode	Payment Format Type
PayFormatGroupCustom	character	calculated	custom fields
PayFormatCodeCustom	character	calculated	custom fields
ti_sequence	integer	calculated	primary index
tc_rowid	character	calculated	= rowid(PayFormatGroup),rowid(PayFormatCode)

Internal usage

QadFinancials

method BCreditor.CreateBankNumberPayCode
method BDDocument.ApiSetDDocumentStatusChange
method BDDocument.CreateHeaderPayCode
method BDDocument.CreateHeaderPayCodeForSel
method BDebtor.CreateBankNumberPayCode
method BDPaymentSelection.GetHeaderPayCodeEnabled
method BPaymentFormat.ApiDefaultPayFormatCode
method BPaymentSelection.GetHeaderPaymentAttributes
dataset BPaymentFormat.tPayFormatCodeByDefaultRef

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 = "BPaymentFormat".
create ttContext.
assign ttContext.propertyName = "methodName"
       ttContext.propertyValue = "PayFormatCodeByDefault".
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/bpaymentformat.payformatcodebydefault.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.