API query PaySelLineInBrowse (optimised)

Description

This query is searching out payment selection line info for browse button in Supplier Payment Selection Confirm/Unconfirm form.

query filter (table tFilter)

tcBusinessFieldName	tcDataType	tcOperator
iiCompanyId	i
tBankNumber.BankNumber	c	=,>=,>,<>,<=,<,begins,can-do,matches
tBankNumber.BankNumberExtension	c	=,>=,>,<>,<=,<,begins,can-do,matches
tBankNumber.BankNumberFormatted	c	=,>=,>,<>,<=,<,begins,can-do,matches
tBankNumber.BankNumberValidation	c	=,>=,>,<>,<=,<,begins,can-do,matches
tBusinessRelation.BusinessRelationCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tBusinessRelation.BusinessRelationName1	c	=,>=,>,<>,<=,<,begins,can-do,matches
tCInvoice.CInvoiceBalanceCreditTC	d	=,>=,>,<>,<=,<
tCInvoice.CInvoiceDate	t	=,>=,>,<>,<=,<
tCInvoice.CInvoiceDiscountDueDate	t	=,>=,>,<>,<=,<
tCInvoice.CInvoiceDueDate	t	=,>=,>,<>,<=,<
tCInvoice.CInvoiceHoldAmountTC	d	=,>=,>,<>,<=,<
tCInvoice.CInvoiceNonDiscAmtTC	d	=,>=,>,<>,<=,<
tCInvoice.CInvoiceOriginalCreditTC	d	=,>=,>,<>,<=,<
tCInvoice.CInvoiceReference	c	=,>=,>,<>,<=,<,begins,can-do,matches
tCInvoice.CInvoiceTSMNumber	c	=,>=,>,<>,<=,<,begins,can-do,matches
tCInvoice.CInvoiceVoucher	i	=,>=,>,<>,<=,<
tCompany.CompanyCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tCorporateGroup.CorporateGroupCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tCreditor.CreditorCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tCreditor.CreditorIsWHT	l	=,<>
tCurrency.CurrencyCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tDivision.DivisionCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tJournal.JournalCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tPaySelLine.PayFormatTypeCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tPaymentCondition.PaymentConditionPercentage	d	=,>=,>,<>,<=,<
tPaySel.PaySelCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tPaySel.PaySelDate	t	=,>=,>,<>,<=,<
tPaySelLine.PaySelLineAmountTC	d	=,>=,>,<>,<=,<
tPaySelLine.PaySelLineDiscountTC	d	=,>=,>,<>,<=,<
tPaySelLine.PaySelLineIntAmtTC	d	=,>=,>,<>,<=,<
tPaySelLine.PaySelLineIsConfirmed	l	=,<>
tPaySelLine.PaySelLineIsRefInFile	l	=,<>
tPaySelLine.PaySelLineObjectType	c	=,>=,>,<>,<=,<,begins,can-do,matches
tPaySelLine.PaySelLineWHTAmtCC	d	=,>=,>,<>,<=,<
tPaySelLine.PaySelLineWHTAmtLC	d	=,>=,>,<>,<=,<
tPaySelLine.PaySelLineWHTAmtTC	d	=,>=,>,<>,<=,<
tPaySel.PaySelStatus	c	=,>=,>,<>,<=,<,begins,can-do,matches
tPeriod.PeriodYear	i	=,>=,>,<>,<=,<

Parameters (internal)

iiCompanyId

integer

Company id

query condition

each PaySel where

PaySel.Company_Id = iiCompanyId AND

each PaySelLine (inner-join) where

PaySelLine.PaySel_ID = PaySel.PaySel_ID AND

first BankNumber (conditional-join) where

BankNumber.BankNumber_ID = PaySelLine.BankNumber_ID AND

first CInvoice (inner-join) where

CInvoice.Company_Id = iiCompanyId AND
CInvoice.CInvoice_ID = PaySelLine.PaySelLineParentObject_ID AND

first Company (inner-join) where

Company.Company_Id = iiCompanyId AND
Company.Company_ID = CInvoice.Company_ID AND

first Creditor (inner-join) where

