Reporting periods

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

List reporting periods

get/objects/general-ledger/reporting-period

Returns a collection with a key, ID, and link for each period. This operation is mostly for use in testing; use the query service to find reporting periods that meet specific criteria and to specify the properties that you want in the response.

Permissions and other requirements
SubscriptionGeneral Ledger
User typeBusiness, Employee, Approver
PermissionsList Reporting Periods
SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "1",
      • "id": "Current Month",
      • "href": "/objects/general-ledger/reporting-period/1"
      },
    • {
      • "key": "2",
      • "id": "Next Month",
      • "href": "/objects/general-ledger/reporting-period/2"
      }
    ],
  • "ia::meta": {
    • "totalCount": 2,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Create a reporting period
post/objects/general-ledger/reporting-period
Creates a new reporting period.



Permissions and other requirements



SubscriptionGeneral Ledger


User typeBusiness


PermissionsAdd Reporting Periods







SecurityOAuth2 
Request 
Request Body schema: application/json
required
Reporting period to create


id
required
string
Name of the reporting period. The name cannot be changed after the reporting period is created.


 
 Example:  "Current Month"
columnHeader1
required
string
The first line to be shown on the report, such as "Quarter Ended".


 
 Example:  "Quarter Ended"
columnHeader2
string or null
The second line to be shown on the report, such as "April 2023".


 
 Example:  "April 2023"
startDate
string or null <date> 
The starting date of the reporting period.


 
 Example:  "2023-04-01"
endDate
string or null <date> 
The ending date of the reporting period.


 
 Example:  "2023-06-30"
isBudgetable
boolean
 Default:  false
Set to true to make this reporting period available for inclusion in budgets.


 
 Example:  true
status
string
 Default:  "active"
Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.


 Enum: "active" "inactive"  
 Example:  "active"
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "startDate": "2023-01-01",
  • "endDate": "2023-12-31",
  • "id": "Current Year 2023",
  • "columnHeader1": "Current Year",
  • "isBudgetable": false
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "1023",
    • "id": "Current Year 2023",
    • "href": "/objects/general-ledger/reporting-period/1023"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Get a reporting period
get/objects/general-ledger/reporting-period/{key}
Returns detailed information for a specified reporting period.



Permissions and other requirements



SubscriptionGeneral Ledger


User typeBusiness, Employee, Approver


PermissionsView Reporting Periods







SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the reporting period.


 
 Example:  240
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "id": "Current Year 2023",
    • "key": "1023",
    • "href": "/objects/general-ledger/reporting-period/1023",
    • "startDate": "2023-02-01",
    • "endDate": "2023-12-31",
    • "isBudgetable": false,
    • "reportingPeriodType": "custom",
    • "dateType": 99,
    • "columnHeader1": "Current Year",
    • "columnHeader2": null,
    • "status": "active",
    • "audit": {
      • "createdDateTime": "2024-10-08T13:29:18Z",
      • "modifiedDateTime": "2024-10-08T13:29:18Z",
      • "createdByUser": {
        },
      • "modifiedByUser": {
        }
      }
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update a reporting period
patch/objects/general-ledger/reporting-period/{key}
Updates an existing reporting period by setting field values. Any fields not provided remain unchanged.



Permissions and other requirements



SubscriptionGeneral Ledger


User typeBusiness


PermissionsEdit Reporting Periods







SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the reporting period.


 
 Example:  240
Request Body schema: application/json
columnHeader1
string
The first line to be shown on the report, such as "Quarter Ended".


 
 Example:  "Quarter Ended"
columnHeader2
string or null
The second line to be shown on the report, such as "April 2023".


 
 Example:  "April 2023"
startDate
string or null <date> 
The starting date of the reporting period.


 
 Example:  "2023-04-01"
endDate
string or null <date> 
The ending date of the reporting period.


 
 Example:  "2023-06-30"
isBudgetable
boolean
 Default:  false
Set to true to make this reporting period available for inclusion in budgets.


 
 Example:  true
status
string
 Default:  "active"
Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.


 Enum: "active" "inactive"  
 Example:  "active"
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "startDate": "2023-01-01",
  • "endDate": "2023-11-30",
  • "columnHeader1": "Current Year till nov",
  • "isBudgetable": false
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "1023",
    • "id": "Current Year 2023",
    • "href": "/objects/general-ledger/reporting-period/1"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Delete a reporting period
delete/objects/general-ledger/reporting-period/{key}
Deletes a reporting period.



Permissions and other requirements



SubscriptionGeneral Ledger


User typeBusiness


PermissionsDelete Reporting Periods







SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the reporting period.


 
 Example:  240
Responses 
204
No Content


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "ia::error": {
      • "code": "invalidRequest",
      • "message": "A POST request requires a payload",
      • "errorId": "REST-1028",
      • "additionalInfo": {
        },
      • "supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
      }
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 0,
    • "totalError": 1
    }
}
Query reporting periods
post/services/core/query
Queries an object for filtered data.


