v4.6 API Changelog
November 2024
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 |
| AggregatedStatisticsReportFilter | Type removed |
| AggregatedTransaction.totalCost | Changed type from Decimal to Int |
| ChargerStatisticsFilter.datetimeRange | Changed type from Datetimerange! to DatetimerangeWithTimezone! |
| ConnectorModelParams | Added input field liquidCooling |
| ConsumptionRateBand | Removed field displayName |
| ConsumptionRateBandInput | Removed input field displayName, Added input field fullDisplayName |
| FilterByChargerState.datetimeRange | Changed type from Datetimerange! to DatetimerangeWithTimezone! |
| FinancialReport.ocppTransactionId | Changed type from IntId to String |
| RootMutationType.chargerStatesStatisticsExport.filter | Changed type from AggregatedStatisticsReportFilter! to ChargerStatisticsFilter! |
| RootMutationType.moveChargersHistory | Removed argument includeRedshift: Boolean |
| RootQueryType.applications | Removed argument searchValue: String |
| RootQueryType.chargerStatesStatisticsReport.filter | Changed type from AggregatedStatisticsReportFilter! to ChargerStatisticsFilter! |
| RootQueryType.transactionsReportRedshift.orderBy | Changed type from TransactionOrderByParams to TransactionRedshiftOrderByParams |
| RootQueryType.utilityRates.searchValue | Changed type from String to TrimmedString |
| Transaction.ocppTransactionId | Changed type from Int! to String! |
| Transaction.site | Changed type from Site to VariedAccessSite! |
| Transaction.totalCost | Changed type from Decimal to Int |
| TransactionReport.totalCost | Changed type from Decimal to Int |
| UtilityRateConsumptionRateBandRequiredStringFields Enum | Removed enum value DISPLAY_NAME |
Driver API Breaking Changes
| Object/Field/Type | Change Description |
| Transaction.ocppTransactionId | Changed type from Int! to String! |
⚠️ 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 |
| ChargerExportColumn Enum | Added enum values CONFIG_TEMPLATE_NAME, POWER_CABINET_NAME |
| ChargerStatesExportColumn Enum | Added enum values CHARGER_NAME, CHARGER_SERIAL_NUMBER |
| ChargerType Enum | Added enum value DC_DISPENSER |
| ConsumptionRateBandInput | Added input field shortDisplayName |
| CreateTransactionAuthorizationArgValidationProblem Union | Added members CreateTransactionAuthorizationNullForbidReasonForAllowCheckConstraintProblem, CreateTransactionAuthorizationNullGroupIdAuthorizationKeyForForbidCheckConstraintProblem |
| ExportType Enum | Added enum values EVE_TRANSACTIONS, POWER_CABINETS |
| FilterByApplication.withSubAccounts | Default value changed from undefined to true |
| FilterType Enum | Added enum value SPLIT_SYSTEM |
| IssueSectionVendor Enum | Added enum value ZEROVA |
| NotableType Enum | Added enum value POWER_CABINET |
| ObjectClases Enum | Added enum value POWER_CABINET |
| RootMutationType.chargersExport | Added argument powerCabinetSearchValue: TrimmedString |
| RootMutationType.createCharger | Added argument eveState: EveStateInput |
| RootMutationType.createTransactionAuthorization | Added arguments forbidReason: TransactionAuthorizationForbidReason, groupIdAuthorizationKey: String |
| RootMutationType.createTransactionAuthorizationWithTypedErrors | Added argument groupIdAuthorizationKey: String |
| RootMutationType.updateCharger | Added argument eveState: EveStateInput |
| RootMutationType.updateTransactionAuthorization | Added arguments forbidReason: TransactionAuthorizationForbidReason, groupIdAuthorizationKey: String |
| RootMutationType.updateTransactionAuthorizationWithTypedErrors | Added arguments forbidReason: TransactionAuthorizationForbidReason, groupIdAuthorizationKey: String |
| RootQueryType.applications | Added argument search: SearchByApplication |
| RootQueryType.chargers | Added argument powerCabinetSearchValue: TrimmedString |
| RootQueryType.clusteredChargers | Added argument powerCabinetSearchValue: TrimmedString |
| RootQueryType.transactionStatistics | Added argument orderBy: TransactionStatisticOrderByParams |
| RootQueryType.utilityRates | Added argument filter: FilterByUtilityRate |
| TagEntityModel Union | Added member PowerCabinet |
| TransactionOrderByFields Enum | Added enum value PEAK_CHARGING_POWER |
| UpdateTransactionAuthorizationArgValidationProblem Union | Added members UpdateTransactionAuthorizationNullForbidReasonForAllowCheckConstraintProblem, UpdateTransactionAuthorizationNullGroupIdAuthorizationKeyForForbidCheckConstraintProblem |
| UtilityRateConsumptionRateBandRequiredStringFields Enum | Added enum value FULL_DISPLAY_NAME |
✅ 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 |
| ApplicationSearchableFields | Type added |
| AssetUpdatesParams | Type added |
| Charger | Added fields eveState, powerCabinet |
| ChargerConnector.lastTransaction | Description updated for clarity |
| ChargerEveSetting | Type added |
| ChargerEveState | Type added |
| ChargerModel | Added field ocppVersion |
| ChargerPowerCabinet | Type added |
| ChargerPowerCabinetDispenser | Type added |
| ChargerResetType | Type added |
| ChargerStatisticsFilter | Description updated for clarification |
| ChargingStationOnboardingMode | Type added |
| ConnectorModelChargerModel | Added field liquidCooling |
| ConsumptionRateBand | Added fields fullDisplayName, shortDisplayName |
| CreatePowerCabinetInput | Type added |
| CreateTransactionAuthorizationNullForbidReasonForAllowCheckConstraintProblem | Type added |
| CreateTransactionAuthorizationNullGroupIdAuthorizationKeyForForbidCheckConstraintProblem | Type added |
| EssentialChargerAsset | Type added |
| EssentialChargerConnector | Type added |
| EssentialEvccid | Type added |
| EssentialTransaction | Type added |
| EssentialVehicleAsset | Type added |
| EveChargerTransactionsRefresh | Type added |
| EveSetting | Type added |
| EveSettingsInput | Type added |
| EveState | Type added |
| EveStateInput | Type added |
| EveTransaction | Type added |
| EveTransactionExportColumn | Type added |
| EveTransactionOrderByFields | Type added |
| EveTransactionOrderByParams | Type added |
| FilterByEveTransaction | Type added |
| FilterByPowerCabinet | Type added |
| FilterByUtilityRate | Type added |
| InaccessibleSite | Type added |
| InputUpdatableLink | Type added |
| ModelPowerRange | Type added |
| OcppVersion | Type added |
| PaginatedEveTransactions | Type added |
| PaginatedPowerCabinetModels | Type added |
| PaginatedPowerCabinets | Type added |
| PowerCabinet | Type added |
| PowerCabinetExportColumn | Type added |
| PowerCabinetModel | Type added |
| PowerCabinetOrderByFields | Type added |
| PowerCabinetOrderByParams | Type added |
| PowerCabinetWarranty | Type added |
| PowerCabinetWarrantyInput | Type added |
| RootMutationType | Added fields: createPowerCabinet, createPowerCabinetModel, deletePowerCabinet, deletePowerCabinetModel, eveTransactionsExport, fetchEveState, fetchEveTransactions, forceSetSecurityProfile, linkDispenserToPowerCabinet, powerCabinetsExport, resetCharger, resetOnboardingStatus, unlinkDispenserFromPowerCabinet, updateEveSetting, updateEveState, updatePowerCabinet, updatePowerCabinetModel |
| RootQueryType | Added fields: eveTransactions, powerCabinet, powerCabinetModel, powerCabinetModels, powerCabinets |
| RootSubscriptionType.assetUpdates | Field deprecated with reason: “Please use chargerAssetUpdates and vehicleAssetUpdates instead” |
| RootSubscriptionType | Added fields: chargerAssetUpdates, eveTransactionAdded, vehicleAssetUpdates |
| SearchByApplication | Type added |
| SettingUpdateResult | Type added |
| Site | Added field powerCabinets |
| TransactionAuthorization | Added fields: forbidReason, groupIdAuthorizationKey |
| TransactionAuthorizationForbidReason | Type added |
| TransactionRedshiftOrderByFields | Type added |
| TransactionRedshiftOrderByParams | Type added |
| TransactionStatisticOrderByFields | Type added |
| TransactionStatisticOrderByParams | Type added |
| TrimmedString | Type added |
| UpdatePowerCabinetInput | Type added |
| UpdateTransactionAuthorizationNullForbidReasonForAllowCheckConstraintProblem | Type added |
| UpdateTransactionAuthorizationNullGroupIdAuthorizationKeyForForbidCheckConstraintProblem | Type added |
| VariedAccessSite | Type added |
Driver API Safe Changes
| Object/Field/Type | Change Description |
| Charger | Added field commonStatus |
| CommonStatus | Type added |