Customer Types

A customer type is a user-defined type, such as reseller or end user, that can be used to tag customers.

Customer types are mainly used for reporting under AR and Order Entry.

Get Customer Type Object Definition

List all the fields and relationships for the customer type object:

<lookup>
    <object>CUSTTYPE</object>
</lookup>

Name	Required	Type	Description
object	Required	string	Use `CUSTTYPE`

List information about each customer type:

<query>
    <object>CUSTTYPE</object>
    <select>
        <field>RECORDNO</field>
        <field>NAME</field>
    </select>
</query>

Name	Required	Type	Description
object	Required	string	Use `CUSTTYPE`
filter	Optional	object	Filter expression to limit the response to only objects that match the expression. Check the value of a single field using operators such as equalto/like, or multiple fields using and/or. Query fields on related objects using the dot operator (for example, `VENDOR.CREDITLIMIT` on APBILL).
select	Required	sequence	The names of the fields that you want included in the response, and an optional aggregate function such as `count` or `sum`. Returning all fields is not supported.
orderby	Optional	object	Provide an `order` element with a field name and choose an ascending or descending sort order, for example: `<order> <field>RECORDNO</field> <descending/> </order>`
options	Optional	object	Query options: Set the `caseinsensitive` element to `true` for a case-insensitive query `<caseinsensitive>true</caseinsensitive>` In a multi-entity company, set the `showprivate` element to `true` to query data in private entities: `<showprivate>true</showprivate>` Specify the `returnformat` for the response: `xml` (default), `json`, or `csv` `<returnformat>json</returnformat>`
pagesize	Optional	integer	Maximum number of matching objects to return in the response, between `1` and `2000` items (Default: `100`)
offset	Optional	integer	Point at which to start indexing into records (Default: `0`)

<readByQuery>
    <object>CUSTTYPE</object>
    <fields>*</fields>
    <query></query>
    <pagesize>100</pagesize>
</readByQuery>

Name	Required	Type	Description
object	Required	string	Use `CUSTTYPE`
fields	Optional	string	Comma-separated list of fields on the object to list. For best performance and predictability, limit the number of fields. To return all fields, omit the element or provide `*` for the value.
query	Required	string	SQL-like query based on fields on the object. The following operators are supported: `<`, `>`, `>=`, `<=`, `=`, `like`, `not like`, `in`, `not in`, `IS NOT NULL`, `IS NULL`, `AND`, `OR`. Illegal XML characters must be properly encoded, and single quotes must be escaped with backslashes (`'Jane\'s Deli'`). Joins are not supported.
pagesize	Optional	integer	Custom page size between `1` and `1000` items (Default: `100`)

<read>
    <object>CUSTTYPE</object>
    <keys>1</keys>
    <fields>*</fields>
</read>

Name	Required	Type	Description
object	Required	string	Use `CUSTTYPE`
keys	Required	string	Comma-separated list of object `RECORDNO` to get
fields	Optional	string	Comma-separated list of fields on the object to get. To return all fields, omit the element or provide `*` for the value. For best performance and predictability, limit the number of fields.
returnFormat	Optional	string	Data format for the response body: `xml` (default) `json` `csv`

<readByName>
    <object>CUSTTYPE</object>
    <keys>N15</keys>
    <fields>*</fields>
</readByName>

Name	Required	Type	Description
object	Required	string	Use `CUSTTYPE`
keys	Required	string	Comma-separated list of object `NAME` to get
fields	Optional	string	Comma-separated list of fields on the object to get. To return all fields, omit the element or provide `*` for the value. For best performance and predictability, limit the number of fields.
returnFormat	Optional	string	Data format for the response body: `xml` (default) `json` `csv`