A budget is a plan to help estimate revenue and expenses for operations. Budget amounts are uploaded early in the cycle (month or quarter), and then are used at the end of the cycle to compare against actuals.


List Budgets

readByQuery

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

Parameters

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

Get Budget

read

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

Parameters

Name Required Type Description
object Required string Use BUDGETHEADER
keys Required string The budget 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 Budget by Name

readByName

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

Parameters

Name Required Type Description
object Required string Use BUDGETHEADER
keys Required string The budget BUDGETID 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 Budget

create

<create>
    <BUDGETHEADER>
        <BUDGETID>TEST1</BUDGETID>
        <DESCRIPTION>TEST1</DESCRIPTION>
        <DEFAULT_BUDGET>true</DEFAULT_BUDGET>
        <CREATIONTYPE>New</CREATIONTYPE>
        <COPYFROM>TEST</COPYFROM>
        <REPORTINGPERIODFROM>Month Ended Apr 30, 2002</REPORTINGPERIODFROM>
        <REPORTINGPERIODTO>Month Ended Nov 30, 2002</REPORTINGPERIODTO>
        <ISCONSOLIDATED></ISCONSOLIDATED>
        <CURRENCY></CURRENCY>
    </BUDGETHEADER>
</create>

Parameters

Name Required Type Description
BUDGETHEADER Optional object The object to create

BUDGETHEADER

Name Required Type Description
BUDGETID Required string Budget ID
DESCRIPTION Required string Description of budget
DEFAULT_BUDGET Optional boolean Use true to make this the company’s default budget otherwise use false
CREATIONTYPE Optional string Use New to create a new budget otherwise use Copy to create from an existing budget
COPYFROM Optional string Required if CREATIONTYPE is Copy, enter a budget ID
REPORTINGPERIODFROM Optional string Required if CREATIONTYPE is Copy, enter a reporting period name to start from
REPORTINGPERIODTO Optional string Required if CREATIONTYPE is Copy, enter a reporting period name to end at
ISCONSOLIDATED Optional boolean Use true to make this a consolidated budget otherwise use false
CURRENCY Optional string Consolidation currency. Required if ISCONSOLIDATED is set to true

Update Budget

update

<update>
    <BUDGETHEADER>
        <RECORDNO>12</RECORDNO>
        <DESCRIPTION>TEST1</DESCRIPTION>
        <DEFAULT_BUDGET>true</DEFAULT_BUDGET>
    </BUDGETHEADER>
</update>

Parameters

Name Required Type Description
BUDGETHEADER Optional object The object to update

BUDGETHEADER

Name Required Type Description
RECORDNO Required integer Record number of the budget
DESCRIPTION Optional string Description of budget
DEFAULT_BUDGET Optional boolean Use true to make this the company’s default budget otherwise use false

Delete Budget

delete

<delete>
    <object>BUDGETHEADER</object>
    <keys>12</keys>
</delete>

Parameters

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

List Budget Details

readByQuery

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

Parameters

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

Get Budget Detail

read

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

Parameters

Name Required Type Description
object Required string Use GLBUDGET
keys Required string The budget detail 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.

Create Budget Detail

create

<create>
    <GLBUDGET>
        <BUDGETID>Test1</BUDGETID>
        <PERIODNAME>Month Ended December 2012</PERIODNAME>
        <ACCT_NO>1000</ACCT_NO>
        <DEPT_NO>20</DEPT_NO>
        <LOCATION_NO>30</LOCATION_NO>
        <AMOUNT>10000</AMOUNT>
    </GLBUDGET>
</create>

Parameters

Name Required Type Description
GLBUDGET Optional object The object to create

GLBUDGET

Name Required Type Description
BUDGETID Required string Budget ID
DESCRIPTION Required string Description of budget detail

Update Budget Detail

update

<update>
    <GLBUDGET>
        <RECORDNO>5</RECORDNO>
        <AMOUNT>15000</AMOUNT>
    </GLBUDGET>
</update>

Parameters

Name Required Type Description
GLBUDGET Optional object The object to update

GLBUDGET

Name Required Type Description
RECORDNO Required integer Record number of the budget
AMOUNT Required currency Budget detail amount

Delete Budget Detail

delete

<delete>
    <object>GLBUDGET</object>
    <keys>2</keys>
</delete>

Parameters

Name Required Type Description
object Required string Use GLBUDGET
keys Required string The budget detail RECORDNO to delete

Provide feedback