BC.OBJECTDEFINITION

Overview

Use the BC.OBJECTDEFINITION function to check for definitions of Business Central objects.
It returns the set of fields, data types, and allowed values available in the specified Business Central object and their description.

It can be helpful when constructing queries with the BC.QUERY function.

Syntax

CODE

=BC.OBJECTDEFINITION(
    ConnectionName, 
    Object,
    API
)

Arguments

Argument	Required/Optional	Description
`ConnectionName`	Required	The name of the connection, as specified in the Connection Manager
`Object`	Required	Business Central Object name Use the BC.EXPANDOBJECTRANGE function to get the list of Sage Intacct objects.
`Api`	Optional	API to be referenced for Object names. The accepted predefined values are: `common` - Common API v2 (default) `web-service` - OData endpoints exposed per tenant `Velixo` - endpoints exposed via the Velixo AL extension Use the following syntax to use a published AL Extension: {publisher}/{group}/{version} - a fragment of the extension's URL `Velixo` is an alias for the most recent version of the Velixo AL extension

Output

The function returns a spill range with the set of fields of the specified object. For every field, the function returns its:

ID
whether it is a part of a key
optionality
data type
valid values, if applicable.

Example

CODE

=BC.OBJECTDEFINITION(
    "BC",
    "customerSales"
)

Description: Returns the set of fields, data types, and allowed values available for the object customerSales

Result: