SI.OBJECTDEFINITION

Overview

If you look for the object structure and field names, use the SI.OJBECTDEFINITION function.
It returns the set of fields available in the specified Sage Intacct object and their description.

That can be helpful when constructing queries with the SI.QUERY function.

Syntax

CODE

=SI.OBJECTDEFINITION(
    ConnectionName, 
    Object
)

Arguments

Argument	Required/Optional	Description
`Connection`	Required	The name of the connection, as specified in the Connection Manager
`Object`	Required	Sage Intacct object name (e.g., `GLACCOUNT`, `INVDOCUMENT`). Use "Object (Subtype)" to retrieve column definitions for a specific subtype. Example: `SI.OBJECTDEFINITION("Sage", "INVDOCUMENT (Adjustment Decrease Value)")` Use the SI.EXPANDOBJECTRANGE function to get the list of Sage Intacct objects.
`IncludeRelationships`	Optional	If `TRUE`, the function returns three more columns: Object name, Object path, Relationship type. Default value: `FALSE`

Output

The function returns a spill range with the set of fields of the specified object. For every field, the function returns its ID, label, description, optionality, editability, data type, valid values (if applicable), and the mark if the field is custom.

If the WithRelationships argument is set to TRUE, the function returns three extra columns (Object name, Object path, Relationship type) for fields that the external objects are related to.
If there are no related objects, the cells are filled with dashes (-).

Example

There are many objects defined within Sage Intacct for which you can retrieve the Object Definition:

For example, here is the list of fields from the Sage Intacct GLACCOUNT object:

The SI.OBJECTDEFINTION function can be used to bring that information into Excel: