project QadFinancials > class BCompany > API query CompanyByCompanyCodeForAddress (optimised)

Description

Query to return the address information from the Comany Code.


query filter (table tFilter)


tcBusinessFieldNametcDataTypetcOperator
iiCompanyIdi
icCompanyCodec=
icAddressTypec=
tAddress.AddressCityc=,>=,>,<>,<=,<,begins,can-do,matches
tAddress.AddressCountyc=,>=,>,<>,<=,<,begins,can-do,matches
tAddress.AddressIsTaxablel=,<>
tAddress.AddressIsTaxInCityl=,<>
tAddress.AddressIsTaxIncludedl=,<>
tAddress.AddressNamec=,>=,>,<>,<=,<,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
tAddressType.AddressTypeCodec=,>=,>,<>,<=,<,begins,can-do,matches
tAddressType.AddressTypeDescriptionc=,>=,>,<>,<=,<,begins,can-do,matches
tBusinessRelation.BusinessRelationCodec=,>=,>,<>,<=,<,begins,can-do,matches
tBusinessRelation.BusinessRelationIsActivel=,<>
tBusinessRelation.BusinessRelationIsInCompl=,<>
tCompany.CompanyCodec=,>=,>,<>,<=,<,begins,can-do,matches
tCompany.CompanyDescriptionc=,>=,>,<>,<=,<,begins,can-do,matches
tCompany.CompanyDomainc=,>=,>,<>,<=,<,begins,can-do,matches
tCompany.CompanyIsActivel=,<>
tCompanyProperty.CompanyPropertyCodec=,>=,>,<>,<=,<,begins,can-do,matches


Parameters (internal)


iiCompanyIdintegerCompany id
icCompanyCodecharacterCompany Code
icAddressTypecharacterThe Address Type to be returned by the query.


query condition


  each Company where
Company.Company_Id = iiCompanyId AND
Company.CompanyCode = icCompanyCode

      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

              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 = icAddressType


query resultset tqCompanyByCompanyCodeForAddress


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.
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.
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.
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.
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.
tiAddressType_IDintegerAddressType.AddressType_IDRecord ID
tcAddressTypeCodecharacterAddressType.AddressTypeCodeAddress Type
tcAddressTypeDescriptioncharacterAddressType.AddressTypeDescriptionDescription
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.
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.
tiCompany_IDintegerCompany.Company_IDRecord ID
tcCompanyCodecharacterCompany.CompanyCodeEntity Code
tcCompanyDescriptioncharacterCompany.CompanyDescriptionEntity Description
tcCompanyDomaincharacterCompany.CompanyDomainDomain
tlCompanyIsActivelogicalCompany.CompanyIsActiveActive
tiCompanyProperty_IDintegerCompanyProperty.CompanyProperty_IDRecord ID
tcCompanyPropertyCodecharacterCompanyProperty.CompanyPropertyCodeEntity Code
tiDomain_IDintegerCompany.Domain_IDDomain
CompanyCustomcharactercalculatedcustom fields
CompanyPropertyCustomcharactercalculatedcustom fields
BusinessRelationCustomcharactercalculatedcustom fields
AddressCustomcharactercalculatedcustom fields
AddressTypeCustomcharactercalculatedcustom fields
ti_sequenceintegercalculatedprimary index
tc_rowidcharactercalculated = rowid(Company),rowid(CompanyProperty),rowid(BusinessRelation),rowid(Address),rowid(AddressType)


Internal usage


unused


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 = "BCompany".
create ttContext.
assign ttContext.propertyName = "methodName"
       ttContext.propertyValue = "CompanyByCompanyCodeForAddress".
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/bcompany.companybycompanycodeforaddress.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.