SecurityOAuth2 
Request 
Request Body schema: application/json
object
string
Object type to query, in the form <application-name>/<object name>. For custom objects use platform-apps/nsp::<object-name>.


 
 Example:  "general-ledger/reporting-period"
fields
Array of strings
List of fields to include in the response. Can be any combination of these:


    

  • The name of a field in the object that you are querying, such as id.
    

    • 

  • The name of a field in a related object, using the form relatedObjectName.fieldName, such as vendor.id.
    

    • 

  • The result of an aggregate function run against the values in the returned objects. Use the form function:fieldName, such as min:startDate to return the earliest starting date. Valid function names are:
    

      

    • count
      • 

    • avg
      • 

    • sum
      • 

    • min
      • 

    • max
      • 

    

    • 

  • The result of an aggregate function run against the values in related objects, using the form function:relatedObjectName.fieldName, such as max:vendor.creditLimit. The same functions are supported as for object fields.
    

    • 



 
 Example:  ["key","id","max:vendor.creditLimit"]
Array of equal (object) or not equal (object) or less than (object) or (less than or equal (object)) or greater than (object) or (greater than or equal (object)) or in (object) or not in (object) or between (object) or not between (object) or contains (object) or does not contain (object) or has (object) or starts with (object) or does not start with (object) or ends with (object) or does not end with (object)
Filter conditions to select the objects to return based on their field values. You use operators and conditions to build your filter, such as {"$eq":{"status":"active"}} to select objects in which status is equal to "active".


 
 Example:  [{"$eq":{"status":"active"}},{"$gt":{"totalDue":"1000"}},{"$contains":{"name":"Acme"}}]
 Array 
Any of:
Field value must be equal to this specified value.


For date fields, you can use these macro values that are relative to the current date or the asOfDate in filterParameters, if set:







    

  • today

  • currentWeek

  • currentMonth

  • currentQuarter

  • currentYear





    

  • yesterday

  • lastWeek

  • priorMonth

  • priorQuarter

  • priorYear









These are most useful for queries that you want to save and use repeatedly, such as for views or reports. Just change the asOfDate each time to retrieve the same data set for different time periods.


For example, {"eq":{"postingDate":"priorYear"}}.


object
The field name and value to be compared with object values.


 
 Example:  {"status":"active"}
filterExpression
string
 Default:  "and"
Logical operators to apply when there are multiple filter conditions. The conditions in the filters array are implicitly numbered starting at 1. Supports and, or, and grouping with parentheses.


Shortcuts:


    

  • and by itself means that all conditions must be true.
    • 

  • or by itself means that at least one condition must be true.
    • 



 
 Example:  "(1 and 2) or 3"
object

Pre-defined filter options.


 
asOfDate
string <date> 
The "as of" date to use with any relative date comparisons in filters. For example, if asOfDate is set to "2022-04-01" then priorMonth will be "03".


The current date is used if asOfDate is not set.


 
 Example:  "2022-04-01"
includeHierarchyFields
boolean
 Default:  false
Set to true to include hierarchical structure information with each object in the response.


 
 Example:  false
caseSensitiveComparison
boolean
 Default:  true
Queries are case-sensitive by default. Set to false to ignore case in a query.


 
 Example:  true
includePrivate
boolean
 Default:  false
By default, in a multi-entity company queries from the top-level entity do not access data in private entities. Set includePrivate to true if you want to query data in private entities.


 
 Example:  false
Array of objects
Set the order of the results by specifying field names to sort by and whether they should be in ascending or descending order.


 
 Example:  [{"totalDue":"asc"},{"lastPaymentMadeDate":"desc"}]
 Array 
property name*
additional property
string
 Enum: "asc" "desc"  
start
integer
First record of the result set to include in the response.


 
 Example:  1
size
integer
Number of records to include in the result set, 4000 maximum.


 
 Example:  100
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "object": "general-ledger/reporting-period",
  • "filters": [
    • {
      • "$eq": {
        }
      }
    ],
  • "fields": [
    • "key",
    • "id",
    • "startDate",
    • "endDate"
    ],
  • "orderBy": [
    • {
      • "startDate": "asc"
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "82",
      • "id": "1001",
      • "startDate": "2023-02-01",
      • "endDate": "2023-02-28"
      },
    • {
      • "key": "83",
      • "id": "1002",
      • "startDate": "2023-03-01",
      • "endDate": "2023-03-31"
      }
    ],
  • "ia::meta": {
    • "totalCount": 2,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}