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

Description

use this query in case you want to lookup a business Relation; this query shoudl only be used by UI-components!!!!


query filter (table tFilter)


tcBusinessFieldNametcDataTypetcOperator
iiDomainIDi=
tAddress.AddressCityc=,>=,>,<>,<=,<,begins,can-do,matches
tAddress.AddressCountyc=,>=,>,<>,<=,<,begins,can-do,matches
tAddress.AddressIsTaxablel=,<>
tAddress.AddressIsTaxIncludedl=,<>
tAddress.AddressStreet1c=,>=,>,<>,<=,<,begins,can-do,matches
tAddress.AddressStreet2c=,>=,>,<>,<=,<,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
tAddressType.AddressTypeCodec=,>=,>,<>,<=,<,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.BusinessRelationIsCompensl=,<>
tBusinessRelation.BusinessRelationIsDomRestrl=,<>
tBusinessRelation.BusinessRelationIsInCompl=,<>
tBusinessRelation.BusinessRelationIsIntercol=,<>
tBusinessRelation.BusinessRelationIsLastFilll=,<>
tBusinessRelation.BusinessRelationIsTaxRepl=,<>
tBusinessRelation.BusinessRelationName1c=,>=,>,<>,<=,<,begins,can-do,matches
tBusinessRelation.BusinessRelationName2c=,>=,>,<>,<=,<,begins,can-do,matches
tBusinessRelation.BusinessRelationName3c=,>=,>,<>,<=,<,begins,can-do,matches
tBusinessRelation.BusinessRelationNameCtrlc=,>=,>,<>,<=,<,begins,can-do,matches
tBusinessRelation.BusinessRelationSearchNamec=,>=,>,<>,<=,<,begins,can-do,matches
tCorporateGroup.CorporateGroupCodec=,>=,>,<>,<=,<,begins,can-do,matches
tCountry.CountryCodec=,>=,>,<>,<=,<,begins,can-do,matches
tCounty.CountyCodec=,>=,>,<>,<=,<,begins,can-do,matches
tBusinessRelation.LastModifiedDatet=,>=,>,<>,<=,<
tBusinessRelation.LastModifiedTimei=,>=,>,<>,<=,<
tBusinessRelation.LastModifiedUserc=,>=,>,<>,<=,<,begins,can-do,matches
tLng.LngCodec=,>=,>,<>,<=,<,begins,can-do,matches
tState.StateCodec=,>=,>,<>,<=,<,begins,can-do,matches


Parameters (internal)


iiDomainIDinteger


query condition


  each BusinessRelation where
(BusinessRelation.Domain_ID = iiDomainID OR
BusinessRelation.Domain_ID = 0 OR
BusinessRelation.Domain_ID = ? )

      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 = 'HEADOFFICE'

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

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

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

      first CorporateGroup (conditional-join) where
CorporateGroup.CorporateGroup_ID = BusinessRelation.CorporateGroup_ID AND

      first Lng (inner-join) where
Lng.Lng_ID = BusinessRelation.Lng_ID AND


query sort order


BusinessRelation.BusinessRelationIsActive (ascending)
BusinessRelation.BusinessRelationCode (ascending)


query resultset tqSelectBusinessRelation


