Customer account groups

Organize customers into account groups to simplify reporting.

List customer account groups

get/objects/accounts-receivable/customer-account-group

Returns a collection with a key, ID, and link for each customer account group.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "1",
      • "id": "HW VGL Group",
      • "href": "/objects/accounts-receivable/customer-account-group/1"
      },
    • {
      • "key": "2",
      • "id": "OS VGL Group",
      • "href": "/objects/accounts-receivable/customer-account-group/2"
      },
    • {
      • "key": "3",
      • "id": "Stationary VGL Group",
      • "href": "/objects/accounts-receivable/customer-account-group/3"
      },
    • {
      • "key": "4",
      • "id": "Electronic VGL Group",
      • "href": "/objects/accounts-receivable/customer-account-group/4"
      },
    • {
      • "key": "5",
      • "id": "Gardening VGL Group",
      • "href": "/objects/accounts-receivable/customer-account-group/5"
      },
    • {
      • "key": "6",
      • "id": "Auto VGL Group",
      • "href": "/objects/accounts-receivable/customer-account-group/6"
      },
    • {
      • "key": "7",
      • "id": "Inactive VGL Group",
      • "href": "/objects/accounts-receivable/customer-account-group/7"
      }
    ],
  • "ia::meta": {
    • "totalCount": 7,
    • "start": 1,
    • "pageSize": 100,
    • "next": 0,
    • "previous": 0
    }
}
Create a customer account group
post/objects/accounts-receivable/customer-account-group
Creates a new customer account group.


SecurityOAuth2 
Request 
Request Body schema: application/json
id
required
string
Customer account group name


 
 Example:  "Top Level customer"
groupType
string
 Default:  "customer"
Customer account group type


 Value: "customer"  
 Example:  "customer"
status
string
 Default:  "active"
Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.


 Enum: "active" "inactive"  
 Example:  "active"
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "id": "1099 Customer Group",
  • "groupType": "customer",
  • "status": "active"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "18",
    • "id": "1099 Customer Group",
    • "href": "/objects/accounts-receivable/customer-account-group/18"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Get a customer account group
get/objects/accounts-receivable/customer-account-group/{key}
Returns detailed information for a specified customer account group.


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


 
 Example:  190
Responses 
200
customer-account-group Found


404
customer-account-group Not Found


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "id": "HW VGL Group",
    • "key": "1",
    • "groupType": "customer",
    • "status": "inactive",
    • "href": "/objects/accounts-receivable/customer-account-group/1"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Update a customer account group
patch/objects/accounts-receivable/customer-account-group/{key}
Updates an existing customer account group by setting field values. Any fields not provided remain unchanged.


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


 
 Example:  190
Request Body schema: application/json
groupType
string
 Default:  "customer"
Customer account group type


 Value: "customer"  
 Example:  "customer"
status
string
 Default:  "active"
Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.


 Enum: "active" "inactive"  
 Example:  "active"
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "status": "inactive"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "18",
    • "id": "1099 Customer Group",
    • "href": "/objects/accounts-receivable/customer-account-group/18"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Delete a customer account group
delete/objects/accounts-receivable/customer-account-group/{key}
Deletes a customer account group.


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


 
 Example:  190
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 customer account groups
post/services/core/query
Use the query service to find customer account groups that meet certain criteria and to specify the properties that are returned.


SecurityOAuth2 
Responses 
200
OK


Request samples