Get a list of available usage rate cards

get/usage-rate-cards
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
contractOwnerId
string (IdFilterParam)

Filter by contract owner

Example: contractOwnerId=0
name
string (StringFilterParam)

Filter by name

Example: name=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
rateCardType
string (StringFilterParam)

Filter by rate card type

Example: rateCardType=xyz | in:x,y | like:xyz
usageProductId
string (IdFilterParam)

Filter by usage product

Example: usageProductId=0
supplierId
string (IdFilterParam)

Filter by supplier

Example: supplierId=0
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

Response samples
application/json
[
  • {
    • "id": 1,
    • "contractOwnerIds": [
      • 1
      ],
    • "name": "string",
    • "rateCardType": "TEMPLATE",
    • "availableFrom": "2019-08-24",
    • "availableTo": "2019-08-24",
    • "usageProductId": 1,
    • "supplierId": 1,
    • "decimalPlaces": 4,
    • "priceRoundingStyle": "UP",
    • "defaultMinCharge": 0,
    • "roundAccessChargeFirstMinute": false,
    • "boltOn": false,
    • "boltOnTaxBandId": 1,
    • "nominalCode": "string",
    • "applyCrossTimeBandCharging": false,
    • "defaultQuantityRoundingIncrement": 1,
    • "defaultVariableChargeUnitSize": 1,
    • "usageRates": [
      • {
        • "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"
        }
      ],
    • "timeBandPlans": [
      • {
        • "id": 1,
        • "timeBandPlanId": 1,
        • "name": "string",
        • "startDate": "2019-08-24",
        • "endDate": "2019-08-24"
        }
      ],
    • "accessCharges": [
      • {
        • "id": 1,
        • "charge": 0,
        • "startDate": "2019-08-24",
        • "endDate": "2019-08-24"
        }
      ],
    • "boltOnCharges": [
      • {
        • "id": 1,
        • "price": 0,
        • "rentalRateType": "ADVANCE",
        • "periodsInAdvance": "STANDARD",
        • "rentalRateFrequency": "DAILY",
        • "showOnInvoice": true,
        • "startDate": "2019-08-24",
        • "endDate": "2019-08-24"
        }
      ]
    }
]