Item groups

An item group categorizes item dimension records, mainly for the purpose of structuring financial reporting.

List item group objects

get/objects/inventory-control/item-group

Returns up to 100 item group references from the collection with a key, ID, and link for each item group. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "1",
      • "id": "Top Level Items",
      • "href": "/objects/inventory-control/item-group/1"
      },
    • {
      • "key": "5",
      • "id": "Items with Activity",
      • "href": "/objects/inventory-control/item-group/5"
      },
    • {
      • "key": "6",
      • "id": "Costing Group",
      • "href": "/objects/inventory-control/item-group/6"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Create an item group
post/objects/inventory-control/item-group
Creates a new item group.


SecurityOAuth2 
Request 
Request Body schema: application/json
Create a new item group


id
required
string
Unique identifier for the Item group.


 
 Example:  "1st Level Items"
name
required
string
Name of the item group.


 
 Example:  "Level 1 Items"
groupType
required
string
Group membership type. The group type and related fields determine which items are included in the group. If you are creating reports that use items in rows or columns, these fields also determine the column headings and row headings that will appear, and the order in which they will be listed.


    

  • specific - Specify the items to include and their order in the groupMembers array. You can optionally filter the array with the memberFilter settings.
    • 

  • all - All items that match the memberFilter criteria.
    • 



 Enum: "all" "specific"  
 Example:  "all"
description
string
Description about the item group.


 
 Example:  "Level 1 Items"
object
One or more filters to select the items to include in the item group. Can be used in addition to the groupMembers array to filter from a selected list of items.


 
object
string
Object type to filter on.


 
 Example:  "accounts-payable/vendor"
Array of equal (object) or not equal (object) or less than (object) or (less than or equal (object)) or greater than (object) or (greater than or equal (object)) or in (object) or not in (object) or contains (object) or does not contain (object) or starts with (object) or does not start with (object) or ends with (object) or does not end with (object)
Filter conditions to select the objects to return based on their field values. You use operators and conditions to build your filter, such as {"$eq":{"status":"active"}} to select objects in which status is equal to "active".


 
 Example:  [{"$eq":{"status":"active"}},{"$gt":{"totalDue":"1000"}},{"$contains":{"name":"Acme"}}]
 Array 
Any of:
Field value must be equal to this specified value.


object
The field name and value to be compared with object values.


 
 Example:  {"status":"active"}
filterExpression
string
 Default:  "and"
Logical operators to apply when there are multiple filter conditions. The conditions in the filters array are implicitly numbered starting at 1. Supports and, or, and grouping with parentheses.


Shortcuts:


    

  • and by itself means that all conditions must be true.
    • 

  • or by itself means that at least one condition must be true.
    • 



 
 Example:  "(1 and 2) or 3"
Array of objects  <= 1 items 
Sort order for the results that match the filters when the group is displayed in reports. Each entry consists of a field name to sort by and whether it should be sorted in ascending or descending order.


 
 Example:  [{"id":"asc"}]
 Array (<= 1 items)
property name*
additional property
string
 Enum: "asc" "desc"  
size
integer
The maximum number of records that match the filters to include in the group when it is displayed in reports.


 
 Example:  100
Array of objects
Members of the item group and their sort order. Only applicable when groupType = specific.


 
 Array 
object
Item group that this item is a member of.


 
object
Item that is a member of the group.


 
sortOrder
integer
Sort Order of the item within the item group.


 
 Example:  1
object
General ledger (GL) account group associated with the item group.


 
key
string
 
 Example:  "23"
id
string
ID for the gl-account-group.


 
 Example:  "1st Level Items"
createDimensionComponents
boolean
 Default:  false
Set to 'true' to create a dimension structure that enables the group to be used on the rows and columns of financial reports. If this field is set to false, the group can only be used for filtering.


 
 Example:  true
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "id": "InsuranceItemsGroup",
  • "name": "Insurance Items Group",
  • "description": "Items that require insurance",
  • "groupType": "specific",
  • "createDimensionComponents": true,
  • "memberFilter": {
    • "object": "inventory-control/item",
    • "filterExpression": "and",
    • "orderBy": [
      • {
        }
      ]
    },
  • "groupMembers": [
    • {
      • "item": {
        },
      • "sortOrder": 0
      },
    • {
      • "item": {
        },
      • "sortOrder": 1
      },
    • {
      • "item": {
        },
      • "sortOrder": 2
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "14",
    • "id": "InsuranceItemsGroup",
    • "href": "/objects/inventory-control/item-group/14"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Get an item group
get/objects/inventory-control/item-group/{key}
Returns detailed information for a specified item group.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the item group.


 
 Example:  176
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "12",
    • "id": "BooksGroup",
    • "name": "BooksGroup",
    • "description": "Group for Books",
    • "groupType": "all",
    • "memberFilter": {
      • "object": "inventory-control/item",
      • "filterExpression": "and",
      • "filters": [
        ],
      • "orderBy": [
        ]
      },
    • "audit": {
      • "createdDateTime": "2023-12-12T23:33:05Z",
      • "modifiedDateTime": "2023-12-12T23:33:05Z",
      • "createdBy": "1",
      • "modifiedBy": "1"
      },
    • "glAccountGroup": {
      • "id": "BooksGroup"
      },
    • "groupMembers": [ ],
    • "href": "/objects/inventory-control/item-group/12"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update an item group
patch/objects/inventory-control/item-group/{key}
Updates an existing item group by setting field values. Any fields not provided remain unchanged.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the item group.


 
 Example:  176
Request Body schema: application/json
name
string
Name of the item group.


 
 Example:  "Level 1 Items"
description
string
Description about the item group.


 
 Example:  "Level 1 Items"
groupType
string
Group membership type. The group type and related fields determine which items are included in the group. If you are creating reports that use items in rows or columns, these fields also determine the column headings and row headings that will appear, and the order in which they will be listed.


    

  • specific - Specify the items to include and their order in the groupMembers array. You can optionally filter the array with the memberFilter settings.
    • 

  • all - All items that match the memberFilter criteria.
    • 



 Enum: "all" "specific"  
 Example:  "all"
object
One or more filters to select the items to include in the item group. Can be used in addition to the groupMembers array to filter from a selected list of items.


 
object
string
Object type to filter on.


 
 Example:  "accounts-payable/vendor"
Array of equal (object) or not equal (object) or less than (object) or (less than or equal (object)) or greater than (object) or (greater than or equal (object)) or in (object) or not in (object) or contains (object) or does not contain (object) or starts with (object) or does not start with (object) or ends with (object) or does not end with (object)
Filter conditions to select the objects to return based on their field values. You use operators and conditions to build your filter, such as {"$eq":{"status":"active"}} to select objects in which status is equal to "active".


 
 Example:  [{"$eq":{"status":"active"}},{"$gt":{"totalDue":"1000"}},{"$contains":{"name":"Acme"}}]
 Array 
Any of:
Field value must be equal to this specified value.


object
The field name and value to be compared with object values.


 
 Example:  {"status":"active"}
filterExpression
string
 Default:  "and"
Logical operators to apply when there are multiple filter conditions. The conditions in the filters array are implicitly numbered starting at 1. Supports and, or, and grouping with parentheses.


Shortcuts:


    

  • and by itself means that all conditions must be true.
    • 

  • or by itself means that at least one condition must be true.
    • 



 
 Example:  "(1 and 2) or 3"
Array of objects  <= 1 items 
Sort order for the results that match the filters when the group is displayed in reports. Each entry consists of a field name to sort by and whether it should be sorted in ascending or descending order.


 
 Example:  [{"id":"asc"}]
 Array (<= 1 items)
property name*
additional property
string
 Enum: "asc" "desc"  
size
integer
The maximum number of records that match the filters to include in the group when it is displayed in reports.


 
 Example:  100
Array of objects
Members of the item group and their sort order. Only applicable when groupType = specific.


 
 Array 
object
Item group that this item is a member of.


 
object
Item that is a member of the group.


 
sortOrder
integer
Sort Order of the item within the item group.


 
 Example:  1
object
General ledger (GL) account group associated with the item group.


 
key
string
 
 Example:  "23"
id
string
ID for the gl-account-group.


 
 Example:  "1st Level Items"
createDimensionComponents
boolean
 Default:  false
Set to 'true' to create a dimension structure that enables the group to be used on the rows and columns of financial reports. If this field is set to false, the group can only be used for filtering.


 
 Example:  true
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "description": "Group for Reference Books"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "12",
    • "id": "BooksGroup",
    • "href": "/objects/inventory-control/item-group/12"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Delete an item group
delete/objects/inventory-control/item-group/{key}
Deletes an item group. An item group can be deleted if it is not being used for reporting.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the item group.


 
 Example:  176
Responses 
204
No Content


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "ia::error": {
      • "code": "invalidRequest",
      • "message": "A POST request requires a payload",
      • "errorId": "REST-1028",
      • "additionalInfo": {
        },
      • "supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
      }
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 0,
    • "totalError": 1
    }
}
Query item groups
post/services/core/query
Queries an object for filtered data.


SecurityOAuth2 
Request 
Request Body schema: application/json
object
string
Object type to query, in the form <application-name>/<object name>. For custom objects use platform-apps/nsp::<object-name>.


 
 Example:  "inventory-control/item-group"
fields
Array of strings
List of fields to include in the response. Can be any combination of these:


    

  • The name of a field in the object that you are querying, such as id.
    

    • 

  • The name of a field in a related object, using the form relatedObjectName.fieldName, such as vendor.id.
    

    • 

  • The result of an aggregate function run against the values in the returned objects. Use the form function:fieldName, such as min:startDate to return the earliest starting date. Valid function names are:
    

      

    • count
      • 

    • avg
      • 

    • sum
      • 

    • min
      • 

    • max
      • 

    

    • 

  • The result of an aggregate function run against the values in related objects, using the form function:relatedObjectName.fieldName, such as max:vendor.creditLimit. The same functions are supported as for object fields.
    

    • 



 
 Example:  ["key","id","max:vendor.creditLimit"]
Array of equal (object) or not equal (object) or less than (object) or (less than or equal (object)) or greater than (object) or (greater than or equal (object)) or in (object) or not in (object) or between (object) or not between (object) or contains (object) or does not contain (object) or starts with (object) or does not start with (object) or ends with (object) or does not end with (object)
Filter conditions to select the objects to return based on their field values. You use operators and conditions to build your filter, such as {"$eq":{"status":"active"}} to select objects in which status is equal to "active".


 
 Example:  [{"$eq":{"status":"active"}},{"$gt":{"totalDue":"1000"}},{"$contains":{"name":"Acme"}}]
 Array 
Any of:
Field value must be equal to this specified value.


For date fields, you can use these macro values that are relative to the current date or the asOfDate in filterParameters, if set:







    

  • today

  • currentWeek

  • currentMonth

  • currentQuarter

  • currentYear





    

  • yesterday

  • lastWeek

  • priorMonth

  • priorQuarter

  • priorYear









These are most useful for queries that you want to save and use repeatedly, such as for views or reports. Just change the asOfDate each time to retrieve the same data set for different time periods.


For example, {"eq":{"postingDate":"priorYear"}}.


object
The field name and value to be compared with object values.


 
 Example:  {"status":"active"}
filterExpression
string
 Default:  "and"
Logical operators to apply when there are multiple filter conditions. The conditions in the filters array are implicitly numbered starting at 1. Supports and, or, and grouping with parentheses.


Shortcuts:


    

  • and by itself means that all conditions must be true.
    • 

  • or by itself means that at least one condition must be true.
    • 



 
 Example:  "(1 and 2) or 3"
object

Pre-defined filter options.


 
asOfDate
string <date> 
The "as of" date to use with any relative date comparisons in filters. For example, if asOfDate is set to "2022-04-01" then priorMonth will be "03".


The current date is used if asOfDate is not set.


 
 Example:  "2022-04-01"
includeHierarchyFields
boolean
 Default:  false
Set to true to include hierarchical structure information with each object in the response.


 
 Example:  false
caseSensitiveComparison
boolean
 Default:  true
Queries are case-sensitive by default. Set to false to ignore case in a query.


 
 Example:  true
includePrivate
boolean
 Default:  false
By default, in a multi-entity company queries from the top-level entity do not access data in private entities. Set includePrivate to true if you want to query data in private entities.


 
 Example:  false
Array of objects
Set the order of the results by specifying field names to sort by and whether they should be in ascending or descending order.


 
 Example:  [{"totalDue":"asc"},{"lastPaymentMadeDate":"desc"}]
 Array 
property name*
additional property
string
 Enum: "asc" "desc"  
start
integer
First record of the result set to include in the response.


 
 Example:  1
size
integer
Number of records to include in the result set, 4000 maximum.


 
 Example:  100
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "object": "inventory-control/item-group",
  • "filters": [
    • {
      • "$eq": {
        }
      }
    ],
  • "fields": [
    • "key",
    • "name",
    • "groupType",
    • "glAccountGroup.key"
    ],
  • "orderBy": [
    • {
      • "id": "asc"
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "2",
      • "name": "Level 1 Items",
      • "groupType": "specific",
      • "glAccountGroup.key": "103"
      },
    • {
      • "key": "3",
      • "name": "Level 2 Items",
      • "groupType": "specific",
      • "glAccountGroup.key": "104"
      },
    • {
      • "key": "4",
      • "name": "Level 3 Items",
      • "groupType": "specific",
      • "glAccountGroup.key": "105"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}