Customer groups

A customer group categorizes customer dimension records, mainly for the purpose of structuring financial reporting.

List customer groups

get/objects/accounts-receivable/customer-group

Returns a collection with a key, ID, and link for each customer group. This operation is mostly for use in testing; use the query service 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": "Active Customers",
      • "href": "/objects/accounts-receivable/customer-group/1"
      },
    • {
      • "key": "2",
      • "id": "Inactive Customers",
      • "href": "/objects/accounts-receivable/customer-group/2"
      },
    • {
      • "key": "3",
      • "id": "Customers Balance",
      • "href": "/objects/accounts-receivable/customer-group/3"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100
    }
}
Create a customer group
post/objects/accounts-receivable/customer-group
Creates a new customer group.


SecurityOAuth2 
Request 
Request Body schema: application/json
required
Creates a new customer group.


id
required
string
Unique ID for the customer group.


 
 Example:  "CustomerGrp4"
name
required
string
Name of the customer group.


 
 Example:  "Active JC Customers"
description
string
Description of the customer group.


 
 Example:  "Charity service customers"
groupType
string
 Default:  "all"
Specifies the group membership type. The group type and related fields determine which customers are included in the group.


    

  • specific - Specify the customers to include and their order in the groupMembers array.
    • 

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



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


 
object
string
Object type to filter on. Must match the type of object contained in the group, such as company-config/department or company-config/employee.


 
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)
Filters to select the records to return based on their field values. You use operators and conditions to build your filter, such as {"$eq":{"status":"active"}} to select records 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. The 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 customer group and their sort order. Only applicable when the groupType is set to specific.


 
 Array 
key
string
Unique key for the customer.


 
 Example:  "23"
id
string
Unique ID for the customer.


 
 Example:  "23"
isDimensionStructure
boolean
 Default:  false
Indicates whether a dimension structure is created from the group. If true, the group can be added to the rows or columns of a financial report.


 
 Example:  false
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "id": "CustGroup4",
  • "name": "Customer Group 4",
  • "description": "Charity service customers",
  • "groupType": "all",
  • "memberFilter": {
    • "object": "accounts-receivable/customer",
    • "filterExpression": "and",
    • "filters": [
      • {
        }
      ],
    • "orderBy": [
      • {
        }
      ]
    }
}
Response samples 
application/json
{
  • "ia::result": {
    • "id": "CustGroup4"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Get a customer group
get/objects/accounts-receivable/customer-group/{key}
Returns detailed information for a specified customer group.


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


 
 Example:  25
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "15",
    • "id": "CustGroup8",
    • "name": "Customer Group 8",
    • "description": "JV service customers",
    • "groupType": "specific",
    • "memberFilter": {
      • "object": "accounts-receivable/customer",
      • "filterExpression": "and",
      • "orderBy": [
        ]
      },
    • "audit": {
      • "createdDateTime": "2025-03-16T13:26:56Z",
      • "modifiedDateTime": "2025-03-16T13:26:56Z",
      • "createdByUser": {
        },
      • "createdBy": "1",
      • "modifiedByUser": {
        },
      • "modifiedBy": "1"
      },
    • "entity": {
      • "key": null,
      • "id": null,
      • "name": null
      },
    • "groupMembers": [
      • {
        },
      • {
        }
      ],
    • "isDimensionStructure": true,
    • "href": "/objects/accounts-receivable/customer-group/15"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update a customer group
patch/objects/accounts-receivable/customer-group/{key}
Updates an existing customer group by setting field values. Any fields not provided remain unchanged. Providing a new value for the groupMembers array replaces the entire array.


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


 
 Example:  25
Request Body schema: application/json
name
string
Name of the customer group.


 
 Example:  "Active JC Customers"
description
string
Description of the customer group.


 
 Example:  "Charity service customers"
groupType
string
 Default:  "all"
Specifies the group membership type. The group type and related fields determine which customers are included in the group.


    

  • specific - Specify the customers to include and their order in the groupMembers array.
    • 

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



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


 
object
string
Object type to filter on. Must match the type of object contained in the group, such as company-config/department or company-config/employee.


 
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)
Filters to select the records to return based on their field values. You use operators and conditions to build your filter, such as {"$eq":{"status":"active"}} to select records 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. The 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 customer group and their sort order. Only applicable when the groupType is set to specific.


 
 Array 
key
string
Unique key for the customer.


 
 Example:  "23"
id
string
Unique ID for the customer.


 
 Example:  "23"
isDimensionStructure
boolean
 Default:  false
Indicates whether a dimension structure is created from the group. If true, the group can be added to the rows or columns of a financial report.


 
 Example:  false
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "description": "Revised JV service customers",
  • "groupMembers": [
    • {
      • "id": "1"
      },
    • {
      • "id": "2"
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "6",
    • "id": "CustGroup4",
    • "href": "/objects/accounts-receivable/customer-group/6"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Delete a customer group
delete/objects/accounts-receivable/customer-group/{key}
Deletes a customer group.


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


 
 Example:  25
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
    }
}