SI.XQUERYLOOKUP

Overview

The SI.XQUERYLOOKUP function returns a field from the specified Sage Intacct REST API object, using key fields/values and an optional filter expression.

Syntax

=SI.XQUERYLOOKUP(
    ConnectionName,
    Object,
    Filter,
    FieldToReturn,
    KeyFields,
    KeyValue, 
    OtherKeyValue1,
    OtherKeyValue2,
    OtherKeyValue3,
    OtherKeyValue4
    ...
)

Arguments

Argument	Required/Optional	Description
`ConnectionName`	Optional	Provide one of the following values: Connection name as defined in Connection Manager. Velixo range expression defining a set of connection names. An array of settings as described in the Multiple connections per formula article. We recommend using the VX.SETTINGS function to construct the array. OR Omit the argument to return results for all compatible connections with default aggregation settings.
`Object`	Required	A case-insensitive Sage Intacct REST API object name.
`Filter`	Optional	An optional filter to be used internally for SI.XQUERY. Compatible with values returned by SI.XQUERYFILTER.
`FieldToReturn`	Required	The name of the field to be retrieved from Sage Intacct.
`KeyFields`	Required	A comma-separated list of Sage Intacct REST API object field names ("key1,key2,key3") whose combination is guaranteed to uniquely identify every record in the object's dataset (at least in the subset filtered using the specified filter). or An Excel range reference. The elements of the Excel range are enumerated left-to-right, top-to-bottom (empty or whitespace cells are ignored).
`KeyValue`		The value corresponding to the first field specified in the KeyFields argument.
`OtherKeyValue1`		The value corresponding to the next field (if any) specified in the KeyFields argument.
...
`OtherKeyValueN`		The value corresponding to the last field (if any) specified in the KeyFields argument.

Example

=SI.XQUERYLOOKUP(
    "Sage",
    "construction-forecasting/wip-project",
    ,
    "estimatedCostAtCompletion",
    "id",
    "24"
)

Description

Queries the Sage Intacct REST API construction-forecasting/wip-project object to retrieve its estimated cost at completion for project with ID 24

Result