Query rated usages

get

https://api.instellix.io/v2/rated-usages

Query rated usages by criteria defined, returning a paged result set.

Query Params

string

Use RSQL query language. Intro here: https://aboullaite.me/rsql/.
The following field combinations can be queried:

ident
contractIdent and status
contractIdent and productReferenceKey
ratedUsageAggregationIdent
created

documentNumber and search parameter are mutually exclusive!

documentNumber

string

Filter rated usages by document number. Results are always sorted ascending by period.start.
documentNumber and search parameter are mutually exclusive!

page

integer

Defaults to 0

Zero-based page index (0..n). Default is 0.

size

integer

Defaults to 20

Size of the page to be returned. Max page size allowed is 100, default is 20.

sort

array of strings

Defaults to ident

A list of one or more sorting criteria each in the format 'property(,asc|desc)' with direction being case-insensitive. If sorting direction is not provided, default direction is 'asc'. Default sorting criteria: 'ident'.

sort

Responses

Language

Credentials

OAuth2

Loading…

Response

Choose an example:

application/json

200Standard response for successful HTTP requests.

4XXerror response for all http error codes in range 4XX

5XXerror response for all http error codes in range 5XX