Account group purposes let you filter account groups according to why you might use them, which is particularly useful in financial reporting. You create account group purposes, which you can then designate when creating or updating your account groups.

NEW!


List Account Group Purposes

readByQuery

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

Parameters

Name Required Type Description
object Required string Use GLACCTGRPPURPOSE
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 Custom page size between 1 and 1000 items (Default: 100)
Name Required Type Description
STATUS Optional string Status. Use T for Active and F for Inactive.

Get Account Group Purpose

read

<read>
    <object>GLACCTGRPPURPOSE</object>
    <keys>11</keys>
    <fields>*</fields>
</read>

Parameters

Name Required Type Description
object Required string Use GLACCTGRPPURPOSE
keys Required string Account group purpose 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 Account Group Purpose by Name

readByName

<readByName>
    <object>GLACCTGRPPURPOSE</object>
    <keys>Budgeted Expenses</keys>
    <fields>*</fields>
</readByName>

Parameters

Name Required Type Description
object Required string Use GLACCTGRPPURPOSE
keys Required string Account group purpose name 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 Account Group Purpose

create

<create>
    <GLACCTGRPPURPOSE>
        <NAME>Budgeted Expenses</NAME>
    </GLACCTGRPPURPOSE>
</create>

Parameters

Name Required Type Description
GLACCTGRPPURPOSE Required object Object to update

GLACCTGRPPURPOSE

Name Required Type Description
NAME Required string Name for the account group purpose
STATUS Optional boolean Status of account group purpose. Use active or inactive. (Default: active)

Update Account Group Purpose

update

<update>
    <GLACCTGRPPURPOSE>
        <RECORDNO>6</RECORDNO>
        <STATUS>inactive</STATUS>
    </GLACCTGRPPURPOSE>
</update>

Parameters

Name Required Type Description
GLACCTGRPPURPOSE Required object Object to update

GLACCTGRPPURPOSE

Name Required Type Description
RECORDNO Optional integer Record number of account group purpose to update.
STATUS Optional string Use active for Active, otherwise inactive for Inactive.

Delete Account Group Purpose

delete

<delete>
    <object>GLACCTGRPPURPOSE</object>
    <keys>6</keys>
</delete>

Parameters

Name Required Type Description
object Required string Use GLACCTGRPPURPOSE
keys Required string Account group purpose RECORDNO to delete

Provide feedback