API query DInvoiceBankForPaymentV01

query filter (table tFilter)

tcBusinessFieldName	tcDataType	tcOperator
iiCompanyId	i
ilIsPaymentAllowed	l	=
icBusinessRelationCode	c	=
icCurrencyCode	c	=
icDivisionCode	c	matches
ilBusinessRelationIsInterco	l	=
icDInvoiceType	c	can-do
ilIsOpen	l	=
ilIsSelected	l	=
icCountryCode	c	=
icAddressTypeCode	c	=
iiBankPayFormat_ID	i	=
icPaymentGroupCode	c	=
iiDInvoice_ID	i	=
ilIsWithBank	l	=
icCorporateGroupCode	c	=
tAddressType.AddressTypeCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
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.BusinessRelationIsInterco	l	=,<>
tBusinessRelation.BusinessRelationName1	c	=,>=,>,<>,<=,<,begins,can-do,matches
tCompany.CompanyCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tCorporateGroup.CorporateGroupCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tCountry.CountryCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tCurrency.CurrencyCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tDebtor.DebtorCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tDInvoice.DInvoiceBalanceCreditTC	d	=,>=,>,<>,<=,<
tDInvoice.DInvoiceBalanceDebitTC	d	=,>=,>,<>,<=,<
tDInvoiceBank.DInvoiceBankToPayTC	d	=,>=,>,<>,<=,<
tDInvoice.DInvoiceDate	t	=,>=,>,<>,<=,<
tDInvoice.DInvoiceDescription	c	=,>=,>,<>,<=,<,begins,can-do,matches
tDInvoice.DInvoiceDiscountDueDate	t	=,>=,>,<>,<=,<
tDInvoice.DInvoiceDueDate	t	=,>=,>,<>,<=,<
tDInvoice.DInvoiceExchangeRate	d	=,>=,>,<>,<=,<
tDInvoice.DInvoiceIsOpen	l	=,<>
tDInvoice.DInvoiceIsPaymentAllowed	l	=,<>
tDInvoice.DInvoiceIsSelected	l	=,<>
tDInvoice.DInvoiceIsWithBank	l	=,<>
tDInvoice.DInvoiceOriginalCreditTC	d	=,>=,>,<>,<=,<
tDInvoice.DInvoiceOriginalDebitTC	d	=,>=,>,<>,<=,<
tDInvoice.DInvoiceRateScale	d	=,>=,>,<>,<=,<
tDInvoice.DInvoiceTSMNumber	c	=,>=,>,<>,<=,<,begins,can-do,matches
tDInvoice.DInvoiceType	c	=,>=,>,<>,<=,<,begins,can-do,matches
tDInvoice.DInvoiceVatCreditTC	d	=,>=,>,<>,<=,<
tDInvoice.DInvoiceVatDebitTC	d	=,>=,>,<>,<=,<
tDInvoice.DInvoiceVoucher	i	=,>=,>,<>,<=,<
tDivision.DivisionCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tDebtor.DomiciliationNumber	i	=,>=,>,<>,<=,<
tJournal.JournalCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tPaymentCondition.PaymentConditionPaymentTyp	c	=,>=,>,<>,<=,<,begins,can-do,matches
tPaymentCondition.PaymentConditionPercentage	d	=,>=,>,<>,<=,<
tPaymentGroup.PaymentGroupCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tPeriod.PeriodPeriod	i	=,>=,>,<>,<=,<
tPeriod.PeriodYear	i	=,>=,>,<>,<=,<

Parameters (internal)

iiCompanyId	integer	Company id
ilIsPaymentAllowed	logical
icBusinessRelationCode	character
icCurrencyCode	character
icDivisionCode	character
ilBusinessRelationIsInterco	logical
icDInvoiceType	character
ilIsOpen	logical
ilIsSelected	logical
icCountryCode	character
icAddressTypeCode	character
iiBankPayFormat_ID	integer
icPaymentGroupCode	character
iiDInvoice_ID	integer
ilIsWithBank	logical
icCorporateGroupCode	character	Group Name

query condition

each DInvoice where

DInvoice.Company_Id = iiCompanyId AND
DInvoice.DInvoice_ID = iiDInvoice_ID AND
DInvoice.DInvoiceType can-do icDInvoiceType AND
DInvoice.DInvoiceIsPaymentAllowed = ilIsPaymentAllowed AND
DInvoice.DInvoiceIsOpen = ilIsOpen AND
DInvoice.DInvoiceIsSelected = ilIsSelected AND
DInvoice.DInvoiceIsWithBank = ilIsWithBank

first Company (inner-join) where

Company.Company_Id = iiCompanyId AND
Company.Company_ID = DInvoice.Company_ID AND

first Currency (inner-join) where

Currency.Currency_ID = DInvoice.DInvoiceCurrency_ID AND
Currency.CurrencyCode = icCurrencyCode

first Debtor (inner-join) where

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

first BusinessRelation (inner-join) where

BusinessRelation.BusinessRelation_ID = Debtor.BusinessRelation_ID AND
BusinessRelation.BusinessRelationCode = icBusinessRelationCode AND
BusinessRelation.BusinessRelationIsInterco = ilBusinessRelationIsInterco