field namedata typedb fielddescription
tcAddressCitycharacterAddress.AddressCityCity. The city for this address. This field can be used to decide the tax zone of the address.
tcAddressCountycharacterAddress.AddressCountyObsolete 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.
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.
tcAddressStreet1characterAddress.AddressStreet1Address: Line one of address details.
This field can be blank.
tcAddressStreet2characterAddress.AddressStreet2Address.Line two 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.
tcAddressTypeCodecharacterAddressType.AddressTypeCodeAddress Type
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.
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.
tlBusinessRelationIsDomRestrlogicalBusinessRelation.BusinessRelationIsDomRestrDomain Restricted. This filed indicates if access to this business relation is restricted by domain.
api annotation:PartialUpdate = yes - defaults to the value for this field defaults from the Business Relations by Domain field in System Maintain.
tlBusinessRelationIsLastFilllogicalBusinessRelation.BusinessRelationIsLastFillLast Filing. For an internal company, this field indicates whether this is the last time your company is filing a 1099-MISC under its current taxpayer ID number.
api annotation:PartialUpdate = yes - defaults to false.
tlBusinessRelationIsTaxReplogicalBusinessRelation.BusinessRelationIsTaxRepTax Report. For an internal company,this filed indicates whether to use this address for 1099 tax reporting.
When this field is yes, the name, first line of the street address, city, state, zip code, telephone number, and federal tax ID for the headoffice address must not be blank.
api annotation:PartialUpdate = yes - defaults to false.
tcBusinessRelationName3characterBusinessRelation.BusinessRelationName3Third Name: A name required for some regional reports.
This field can be blank.
tcBusinessRelationNameCtrlcharacterBusinessRelation.BusinessRelationNameCtrlName Control. For an internal company, the value is the IRS magnetic media control code assigned to this company.
When Tax Report is selected, a warning displays when this field is blank.
tcCorporateGroupCodecharacterCorporateGroup.CorporateGroupCodeGroup Name
tcCountryCodecharacterCountry.CountryCodeCountry Code
tcCountyCodecharacterCounty.CountyCodeCounty Code
tiDomain_IDintegerBusinessRelation.Domain_IDLink to Domains
ttLastModifiedDatedateBusinessRelation.LastModifiedDateLast Modified Date
tiLastModifiedTimeintegerBusinessRelation.LastModifiedTimeLast Modified Time
tcLastModifiedUsercharacterBusinessRelation.LastModifiedUserLast Modified User
tcLngCodecharacterLng.LngCodeLanguage Code
tiState_IDintegerState.State_IDRecord ID
tcStateCodecharacterState.StateCodeState
tiBusinessRelation_IDintegerBusinessRelation.BusinessRelation_IDRecord ID
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.
tcBusinessRelationSearchNamecharacterBusinessRelation.BusinessRelationSearchNameSearch Name: An alternate name for finding the business relation. This field can be useful for sorting and filtering.
api annotation:PartialUpdate = yes - defaults to the BusinessRelationCode.
tcBusinessRelationName1characterBusinessRelation.BusinessRelationName1Name: 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.
tcBusinessRelationName2characterBusinessRelation.BusinessRelationName2Second Name. An extended name when the Name field is not large enough to contain all information.
This fielsd can be blank.
tiCorporateGroup_IDintegerBusinessRelation.CorporateGroup_IDGroup Name
tlBusinessRelationIsActivelogicalBusinessRelation.BusinessRelationIsActiveActive: This field indicates if this is an active record.
api annotation:PartialUpdate = yes - defaults to true.
tlBusinessRelationIsInComplogicalBusinessRelation.BusinessRelationIsInCompInternal Entity. This filed indicates if the business relation identifies one of your entities within this database.
If this is an internal entity, you can also update the Tax Report, Name Control, and Last Filing fields, which are used for filing 1099-MISC reports in the US.
api annotation:PartialUpdate = yes - defaults to false.
For internal entities, this field defaults to yes and cannot be changed.
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.
tlBusinessRelationIsCompenslogicalBusinessRelation.BusinessRelationIsCompensCustomer/Supplier Compensation Allowed. This filed indicates how open items should be managed during payment processing when a customer and supplier are both associated with this business relation.
api annotation:PartialUpdate = yes - defaults to false.
tiLng_IDintegerBusinessRelation.Lng_IDLanguage Code
BusinessRelationCustomcharactercalculatedcustom fields
AddressCustomcharactercalculatedcustom fields
AddressTypeCustomcharactercalculatedcustom fields
CountryCustomcharactercalculatedcustom fields
CountyCustomcharactercalculatedcustom fields
StateCustomcharactercalculatedcustom fields
CorporateGroupCustomcharactercalculatedcustom fields
LngCustomcharactercalculatedcustom fields
ti_sequenceintegercalculatedprimary index
tc_rowidcharactercalculated = rowid(BusinessRelation),rowid(Address),rowid(AddressType),rowid(Country),rowid(County),rowid(State),rowid(CorporateGroup),rowid(Lng)


Internal usage


QadFinancials
lookup query on tBusinessRelation.BusinessRelationCode
lookup query on tBankBranch.tcBusinessRelationCode
lookup query on tBankCharge.tcBusinessRelationCode
lookup query on tBankNumber.tcBankBusinessRelationCode
lookup query on tCInvoice.tcBusinessRelationCode
lookup query on tCInvoice.tcShipToBusinessRelationCode
lookup query on tCInvoiceBank.tcBusinessRelationCode
lookup query on tCompanyProperty.tcBusinessRelationCode
lookup query on tCreditor.tcBusinessRelationCode
lookup query on tDebtor.tcBusinessRelationCode
lookup query on tDebtorEndUser.tcBusinessRelationCode
lookup query on tDebtorShipTo.tcBusinessRelationCode
lookup query on tDInvoice.tcBusinessRelationCode
lookup query on tDInvoice.tcShipFromBusinessRelationCode
lookup query on tDInvoice.tcShipToBusinessRelationCode
lookup query on tDInvoiceBank.tcBusinessRelationCode
lookup query on tEmployee.tcBusinessRelationCode
lookup query on tPaySelPrepay.tcBusinessRelationCode
lookup query on tProject.tcBusinessRelationCode
lookup query on tProject.tcInvoiceBusinessRelationCode
lookup query on tProject.tcSiteBusinessRelationCode
lookup query on tRevalGL.tcIntercoBusinessRelationCode


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 = "SelectBusinessRelation".
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.selectbusinessrelation.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.