InControl v4.8 API Changelog
April 2025
Julian Ares
Last Update 17 days ago
This release includes schema updates to both the Management API and Driver API that improve accuracy, enable new features, and retire deprecated fields.
🔴 Breaking Changes (Action Required)
These changes may cause errors if your current integration relies on affected fields or data types. Please review and update accordingly.
Management API Breaking Changes
| Object/Field/Type | Change Description |
| AccountStats.totalEnergy Field | Changed type from TotalEnergy! to EnergyMetric! |
| AggregatedTransaction.duration Field | Changed type from Float to Int! |
| AggregatedTransaction.energy Field | Changed type from Float to Decimal! |
| AggregatedTransaction.greenHouse Field | Changed type from Float to Decimal! |
| AttachUtilityRateInput.billingPeriodInterval Input Field | Changed type from UtilityRateSiteAttachmentBillingPeriod to UtilityRateElectricityPowerAgreementBillingPeriod |
| AttachUtilityRateResult Union type | Removed union member UtilityRateSiteAttachment |
| ConvertGenabilityTariffInput.billingPeriodInterval Input Field | Changed type from UtilityRateSiteAttachmentBillingPeriod to UtilityRateElectricityPowerAgreementBillingPeriod |
| EssentialTransaction.energy Field | Changed type from Float to Decimal |
| EssentialTransaction.greenHouse Field | Changed type from Float to Decimal |
| MetricValue.value Field | Changed type from Float to Decimal |
| NotificationRule.hardwareStatuses Field | Changed type from [ConnectorStateValue] to [NotificationRuleHardwareStatuses] |
| RootMutationType.createNotificationRule Field (Argument) | Changed argument hardwareStatuses type from [ConnectorStatus] to [NotificationRuleHardwareStatuses] |
| RootMutationType.setPowerBiReportForAccount Field | Removed field setPowerBiReportForAccount |
| RootMutationType.updateNotificationRule Field (Argument) | Changed argument hardwareStatuses type from [ConnectorStatus] to [NotificationRuleHardwareStatuses] |
| RootSubscriptionType.coStatusUpdate Field (Argument) | Added argument controlOperationType: ControlOperationType! |
| RootSubscriptionType.coStatusUpdate Field (Argument) | Removed argument controlOperationUuid: String |
| Site | Removed field siteAttachment from |
| SmartChargingLifecycleStageActionInput Input Object type | Added input field maxRetryCount |
| TotalEnergy Type | Removed type TotalEnergy |
| Transaction.energy Field | Changed type from Float to Decimal |
| Transaction.greenHouse Field | Changed type from Float to Decimal |
| TransactionReport.duration Field | Changed type from Float to Int |
| TransactionReport.energy Field | Changed type from Float to Decimal |
| TransactionReport.gasDisplacement Field | Changed type from Float to Decimal |
| TransactionReport.greenHouse Field | Changed type from Float to Decimal |
| UtilityRate | Removed field siteAttachments |
| UtilityRateSiteAttachment Type | Removed type UtilityRateSiteAttachment |
| UtilityRateSiteAttachmentBillingPeriod Type | Removed type UtilityRateSiteAttachmentBillingPeriod |
Driver API Breaking Changes
| Object/Field/Type | Change Description |
| Transaction.charger Field | Changed type from Charger! to Charger |
| Transaction | Removed field duration |
| Transaction.energy Field | Changed type from Float to Decimal |
| Transaction | Removed field startTimestamp |
| Transaction | Removed field stopTimestamp |
⚠️ Potential Issues
These changes add new fields or enum values and may affect optional parameters or response structures.
Management API Potential Issues
| Object/Field/Type | Change Description |
| AggregatedTransactionOrderByFields Enum | Added enum value FAILURE_RATE |
| AggregatedTransactionOrderByFields Enum | Added enum value SUCCESS_RATE |
| AttachUtilityRateResult Union type | Added union member UtilityRateElectricityPowerAgreement |
| AuditTransactionEntityType Enum | Added enum value SALESFORCE_DATA |
| ChargerExportColumn Enum | Added enum value SALESFORCE_STATUS |
| ConsumptionRateBandInput Input Object type | Added input field id |
| ExportType Enum | Added enum value SITE_ENERGY_SUMMARY |
| FilterByCharger Input Object type | Added input field salesforceStatuses |
| FixedRateBandInput Input Object type | Added input field id |
| FlatDemandChargeInput Input Object type | Added input field id |
| RootMutationType.coReset Field | Added argument delayed: Boolean |
| SubscriptionBlockDemandChargeInput Input Object type | Added input field id |
| TieredDemandChargeInput Input Object type | Added input field id |
| TieredDemandChargeTierInput Input Object type | Added input field id |
| TimeOfUseDemandChargeInput Input Object type | Added input field id |
| TimeOfUseDemandChargeLimitInput Input Object type | Added input field id |
| TransactionExportColumn Enum | Added enum value CONNECTION_DURATION |
| UpdateUtilityRateResult Union type | Added union member UtilityRateOutdatedError |
| UpdateUtilityRateResult Union type | Added union member UtilityRateUpdateError |
| UtilityRateSeasonInput Input Object type | Added input field id |
| IssueSectionVendor Enum | Added enum value BTC |
| GroupByTransaction Enum | Added enum value INTO_SINGLE_RECORD |
✅ Safe Changes
New features, types, and fields added — available for use but won’t impact existing calls.
Management API Safe Changes
| Object/Field/Type | Change Description |
| AggregatedTransaction.avgEnergy Field | Updated description to fix typo: "avarage" → "average" |
| AggregatedTransaction.gasDisplacement Field | Changed type from Volume to Volume! |
| AggregatedTransaction.plugInRate Field | Added field plugInRate |
| AssetStatus Type | Added type AssetStatus |
| Charger.inProxyMode Field | Updated deprecation reason to: "Use operationalMode instead" |
| Charger.salesforceData Field | Added field salesforceData |
| ChargersReport Type | Added type ChargersReport |
| EnergyMetric Type | Added type EnergyMetric |
| EssentialChargerAsset.inProxyMode Field | Updated deprecation reason to: "Use operationalMode instead" |
| EssentialTransaction.inProxyMode Field | Updated description: now indicates deprecation |
| EssentialTransaction.inProxyMode Field | Deprecated field inProxyMode with reason: "Please use the operationalMode field" |
| EssentialTransaction.ocppTransactionId Field | Updated description to remove period at the end |
| FilterByCharger.inProxyMode Input Field | Updated description: now indicates deprecation |
| FilterByPowerAnalytics Type | Added type FilterByPowerAnalytics |
| FilterBySiteEnergySummary Type | Added type FilterBySiteEnergySummary |
| GroupByChargerReport Type | Added type GroupByChargerReport |
| GroupingChargerReport Type | Added type GroupingChargerReport |
| NotificationRuleHardwareStatuses Type | Added type NotificationRuleHardwareStatuses |
| PaginatedAggregatedChargersReport Type | Added type PaginatedAggregatedChargersReport |
| PaginatedTransactionEvents Type | Added type PaginatedTransactionEvents |
| PlugInRate Type | Added type PlugInRate |
| PowerAnalyticsMonthlyChargingData Type | Added type PowerAnalyticsMonthlyChargingData |
| PowerAnalyticsPowerPoint Type | Added type PowerAnalyticsPowerPoint |
| PowerAnalyticsWeeklyChargingData Type | Added type PowerAnalyticsWeeklyChargingData |
| RootMutationType Field | Added field attachPowerBiReportToAccount |
| RootMutationType.createNotificationRule Argument | Updated description for hardwareStatuses argument to: "A list of triggers for notification rule" |
| RootMutationType Field | Added field detachPowerBiReportFromAccount |
| RootMutationType Field | Added field siteEnergySummaryExport |
| RootMutationType Field | Added field updateChargerSalesforceData |
| RootMutationType Field | Added field updateChargerScImportantFlag |
| RootMutationType.updateNotificationRule Argument | Updated description for hardwareStatuses argument to: "A list of triggers for notification rule" |
| RootQueryType Field | Added field aggregatedChargersReport |
| RootQueryType.oidcLogoutUrl Field | Added field oidcLogoutUrl |
| RootQueryType Field | Added field powerAnalyticsMonthlyCharging |
| RootQueryType Field | Added field powerAnalyticsWeeklyCharging |
| RootQueryType Field | Added field transactionEvents |
| RootSubscriptionType.coStatusUpdate Field | Updated description to include: "Once control operation reaches final status subscription will be automatically terminated. Final statuses: SKIPPED, CANCELED, SUCCESS, ERROR" |
| SalesforceData Type | Added type SalesforceData |
| Site Field | Added field electricityPowerAgreement |
| SiteEnergySummaryExportColumn Type | Added type SiteEnergySummaryExportColumn |
| SmartChargingLifecycleStageAction Field | Added field maxRetryCount |
| Transaction.inProxyMode Field | Updated description: now indicates deprecation |
| Transaction.inProxyMode Field | Deprecated field inProxyMode with reason: "Please use the operationalMode field" |
| Transaction.ocppTransactionId Field | Updated description to remove period at the end |
| TransactionEvent Type | Added type TransactionEvent |
| TransactionEventTriggerReason Type | Added type TransactionEventTriggerReason |
| TransactionEventType Type | Added type TransactionEventType |
| UtilityRate Field | Added field electricityPowerAgreements |
| UtilityRateElectricityPowerAgreement Type | Added type UtilityRateElectricityPowerAgreement |
| UtilityRateElectricityPowerAgreementBillingPeriod Type | Added type UtilityRateElectricityPowerAgreementBillingPeriod |
| UtilityRateOutdatedError Type | Added type UtilityRateOutdatedError |
| UtilityRateUpdateError Type | Added type UtilityRateUpdateError |
Driver API Safe Changes
| Object/Field/Type | Change Description |
| BillingAccountPricingSchedule Type | Added type BillingAccountPricingSchedule |
| Charger Field | Added field pricingSchedule |
| ChargerConnector Field | Added field lastChargingDirection |
| ChargerConnector Field | Added field operationStatus |
| ChargerConnectorOperationStatuses Type | Added type ChargerConnectorOperationStatuses |
| DayOfWeek Type | Added type DayOfWeek |
| Invoice Field | Added field id |
| Invoice Field | Added field paymentMethodType |
| PaymentMethodType Type | Added type PaymentMethodType |
| Transaction.charger Field | Updated description to: "A charger to which the transaction is related" |
| Transaction Field | Added field chargerConnector |
| Transaction.currentTimestamp Field | Updated description to: "Date and time of the last transaction report" |
| Transaction Field | Added field session |
| TransactionChargingDirections Type | Added type TransactionChargingDirections |
| TransactionSession Type | Added type TransactionSession |