Classes

Class is a dimension that can be defined by the company and set on transactions to expand report functionality and insight.

Get Class Object Definition

lookup

List all the fields and relationships for the class object:

<lookup>
    <object>CLASS</object>
</lookup>

Parameters

Name Required Type Description
object Required string Use CLASS

Query and List Classes

query

List the record number and class ID for each class:

<query>
    <object>CLASS</object>
    <select>
        <field>RECORDNO</field>
        <field>CLASSID</field>
    </select>
</query>

Parameters

Name Required Type Description
object Required string Use CLASS
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)

Query and List Classes (Legacy)

readByQuery

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

Parameters

Name Required Type Description
object Required string Use CLASS
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)

query Fields

Name Required Type Description
STATUS Optional string Status. Use T for Active and F for Inactive.

Get Class

read

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

Parameters

Name Required Type Description
object Required string Use CLASS
keys Required string Comma-separated list of class 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

Get Class by ID

readByName

<readByName>
    <object>CLASS</object>
    <keys>TEST</keys>
    <fields>*</fields>
</readByName>

Parameters

Name Required Type Description
object Required string Use CLASS
keys Required string Comma-separated list of class CLASSID 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

Create Class

create

<create>
    <CLASS>
        <CLASSID>C1234</CLASSID>
        <NAME>hello world</NAME>
    </CLASS>
</create>

Parameters

Name Required Type Description
CLASS Required object Object to create

CLASS

Name Required Type Description
CLASSID Required string Class ID to create
NAME Required string Class name
DESCRIPTION Optional string Description
PARENTID Optional string Parent class ID
STATUS Optional string Class status. Use active for Active otherwise use inactive for Inactive (Default: active)
Custom field name varies varies Custom field names and values as defined for this object.
For a multi-pick-list custom field, implode multiple field values with #~#.

Create Class (Legacy)

create_class

<create_class>
    <classid>C1234</classid>
    <name>hello world</name>
</create_class>

Parameters

Name Required Type Description
classid Required string Class ID to create
name Required string Class name
description Optional string Description
parentid Optional string Parent class ID
status Optional string Class status. Use active for Active otherwise use inactive for Inactive (Default: active)
customfields Optional array of customfield Custom fields

customfield

Name Required Type Description
customfieldname Optional string Custom field ID
customfieldvalue Optional varies Custom field value. For a multi-pick-list custom field, implode multiple field values with #~#.

Update Class

update

<update>
    <CLASS>
        <RECORDNO>12</RECORDNO>
        <NAME>hello world</NAME>
    </CLASS>
</update>

Parameters

Name Required Type Description
CLASS Required object Object to update

CLASS

Name Required Type Description
RECORDNO Optional integer Record number of class to update. Required if not using CLASSID.
CLASSID Optional string Class ID. Required if not using RECORDNO.
NAME Optional string Class name
DESCRIPTION Optional string Description
PARENTID Optional string Parent class ID
STATUS Optional string Class status. Use active for Active otherwise use inactive for Inactive. (Default: active)
Custom field name varies varies Custom field names and values as defined for this object.
For a multi-pick-list custom field, implode multiple field values with #~#.

Update Class (Legacy)

update_class

<update_class key="C1234">
    <name>hello world</name>
</update_class>

Parameters

Name Required Type Description
key Required string Class ID to update
name Optional string Class name
description Optional string Description
parentid Optional string Parent class ID
status Optional string Class status. Use active for Active otherwise use inactive for Inactive. (Default: active)
customfields Optional array of customfield Custom fields

customfield

Name Required Type Description
customfieldname Optional string Custom field ID
customfieldvalue Optional varies Custom field value. For a multi-pick-list custom field, implode multiple field values with #~#.

Delete Class

delete

<delete>
    <object>CLASS</object>
    <keys>112</keys>
</delete>

Parameters

Name Required Type Description
object Required string Use CLASS
keys Required string Comma-separated list of class RECORDNO to delete

Delete Class (Legacy)

delete_class

<delete_class key="C1234"></delete_class>

Parameters

Name Required Type Description
key Required string Class ID to delete

Provide feedback