The chart of accounts is the base for users tracking financial data.


List Accounts

readByQuery

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

Parameters

Name Required Type Description
object Required string Use GLACCOUNT
fields Required string Comma separated list of fields on the account to list. Use * to return all fields.
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)

Get Account

read

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

Parameters

Name Required Type Description
object Required string Use GLACCOUNT
keys Required string The account RECORDNO to get
fields Required string Comma separated list of fields on the account to get. Use * to return all fields.

Get Account by Name

readByName

<readByName>
    <object>GLACCOUNT</object>
    <keys>6700</keys>
    <fields>*</fields>
</readByName>

Parameters

Name Required Type Description
object Required string Use GLACCOUNT
keys Required string The account ACCOUNTNO to get
fields Required string Comma separated list of fields on the budget to get. Use * to return all fields.

Create Account

create

<create>
    <GLACCOUNT>
        <ACCOUNTNO>6700</ACCOUNTNO>
        <TITLE>Payroll Expense</TITLE>
    </GLACCOUNT>
</create>

Parameters

Name Required Type Description
GLACCOUNT Optional object The object to create

GLACCOUNT

Name Required Type Description
ACCOUNTNO Required string Account number
TITLE Required string Title
CATEGORY Optional string System Category
ACCOUNTTYPE Optional string Account type. Use balancesheet for a Balance Sheet Account otherwise use incomestatement for an Income Statement Account (Default: balancesheet)
NORMALBALANCE Optional string Normal balance of account. Use debit for Debit otherwise use credit for Credit (Default: debit)
CLOSINGTYPE Optional string Period end closing type. Use non-closing account for Non-Closing Account otherwise use closing account for Closing Account (Default: non-closing account)
CLOSINGACCOUNTNO Optional string Close into account number. Required if CLOSINGTYPE is set to closing account
ALTERNATIVEACCOUNT Optional string GL account alternative. Use None for None, Payables account for Payables Account, or Receivables account for Receivables Account (Default: None)
STATUS Optional string Account status. Use active for Active otherwise use inactive for Inactive (Default: active)
REQUIREDEPT Optional boolean Use true to make department required for this account, otherwise use false. (Default: false)
REQUIRELOC Optional boolean Use true to make location required for this account, otherwise use false. (Default: false)
REQUIREPROJECT Optional boolean Use true to make project required for this account, otherwise use false. (Default: false)
REQUIRECUSTOMER Optional boolean Use true to make customer required for this account, otherwise use false. (Default: false)
REQUIREVENDOR Optional boolean Use true to make vendor required for this account, otherwise use false. (Default: false)
REQUIREEMPLOYEE Optional boolean Use true to make employee required for this account, otherwise use false. (Default: false)
REQUIREITEM Optional boolean Use true to make item required for this account, otherwise use false. (Default: false)
REQUIRECLASS Optional boolean Use true to make class required for this account, otherwise use false. (Default: false)
REQUIRETASK Optional boolean Use true to make task required for this account, otherwise use false. (Default: false)
REQUIREGLDIM* Optional boolean Use true to make user defined dimension required for this account, otherwise use false. UDD object integration name usually appended to REQUIREGLDIM (Default: false)

Update Account

update

<update>
    <GLACCOUNT>
        <RECORDNO>141</RECORDNO>
        <TITLE>Payroll Expenses</TITLE>
    </GLACCOUNT>
</update>

Parameters

Name Required Type Description
GLACCOUNT Optional object The object to update

GLACCOUNT

Name Required Type Description
RECORDNO Required integer Record number of account
TITLE Optional string Title
CATEGORY Optional string System Category
ACCOUNTTYPE Optional string Account type. Use balancesheet for a Balance Sheet Account otherwise use incomestatement for an Income Statement Account (Default: balancesheet)
NORMALBALANCE Optional string Normal balance of account. Use debit for Debit otherwise use credit for Credit (Default: debit)
CLOSINGTYPE Optional string Period end closing type. Use non-closing account for Non-Closing Account otherwise use closing account for Closing Account (Default: non-closing account)
CLOSINGACCOUNTNO Optional string Close into account number. Required if CLOSINGTYPE is set to closing account
ALTERNATIVEACCOUNT Optional string GL account alternative. Use None for None, Payables account for Payables Account, or Receivables account for Receivables Account (Default: None)
STATUS Optional string Account status. Use active for Active otherwise use inactive for Inactive (Default: active)
REQUIREDEPT Optional boolean Use true to make department required for this account, otherwise use false. (Default: false)
REQUIRELOC Optional boolean Use true to make location required for this account, otherwise use false. (Default: false)
REQUIREPROJECT Optional boolean Use true to make project required for this account, otherwise use false. (Default: false)
REQUIRECUSTOMER Optional boolean Use true to make customer required for this account, otherwise use false. (Default: false)
REQUIREVENDOR Optional boolean Use true to make vendor required for this account, otherwise use false. (Default: false)
REQUIREEMPLOYEE Optional boolean Use true to make employee required for this account, otherwise use false. (Default: false)
REQUIREITEM Optional boolean Use true to make item required for this account, otherwise use false. (Default: false)
REQUIRECLASS Optional boolean Use true to make class required for this account, otherwise use false. (Default: false)
REQUIRETASK Optional boolean Use true to make task required for this account, otherwise use false. (Default: false)
REQUIREGLDIM* Optional boolean Use true to make user defined dimension required for this account, otherwise use false. UDD object integration name usually appended to REQUIREGLDIM (Default: false)

Delete Account

delete

<delete>
    <object>GLACCOUNT</object>
    <keys>112</keys>
</delete>

Parameters

Name Required Type Description
object Required string Use GLACCOUNT
keys Required string The account RECORDNO to delete

List Entity Level Account Titles

readByQuery

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

Parameters

Name Required Type Description
object Required string Use ACCTTITLEBYLOC
fields Required string Comma separated list of fields on the title to list. Use * to return all fields.
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)

Get Entity Level Account Title

read

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

Parameters

Name Required Type Description
object Required string Use ACCTTITLEBYLOC
keys Required string The title RECORDNO to get
fields Required string Comma separated list of fields on the title to get. Use * to return all fields.

Provide feedback