logo

Retrieve a future renewals report

Retrieves a future renewals report.

SecuritySecretApiKey or JWT
Request
query Parameters
periodStart
required
string^\d{4}-\d{2}$

Date and time when the report starts. This date must be in the future.

Example: periodStart=2032-01
periodEnd
required
string^\d{4}-\d{2}$

Date and time when the report ends. This date must be in the future.

Example: periodEnd=2032-02
limit
integer [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offset
integer >= 0

Specifies the starting point within the collection of items to be returned.

Responses
200

Report retrieved.

Response Headers
Pagination-Total
integer

Total number of items.

Example: 332
Pagination-Limit
integer

Maximum number of items per page.

Example: 100
Pagination-Offset
integer

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

Example: 2
Response Schema: application/json
Array of objects

Future renewals data.

Array
date
string

Date in YYYY-MM format.

sum
number <double>

Total amount of future renewals in the user's reporting currency.

Array of objects

Plan within the aggregation.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

get/experimental/reports/future-renewals
Request samples 
const params = {
    periodStart: '2017-09-22T00:00:00Z',
    periodEnd: '2017-09-29T23:59:59Z',
    limit: 20,
    offset: 0,
    tz: 0
};
const report = await api.reports.getFutureRenewals(params);
Response samples
application/json
{
  • "data": [
    ]
}
➔ Next to Retrieve a journal report