Organize customers into account groups to simplify reporting.
Returns a collection with a key, ID, and link for each customer account group.
OK
Bad Request
{- "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
}
}
Creates a new customer account group.
id required | string Customer account group name Example: "Top Level customer" |
groupType | string Default: "customer" Customer account group type Example: "customer" |
status | string Default: "active" Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced. Example: "active" |
Created
Bad Request
{- "id": "1099 Customer Group",
- "groupType": "customer",
- "status": "active"
}
{- "ia::result": {
- "key": "18",
- "id": "1099 Customer Group",
- "href": "/objects/accounts-receivable/customer-account-group/18"
}, - "ia::meta": {
- "totalCount": 1
}
}
Returns detailed information for a specified customer account group.
key required | string System-assigned unique key for the customer account group. |
customer-account-group Found
customer-account-group Not Found
{- "ia::result": {
- "id": "HW VGL Group",
- "key": "1",
- "groupType": "customer",
- "status": "inactive",
- "href": "/objects/accounts-receivable/customer-account-group/1"
}, - "ia::meta": {
- "totalCount": 1
}
}
Updates an existing customer account group by setting field values. Any fields not provided remain unchanged.
key required | string System-assigned unique key for the customer account group. |
groupType | string Default: "customer" Customer account group type Example: "customer" |
status | string Default: "active" Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced. Example: "active" |
OK
Bad Request
{- "status": "inactive"
}
{- "ia::result": {
- "key": "18",
- "id": "1099 Customer Group",
- "href": "/objects/accounts-receivable/customer-account-group/18"
}, - "ia::meta": {
- "totalCount": 1
}
}
Deletes a customer account group.
key required | string System-assigned unique key for the customer account group. |
No Content
Bad Request
{- "ia::result": {
- "ia::error": {
- "code": "invalidRequest",
- "message": "A POST request requires a payload",
- "errorId": "REST-1028",
- "additionalInfo": {
- "messageId": "IA.REQUEST_REQUIRES_A_PAYLOAD",
- "placeholders": {
- "OPERATION": "POST"
}, - "propertySet": { }
}, - "supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
}
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 0,
- "totalError": 1
}
}
Queries an object for filtered data.
object | string Object type to query, in the form Example: "accounts-receivable/customer-account-group" | ||||||||
fields | Array of strings List of fields to include in the response. Can be any combination of these:
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 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
These are most useful for queries that you want to save and use repeatedly, such as for views or reports. Just change the For example,
| |||||||||
filterExpression | string Default: "and" Logical operators to apply when there are multiple filter conditions. The conditions in the Shortcuts:
Example: "(1 and 2) or 3" | ||||||||
| |||||||||
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
| |||||||||
start | integer First record of the result set to include in the response. Example: 1 | ||||||||
size | integer Number of records to include in the response. Example: 100 |
OK
Bad Request
{- "object": "accounts-payable/vendor",
- "fields": [
- "id",
- "name",
- "status",
- "href"
], - "filters": [
- {
- "$eq": {
- "status": "active"
}
}, - {
- "$eq": {
- "billingType": "openItem"
}
}
], - "filterExpression": "1 and 2",
- "orderBy": [
- {
- "id": "asc"
}
]
}
{- "ia::result": [
- {
- "id": "Vend-00002",
- "name": "Test vendor",
- "status": "active",
- "href": "/objects/accounts-payable/vendor/85"
}, - {
- "id": "VEND-00010",
- "name": "Design Works",
- "status": "active",
- "href": "/objects/accounts-payable/vendor/111"
}
], - "ia::meta": {
- "totalCount": 2,
- "start": 1,
- "pageSize": 100,
- "next": null,
- "previous": null
}
}