4.7 API Changelog
January 2025
Julian Ares
Last Update 3 months 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 |
| AggregatedChargerConnectorStateReport.chargerConnectorNumber | Changed type from Int! to Int |
| AggregatedChargerConnectorStateReport.chargerConnectorType | Changed type from ConnectorModelType! to ConnectorModelType |
| Charger | Removed field freevendmode |
| Charger | Removed field freevendtag |
| Charger | Removed field hasOcppPassword |
| Charger | Removed field powerDistribution |
| Charger | Removed field securityExtensionSupport |
| ChargerConnectorState.chargerConnectorNumber | Changed type from Int! to Int |
| ChargerConnectorState.chargerConnectorType | Changed type from ConnectorModelType! to ConnectorModelType |
| ChargerExportColumn Enum | Removed enum value FIRMWARE_VERSION |
| ChargerModel | Removed field ocppVersion |
| ConnectorState | Removed field number |
| CreatePowerCabinetInput | Removed input field manufacturerCertificate |
| CreateUtilityRateResult Union type | Removed member UtilityRateSubscriptionBlockDemandChargeBlockRateCentsPerKwMustBePositiveValidationError |
| EssentialChargerAsset | Removed field freevendMode |
| EssentialChargerAsset | Removed field freevendTag |
| EssentialChargerAsset | Removed field powerDistribution |
| EssentialChargerAsset | Removed field securityExtensionSupport |
| EssentialTransaction.authorizationType | Chnaged type from TransactionAuthorizationType! to TransactionAuthorizationType |
| EssentialTransaction | Removed fields duration, startTimestamp, stopTimestamp |
| EveTransaction.stopReason | Changed type from StopReasonName to String |
| ExportType Enum | Removed enum value TRANSACTIONS |
| IssueSeverityCode Enum | Removed enum value FATAL |
| MeterValue.connectorId | Changed type from Int! to Int |
| MeterValue.ocppTrasnactionId | Changed type from Int! to String |
| PaginatedScLog.pagination | Changed type from KeysetPagination! to KeysetPaginationWithoutTotalRecords! |
| PowerCabinet | Removed field manufaturerCertificate |
| RootMutationType.createCharger | Removed arguments: ocppPassword, powerDistribution |
| RootMutationType.createChargerModel | Removed arguments: authorizations, chargerElectricConnectionId, chargerType, connectorModels, description, externalId, links, mainPhotoId, manufacturerId, maxDischargePower, maxPower, name, photoIds, powerDistributionModes |
| RootQueryType.meterValues | Removed argument chargerConnectorNumbers, Added argument filter: FilterByMeterValue! |
| RootQueryType.scLogs | Changed type for argument pagination from KeysetPaginationParams to KeysetPaginationWithoutTotalRecordsParams |
| SampledValue.unit | Changed type from String! to String |
| SubscriptionBlockDemandCharge | Removed field blockRateCentsPerKw |
| SubscriptionBlockDemandChargeInput | Removed input field blockRateCentsPerKw, Added input field priceCentsPerBlock |
| Transaction.authorizationType | Changed type from TransactionAuthorizationType! to TransactionAuthorizationType |
| Transaction | Removed fields duration, startTimestamp, stopTimestamp |
| TransactionReport | Removed fields startTimestamp, stopTimestamp |
| UpdatePowerCabinetInput | Removed input field manufacturerCertificate |
| UpdateUtilityRateResult Union type | Removed member UtilityRateSubscriptionBlockDemandChargeBlockRateCentsPerKwMustBePositiveValidationError |
| UtilityRateSubscriptionBlockDemandChargeBlockRateCentsPerKwMustBePositiveValidationError | Removed type |
⚠️ 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 |
| ChargerExportColum Enum | Added enum value LAST_USED_PROTOCOL |
| ChargerExportColumn Enum | Added enum value OPERATIONAL_MODE |
| ChargerExportColumn Enum | Added enum value REPORTED_FIRMWARE_VERSION |
| ChargerOrderByFields Enum | Added enum value REPORTED_FIRMWARE_VERSION |
| ChargerStatisticsFilter Input Object type | Added input field disconnected |
| ChargerStatisticsFilter Input Object type | Added input field lastUsedProtocol |
| ConnectorStateValue Enum | Added enum value OCCUPIED |
| ConnectorStatus Enum | Added enum value OCCUPIED |
| CreateUtilityRateResult Union type | Added member UtilityRateSubscriptionBlockDemandChargePriceCentsPerBlockMustBePositiveValidationError |
| ExportType Enum | Added enum value TRANSACTIONS_PG |
| ExportType Enum | Added enum value TRANSACTIONS_REDSHIFT |
| FilterByAccountStats Input Object type | Added input field ocppVersions |
| FilterByAggregatedTransaction Input Object type | Added input field ocppVersions |
| FilterByAsset Input Object type | Added input field lastUsedProtocol |
| FilterByCharger Input Object type | Added input fields disconnected, lastUsedProtocol, operationalMode, reportedFirmwareVersions, reportedVendorName |
| FilterByChargerState Input Object type | Added input fields disconnected, lastUsedProtocol |
| FilterByClusteredAsset Input Object type | Added input field lastUsedProtocol |
| FilterByEnergyEfficiency Input Object type | Added input field ocppVersions |
| FilterByTransaction Input Object type | Added input field ocppVersions |
| FilterByTransactionAnalytics Input Object type | Added input field ocppVersions |
| IssueSectionVendor Enum | Added enum values EATON, JOINT, ZEMETRIC |
| IssueSeverityCode Enum | Added enum value CRITICAL |
| OcppExportColumn Enum | Added enum value SOURCE |
| RootMutationType.createCharger | Added argument ocpp16ChargerSpecificFields: CreateOcpp16ChargerSpecificFieldsInput |
| RootMutationType.createChargerModel | Added argument params: CreateChargerModelParams |
| RootMutationType.updateCharger | Added argument ocpp16ChargerSpecificFields: UpdateOcpp16ChargerSpecificFieldsInput |
| RootMutationType.updateChargerModel | Added argument params: UpdateChargerModelParams |
| RootQueryType.billingAccountDrivers | Added argument orderBy: BillingAccountDriverOrderByParams |
| TransactionDiagnosticExportColumn Enum | Added enum values CHARGING_DURATION, CHARGING_END_TIMESTAMP, CHARGING_START_TIMESTAMP, IDLE_DURATION, OCPP_VERSION, PLUGGED_AT, PLUGGED_DURATION, UNPLUGGED_AT |
| TransactionExportColumn Enum | Added enum values CHARGING_DURATION, CHARGING_END_TIMESTAMP, CHARGING_START_TIMESTAMP, IDLE_DURATION, OCPP_VERSION, OFFLINE, PLUGGED_AT, PLUGGED_DURATION, UNPLUGGED_AT |
| UpdateUtilityRateResult Union type | Added member UtilityRateSubscriptionBlockDemandChargePriceCentsPerBlockMustBePositiveValidationError |
Driver API Potential Issues
| Object/Field/Type | Change Description |
| ConnectorStatus Enum | Added enum value OCCUPIED |
✅ Safe Changes
These changes include additions, deprecations, or description updates that are backward-compatible and should not break existing implementations.
Management API Safe Changes
| Object/Field/Type | Change Description |
| AggregatedChargerConnectorStateReport.chargerConnectorType | Description updated to include OCPP 1.6 context |
| AggregatedChargerConnectorStateReport | Added field chargerEvseNumber |
| AggregatedChargerConnectorStateReport | Added field chargerLastUsedProtocol |
| AggregatedChargerConnectorStateReport.chargerSerialNumber | Description updated for clarity on latest value source |
| AggregatedChargerConnectorStateReport.durationOperational | Description updated to include OCCUPIED state |
| AggregatedChargerConnectorStateReport | Added field reportedChargerConnectorType |
| BillingAccountDriverOrderByFields | Type added |
| BillingAccountDriverOrderByParams | Type added |
| CachedChargerStateStatsEntity.chargerAvailability | Description updated to include occupied status |
| CachedChargerStateStatsEntity.inUse | Description updated to include occupied status |
| Charger.chargeBoxSerialNumber | Description updated and field deprecated with replacement noted |
| Charger.chargePointModel | Description updated and field deprecated with replacement noted |
| Charger.chargePointSerialNumber | Description updated and field deprecated with replacement noted |
| Charger.chargePointVendor | Description updated and field deprecated with replacement noted |
| Charger | Added field evseUnits |
| Charger.firmwareVersion | Description updated and field deprecated with replacement noted |
| Charger.inProxyMode | Description updated and field deprecated in favor of OperationalMode |
| Charger.lastActionableIssue | Description updated to reflect new severity level |
| Charger | Added field lastUsedProtocol |
| Charger.meterSerialNumber | Description updated and field deprecated with replacement noted |
| Charger.meterType | Description updated and field deprecated with replacement noted |
| Charger | Added fields ocpp16ChargerScecificFields, operationalMode, reportedFirmwareVersion, reportedModel, reportedSerialNumber, reportedVendorName |
| ChargerConnector | Added field reportedType |
| ChargerConnectorState.chargerConnectorType | Description updated to include OCPP 1.6 context |
| ChargerConnectorState | Added fields chargerEvseNumber, reportedChargerConnectorType |
| ChargerFilterByOcppProtocol | Type added |
| ChargerFirmwareVersions | Description updated (deprecated), field firmwareVersion also deprecated |
| ChargerModel | Added field ocppVersions |
| ChargerOrderByFields.FIRMWARE_VERSION | Description updated to make as deprecated |
| ChargerStateStatistics.chargerAvailability | Description updated to include occupied status |
| ChargerStateStatistics.inUse | Description updated to include occupied status |
| ChargerUptime.chargerAvailability | Description updated to include occupied status |
| ChargerUptime.inUse | Description updated to include occupied status |
| ChargingState | Type added |
| ConnectorState | Added fields connectorNumber, evseNumber |
| ConnectorsStatusDuration | Added field occupied |
| CreateChargerModelParams | Type added |
| CreateOcpp16ChargerSpecificFieldsInput | Type added |
| EssentialChargerAsset | Fields and descriptions updated or deprecated similarly to Charger type |
| EssentialTransaction | Added fields charging, chargingState, connection, idleDuration, ocppVersion, offline, session |
| EvseUnit | Type added |
| FilterByCharger.chargePointVendor | Description marked as deprecated |
| FilterByCharger.firmwareVersions | Description marked as deprecated |
| FilterByMeterValue | Type added |
| FinacialReport.stopTimestamp | Description updated |
| Firmware.systemVendor | Description updated to use reported_vendor_name |
| MeterValue | Added field evse |
| MeterValueEvse | Type added |
| MeterValueEvseInput | Type added |
| Ocpp16ChargerSpecificFields | Type added |
| OcppProtocol | Type added |
| OcppVersion | Description updated |
| OperationalMode | Type added |
| PowerBiEmbedToken | Type added |
| PowerBiReport | Type added |
| ReportedChargerFirmwareVersions | Type added |
| RootMutationType.createFirmware.systemVendor | Description updated to use reported_vendor_name |
| RootMutationType | Added fields setPowerBiReportForAccount, setSecurityProfileInfo, transactionsPgExport, transactionsRedshiftExport |
| RootMutationType.updateFirmware.systemVendor | Description updated to use reported_vendor_name |
| RootQueryType.chargerFirmwareVersions | Field deprecated with reason provided |
| RootQueryType | Added fields fetchReportByAccountId, reportedChargerFirmwareVersions |
| RootQueryType.scLogs.pagination | Description updated to exclude total param |
| SampledValue | Added field signedMeterValue, unitOfMeasure and updated unit description |
| SignedMeterValue | Type added |
| SubscriptionBlockDemandCharge | Added field priceCentsPerBlock |
| Transaction | Added fields charging, chargingState, connection, evseUnit, idleDuration, ocppVersion, offline, session |
| TransactionCharging | Type added |
| TransactionConnection | Type added |
| TransactionReport | Added fields charging, connection, idleDuration, ocppVersion, offline, session |
| TransactionSession | Type added |
| UnitOfMeasure | Type added |
| UpdateChargerModelParams | Type added |
| UpdateOcpp16ChargerSpecificFieldsInput | UtilityRateSubscriptionBlockDemandChargePriceCentsPerBlockMustBePositiveValidationError |
| UtilityRateSubscriptionBlockDemandChargePriceCentsPerBlockMustBePositiveValidationError | Type added |
Driver API Safe Changes
| Object/Field/Type | Change Description |
| Charger | Added field lastUsedProtocol |
| ChargerConnector.availability | Description updated for typo fic (from “avaiaibility” to “availability”) |
| ChargerConnector.connectorModelType | Description updated to reflect OCPP 1.6 context |
| ChargerConnector | Added field reportedType |
| OcppProtocol | Type added |
| PublicReceiptChargerConnector.connectorModelType | Description updated to reflect OCPP 1.6 context |
| PublicReceiptChargerConnector | Added field reportedType |