Skip to main content

GetListInfo Function

GetListInfo Function

Description

The GetListInfo function makes it easy to return any needed list information based on a list's name, number, or identifying field.

Function Arguments

Argument NameInput Information
List NameThe exact name of a list from the Data Retrieval > From List selection
Name/Number/IdentifierThe exact name, number or identifier (Id) from the list selected will allow this function to hone in on the row to look at
Property NameThe exact name of a column header from the list selected that will be used to return the value for that property based on the row identified from the name/number/identifier
PrefixOptional Parameter to add a string value to the start of the returned list information
SuffixOptional input to add a string value to the end of the returned list information

Remarks

To ensure proper names are being used for each argument, utilize the dropdown options when possible. Additionally, pull in any list to review what information you're trying to return.

Example

Let's say a user wants to return the AccountCategory for each account number in order to properly group assets and liabilities based on accounts for a balance sheet. They can use the GetListInfo function to do this.

  1. Select Finsyte Functions > GetListInfo
  2. Fill in the arguments. List Name is "GL Accounts", Name should link to the AccountNumber and Property Name should reference "AccountCategory" as seen in the GL Accounts list. GetListInfo
  3. Apply the function down the list of GL Accounts to see the AccountCategory change when accounts switch from Assets to Liabilities to Equity. Account Category

Note: The Prefix can be great for more easily returning cell labels like "Total - Liabilities" rather than having to concatenate "Liabilities" to a string after returning a list value.