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

=BC.OBJECTDEFINITION(
    ConnectionName, 
    Object,
    API
)

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	Business Central Object name Use the BC.EXPANDOBJECTRANGE function to get the list of Business Central 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

Example

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

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

Result: