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


List Classes

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. Illegal XML characters must be properly encoded. The following SQL operators are supported: <, >, >=, <=, =, like, not like, in, not in. When doing NULL comparisons: IS NOT NULL, IS NULL. Multiple fields may be matched using the AND and OR operators. Joins are not supported. Single quotes in any operands must be escaped with a backslash - For example, the value Erik's Deli would become 'Erik\'s Deli'.
pagesize Optional integer Set a custom page size between 1 and 1000 items (Default: 100)

query

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 The class RECORDNO to get
fields Optional string Comma-separated list of fields on the object to get. For best performance and predictability, limit the number of fields. To return all fields, omit the element or provide * for the value.

Get Class by Name

readByName

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

Parameters

Name Required Type Description
object Required string Use CLASS
keys Required string The class CLASSID to get
fields Optional string Comma-separated list of fields on the object to get. For best performance and predictability, limit the number of fields. To return all fields, omit the element or provide * for the value.

Create Class

create

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

Parameters

Name Required Type Description
CLASS Optional object The object to create

CLASS

Name Required Type Description
CLASSID Required string The 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 fields Optional varies This object supports custom fields.

Update Class

update

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

Parameters

Name Required Type Description
CLASS Optional object The object to update

CLASS

Name Required Type Description
RECORDNO Required integer Record number of class
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 fields Optional varies This object supports custom fields.

Delete Class

delete

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

Parameters

Name Required Type Description
object Required string Use CLASS
keys Required string The class RECORDNO to delete

Provide feedback