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 BillImportRule BillSplit BillView Budget CalculatedBill Channel ChargebackEngine ChargebackTask ChargebackWorkflow Collection Commodity CommodityCategory CommodityDigest CostCategory CostCenter CostCenterDigest Country Customer Dashboard DataPoint EmissionRecord EmissionSource EnergyProject EnergyStar Environment EsaChannel EsaPlace EsaReading EsaReadingNote EUIGoal 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 Watts WeatherStation WebCaptureCredential WebCapturePartner Webhook Widget Workflow
API Reference / Rate

Rate

GET 6 endpoints
/api/v202105/rate/{rateId}/version/{versionId}/udf/{udfId}/download DownloadRateCustomFieldFileV202105
Downloads the file attached to a rate version's custom field
/api/v3/rate GetRatesV3
Retrieves a paginated list of rate schedules, with optional filtering
/api/v3/rate/{rateId}/unit GetRateUnitV3
Retrieves the usage unit associated with a rate schedule
/api/v3/rate/{rateId} GetRateV3
Retrieves a single rate schedule by its unique identifier
/api/v3/rate/{rateId}/version GetRateVersionsV3
Retrieves all versions for a rate schedule, ordered by effective date
/api/v3/rate/{rateId}/version/{versionId} GetRateVersionV3
Retrieves a single rate schedule version by rate and version identifiers
POST 2 endpoints
/api/v3/rate CreateRateV3
Creates a new rate schedule
/api/v3/rate/{rateId}/version CreateRateVersionV3
Creates a new version for an existing rate schedule
PUT 2 endpoints
/api/v3/rate/{rateId} EditRateV3
Updates the properties of an existing rate schedule
/api/v3/rate/{rateId}/version/{versionId} EditRateVersionV3
Updates an existing rate schedule version
DELETE 2 endpoints
/api/v3/rate/{rateId} DeleteRateV3
Deletes a rate schedule and all its versions
/api/v3/rate/{rateId}/version/{versionId} DeleteRateVersionV3
Deletes a single version from a rate schedule