API query VatNumberForMyCompany (optimised)

Description

query for retrieval of Vat Number of a company

query filter (table tFilter)

tcBusinessFieldName	tcDataType	tcOperator
iiCompanyId	i
icIdentityCountryCode	c	=
tBusinessRelation.BusinessRelationCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tCountry1.CountryCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tCountry2.CountryCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tVatNumber.VatNumberDeclaration	c	=,>=,>,<>,<=,<,begins,can-do,matches
tVatNumber.VatNumberIdentity	c	=,>=,>,<>,<=,<,begins,can-do,matches
tVatNumber.VatNumberIsActive	l	=,<>

Parameters (internal)

iiCompanyId	integer	Company id
icIdentityCountryCode	character	Country Tax Identification

query condition

each VatNumber where

first BusinessRelation (inner-join) where

BusinessRelation.BusinessRelation_ID = VatNumber.BusinessRelation_ID AND

each CompanyProperty (inner-join) where

CompanyProperty.Company_Id = iiCompanyId AND
CompanyProperty.BusinessRelation_ID = BusinessRelation.BusinessRelation_ID AND

first Country1 (inner-join) where

Country1.Country_ID = VatNumber.IdentityCountry_ID AND
Country1.CountryCode = icIdentityCountryCode

first Country2 (inner-join) where

Country2.Country_ID = VatNumber.DeclarationCountry_ID AND

query resultset tqVatNumberForMyCompany

field name	data type	db field	description
tcBusinessRelationCode	character	BusinessRelation.BusinessRelationCode	Business 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.
tcVatNumberIdentity	character	VatNumber.VatNumberIdentity	Obsolete field
tcVatNumberDeclaration	character	VatNumber.VatNumberDeclaration	Obsolete field
tlVatNumberIsActive	logical	VatNumber.VatNumberIsActive	Obsolete field
tiVatNumber_ID	integer	VatNumber.VatNumber_ID	Record ID
tiIdentityCountry_ID	integer	VatNumber.IdentityCountry_ID	Country Tax Identification
tcCountryCode	character	Country1.CountryCode	Country Code
tiDeclarationCountry_ID	integer	VatNumber.DeclarationCountry_ID	Country Tax Declaration
tcCountryCode2	character	Country2.CountryCode	Country Code
tiBusinessRelation_ID	integer	VatNumber.BusinessRelation_ID	Link to BusinessRelation
VatNumberCustom	character	calculated	custom fields
BusinessRelationCustom	character	calculated	custom fields
Country1Custom	character	calculated	custom fields
Country2Custom	character	calculated	custom fields
ti_sequence	integer	calculated	primary index
tc_rowid	character	calculated	= rowid(VatNumber),rowid(BusinessRelation),rowid(CompanyProperty),rowid(Country1),rowid(Country2)

Internal usage

QadFinancials

method BBankStateImport.AdditionalUpdatesCodeStart1
method BDCollection.ExportDOM80

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 = "VatNumberForMyCompany".
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.vatnumberformycompany.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.