API query SelectCompanyForExtended (optimised)

Description

Show detailed information for company.

query filter (table tFilter)

tcBusinessFieldName	tcDataType	tcOperator
iiCompanyId	i
tBusinessRelation.BusinessRelationCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tBusinessRelation.BusinessRelationICCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tCompany.CompanyCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tCompany.CompanyDescription	c	=,>=,>,<>,<=,<,begins,can-do,matches
tCompany.CompanyIsActive	l	=,<>
tCompanyProperty.CompanyPropertyActCheckp	c	=,>=,>,<>,<=,<,begins,can-do,matches
tCompanyProperty.CompanyPropertyActConvFact	d	=,>=,>,<>,<=,<
tCompanyProperty.CompanyPropertyDelTax	c	=,>=,>,<>,<=,<,begins,can-do,matches
tCompanyProperty.CompanyPropertyExchTolAP	d	=,>=,>,<>,<=,<
tCompanyProperty.CompanyPropertyExchTolAR	d	=,>=,>,<>,<=,<
tCompanyProperty.CompanyPropertyIsActDurat	l	=,<>
tCompanyProperty.CompanyPropertyIsAddGLNbr	l	=,<>
tCompanyProperty.CompanyPropertyIsAddNrYrly	l	=,<>
tCompanyProperty.CompanyPropertyIsBudOverCh	l	=,<>
tCompanyProperty.CompanyPropertyIsCompens	l	=,<>
tCompanyProperty.CompanyPropertyIsConsolid	l	=,<>
tCompanyProperty.CompanyPropertyIsGlobalTax	l	=,<>
tCompanyProperty.CompanyPropertyIsGrIncAcc	l	=,<>
tCompanyProperty.CompanyPropertyIsOICrossCy	l	=,<>
tCompanyProperty.CompanyPropertyIsPLReverse	l	=,<>
tCompanyProperty.CompanyPropertyIsPrimary	l	=,<>
tCompanyProperty.CompanyPropertyIsPrintRem	l	=,<>
tCompanyProperty.CompanyPropertyIsSalPost	l	=,<>
tCompanyProperty.CompanyPropertyIsStockMgt	l	=,<>
tCompanyProperty.CompanyPropertyIsWHT	l	=,<>
tCompanyProperty.CompanyPropertyMirrorSetup	c	=,>=,>,<>,<=,<,begins,can-do,matches
tCompanyProperty.CompanyPropertyOINetRestr	c	=,>=,>,<>,<=,<,begins,can-do,matches
tCompanyProperty.CompanyPropertyPriceNumDec	i	=,>=,>,<>,<=,<
tCompanyProperty.CompanyPropertyQtyNumDec	i	=,>=,>,<>,<=,<
tCompanyProperty.CompanyPropertyRevRecMinim	d	=,>=,>,<>,<=,<
tCompanyProperty.CompanyPropertyRevRecTresh	d	=,>=,>,<>,<=,<
tCompanyProperty.CompanyPropertySuspTax	c	=,>=,>,<>,<=,<,begins,can-do,matches
tCompanyProperty.CompanyPropertyUppLimit	d	=,>=,>,<>,<=,<
tCompanyProperty.CompanyPropertyWHTNextNbr	i	=,>=,>,<>,<=,<
tCurrency2.CurrencyCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tCurrency1.CurrencyCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tDomains.DomainCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tUsr.UsrLogin	c	=,>=,>,<>,<=,<,begins,can-do,matches

Parameters (internal)

iiCompanyId

integer

Company id

query condition

each Company where

Company.Company_Id = iiCompanyId AND

first Domains (inner-join) where

Domains.Domain_ID = Company.Domain_ID AND

each DomainProperty (inner-join) where

DomainProperty.Domain_ID = Domains.Domain_ID AND

first Currency2 (inner-join) where

Currency2.Currency_ID = DomainProperty.StatutoryCurrency_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

first Currency1 (inner-join) where

Currency1.Currency_ID = CompanyProperty.Currency_ID AND

each UsrCompany (inner-join) where

UsrCompany.Company_Id = iiCompanyId AND
UsrCompany.Company_ID = Company.Company_ID AND

first Usr (inner-join) where

Usr.Usr_ID = UsrCompany.Usr_ID AND

query sort order

Company.CompanyCode (ascending)

