Retrieve a future renewals report

Retrieve a future renewals report.

SecuritySecretApiKey or JWT
Request
query Parameters
periodStart
required
string

Report start date. It should be in the future.

periodEnd
required
string

Report end date.

limit
integer [ 0 .. 1000 ]

The collection items limit.

offset
integer >= 0

The collection items offset.

Responses
200

Report was retrieved successfully.

Response Headers
Pagination-Total
integer

Total items count.

Example: 332
Pagination-Limit
integer

Items per page limit.

Example: 100
Pagination-Offset
integer

Pagination offset.

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

Date in format YYYY-MM.

sum
number <double>

Amount of future renewals in user's reporting currency.

Array of objects
401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

get/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": [
    ]
}