Creditor.SharedSet_Id = vi_CREDITOR_sharedset(iiCompanyId) AND
Creditor.Creditor_ID = CInvoice.Creditor_ID AND

first BusinessRelation (inner-join) where

BusinessRelation.BusinessRelation_ID = Creditor.BusinessRelation_ID AND

first CorporateGroup (conditional-join) where

CorporateGroup.CorporateGroup_ID = BusinessRelation.CorporateGroup_ID AND

first Currency (inner-join) where

Currency.Currency_ID = CInvoice.CInvoiceCurrency_ID AND

first Division (conditional-join) where

Division.SharedSet_Id = vi_DIVISION_sharedset(iiCompanyId) AND
Division.Division_ID = CInvoice.Division_ID AND

first Journal (inner-join) where

Journal.SharedSet_Id = vi_JOURNAL_sharedset(iiCompanyId) AND
Journal.Journal_ID = CInvoice.Journal_ID AND

first PaymentCondition (inner-join) where

PaymentCondition.PaymentCondition_ID = CInvoice.NormalPaymentCondition_ID AND

first Period (inner-join) where

Period.Company_Id = iiCompanyId AND
Period.Period_ID = CInvoice.Period_ID AND

query resultset tqPaySelLineInBrowse

field name	data type	db field	description
tcBankAccountNumber	character	calculated
tcBankNumber	character	BankNumber.BankNumber	Bank Number
tcBankNumberExtension	character	BankNumber.BankNumberExtension	Bank Extension
tcBankNumberFormatted	character	BankNumber.BankNumberFormatted	Formatted Bank Account No
tcBankNumberValidation	character	BankNumber.BankNumberValidation	Validation
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.
tcBusinessRelationName1	character	BusinessRelation.BusinessRelationName1	Name: The full name of the business relation. This field sets the default name for linked addresses such as customers and suppliers.
	api annotation:		PartialUpdate = yes - defaults to the BusinessRelationCode.
tdCInvoiceBalanceCreditTC	decimal	CInvoice.CInvoiceBalanceCreditTC	TC Balance Amount CR. This field displays the sum of the credit amounts of all posting lines in transaction currency.
ttCInvoiceDate	date	CInvoice.CInvoiceDate	Invoice Date. This field indicates the invoice creation date. The system uses this field with the credit terms to calculate due date and discount date.
	api annotation:		This field defaults from the system date.
