API query SelectDebtorShipTo (optimised)

query filter (table tFilter)

tcBusinessFieldName	tcDataType	tcOperator
iiCompanyId	i
tAddress.AddressCity	c	=,>=,>,<>,<=,<,begins,can-do,matches
tAddress.AddressIsTaxInCity	l	=,<>
tAddress.AddressName	c	=,>=,>,<>,<=,<,begins,can-do,matches
tAddress.AddressSearchName	c	=,>=,>,<>,<=,<,begins,can-do,matches
tAddress.AddressStreet1	c	=,>=,>,<>,<=,<,begins,can-do,matches
tAddress.AddressStreet2	c	=,>=,>,<>,<=,<,begins,can-do,matches
tAddress.AddressStreet3	c	=,>=,>,<>,<=,<,begins,can-do,matches
tAddressType.AddressTypeCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tAddress.AddressZip	c	=,>=,>,<>,<=,<,begins,can-do,matches
tBusinessRelation.BusinessRelationCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tCountry.CountryIsEUCountry	l	=,<>
tDebtor.DebtorCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tDebtorShipTo.DebtorShipToCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tDebtorShipTo.DebtorShipToIsDebtor	l	=,<>
tDebtorShipTo.DebtorShipToName	c	=,>=,>,<>,<=,<,begins,can-do,matches
tAddress.TxclTaxCls	c	=,>=,>,<>,<=,<,begins,can-do,matches
tAddress.TxuTaxUsage	c	=,>=,>,<>,<=,<,begins,can-do,matches
tAddress.TxzTaxZone	c	=,>=,>,<>,<=,<,begins,can-do,matches

Parameters (internal)

iiCompanyId

integer

Company id

query condition

each DebtorShipTo where

DebtorShipTo.SharedSet_Id = vi_DEBTOR_sharedset(iiCompanyId) AND

first Address (inner-join) where

Address.Address_ID = DebtorShipTo.Address_ID AND

first AddressType (inner-join) where

AddressType.AddressType_ID = Address.AddressType_ID AND

first BusinessRelation (inner-join) where

BusinessRelation.BusinessRelation_ID = Address.BusinessRelation_ID AND

first Country (inner-join) where

Country.Country_ID = Address.Country_ID AND

first Debtor (inner-join) where

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

query sort order

DebtorShipTo.Debtor_ID (ascending)
DebtorShipTo.DebtorShipToCode (ascending)

query resultset tqSelectDebtorShipTo

field name	data type	db field	description
tiAddress_ID	integer	DebtorShipTo.Address_ID	City
tcAddressCity	character	Address.AddressCity	City. The city for this address. This field can be used to decide the tax zone of the address.
tlAddressIsTaxInCity	logical	Address.AddressIsTaxInCity	Tax in City. This field determines whether the address is in the city limits for taxation purposes. It is used only with the Sales and Use Tax Interface for US and Canadian tax processing.
	api annotation:		PartialUpdate = yes - defaults to true.
tcAddressName	character	Address.AddressName	Name. The full name of this particular address. The name of a headoffice address is the same as the name of the business relationship and can not be modified.
	api annotation:		PartialUpdate = yes - defaults to the name of the businessRelation.
tcAddressSearchName	character	Address.AddressSearchName	Search Name. An alternate name for finding this address. The searchname of a headoffice address is the same as the business relationship and can not be modified.
	api annotation:		PartialUpdate = yes - defaults to the searchname of the businessRelation.
tcAddressStreet1	character	Address.AddressStreet1	Address: Line one of address details. This field can be blank.
tcAddressStreet2	character	Address.AddressStreet2	Address.Line two of address details. This field can be blank.
tcAddressStreet3	character	Address.AddressStreet3	Address.Line three of address details. This field can be blank.
tcAddressTypeCode	character	AddressType.AddressTypeCode	Address Type
tcAddressZip	character	Address.AddressZip	Zip. The postal code or US zip code associated with this address. This field is used to decide the tax zone for the address. This field can be blank.
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.
tlCountryIsEUCountry	logical	Country.CountryIsEUCountry	EU Member
tiDebtor_ID	integer	DebtorShipTo.Debtor_ID	Customer Code
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.
tiDebtorShipTo_ID	integer	DebtorShipTo.DebtorShipTo_ID	Record ID
tcDebtorShipToCode	character	DebtorShipTo.DebtorShipToCode	Ship-To Code. If you are not linking to another customer or to an end user, specify a new code. This code is automatically created with an address type of ship-to. If you leave Ship-To Code blank, the system Setting Up Business Relations automatically generates a number for the record based on the sequence defined in Customer Autonumber Create.
	api annotation:		If you select Link to Another Customer or Link to End User, the Ship-To Code field is filled with the value you specify for the customer or end user. These addresses are added as ship-tos for the customer specified in Customer Code.
tlDebtorShipToIsDebtor	logical	DebtorShipTo.DebtorShipToIsDebtor	Select this field if you want to specify another customer as the ship-to of this customer.
	api annotation:		Value for this field defaults to false. If it is true, the related customer code selected is used to fill the ship-to code field.
tcDebtorShiptoName	character	DebtorShipTo.DebtorShipToName	Ship-To Name
tcTxclTaxCls	character	Address.TxclTaxCls	Tax Class. This field indicates the tax class of the address. This field helps to determine the default tax environment (set of tax types) for related transactions. The value of this field defaults to the header of transactions created for this address. This field can be blank.
tcTxuTaxUsage	character	Address.TxuTaxUsage	Tax Usage. This field identifies the normal use of items sold to this address. Tax usage codes, along with tax class and tax date, determine which tax rates apply. Tax usage codes identify the normal use of items sold to this address. This field can be blank.
tcTxzTaxZone	character	Address.TxzTaxZone	Tax Zone. This field indicates the tax zone for this address. This field is mandatory.
	api annotation:		PartialUpdate = yes - defaults to a value the system searches for based on the country, state or province, county, city, and postal code of the current address.
DebtorShipToCustom	character	calculated	custom fields
AddressCustom	character	calculated	custom fields
AddressTypeCustom	character	calculated	custom fields
BusinessRelationCustom	character	calculated	custom fields
CountryCustom	character	calculated	custom fields
DebtorCustom	character	calculated	custom fields
ti_sequence	integer	calculated	primary index
tc_rowid	character	calculated	= rowid(DebtorShipTo),rowid(Address),rowid(AddressType),rowid(BusinessRelation),rowid(Country),rowid(Debtor)

Internal usage

QadFinancials

lookup query on tDebtorShipTo.DebtorShipToCode

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 = "BDebtorShipTo".
create ttContext.
assign ttContext.propertyName = "methodName"
       ttContext.propertyValue = "SelectDebtorShipTo".
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/bdebtorshipto.selectdebtorshipto.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.