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 / UDF

UDF

GET 2 endpoints
/api/v3/udf GetUDFsV3
Retrieves all User defined fields/custom fields. The array of UDFs can be filtered by UDF type. Possible values for this filter include: "Account", "Meter", "Place", "Vendor", "ChannelVersion", "Rate", "Bill", "EnergyProject", "Collection", and "EmissionSource". See the filter property for more details
/api/v3/udf/{udfId} GetUDFV3
Retrieves one user defined field / custom field
POST 1 endpoint
/api/v3/udf CreateUDFV3
Creates a user defined field / custom field
PUT 2 endpoints
/api/v3/udf/list/{udfType} EditCustomFieldsV3
Edits a list of user defined fields / custom fields
/api/v3/udf/{udfId} EditUDFV3
Edits a user defined field / custom field
DELETE 1 endpoint
/api/v3/udf/{udfId} DeleteUDFV3
Deletes a user defined field / custom field. Currently NO confirmation is required