Operation: EditLicenseDetailsV3
Edit the license details.
Type Reference: LicenseRequest
| Parameter | Description | Type |
|---|---|---|
| validationKey | User’s license validation key. Required (defined) | string |
{
"validationKey": "string"
}Type Reference: LicenseResponse
| Parameter | Description | Type |
|---|---|---|
| validationKey | User’s license validation key. | string |
| expirationDate | User’s license expiration date. | string |
| licensedMeters | Number of licensed meters for this user. | integer |
| userNumber | The user number. | string |
| version | EnergyCAP version on this license. | string |
| notes | Additional notes related to the license. | string |
| meterUsage | AccountOrMeterUsage | |
| chargeback | Number of chargeback accounts or meters. | integer |
| nonChargeback | Number of non-chargeback accounts or meters. | integer |
| inactive | Number of inactive accounts or meters. | integer |
| accountUsage | AccountOrMeterUsage | |
| chargeback | Number of chargeback accounts or meters. | integer |
| nonChargeback | Number of non-chargeback accounts or meters. | integer |
| inactive | Number of inactive accounts or meters. | integer |
| billsCreatedLast30Days | BillUsage | |
| manuallyEntered | Number of bills that are manually entered. | integer |
| imported | Number of bills that are imported. | integer |
| chargeback | Number of bills that are chargeback. | integer |
| accrual | Number of bills that have accrued. | integer |
| billsCreatedLast12Months | BillUsage | |
| manuallyEntered | Number of bills that are manually entered. | integer |
| imported | Number of bills that are imported. | integer |
| chargeback | Number of bills that are chargeback. | integer |
| accrual | Number of bills that have accrued. | integer |
| licenseFeatures | LicenseFeatures | |
| accountingExport | Whether accounting export is available on the user’s the license. | boolean |
| billAccruals | Whether bill accruals are available on the user’s license. | boolean |
| chargebacks | Whether chargebacks are available on the user’s license. | boolean |
| costAvoidance | Whether cost avoidance is available on the user’s license. | boolean |
| customBenchmarks | Whether custom benchmarks are available on the user’s license. | boolean |
| intervalDataAnalysis | Whether interval data analysis is available on the user’s license. | boolean |
| reportDesigner | Whether report designer is available on the user’s license. | boolean |
| reportDistribution | Whether report distribution is available on the user’s license. | boolean |
| ghg | Whether CarbonHub Standard is available on the user’s license. | boolean |
| ghgPremium | Whether CarbonHub Premium is available on the user’s license. | boolean |
| ghgLegacy | Whether Legacy GHG features are available on the user’s license. | boolean |
| budgets | Whether Budgets is available on the user’s license | boolean |
| energyCAPPayments | Whether EnergyCAP Payments is available on the user’s license | boolean |
| billCAPtureManagedServices | Whether Bill CAPture Managed Services is available on the user’s license | boolean |
| carbonHub | Whether CarbonHub is available on the user’s license | boolean |
| intervalData | Whether Interval Data Managed Services is available on the user’s license | boolean |
| billCapturePrePay | Whether Bill CAPture PrePay is available on the user’s license | boolean |
| billCapturePostPay | Whether Bill CAPture PostPay is available on the user’s license | boolean |
| nonEnglishBills | Whether Bill CAPture NonEnglish Bills is available on the user’s license | boolean |
| vendorManagementServices | Whether Vendor Management Services is available on the user’s license | boolean |
| uIdI | Whether UIDI is available on the user’s license | boolean |
| utilityManagementSKU | Application SKU as set in the license code for UtilityManagement. Possible values are: SaaS (Express), Professional, Online (Enterprise), ConsultantPlatform, ConsultantPlatformPlus, UtilityCompanyPlatform, and Other. |
string |
| emissionSourcesScope1And2Usage | LicenseUsage | |
| purchased | Purchased allotment of licensed items | integer |
| active | Number of active licenses | integer |
| inactive | Number of inactive licenses | integer |
| emissionSourcesScope3Usage | LicenseUsage | |
| purchased | Purchased allotment of licensed items | integer |
| active | Number of active licenses | integer |
| inactive | Number of inactive licenses | integer |
{
"validationKey": "string",
"expirationDate": "2025-03-20",
"licensedMeters": 1,
"userNumber": "string",
"version": "string",
"notes": "string",
"meterUsage": {
"chargeback": 1,
"nonChargeback": 1,
"inactive": 1
},
"accountUsage": {
"chargeback": 1,
"nonChargeback": 1,
"inactive": 1
},
"billsCreatedLast30Days": {
"manuallyEntered": 1,
"imported": 1,
"chargeback": 1,
"accrual": 1
},
"billsCreatedLast12Months": {
"manuallyEntered": 1,
"imported": 1,
"chargeback": 1,
"accrual": 1
},
"licenseFeatures": {
"accountingExport": false,
"billAccruals": false,
"chargebacks": false,
"costAvoidance": false,
"customBenchmarks": false,
"intervalDataAnalysis": false,
"reportDesigner": false,
"reportDistribution": false,
"ghg": false,
"ghgPremium": false,
"ghgLegacy": false,
"budgets": false,
"energyCAPPayments": false,
"billCAPtureManagedServices": false,
"carbonHub": false,
"intervalData": false,
"billCapturePrePay": false,
"billCapturePostPay": false,
"nonEnglishBills": false,
"vendorManagementServices": false,
"uIdI": false
},
"utilityManagementSKU": "string",
"emissionSourcesScope1And2Usage": {
"purchased": 1,
"active": 1,
"inactive": 1
},
"emissionSourcesScope3Usage": {
"purchased": 1,
"active": 1,
"inactive": 1
}
}