Type | Read/write | Author | Availability |
Read | FINBOURNE | Provided with LUSID |
Providing you have sufficient access control permissions, the Lusid.ChartOfAccounts
provider enables you to write a Luminesce SQL query that retrieves chart of account (CoA) entities stored in LUSID.
Note: By default,
Lusid.ChartOfAccounts
cannot retrieve properties for CoA entities. To do this, you must first configureLusid.ChartOfAccounts
to 'inline' properties. See how to do this.
See also: Lusid.ChartOfAccounts.Writer
Basic usage
select * from Lusid.ChartOfAccounts where <filter-expression>
Query parameters
Lusid.ChartOfAccounts
has parameters that enable you to filter or refine a query.
To list available parameters, their data types, default values, and an explanation for each, run the following query using a suitable tool:
select FieldName, DataType, ParamDefaultValue, Description from Sys.Field where TableName = 'Lusid.ChartOfAccounts' and FieldType = 'Parameter';
Data fields
By default, Lusid.ChartOfAccounts
returns a table of data populated with particular fields (columns). You can return a subset of these fields.
To list fields available to return, their data types, whether fields are considered 'main', and an explanation for each, run the following query using a suitable tool:
select FieldName, DataType, IsMain, IsPrimaryKey, SampleValues, Description from Sys.Field where TableName = 'Lusid.ChartOfAccounts' and FieldType = 'Column';
Note: Fields marked 'main' are returned by queries that select a caret character, for example
select ^ from Lusid.ChartOfAccounts
.
Examples
Note: For more example Luminesce SQL queries, visit our Github repo.
Example 1: Retrieve every CoA
select * from Lusid.ChartOfAccounts;
Example 2: Retrieve a particular CoA
select * from Lusid.ChartOfAccounts where ChartOfAccountsScope = 'Abor' and ChartOfAccountsCode = 'Standard';
Example 3: Retrieve CoAs with particular names
This query retrieves names starting both 's' and 'S'.
select * from Lusid.ChartOfAccounts where DisplayName like 's%';