project QadFinancials > class BDomain > API query AddressForDomains (optimised)

Description

Retrieve address information for the selected domain and/or company


query filter (table tFilter)


tcBusinessFieldNametcDataTypetcOperator
icDomainCodec=
iiCompanyIdi
ilisTaxRepresentativel=
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
tBusinessRelation.BusinessRelationIsTaxRepl=,<>
tCompany.CompanyCodec=,>=,>,<>,<=,<,begins,can-do,matches
tDomains.DomainCodec=,>=,>,<>,<=,<,begins,can-do,matches


Parameters (internal)


icDomainCodecharacterDomain Code
iiCompanyIdintegerCompany id
ilisTaxRepresentativelogicalindicates if the businessrelation is indicated as a taxrepresentative


query condition


  each Domains where
Domains.DomainCode = icDomainCode

      each Company (inner-join) where
Company.Company_Id = iiCompanyId AND
Company.Domain_ID = Domains.Domain_ID AND

          each CompanyProperty (inner-join) where
CompanyProperty.Company_Id = iiCompanyId AND
CompanyProperty.Company_ID = Company.Company_ID AND

              first BusinessRelation (inner-join) where
BusinessRelation.BusinessRelation_ID = CompanyProperty.BusinessRelation_ID AND
BusinessRelation.BusinessRelationIsTaxRep = ilisTaxRepresentative

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


query resultset tqAddressForDomains


field namedata typedb fielddescription
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.
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.
tcCompanyCodecharacterCompany.CompanyCodeEntity Code
tiDomain_IDintegerDomains.Domain_IDRecord ID
tcDomainCodecharacterDomains.DomainCodeDomain
DomainsCustomcharactercalculatedcustom fields
CompanyCustomcharactercalculatedcustom fields
BusinessRelationCustomcharactercalculatedcustom fields
AddressCustomcharactercalculatedcustom fields
ti_sequenceintegercalculatedprimary index
tc_rowidcharactercalculated = rowid(Domains),rowid(Company),rowid(CompanyProperty),rowid(BusinessRelation),rowid(Address)


Internal usage


QadFinancials
method BBox1099Report.GetBusinessFields
method BVATReport.GetBusinessFields3


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 = "BDomain".
create ttContext.
assign ttContext.propertyName = "methodName"
       ttContext.propertyValue = "AddressForDomains".
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/bdomain.addressfordomains.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.