Custom List
Returns CustomLists and their CustomListValues
Date Released: Feb 2021 Date Updated: Feb 2021
Please note: While accessibility via the API is available to both AccountRight and new Essentials files. Not all features will be displayed in Product for new Essentials
The elements list below details information for Custom List. To view the descriptions for the elements you can either hover any attribute to reveal details or click here to show all details inline.
Items shown with are required when posting or puting data
Items shown with are read-only elements
Attribute Details
- ItemsArray
- The following information pulls through Custom List Name and Custom List value details.
-
- ListIDInteger
- ....
- IsSystemBoolean
- Returns a true or false value to determine if it is a system made Custom list.
- ListIndexInteger
- .......
- ListNameString
- Name of the Custom List.
- ListTypeString
- Type of Custom List eg. Item, Customer, Supplier, Employee.
- ValuesArray
- The following information is the Custom List values for this Custom List.
- ValueString
- Name of the Custom List Value.
Example json GET response
- {
- "Items": [
- {
- "ListId": 1,
- "IsSystem": true,
- "ListIndex": 0,
- "ListName": "Product Source",
- "ListType": "Item",
- "Values": [
- {
- "Value": "VIC"
- },
- {
- "Value": "NSW"
- },
- {
- "Value": "WA"
- }
- ]
- }
- ]
- }