query resultset tqSelectCompanyForExtended

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.
tcBusinessRelationICCode	character	BusinessRelation.BusinessRelationICCode	Intercompany 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.
tiCompany_ID	integer	Company.Company_ID	Record ID
tcCompanyCode	character	Company.CompanyCode	Entity Code
tcCompanyDescription	character	Company.CompanyDescription	Entity Description
tlCompanyIsActive	logical	Company.CompanyIsActive	Active
tcCompanyPropertyActCheckp	character	CompanyProperty.CompanyPropertyActCheckp	Activity Sheets Checkpoint
tdCompanyPropertyActConvFact	decimal	CompanyProperty.CompanyPropertyActConvFact	Conversion Factor to Minutes
tcCompanyPropertyDelTax	character	CompanyProperty.CompanyPropertyDelTax	Delayed Tax
tdCompanyPropertyExchTolAP	decimal	CompanyProperty.CompanyPropertyExchTolAP	AP Exchange Tolerance %
tdCompanyPropertyExchTolAR	decimal	CompanyProperty.CompanyPropertyExchTolAR	AR Exchange Tolerance %
tlCompanyPropertyIsActDurat	logical	CompanyProperty.CompanyPropertyIsActDurat	Allow Duration
tlCompanyPropertyIsAddGLNbr	logical	CompanyProperty.CompanyPropertyIsAddGLNbr	Additional GL Numbering
tlCompanyPropertyIsAddNrYrly	logical	CompanyProperty.CompanyPropertyIsAddNrYrly	Yearly Additional JE Numbering
tlCompanyPropertyIsBudOverCh	logical	CompanyProperty.CompanyPropertyIsBudOverCh	Check Budgets on Overlap
tlCompanyPropertyIsCompens	logical	CompanyProperty.CompanyPropertyIsCompens	Customer/Supplier Compensation allowed
tlCompanyPropertyIsConsolid	logical	CompanyProperty.CompanyPropertyIsConsolid	Consolidation Entity
tlCompanyPropertyIsGlobalTax	logical	CompanyProperty.CompanyPropertyIsGlobalTax	Global Tax
tlCompanyPropertyIsGrIncAcc	logical	CompanyProperty.CompanyPropertyIsGrIncAcc	Gross Income Accounting
tlCompanyPropertyIsOICrossCy	logical	CompanyProperty.CompanyPropertyIsOICrossCy	Open Item Cross Entity Allowed
tlCompanyPropertyIsPLReverse	logical	CompanyProperty.CompanyPropertyIsPLReverse	Reverse P&L Revaluations
tlCompanyPropertyIsPrimary	logical	CompanyProperty.CompanyPropertyIsPrimary	Primary Entity
tlCompanyPropertyIsPrintRem	logical	CompanyProperty.CompanyPropertyIsPrintRem	Print Remittance
tlCompanyPropertyIsSalPost	logical	CompanyProperty.CompanyPropertyIsSalPost	Salary Posting
tlCompanyPropertyIsStockMgt	logical	CompanyProperty.CompanyPropertyIsStockMgt	Stock Management
tlCompanyPropertyIsWHT	logical	CompanyProperty.CompanyPropertyIsWHT	Use Withholding Tax
tcCompanyPropertyMirrorSetup	character	CompanyProperty.CompanyPropertyMirrorSetup	Mirror Setup
tcCompanyPropertyOINetRestr	character	CompanyProperty.CompanyPropertyOINetRestr	Open Item Netting Restriction
tcCompanyPropertyOINetRestrCalc	character	calculated	Open Item Netting restriction : translatable value
tiCompanyPropertyPriceNumDec	integer	CompanyProperty.CompanyPropertyPriceNumDec	Decimals for Price
tiCompanyPropertyQtyNumDec	integer	CompanyProperty.CompanyPropertyQtyNumDec	Decimals for Qty
tdCompanyPropertyRevRecMinim	decimal	CompanyProperty.CompanyPropertyRevRecMinim	Minimum Percentage of Completion
tdCompanyPropertyRevRecTresh	decimal	CompanyProperty.CompanyPropertyRevRecTresh	Forecasted Revenue Threshold
tcCompanyPropertySuspTax	character	CompanyProperty.CompanyPropertySuspTax	Suspended Tax
tdCompanyPropertyUppLimit	decimal	CompanyProperty.CompanyPropertyUppLimit	Invoice Upper Limit
tiCompanyPropertyWHTNextNbr	integer	CompanyProperty.CompanyPropertyWHTNextNbr	Next WHT Number
tiCurrency_ID	integer	CompanyProperty.Currency_ID	Base Currency
tcCurrencyCode	character	Currency1.CurrencyCode	Currency Code
tcCurrencyCode1	character	Currency2.CurrencyCode	Currency Code
tcDomainCode	character	Domains.DomainCode	Domain
tcUsrLogin	character	Usr.UsrLogin	Login
CompanyCustom	character	calculated	custom fields
CompanyPropertyCustom	character	calculated	custom fields
BusinessRelationCustom	character	calculated	custom fields
Currency1Custom	character	calculated	custom fields
DomainsCustom	character	calculated	custom fields
Currency2Custom	character	calculated	custom fields
UsrCustom	character	calculated	custom fields
ti_sequence	integer	calculated	primary index
tc_rowid	character	calculated	= rowid(Company),rowid(Domains),rowid(DomainProperty),rowid(Currency2),rowid(CompanyProperty),rowid(BusinessRelation),rowid(Currency1),rowid(UsrCompany),rowid(Usr)

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 = "SelectCompanyForExtended".
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.selectcompanyforextended.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.