Customer types provide a way to group customers into categories, such as reseller and end user. Setting up meaningful customer types streamlines management and analysis of customer information.
Returns a collection with a key, ID, and link for each customer type. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned.
Subscription | Accounts Receivable |
---|---|
User type | Business, Employee, Project Manager, and Warehouse |
Permissions | List, View Customer Types |
OK
Bad Request
{- "ia::result": [
- {
- "key": "1",
- "id": "Account Manager",
- "href": "/objects/accounts-receivable/customer-type/1"
}, - {
- "key": "2",
- "id": "Auto ACH",
- "href": "/objects/accounts-receivable/customer-type/2"
}, - {
- "key": "3",
- "id": "Auto CC Payment",
- "href": "/objects/accounts-receivable/customer-type/3"
}, - {
- "key": "4",
- "id": "Credit Card",
- "href": "/objects/accounts-receivable/customer-type/4"
}
], - "ia::meta": {
- "totalCount": 4,
- "start": 1,
- "pageSize": 100,
- "next": 0,
- "previous": 0
}
}
Creates a new customer type.
Subscription | Accounts Receivable |
---|---|
User type | Business |
Permissions | List, View, Add Customer Types |
id required | string Name of the customer type. Example: "Top Level 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" | ||||
object Parent of a subordinate customer type. | |||||
|
Created
Bad Request
{- "id": "Top Level Customer",
- "status": "active"
}
{- "ia::result": {
- "key": "9",
- "id": "Client Start Trial",
- "href": "/objects/accounts-receivable/customer-type/9"
}, - "ia::meta": {
- "totalCount": 1
}
}
Returns detailed information for a specified customer type.
Subscription | Accounts Receivable |
---|---|
User type | Business |
Permissions | List, View Customer Types |
key required | string System-assigned key for the customer type. Example: 4 |
OK
Bad Request
{- "ia::result": {
- "id": "Client Start Trial",
- "parent": {
- "key": "1",
- "id": "Account Manager"
}, - "status": "active",
- "key": "9",
- "audit": {
- "createdDateTime": "2022-01-07T06:18:51Z",
- "modifiedDateTime": "2022-01-07T06:18:51Z",
- "createdBy": "1",
- "modifiedBy": "1"
}, - "entity": {
- "key": null,
- "id": null,
- "name": null
}, - "href": "/objects/accounts-receivable/customer-type/9"
}, - "ia::meta": {
- "totalCount": 1
}
}
Updates an existing customer type by setting field values. Any fields not provided remain unchanged.
Subscription | Accounts Receivable |
---|---|
User type | Business |
Permissions | List, View, Edit Customer Types |
key required | string System-assigned key for the customer type. Example: 4 |
status | string Default: "active" Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced. Example: "active" | ||||
object Parent of a subordinate customer type. | |||||
|
OK
Bad Request
{- "status": "inactive"
}
{- "ia::result": {
- "key": "2",
- "id": "Auto ACH",
- "href": "/objects/accounts-receivable/customer-type/2"
}, - "ia::meta": {
- "totalCount": 1
}
}
Deletes a customer type.
Subscription | Accounts Receivable |
---|---|
User type | Business |
Permissions | List, View, Delete Customer Types |
key required | string System-assigned key for the customer type. Example: 4 |
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-type" | ||||||||
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-receivable/customer-type",
- "filters": [
- {
- "$eq": {
- "status": "active"
}
}
], - "fields": [
- "key",
- "id",
- "href"
], - "orderBy": [
- {
- "id": "asc"
}
]
}
{- "ia::result": [
- {
- "key": "2",
- "id": "Customer - Channel",
- "href": "/objects/accounts-receivable/customer-type/2"
}, - {
- "key": "1",
- "id": "Customer - Direct",
- "href": "/objects/accounts-receivable/customer-type/1"
}, - {
- "key": "5",
- "id": "Partner",
- "href": "/objects/accounts-receivable/customer-type/5"
}, - {
- "key": "4",
- "id": "Partners",
- "href": "/objects/accounts-receivable/customer-type/4"
}, - {
- "key": "6",
- "id": "Platinum Level Customer",
- "href": "/objects/accounts-receivable/customer-type/6"
}
], - "ia::meta": {
- "totalCount": 5,
- "start": 1,
- "pageSize": 100,
- "next": null,
- "previous": null
}
}