Get a list of usage rates

get/usage-rates
SecuritybearerAuth
Request
query Parameters
page
required
integer <int32> (PageParam) >= 1

Page of results to show

Example: page=1
pageSize
required
integer <int32> (ResultsPerPageParam) [ 1 .. 1000 ]

Results to return per page

Example: pageSize=100
sort
string (SortParam)

Comma-delimited list of the fields to sort by - defaults to ascending order, suffix :desc to change

Example: sort=id,name | name:desc
fields
string (FieldsParam)

Comma-delimited list of the field(s) to return if only a subset is required

Example: fields=id,name
usageRateCardId
required
string (IdFilterParam)

Filter by usage rate card

Example: usageRateCardId=0
chargeGroupId
string (IdFilterParam)

Filter by charge group

Example: chargeGroupId=0
usageRateType
string (StringFilterParam)

Filter by usage rate type

Example: usageRateType=xyz | in:x,y | like:xyz
availableFrom
string (DateFilterParam)

Filter by available from date

Example: availableFrom=yyyy-MM-dd | lt:yyyy-MM-dd | gt:yyyy-MM-dd | gtn:yyyy-MM-dd
availableTo
string (DateFilterParam)

Filter by available to date

Example: availableTo=yyyy-MM-dd | lt:yyyy-MM-dd | gt:yyyy-MM-dd | gtn:yyyy-MM-dd
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

Response samples
application/json
[
  • {
    • "id": 1,
    • "chargeGroupId": 1,
    • "usageRateType": "MARKUP",
    • "peakInitialCharge": 0,
    • "peakInitialPeriod": 0,
    • "peakValue": 0,
    • "peakMinimum": 0,
    • "offPeakInitialCharge": 0,
    • "offPeakInitialPeriod": 0,
    • "offPeakValue": 0,
    • "offPeakMinimum": 0,
    • "weekendInitialCharge": 0,
    • "weekendInitialPeriod": 0,
    • "weekendValue": 0,
    • "weekendMinimum": 0,
    • "quantityRoundingIncrement": 1,
    • "variableChargeUnitSize": 1,
    • "surchargeInitialCharge": 0,
    • "surchargeInitialPeriod": 0,
    • "surchargeValue": 0,
    • "surchargeMinimum": 0,
    • "startDate": "2019-08-24",
    • "endDate": "2019-08-24"
    }
]