Filter expression to limit the response to only objects that match the expression. Check the value of a single field using operators such as equalto/like, or multiple fields using and/or. Query fields on related objects using the dot operator (for example, VENDOR.CREDITLIMIT on APBILL).
select
Required
sequence
The names of the fields that you want included in the response, and an optional aggregate function such as count or sum. Returning all fields is not supported.
orderby
Optional
object
Provide an order element with a field name and choose an ascending or descending sort order, for example: <order> <field>RECORDNO</field> <descending/> </order>
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. The following operators are supported: <, >, >=, <=, =, like, not like, in, not in, IS NOT NULL, IS NULL, AND, OR. Illegal XML characters must be properly encoded, and single quotes must be escaped with backslashes ('Jane\'s Deli'). Joins are not supported.
pagesize
Optional
integer
Custom page size between 1 and 1000 items (Default: 100)
query Fields
Name
Required
Type
Description
budgeting
Optional
boolean
Period is budgetable. Use T for true or F for false.
Comma-separated list of reporting period RECORDNO to get
fields
Optional
string
Comma-separated list of fields on the object to get. To return all fields, omit the element or provide * for the value. For best performance and predictability, limit the number of fields.
Comma-separated list of reporting period NAME to get
fields
Optional
string
Comma-separated list of fields on the object to get. To return all fields, omit the element or provide * for the value. For best performance and predictability, limit the number of fields.
returnFormat
Optional
string
Data format for the response body:
xml (default)
json
csv
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
Required
object
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)