ttCInvoiceDiscountDueDate	date	CInvoice.CInvoiceDiscountDueDate	Discount Due Date.This field indicates the last date a discount applies, calculated by the system based on the credit terms and the invoice date. User can modify this field without affecting the credit terms.
ttCInvoiceDueDate	date	CInvoice.CInvoiceDueDate	Due Date.This field indicates the date when payment become due. This field can be modified without affecting the credit terms. This field is calculated by the system based on the credit terms and the invoice date.
tdCInvoiceHoldAmountTC	decimal	CInvoice.CInvoiceHoldAmountTC	TC Hold Amount. This field displays the amount of the invoice total that is not to be paid. If this field is not blank, the hold amount is taken into account during payment processing. Hold amounts must be: For invoices or correction invoices: Less than the invoice total and greater than zero. For credit notes or correction credit notes: Greater than the document total and less than zero. The hold amount for a negative payment must always be set to zero.
tdCInvoiceNonDiscAmtTC	decimal	CInvoice.CInvoiceNonDiscAmtTC	TC Non-discount Amount. This field display the invoice amount without discount in base currency.
tdCInvoiceOpenAmountTC	decimal	calculated
tdCInvoiceOriginalCreditTC	decimal	CInvoice.CInvoiceOriginalCreditTC	TC Invoice Amount CR. This field displays the credit total invoice amount in the transaction currency. If you modify this field, the system automatically recalculates the exchange rate to ensure that the BC Invoice Amount remains the same.
tcCInvoiceReference	character	CInvoice.CInvoiceReference	Reference. An alphanumeric reference to help identify the invoice in the system. This reference is typically the ID number of the invoice received from the supplier.
tcCInvoiceTSMNumber	character	CInvoice.CInvoiceTSMNumber	Payment Reference. This field displays a unique reference number to be included in the supplier payment file. This reference can consist of a Transfer with Structured Message (TSM) number. This field can be blank.
tiCInvoiceVoucher	integer	CInvoice.CInvoiceVoucher	Voucher. This field displays the numeric identifier assigned to the posting. When the daybook of the journal entry is changed (after transfer), the voucher is cleared. Voucher must be unique in one GL period. When the user input is zero, the system automatically assign a value not used yet for this field.
tcCompanyCode	character	Company.CompanyCode	Entity Code
tcCorporateGroupCode	character	CorporateGroup.CorporateGroupCode	Group Name
tcCreditorCode	character	Creditor.CreditorCode	Supplier Code
tlCreditorIsWHT	logical	Creditor.CreditorIsWHT	Withholding Tax
tcCurrencyCode	character	Currency.CurrencyCode	Currency Code
tcDivisionCode	character	Division.DivisionCode	Sub-Account
tcInternalNumber	character	calculated
tcJournalCode	character	Journal.JournalCode	A daybook code (maximum eight characters).
tcPayFormatTypeCode	character	PaySelLine.PayFormatTypeCode	Payment format of the payment selection
tdPaymentConditionPercentage	decimal	PaymentCondition.PaymentConditionPercentage	Discount Percentage
tiPaySel_ID	integer	PaySel.PaySel_ID	Record ID
tcPaySelCode	character	PaySel.PaySelCode	Code
ttPaySelDate	date	PaySel.PaySelDate	Execution Date
tdPaySelLineAmountTC	decimal	PaySelLine.PaySelLineAmountTC	Amount
tdPaySelLineDiscountTC	decimal	PaySelLine.PaySelLineDiscountTC	Discount
tdPaySelLineIntAmtTC	decimal	PaySelLine.PaySelLineIntAmtTC	TC Interest Amount
tlPaySelLineIsConfirmed	logical	PaySelLine.PaySelLineIsConfirmed	PaySelLine is confirmed
tlPaySelLineIsRefInFile	logical	PaySelLine.PaySelLineIsRefInFile	Ref in File
tcPaySelLineObjectType	character	PaySelLine.PaySelLineObjectType	Type
tdPaySelLineWHTAmtCC	decimal	PaySelLine.PaySelLineWHTAmtCC	SC WHT Amount
tdPaySelLineWHTAmtLC	decimal	PaySelLine.PaySelLineWHTAmtLC	BC WHT Amount
tdPaySelLineWHTAmtTC	decimal	PaySelLine.PaySelLineWHTAmtTC	TC WHT Amount
tcPaySelStatus	character	PaySel.PaySelStatus	Status
tiPeriodYear	integer	Period.PeriodYear	GL Calendar Year
PaySelCustom	character	calculated	custom fields
PaySelLineCustom	character	calculated	custom fields
CInvoiceCustom	character	calculated	custom fields
CreditorCustom	character	calculated	custom fields
BusinessRelationCustom	character	calculated	custom fields
CurrencyCustom	character	calculated	custom fields
PaymentConditionCustom	character	calculated	custom fields
CompanyCustom	character	calculated	custom fields
DivisionCustom	character	calculated	custom fields
JournalCustom	character	calculated	custom fields
PeriodCustom	character	calculated	custom fields
BankNumberCustom	character	calculated	custom fields
CorporateGroupCustom	character	calculated	custom fields
ti_sequence	integer	calculated	primary index
tc_rowid	character	calculated	= rowid(PaySel),rowid(PaySelLine),rowid(BankNumber),rowid(CInvoice),rowid(Company),rowid(Creditor),rowid(BusinessRelation),rowid(CorporateGroup),rowid(Currency),rowid(Division),rowid(Journal),rowid(PaymentCondition),rowid(Period)

Internal usage

unused

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 = "BPaymentSelection".
create ttContext.
assign ttContext.propertyName = "methodName"
       ttContext.propertyValue = "PaySelLineInBrowse".
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/bpaymentselection.paysellineinbrowse.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.