EnergyCAP Developer
Documentation API Reference
Guides
Getting Started
Getting Started Environments API Authentication Paging Filters Field Reduction API Versioning Webhooks
SDKs
Overview C# SDK Python SDK (Beta) Angular/TypeScript SDK (Beta) PowerShell
SSO
Overview Microsoft Entra ID Okta
Reference
API Reference
Account AccountDigest AccountMeter Accrual Activity Admin Api ApiKey Audit Authentication Batch Bill BillAccountChargeSplit BillSplit BillView Budget CalculatedBill Channel ChargebackEngine ChargebackTask ChargebackWorkflow Collection Commodity CommodityCategory CommodityDigest CostCategory CostCenter CostCenterDigest Country Customer Dashboard DataPoint EmissionRecord EmissionSource EnergyManager EnergyProject EnergyStar Environment EsaChannel EsaPlace EsaReading Export FileStore Filter Flag Formula GeneralLedger GHG Hierarchy Import List Me Meter MeterDigest MeterGroup MeterGroupDigest Notification Observation ObservationType Place PlaceBenchmark PlaceDigest PlaceGroup PlaceGroupDigest PostalCode PrimaryUse Rate RateDigest Report ReportBuilder ReportDistribution Route Savings Schedule Search Sentinel Setup SummaryAccount SystemUser Tag Task Template TimeZone UDF Unit UserGroup UserRole UtilityPlatform Vendor VendorDigest WeatherStation Webhook Widget Workflow
API Reference / Rate

Rate

GET 6 endpoints
/api/v202105/rate/{rateId}/version/{versionId}/udf/{udfId}/download DownloadRateCustomFieldFileV202105
Download file for a rate custom field
/api/v3/rate GetRatesV3
Get a list of all rate schedules matching the provided filters
/api/v3/rate/{rateId}/unit GetRateUnitV3
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.
/api/v3/rate/{rateId} GetRateV3
Get a rate schedule
/api/v3/rate/{rateId}/version GetRateVersionsV3
Get a list of all versions for a rate schedule with their details including dates, unit cost values, and bodylines
/api/v3/rate/{rateId}/version/{versionId} GetRateVersionV3
Get a rate version with its details including dates, unit cost values, and bodylines
POST 2 endpoints
/api/v3/rate CreateRateV3
Create a rate schedule
/api/v3/rate/{rateId}/version CreateRateVersionV3
Create a rate schedule version
PUT 2 endpoints
/api/v3/rate/{rateId} EditRateV3
Edit a rate
/api/v3/rate/{rateId}/version/{versionId} EditRateVersionV3
Edit a rate schedule version
DELETE 2 endpoints
/api/v3/rate/{rateId} DeleteRateV3
Delete a rate schedule
/api/v3/rate/{rateId}/version/{versionId} DeleteRateVersionV3
Delete a version of a rate schedule