Reporting periods are used when creating reports and budgets, and when opening and closing books. They limit the information on the report to specific time ranges.


List Reporting Periods

readByQuery

<readByQuery>
    <object>REPORTINGPERIOD</object>
    <fields>*</fields>
    <query>budgeting = 'T'</query>
    <pagesize>100</pagesize>
</readByQuery>

Parameters

Name Required Type Description
object Required string Use REPORTINGPERIOD
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
budgeting Optional boolean Period is budgetable. Use T for true or F for false.

Get Reporting Period

read

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

Parameters

Name Required Type Description
object Required string Use REPORTINGPERIOD
keys Required string The reporting period 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 Reporting Period by Name

readByName

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

Parameters

Name Required Type Description
object Required string Use REPORTINGPERIOD
keys Required string The reporting period 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 Reporting Period

create

<create>
    <REPORTINGPERIOD>
        <NAME>Month Ended January 2017</NAME>
        <HEADER1>Month Ended</HEADER1>
        <HEADER2>January 2017</HEADER2>
        <START_DATE>01/01/2017</START_DATE>
        <END_DATE>01/31/2017</END_DATE>
        <BUDGETING>true</BUDGETING>
        <STATUS>active</STATUS>
    </REPORTINGPERIOD>
</create>

Parameters

Name Required Type Description
REPORTINGPERIOD Optional object The object to create

REPORTINGPERIOD

Name Required Type Description
NAME Required string Reporting Period Name
HEADER1 Required string Header 1
HEADER2 Optional string Header 2
START_DATE Required string Start date in format mm/dd/yyyy.
END_DATE Required string End date in format mm/dd/yyyy.
BUDGETING Optional boolean Use true to make this period budgetable, otherwise use false. Budgeting periods cannot overlap. (Default: false)
STATUS Optional string Use active for Active, otherwise inactive for Inactive. (Default: active)

Update Reporting Period

update

<update>
    <REPORTINGPERIOD>
        <RECORDNO>124</RECORDNO>
        <HEADER1>Month Ended</HEADER1>
        <HEADER2>January 2017</HEADER2>
        <START_DATE>01/01/2017</START_DATE>
        <END_DATE>01/31/2017</END_DATE>
        <BUDGETING>true</BUDGETING>
        <STATUS>active</STATUS>
    </REPORTINGPERIOD>
</update>

Parameters

Name Required Type Description
REPORTINGPERIOD Optional object The object to update

REPORTINGPERIOD

Name Required Type Description
RECORDNO Required string Record number of the reporting period
HEADER1 Required string Header 1
HEADER2 Optional string Header 2
START_DATE Required string Start date in format mm/dd/yyyy.
END_DATE Required string End date in format mm/dd/yyyy.
BUDGETING Optional boolean Use true to make this period budgetable, otherwise use false. Budgeting periods cannot overlap.
STATUS Optional string Use active for Active, otherwise inactive for Inactive.

Delete Reporting Period

delete

<delete>
    <object>REPORTINGPERIOD</object>
    <keys>12</keys>
</delete>

Parameters

Name Required Type Description
object Required string Use REPORTINGPERIOD
keys Required string The reporting period RECORDNO to delete

Provide feedback