project QadFinancials > class BCompanyProperty > API query CompanyPropertyByActBusRelAddr (optimised)

Description

Business Relation and Address inforation for a company based on the company Id.
Used for procurement integration


query filter (table tFilter)


tcBusinessFieldNametcDataTypetcOperator
iiCompanyIdi
tAddress.AddressCityc=,>=,>,<>,<=,<,begins,can-do,matches
tAddress.AddressEMailc=,>=,>,<>,<=,<,begins,can-do,matches
tAddress.AddressFaxc=,>=,>,<>,<=,<,begins,can-do,matches
tAddress.AddressStreet1c=,>=,>,<>,<=,<,begins,can-do,matches
tAddress.AddressStreet2c=,>=,>,<>,<=,<,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
tBusinessRelation.BusinessRelationCodec=,>=,>,<>,<=,<,begins,can-do,matches
tBusinessRelation.BusinessRelationICCodec=,>=,>,<>,<=,<,begins,can-do,matches
tBusinessRelation.BusinessRelationIsActivel=,<>
tBusinessRelation.BusinessRelationIsIntercol=,<>
tCountry.CountryCodec=,>=,>,<>,<=,<,begins,can-do,matches
tLng.LngCodec=,>=,>,<>,<=,<,begins,can-do,matches
tLng.LngDescriptionc=,>=,>,<>,<=,<,begins,can-do,matches


Parameters (internal)


iiCompanyIdintegerCompany id


query condition


  each CompanyProperty where
CompanyProperty.Company_Id = iiCompanyId AND

      first BusinessRelation (inner-join) where
BusinessRelation.BusinessRelation_ID = CompanyProperty.BusinessRelation_ID AND
BusinessRelation.BusinessRelationIsActive = TRUE

          each Address (inner-join) where
Address.BusinessRelation_ID = BusinessRelation.BusinessRelation_ID AND

              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 Lng (outer-join) where
Lng.Lng_ID = Address.Lng_ID AND


query resultset tqCompanyPropertyByActBusRelAddr


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.
tcAddressEMailcharacterAddress.AddressEMailE-Mail. This field indicates the e-mail address associated with this business relation.
This field can be blank.
tcAddressFaxcharacterAddress.AddressFaxFax. This field indicates the fax or telex number to use when sending documents to this address.
This field can be balnk.
tcAddressStreet1characterAddress.AddressStreet1Address: Line one of address details.
This field can be blank.
tcAddressStreet2characterAddress.AddressStreet2Address.Line two of address details.
This field can be blank.
tcAddressTelephonecharacterAddress.AddressTelephoneTelephone. The telephone number for calling this business relation address.
This field can be blank.
tiAddressType_IDintegerAddressType.AddressType_IDRecord ID
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_IDintegerCompanyProperty.BusinessRelation_IDMandatory
tcBusinessRelationCodecharacterBusinessRelation.BusinessRelationCodeBusiness 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.
tcBusinessRelationICCodecharacterBusinessRelation.BusinessRelationICCodeIntercompany Code. When Intercompany is true, this field is mandatory.
The code entered here must match the intercompany code entered for GL accounts in order to generate intercompany reports.
The intercompany code must be unique for this business relation.
tlBusinessRelationIsActivelogicalBusinessRelation.BusinessRelationIsActiveActive: This field indicates if this is an active record.
api annotation:PartialUpdate = yes - defaults to true.
tlBusinessRelationIsIntercologicalBusinessRelation.BusinessRelationIsIntercoIntercompany. 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.
tiCountry_IDintegerAddress.Country_IDCountry Format
tiCountry_ID2integerCountry.Country_IDRecord ID
tcCountryCodecharacterCountry.CountryCodeCountry Code
tiLng_IDintegerLng.Lng_IDRecord ID
tcLngCodecharacterLng.LngCodeLanguage Code
tcLngDescriptioncharacterLng.LngDescriptionDescription
CompanyPropertyCustomcharactercalculatedcustom fields
BusinessRelationCustomcharactercalculatedcustom fields
AddressCustomcharactercalculatedcustom fields
AddressTypeCustomcharactercalculatedcustom fields
CountryCustomcharactercalculatedcustom fields
LngCustomcharactercalculatedcustom fields
ti_sequenceintegercalculatedprimary index
tc_rowidcharactercalculated = rowid(CompanyProperty),rowid(BusinessRelation),rowid(Address),rowid(AddressType),rowid(Country),rowid(Lng)


Internal usage


QadFinancials
method BDInvoice.ApiStdMaintainTTWithExtPost
method BDInvoice.StdMaintainTTWithExtPost


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 = "BCompanyProperty".
create ttContext.
assign ttContext.propertyName = "methodName"
       ttContext.propertyValue = "CompanyPropertyByActBusRelAddr".
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/bcompanyproperty.companypropertybyactbusreladdr.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.