each Address (inner-join) where

Address.BusinessRelation_ID = BusinessRelation.BusinessRelation_ID AND

first AddressType (inner-join) where

AddressType.AddressType_ID = Address.AddressType_ID AND
AddressType.AddressTypeCode = icAddressTypeCode

first Country (inner-join) where

Country.Country_ID = Address.Country_ID AND
Country.CountryCode = icCountryCode

first CorporateGroup (conditional-join) where

CorporateGroup.CorporateGroup_ID = BusinessRelation.CorporateGroup_ID AND
CorporateGroup.CorporateGroupCode = icCorporateGroupCode

first PaymentGroup (conditional-join) where

PaymentGroup.PaymentGroup_ID = Debtor.PaymentGroup_ID AND
PaymentGroup.PaymentGroupCode = icPaymentGroupCode

each DInvoiceBank (conditional-join) where

DInvoiceBank.DInvoice_ID = DInvoice.DInvoice_ID AND

first BankNumber (conditional-join) where

BankNumber.BankNumber_ID = DInvoiceBank.BankNumber_ID AND
BankNumber.BankPayFormat_ID = iiBankPayFormat_ID

first Division (conditional-join) where

Division.SharedSet_Id = vi_DIVISION_sharedset(iiCompanyId) AND
Division.Division_ID = DInvoice.Division_ID AND
Division.DivisionCode matches icDivisionCode

first Journal (inner-join) where

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

first PaymentCondition (inner-join) where

PaymentCondition.PaymentCondition_ID = DInvoice.NormalPaymentCondition_ID AND

first Period (inner-join) where

Period.Company_Id = iiCompanyId AND
Period.Period_ID = DInvoice.Period_ID AND

query resultset tqDInvoiceBankForPaymentV01

field name	data type	db field	description
tcAddressTypeCode	character	AddressType.AddressTypeCode	Address Type
tcBankNumber	character	BankNumber.BankNumber	Bank Number
tiBankNumber_ID	integer	DInvoiceBank.BankNumber_ID	Formatted Bank Account No
tcBankNumberExtension	character	BankNumber.BankNumberExtension	Bank Extension
tcBankNumberFormatted	character	BankNumber.BankNumberFormatted	Formatted Bank Account No
tcBankNumberValidation	character	BankNumber.BankNumberValidation	Validation
tiBankPayFormat_ID	integer	BankNumber.BankPayFormat_ID	Link to BankPayFormat
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.
tlBusinessRelationIsInterco	logical	BusinessRelation.BusinessRelationIsInterco	Intercompany. This field Indicates if the business relation identifies an entity that is a member of a group of entities that trade with each other. If the business relation is identified as an internal entity,this field is true and cannot be changed.
	api annotation:		PartialUpdate = yes - defaults to false.
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.
tiCnControlGLProfile_ID	integer	Debtor.CnControlGLProfile_ID	Control GL Profile (Credit Note)
tcCompanyCode	character	Company.CompanyCode	Entity Code
tcCorporateGroupCode	character	CorporateGroup.CorporateGroupCode	Group Name
tcCountryCode	character	Country.CountryCode	Country Code
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	DInvoice.DInvoice_ID	Record ID
tdDInvoiceBalanceCreditTC	decimal	DInvoice.DInvoiceBalanceCreditTC	TC Balance Amount CR. This field displays the sum of the credit amounts of all posting lines in transaction currency.
tdDInvoiceBalanceDebitTC	decimal	DInvoice.DInvoiceBalanceDebitTC	TC Balance Amount DR. This field displays the sum of the debit amounts of all posting lines in transaction currency.
tiDInvoiceBank_ID	integer	DInvoiceBank.DInvoiceBank_ID	Record ID
tdDInvoiceBankToPayTC	decimal	DInvoiceBank.DInvoiceBankToPayTC	TC Payment Amount. This field displays the payment amount in the transaction currency.
ttDInvoiceDate	date	DInvoice.DInvoiceDate	Invoice Date. This field indicates the invoice creation date.This field is normallly prior to the posting date and within the same accounting period as the posting date. The date must be within the upper and lower date limits of an open GL period. The system uses the invoice date with the credit terms to calculate due date and discount date.
	api annotation:		This field defaults to the DInvoicePostingDate.
tcDInvoiceDescription	character	DInvoice.DInvoiceDescription	Description. A brief description of the invoice. This field is mandatory.
ttDInvoiceDiscountDueDate	date	DInvoice.DInvoiceDiscountDueDate	Discount Due Date. This field displays the last date a discount applies, calculated by the system based on the credit terms and the invoice date. You can modify the due date without affecting the credit terms. If the credit terms have a base date specified, this is used in the due date calculations rather than the invoice creation date.
ttDInvoiceDueDate	date	DInvoice.DInvoiceDueDate	Due Date. This field displays the date when payment is due, calculated by the system based on the credit terms and the invoice date. User can modify the due date without affecting the credit terms. If the credit terms have a base date specified, this is used in the due date calculations rather than the invoice creation date.
tdDInvoiceExchangeRate	decimal	DInvoice.DInvoiceExchangeRate	Exchange Rate. The accounting exchange rate used by the invoice. The BC Invoice Amount is calculated based on the exchange rate. If user modify the TC Invoice Amount, the BC invoice amount is automatically adjusted.
tlDInvoiceIsOpen	logical	DInvoice.DInvoiceIsOpen	Open.This field indicates if the invoice has been completely paid. This field is updated automatically when complete payment is confirmed. This field is read-only.
	api annotation:		PartialUpdate = yes - defaults to true
