Rate APIs

Get /api/v3/rate/{rateId}

Operation: GetRateV3 Permissions: VendorsAndRatesModule (View)

Get a rate schedule


Put /api/v3/rate/{rateId}

Operation: EditRateV3 Permissions: RateSchedules (Edit)

Edit a rate


Delete /api/v3/rate/{rateId}

Operation: DeleteRateV3 Permissions: RateSchedules (Delete)

Delete a rate schedule


Get /api/v3/rate

Operation: GetRatesV3 Permissions: VendorsAndRatesModule (View) Paginated

Get a list of all rate schedules matching the provided filters


Post /api/v3/rate

Operation: CreateRateV3 Permissions: RateSchedules (Create)

Create a rate schedule


Get /api/v3/rate/{rateId}/version/{versionId}

Operation: GetRateVersionV3 Permissions: VendorsAndRatesModule (View)

Get a rate version with its details including dates, unit cost values, and bodylines


Put /api/v3/rate/{rateId}/version/{versionId}

Operation: EditRateVersionV3 Permissions: RateSchedules (Edit)

Edit a rate schedule version


Delete /api/v3/rate/{rateId}/version/{versionId}

Operation: DeleteRateVersionV3 Permissions: RateSchedules (Edit)

Delete a version of a rate schedule


Get /api/v3/rate/{rateId}/version

Operation: GetRateVersionsV3 Permissions: VendorsAndRatesModule (View)

Get a list of all versions for a rate schedule with their details including dates, unit cost values, and bodylines


Post /api/v3/rate/{rateId}/version

Operation: CreateRateVersionV3 Permissions: RateSchedules (Edit)

Create a rate schedule version


Get /api/v3/rate/{rateId}/unit

Operation: GetRateUnitV3 Permissions: VendorsAndRatesModule (View)

Get the unit used by a rate. The unit is determined by the usage unit on the most recent template assigned to a meter with the given rate.


Get /api/v202105/rate/{rateId}/version/{versionId}/udf/{udfId}/download

Operation: DownloadRateCustomFieldFileV202105 Permissions: VendorsAndRatesModule (View)

Download file for a rate custom field