project QadFinancials > class BBusinessRelation > API query AddressById (optimised)

Description

This query returns the address info by addressID.


query filter (table tFilter)


tcBusinessFieldNametcDataTypetcOperator
iiAddressIDi=
tAddress.AddressCityc=,>=,>,<>,<=,<,begins,can-do,matches
tAddress.AddressCityCodec=,>=,>,<>,<=,<,begins,can-do,matches
tAddress.AddressCountyc=,>=,>,<>,<=,<,begins,can-do,matches
tAddress.AddressEMailc=,>=,>,<>,<=,<,begins,can-do,matches
tAddress.AddressExternalValidationCodec=,>=,>,<>,<=,<,begins,can-do,matches
tAddress.AddressFaxc=,>=,>,<>,<=,<,begins,can-do,matches
tAddress.AddressFormati=,>=,>,<>,<=,<
tAddress.AddressIsSendToPostall=,<>
tAddress.AddressIsTaxablel=,<>
tAddress.AddressIsTaxInCityl=,<>
tAddress.AddressIsTaxIncludedl=,<>
tAddress.AddressIsTemporaryl=,<>
tAddress.AddressLogicKeyStringc=,>=,>,<>,<=,<,begins,can-do,matches
tAddress.AddressNamec=,>=,>,<>,<=,<,begins,can-do,matches
tAddress.AddressPostalAddress1c=,>=,>,<>,<=,<,begins,can-do,matches
tAddress.AddressPostalAddress2c=,>=,>,<>,<=,<,begins,can-do,matches
tAddress.AddressPostalCityc=,>=,>,<>,<=,<,begins,can-do,matches
tAddress.AddressPostalZipc=,>=,>,<>,<=,<,begins,can-do,matches
tAddress.AddressSearchNamec=,>=,>,<>,<=,<,begins,can-do,matches
tAddress.AddressStatec=,>=,>,<>,<=,<,begins,can-do,matches
tAddress.AddressStreet1c=,>=,>,<>,<=,<,begins,can-do,matches
tAddress.AddressStreet2c=,>=,>,<>,<=,<,begins,can-do,matches
tAddress.AddressStreet3c=,>=,>,<>,<=,<,begins,can-do,matches
tAddress.AddressTaxDeclarationi=,>=,>,<>,<=,<
tAddress.AddressTaxIDFederalc=,>=,>,<>,<=,<,begins,can-do,matches
tAddress.AddressTaxIDMisc1c=,>=,>,<>,<=,<,begins,can-do,matches
tAddress.AddressTaxIDMisc2c=,>=,>,<>,<=,<,begins,can-do,matches
tAddress.AddressTaxIDMisc3c=,>=,>,<>,<=,<,begins,can-do,matches
tAddress.AddressTaxIDStatec=,>=,>,<>,<=,<,begins,can-do,matches
tAddress.AddressTelephonec=,>=,>,<>,<=,<,begins,can-do,matches
tAddressType.AddressTypeCodec=,>=,>,<>,<=,<,begins,can-do,matches
tAddress.AddressWebSitec=,>=,>,<>,<=,<,begins,can-do,matches
tAddress.AddressZipc=,>=,>,<>,<=,<,begins,can-do,matches
tCountry.CountryCodec=,>=,>,<>,<=,<,begins,can-do,matches
tCountry.CountryDescriptionc=,>=,>,<>,<=,<,begins,can-do,matches
tCountry.CountryIsEUCountryl=,<>
tCounty.CountyCodec=,>=,>,<>,<=,<,begins,can-do,matches
tCounty.CountyDescriptionc=,>=,>,<>,<=,<,begins,can-do,matches
tAddress.LastModifiedDatet=,>=,>,<>,<=,<
tAddress.LastModifiedTimei=,>=,>,<>,<=,<
tAddress.LastModifiedUserc=,>=,>,<>,<=,<,begins,can-do,matches
tLng.LngCodec=,>=,>,<>,<=,<,begins,can-do,matches
tLng.LngDescriptionc=,>=,>,<>,<=,<,begins,can-do,matches
tState.StateCodec=,>=,>,<>,<=,<,begins,can-do,matches
tState.StateDescriptionc=,>=,>,<>,<=,<,begins,can-do,matches
tAddress.TxclTaxClsc=,>=,>,<>,<=,<,begins,can-do,matches
tAddress.TxuTaxUsagec=,>=,>,<>,<=,<,begins,can-do,matches
tAddress.TxzTaxZonec=,>=,>,<>,<=,<,begins,can-do,matches