tlDInvoiceIsPaymentAllowed	logical	DInvoice.DInvoiceIsPaymentAllowed	CN Payment Allowed. This field applies to only credit notes;otherwise, it is read-only. Selecting the field indicates that the customer credit note can be included in a payment selection.
	api annotation:		PartialUpdate = yes - defaults to false
tlDInvoiceIsSelected	logical	DInvoice.DInvoiceIsSelected	Selected. This field indicates whether the invoice is included in a payment selection. This field is read-only.
	api annotation:		PartialUpdate = yes - defaults to false
tlDInvoiceIsWithBank	logical	DInvoice.DInvoiceIsWithBank	With Bank. This field indicates if the invoice has a customer bank number specified for it.
	api annotation:		PartialUpdate = yes - defaults to true
tdDInvoiceOriginalCreditTC	decimal	DInvoice.DInvoiceOriginalCreditTC	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.
tdDInvoiceOriginalDebitTC	decimal	DInvoice.DInvoiceOriginalDebitTC	TC AP Amount. This field displays the debit total invoice amount in the transaction currency. If you modify this field, the system automatically recalculates the exchange rate to ensure that the TC Invoice Amount remains the same.
tdDInvoiceRateScale	decimal	DInvoice.DInvoiceRateScale	Scale Factor.This field indicates the scale factor applying to the exchange rate in use for foreign currency payments. The exchange rate is multiplied by the scale factor to determine the actual exchange rate.
	api annotation:		The value for the scale factor defaults from the exchange rate definition, but it can be modified.
tcDInvoiceTSMNumber	character	DInvoice.DInvoiceTSMNumber	Payment Reference. This field contains a reference number to identify a customer payment for this invoice. Normally this could be a unique transaction structured message (TSM) number. The TSM is a standard reference numbering system for electronic transfers,used by many banks.
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
tdDInvoiceVatCreditTC	decimal	DInvoice.DInvoiceVatCreditTC	TC Tax Amount CR. This field displays the credit tax amount (TC) calculated by the system using the total invoice amount (TC) and the applicable tax rate code.
tdDInvoiceVatDebitTC	decimal	DInvoice.DInvoiceVatDebitTC	TC Tax Amount DR. This field displays the debit tax amount (TC) calculated by the system using the total invoice amount (TC) and the applicable tax rate code.
tiDInvoiceVoucher	integer	DInvoice.DInvoiceVoucher	Voucher.This field displays the numeric identifier assigned to the posting. When the daybook of the journal entry is charged(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.
tcDivisionCode	character	Division.DivisionCode	Sub-Account
tiDomiciliationNumber	integer	Debtor.DomiciliationNumber	Domiciliation Number
tcJournalCode	character	Journal.JournalCode	A daybook code (maximum eight characters).
tcPaymentConditionPaymentTyp	character	PaymentCondition.PaymentConditionPaymentTyp	Payment Type
tdPaymentConditionPercentage	decimal	PaymentCondition.PaymentConditionPercentage	Discount Percentage
tcPaymentGroupCode	character	PaymentGroup.PaymentGroupCode	Payment Group
tiPeriodPeriod	integer	Period.PeriodPeriod	GL Period
tiPeriodYear	integer	Period.PeriodYear	GL Calendar Year
DInvoiceCustom	character	calculated	custom fields
CompanyCustom	character	calculated	custom fields
CurrencyCustom	character	calculated	custom fields
DebtorCustom	character	calculated	custom fields
BusinessRelationCustom	character	calculated	custom fields
AddressTypeCustom	character	calculated	custom fields
CountryCustom	character	calculated	custom fields
CorporateGroupCustom	character	calculated	custom fields
PaymentGroupCustom	character	calculated	custom fields
DInvoiceBankCustom	character	calculated	custom fields
BankNumberCustom	character	calculated	custom fields
DivisionCustom	character	calculated	custom fields
JournalCustom	character	calculated	custom fields
PaymentConditionCustom	character	calculated	custom fields
PeriodCustom	character	calculated	custom fields
ti_sequence	integer	calculated	primary index
tc_rowid	character	calculated	= rowid(DInvoice),rowid(Company),rowid(Currency),rowid(Debtor),rowid(BusinessRelation),rowid(Address),rowid(AddressType),rowid(Country),rowid(CorporateGroup),rowid(PaymentGroup),rowid(DInvoiceBank),rowid(BankNumber),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 = "BDInvoice".
create ttContext.
assign ttContext.propertyName = "methodName"
       ttContext.propertyValue = "DInvoiceBankForPaymentV01".
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.dinvoicebankforpaymentv01.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.