Parameters (internal)


iiAddressIDinteger


query condition


  each Address where
Address.Address_ID = iiAddressID

      first AddressType (inner-join) where
AddressType.AddressType_ID = Address.AddressType_ID AND

      first Country (inner-join) where
Country.Country_ID = Address.Country_ID AND

      first County (outer-join) where
County.County_ID = Address.County_ID AND

      first Lng (outer-join) where
Lng.Lng_ID = Address.Lng_ID AND

      first State (outer-join) where
State.State_ID = Address.State_ID AND


query resultset tqAddressById


field namedata typedb fielddescription
tiAddress_IDintegerAddress.Address_IDRecord ID
tcAddressCitycharacterAddress.AddressCityCity. The city for this address. This field can be used to decide the tax zone of the address.
tcAddressCityCodecharacterAddress.AddressCityCodeCity Code
tcAddressCountycharacterAddress.AddressCountyObsolete field
tcAddressEMailcharacterAddress.AddressEMailE-Mail. This field indicates the e-mail address associated with this business relation.
This field can be blank.
tcAddressExternalValidationCodecharacterAddress.AddressExternalValidationCodeExternal Validation Code
tcAddressFaxcharacterAddress.AddressFaxFax. This field indicates the fax or telex number to use when sending documents to this address.
This field can be balnk.
tiAddressFormatintegerAddress.AddressFormatFormat. This field determines where postal codes display on printed addresses.
api annotation:PartialUpdate = yes - defaults to the value for the same field defined for the country.
tlAddressIsSendToPostallogicalAddress.AddressIsSendToPostalObsolete field
tlAddressIsTaxablelogicalAddress.AddressIsTaxableTaxable Address. This field indicates if business activities for this address are normally subject to tax.
The taxable status of the address defaults to transactions where the address is used.
api annotation:PartialUpdate = yes - defaults to false.
tlAddressIsTaxInCitylogicalAddress.AddressIsTaxInCityTax 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.
tlAddressIsTaxIncludedlogicalAddress.AddressIsTaxIncludedTax Is Included. This field indicates if line item prices for this address normally include tax.
The value of Tax Is Included defaults to the header of transactions created for this address.
api annotation:PartialUpdate = yes - defaults to false.
tlAddressIsTemporarylogicalAddress.AddressIsTemporaryTemporary. If the type of this address is ship-to or dock, this field indicates if the address is temporary.
This field is for reference and can be useful for sorting and filtering records.
api annotation:PartialUpdate = yes - defaults to false.
tcAddressLogicKeyStringcharacterAddress.AddressLogicKeyStringLogic Key String. Alternative unique key for address table for integration purpose when making update existing record.
api annotation:PartialUpdate = yes - defaults to 1.
tcAddressNamecharacterAddress.AddressNameName. 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.
tcAddressPostalAddress1characterAddress.AddressPostalAddress1Obsolete field
tcAddressPostalAddress2characterAddress.AddressPostalAddress2Obsolete field
tcAddressPostalCitycharacterAddress.AddressPostalCityObsolete field
tcAddressPostalZipcharacterAddress.AddressPostalZipObsolete field
tcAddressSearchNamecharacterAddress.AddressSearchNameSearch 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.
tcAddressStatecharacterAddress.AddressStateObsolete field
tcAddressStreet1characterAddress.AddressStreet1Address: Line one of address details.
This field can be blank.
tcAddressStreet2characterAddress.AddressStreet2Address.Line two of address details.
This field can be blank.
tcAddressStreet3characterAddress.AddressStreet3Address.Line three of address details.
This field can be blank.
tiAddressTaxDeclarationintegerAddress.AddressTaxDeclarationThis field is mandatory.
tcAddressTaxIDFederalcharacterAddress.AddressTaxIDFederalFederal Tax. The value of this filed is the tax ID assigned to this address by the federal or national government.
If Tax Report is true, the Federal tax ID must be unique; otherwise, related business relations can share an ID.
tcAddressTaxIDMisc1characterAddress.AddressTaxIDMisc1Miscellaneous Tax 1.This field is for reference and documentation purposes, its value can be any other tax identification numbers that are useful.
This field can be blank.
tcAddressTaxIDMisc2characterAddress.AddressTaxIDMisc2Miscellaneous Tax 2.This field is for reference and documentation purposes, its value can be any other tax identification numbers that are useful.
This field can be blank.
tcAddressTaxIDMisc3characterAddress.AddressTaxIDMisc3Miscellaneous Tax 3.This field is for reference and documentation purposes, its value can be any other tax identification numbers that are useful.
This field can be blank.
tcAddressTaxIDStatecharacterAddress.AddressTaxIDStateState Tax. This field is for reference and documentation purposes, the value of the field is either a state or provincial tax identification number or a VAT registration number.
tcAddressTelephonecharacterAddress.AddressTelephoneTelephone. The telephone number for calling this business relation address.
This field can be blank.
tiAddressType_IDintegerAddress.AddressType_IDAddress Type
tcAddressTypeCodecharacterAddressType.AddressTypeCodeAddress Type
tcAddressWebSitecharacterAddress.AddressWebSiteInternet. This field indicates the Web site of this business relation.
This field can be blank.
tcAddressZipcharacterAddress.AddressZipZip. 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.
tiBusinessRelation_IDintegerAddress.BusinessRelation_IDLink to BusinessRelation
tiCountry_IDintegerCountry.Country_IDRecord ID
tcCountryCodecharacterCountry.CountryCodeCountry Code
tcCountryDescriptioncharacterCountry.CountryDescriptionDescription
tlCountryIsEUCountrylogicalCountry.CountryIsEUCountryEU Member
tiCounty_IDintegerCounty.County_IDRecord ID
tcCountyCodecharacterCounty.CountyCodeCounty Code
tcCountyDescriptioncharacterCounty.CountyDescriptionDescription
tcCustomCombo0characterAddress.CustomCombo0Custom Combo Field
tcCustomCombo1characterAddress.CustomCombo1Custom Combo Field
tcCustomCombo2characterAddress.CustomCombo2Custom Combo Field
tcCustomCombo3characterAddress.CustomCombo3Custom Combo Field
tcCustomCombo4characterAddress.CustomCombo4Custom Combo Field
tcCustomCombo5characterAddress.CustomCombo5Custom Combo Field
tcCustomCombo6characterAddress.CustomCombo6Custom Combo Field
tcCustomCombo7characterAddress.CustomCombo7Custom Combo Field
tcCustomCombo8characterAddress.CustomCombo8Custom Combo Field
tcCustomCombo9characterAddress.CustomCombo9Custom Combo Field
ttCustomDate0dateAddress.CustomDate0Custom Date Field
ttCustomDate1dateAddress.CustomDate1Custom Date Field
ttCustomDate2dateAddress.CustomDate2Custom Date Field
ttCustomDate3dateAddress.CustomDate3Custom Date Field
ttCustomDate4dateAddress.CustomDate4Custom Date Field
tdCustomDecimal0decimalAddress.CustomDecimal0Custom Decimal Field
tdCustomDecimal1decimalAddress.CustomDecimal1Custom Decimal Field
tdCustomDecimal2decimalAddress.CustomDecimal2Custom Decimal Field
tdCustomDecimal3decimalAddress.CustomDecimal3Custom Decimal Field
tdCustomDecimal4decimalAddress.CustomDecimal4Custom Decimal Field
tiCustomInteger0integerAddress.CustomInteger0Custom Integer Field
tiCustomInteger1integerAddress.CustomInteger1Custom Integer Field
tiCustomInteger2integerAddress.CustomInteger2Custom Integer Field
tiCustomInteger3integerAddress.CustomInteger3Custom Integer Field
tiCustomInteger4integerAddress.CustomInteger4Custom Integer Field
tcCustomLong0characterAddress.CustomLong0Custom Long Field
tcCustomLong1characterAddress.CustomLong1Custom Long Field
tcCustomNotecharacterAddress.CustomNoteCustom Note Field
tcCustomShort0characterAddress.CustomShort0Custom Short Field
tcCustomShort1characterAddress.CustomShort1Custom Short Field
tcCustomShort2characterAddress.CustomShort2Custom Short Field
tcCustomShort3characterAddress.CustomShort3Custom Short Field
tcCustomShort4characterAddress.CustomShort4Custom Short Field
tcCustomShort5characterAddress.CustomShort5Custom Short Field
tcCustomShort6characterAddress.CustomShort6Custom Short Field
tcCustomShort7characterAddress.CustomShort7Custom Short Field
tcCustomShort8characterAddress.CustomShort8Custom Short Field
tcCustomShort9characterAddress.CustomShort9Custom Short Field
ttLastModifiedDatedateAddress.LastModifiedDateLast Modified Date
tiLastModifiedTimeintegerAddress.LastModifiedTimeLast Modified Time
tcLastModifiedUsercharacterAddress.LastModifiedUserLast Modified User
tiLng_IDintegerLng.Lng_IDRecord ID
tcLngCodecharacterLng.LngCodeLanguage Code
tcLngDescriptioncharacterLng.LngDescriptionDescription
tcQADC01characterAddress.QADC01unused QAD reserved field
tcQADC02characterAddress.QADC02unused QAD reserved field
tdQADD01decimalAddress.QADD01unused QAD reserved field
ttQADT01dateAddress.QADT01unused QAD reserved field
tiState_IDintegerState.State_IDRecord ID
tcStateCodecharacterState.StateCodeState
tcStateDescriptioncharacterState.StateDescriptionDescription
tcTxclTaxClscharacterAddress.TxclTaxClsTax 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.
tcTxuTaxUsagecharacterAddress.TxuTaxUsageTax 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.
tcTxzTaxZonecharacterAddress.TxzTaxZoneTax 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.
AddressCustomcharactercalculatedcustom fields
AddressTypeCustomcharactercalculatedcustom fields
CountryCustomcharactercalculatedcustom fields
CountyCustomcharactercalculatedcustom fields
LngCustomcharactercalculatedcustom fields
StateCustomcharactercalculatedcustom fields
ti_sequenceintegercalculatedprimary index
tc_rowidcharactercalculated = rowid(Address),rowid(AddressType),rowid(Country),rowid(County),rowid(Lng),rowid(State)


Internal usage


QadFinancials
method BBusinessRelation.GetAddressWithID
method BDebtorEndUser.ApiLoadDebtorEndUser
method BDebtorEndUser.ApiStdMaintainTT
method BDebtorReport.DebtorInvoicePrint
method BDebtorShipTo.ApiLoadDebtorShipTo
method BPosting.AddTaxPostingAddress
method BMfgAddress.ApiGetDockAddress
method BMfgAddress.ApiReplicateFromFinancialsEndUSer
method BMfgAddress.ApiReplicateFromFinancialsShipTo
method BMfgAddress.MapMfgAddressData
method BMfgEndUser.ApiReplicateFromFinancials


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 = "BBusinessRelation".
create ttContext.
assign ttContext.propertyName = "methodName"
       ttContext.propertyValue = "AddressById".
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/bbusinessrelation.addressbyid.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.