Service Reference Variant

2.1 · Update Prepay Configuration

Service details

Identifiers, rules, and applicability

Service reference
2.1
Service Reference Variant
2.1
DUIS section
3.8.8
Command variants
4, 5, 6, 7
DUIS possible responses
Response to Transform Request - PreCommand FormatAcknowledgementService Response from Device - GBCSPayloadFutureDatedDeviceAlertMessageResponse to a Command for Local Delivery Request - LocalCommand FormatCountersigned SMETS1 Response
Critical
Yes
Sensitive response
No
Protection against replay
Yes
On demand
Yes
Future dated
Device
DSP scheduled
No
DCC only
No
SMETS1 applicability
Yes
SAPC requirement
Optional
DUIS applicability
3.0, 3.1, 4.0, 5.0, 5.1, 5.2, 5.3

Cross-specification evidence

SMETS/CHTS to GBCS Mapping

This section shows the SMETS and CHTS attributes that can be read or written by the identified GBCS Use Case. Command requirements are shown separately from the mapped attributes.

ECS08a7 attributes0x00DEESME
SpecificationItemReferenceDescription
SMETSDebt Recovery Rate Cap [INFO]5.7.4.13The maximum amount in Currency Units per unit time that can be recovered through Payment-based Debt Recovery when ESME is operating in Prepayment Mode.
SMETSEmergency Credit Limit [INFO]5.7.4.16The amount of Emergency Credit in Currency Units to be made available to a Consumer where Emergency Credit is activated.
SMETSEmergency Credit Threshold [INFO]5.7.4.17The threshold in Currency Units below which Emergency Credit Balance [INFO](5.7.5.15) may be activated if so configured when ESME is operating in Prepayment Mode.
SMETSLow Credit Threshold [INFO]5.7.4.23The threshold in Currency Units below which a low credit Alert is signalled.
SMETSMaximum Credit Threshold5.7.4.25The maximum credit which can be applied by any Add Credit Command.
SMETSMaximum Meter Balance Threshold5.7.4.27The Meter Balance [INFO](5.7.5.22) threshold in Currency Units above which an Add Credit Command is rejected.
SMETSNon-Disablement Calendar [INFO]5.7.4.30A Switching Table comprising a set of rules specifying periods during which the Supply will not be Disabled due to the Meter Balance [INFO](5.7.5.22) being below, or falling below, the Disablement Threshold [INFO](5.7.4.15) and, if Emergency Credit is activated, the Emergency Credit Balance [INFO](5.7.5.15) being, or falling to, zero, when ESME is operating in Prepayment Mode.
GCS058 attributes0x006FGSME
SpecificationItemReferenceDescription
SMETSBilling Calendar4.6.4.2A calendar defining billing dates for the storage of billing related information in the Billing Data Log(4.6.5.3).
SMETSDebt Recovery Rate Cap4.6.4.10The maximum amount in Currency Units per unit time that can be recovered through Payment-based Debt Recovery when GSME is operating in Prepayment Mode.
SMETSEmergency Credit Limit4.6.4.13The amount of Emergency Credit in Currency Units to be made available to a Consumer where Emergency Credit is activated.
SMETSEmergency Credit Threshold4.6.4.14The threshold in Currency Units below which Emergency Credit Balance(4.6.5.8) may be activated if so configured when GSME is operating in Prepayment Mode.
SMETSLow Credit Threshold4.6.4.16The threshold in Currency Units below which a low credit Alert is signalled.
SMETSMaximum Credit Threshold4.6.4.17The maximum credit which can be applied by any Add Credit Command.
SMETSMaximum Meter Balance Threshold4.6.4.18The Meter Balance(4.6.5.11) threshold in Currency Units above which an Add Credit Command is rejected.
SMETSNon-Disablement Calendar4.6.4.20A Switching Table comprising a set of rules specifying periods during which the Supply will not be Disabled due to the Meter Balance(4.6.5.11) being below, or falling below, the Disablement Threshold(4.6.4.12) and, if Emergency Credit is activated, the Emergency Credit Balance(4.6.5.8) being, or falling to, zero when GSME is operating in Prepayment Mode.

Specific Errors

Response codes and descriptions

No specific validation is defined for this SRV.

GBCS Use Case

Use cases, device coverage, and applicability

Use Case / Message Code
ECS080x001F
DUIS Applicability
v3.0 – v5.3
GBCS Applicability
v1.0 – v1.1
GBCS Criticality
Critical
Sensitive Response
No
Future Dated
Device
GBT
No
SMETS1 Applicable
No
Eligible Roles
EISESME
Use Case / Message Code
ECS08a0x00DE
DUIS Applicability
v3.0 – v5.3
GBCS Applicability
v2.0 – v4.3
GBCS Criticality
Critical
Sensitive Response
No
Future Dated
Device
CommandESMENot always GBT
SMETS1 Applicable
Yes
Eligible Roles
EISESME
Use Case / Message Code
GCS050x006F
DUIS Applicability
v3.0 – v5.3
GBCS Applicability
v1.0 – v4.3
GBCS Criticality
Critical
Sensitive Response
No
Future Dated
Device
GBT
No
SMETS1 Applicable
Yes
Eligible Roles
GISGSME

DUIS Service Definition

Data items and DCC processing

Request data items

Table 96: UpdatePrepayConfiguration (sr: UpdatePrepayConfiguration) data items
Data ItemDescription / Valid SetTypeMandatoryDefaultUnits
ExecutionDateTimeA User shall only add this Data Item to the Service Request where they require the Service Request to be executed at a future date and time. The UTC date and time the User requires the command to be executed on the Device Date-time in the future that is either <= current date + 30 days or the date = ‘3000-12-31T00:00:00Z’xs:dateTimeNoNoneUTC Date-Time
UpdatePrepayConfigElectricityElectricity Smart Meter Prepay configuration elementssr: UpdatePrepayConfigElec see Table 97Device Type = Electricity Smart Meter Yes Otherwise, N/ANoneN/A
UpdatePrepayConfigGasGas Smart Meter Prepay configuration elementssr: UpdatePrepayConfigGas see Table 98Device Type = Gas Smart Meter Yes Otherwise, N/ANoneN/A
Table 97: UpdatePrepayConfigElectricity (sr: UpdatePrepayConfigElec) data items
Data ItemDescription / Valid SetTypeMandatoryDefaultUnits
DebtRecoveryRateCapThe maximum amount in Currency Units per unit time (week) that can be recovered through Payment-based Debt Recovery when the Meter is operating in prepayment mode.xs: unsignedShortYesNoneGBP / ECB / week
EmergencyCreditLimitThe amount of Emergency Credit in Currency Units to be made available to a Consumer when Emergency Credit is activated by the Consumer.xs:intYesNone1000th pence / cent
EmergencyCreditThresholdThe threshold in Currency Units below which Emergency Credit may be activated by the Consumer, if so configured, when the Meter is operating in prepayment mode.xs:intYesNone1000th pence / cent
LowCreditThresholdThe threshold in Currency Units below which a low credit Alert is signalled.xs:intYesNone1000th pence / cent
ElectricityNonDisablementCalendarA calendar defining UTC times, days and dates that specify periods during which the Supply will not be Disabled when the meter is operating in prepayment mode, in on and off dates/times.sr:ElectricityNonDisablementCalendarYesNoneN/A
MaxMeterBalanceThe Meter Balance threshold in Currency Units above which an Add Credit Command is rejected.xs:intYesNone1000th pence / cent
MaxCreditThresholdThe maximum credit which can be applied by any Add Credit Commandxs:intYesNone1000th pence / cent
Table 98: UpdatePrepayConfigGas(sr: UpdatePrepayConfigGas) data items
Data ItemDescription / Valid SetTypeMandatoryDefaultUnits
DebtRecoveryRateCapThe maximum amount in Currency Units per unit time (week) that can be recovered through Payment-based Debt Recovery when the Meter is operating in prepayment mode.xs:intYesNone1000th pence / cent / week
EmergencyCreditLimitThe amount of Emergency Credit in Currency Units to be made available to a Consumer when Emergency Credit is activated by the Consumer.xs:unsignedIntYesNone1000th pence / cent
EmergencyCreditThresholdThe threshold in Currency Units below which Emergency Credit may be activated by the Consumer, if so configured, when the Meter is operating in prepayment mode.xs:unsignedIntYesNone1000th pence / cent
LowCreditThresholdThe threshold in Currency Units below which a low credit Alert is signalled.xs:unsignedIntYesNone1000th pence / cent
GasNonDisablementCalendarA calendar defining UTC times, days and dates that specify periods during which the Supply will not be Disabled when the meter is operating in prepayment mode, in on and off dates/times. Calendar defining the time periods when Non-Disablement applies or doesn’t apply. The calendar includes the definition of: • Day Identifiers. Array of up to 5 elements, each including a Day ID and up to 3 times of day to run a script to start or end a disablement period • Weeks. Array of up to 2 elements, each including a Week ID and the Day ID associated to each day of that Week ID • Seasons. Array of up to 3 elements, each including a Season Start Date and the Week ID associated to that Season • Special Days. Array of up to 20 Special Day elements, defined as a date and Referenced Day Name. Special Days (e.g. public holidays) are used to apply different switching rules to those defined in the corresponding season.sr:GasNonDisablementCalendarYesNoneN/A
MaxMeterBalanceThe Meter Balance threshold in Currency Units above which an Add Credit Command is rejected.xs:unsignedIntYesNone1000th pence / cent
MaxCreditThresholdThe maximum credit which can be applied by any Add Credit Commandxs:unsignedIntYesNone1000th pence / cent
Table 99: ElectricityNonDisablementCalendar (sr:ElectricityNonDisablementCalendar) data items
Data ItemDescription / Valid SetTypeMandatoryDefaultUnits
ElectricitySpecialDaysA collection of between 0 and 20 Special Days within the mandatory group itemsr:ElecSpecialDaysPrepayment See Table 100Yes If there are no Special Days, this XML element will be present, but empty, i.e. it will contain 0 SpecialDay elementsNoneN/A
ElectricityNonDisablementScheduleList of up to 22 schedules defining the time periods when Non-Disablement applies or doesn’t applysr:ElectricityNonDisablementSchedule (minOccurs = 1, maxOccurs = 22) See Table 102YesNoneN/A
Table 100: Electricity Special Days (sr:ElecSpecialDaysPrepayment) data items
Data ItemDescription / Valid SetTypeMandatoryDefaultUnits
SpecialDayBetween 0 and 20 SpecialDay items Note that the attribute Index provides an ordering for these elementssr:ElecSpecialDayPrepayment (minOccurs = 0, maxOccurs = 20)NoNoneN/A
Index (attribute of SpecialDay)Provides a position within the collection of SpecialDay elements Unique and consecutive numbers starting at 1sr:range_1_20 (xs:positiveinteger minInclusive 1 maxInclusive 20)No (Required if SpecialDay has been defined)NoneN/A
Table 101: Special Day (sr:ElecSpecialDayPrepayment) data items
Data ItemDescription / Valid SetTypeMandatoryDefaultUnits
DateThe date on which the special day applies.sr:Date (with wildcards)YesNoneN/A
Table 102: ElectricityNonDisablementSchedule (sr:ElectricityNonDisablementSchedule) data items
Data ItemDescription / Valid SetTypeMandatoryDefaultUnits
NonDisablementScriptIdentifier to establish whether to begin (Start) or end (Stop) the non disablement period. Valid set: START STOPRestriction of xs: string (Enumeration)YesNoneN/A
SpecialDaysApplicabilitySpecial Days to which the schedule appliessr:SpecialDaysApplicability See Table 103Yes If there are no Special Days, this XML element will be present, but empty, i.e. it will contain 0 SpecialDayApplicability elementsNoneN/A
DaysOfWeekApplicabilityThe days of the week to which the schedule applies defined as an array of up to 7 DayOfWeekIDssr:DaysOfWeekApplicability See Table 105Yes Minimum of 0 and maximum of 7 Days Of Week Applicability. If there are no applicable Days, this XML element will be present, but empty, i.e. it will contain 0 DayOfWeekApplicability elementsNoneN/A
ScheduleDatesAndTimeThe switch time and date range (without wildcards) when the script is to be runsr:ScheduleDatesAndTimeWithoutWildcards See 3.10.1.20YesNoneN/A
Table 103: SpecialDaysApplicability (sr:SpecialDaysApplicability) data items
Data ItemDescription / Valid SetTypeMandatoryDefaultUnits
SpecialDayApplicabilityAn array of between 0 and 20 SpecialDayID elementssr:SpecialDayApplicability (minOccurs = 0, maxOccurs = 20)NoNoneN/A
Table 104: SpecialDayApplicability (sr:SpecialDayApplicability) data items
Data ItemDescription / Valid SetTypeMandatoryDefaultUnits
SpecialDayIDIdentifier of the Special Day, which correspond to the indices in SpecialDay Valid set: Value between 1 and 20Restriction of xs:positiveInteger (minInclusive = 1 maxInclusive = 20)YesNoneN/A
Table 105: DaysOfWeekApplicability (sr:DaysOfWeekApplicability) data items
Data ItemDescription / Valid SetTypeMandatoryDefaultUnits
DayOfWeekApplicabilityArray of Day Of Week IDs This indicates the days on which the schedule is active. Unique and chronologically ordered, may not be consecutive.sr:DayOfWeekApplicability (minOccurs = 0, maxOccurs = 7) If there are no applicable Days, this XML element will be present, but empty, i.e. it will contain 0 DayOfWeekApplicability elementsYesNoneN/A
Table 106: DayOfWeekApplicability (sr:DayOfWeekApplicability) data items
Data ItemDescription / Valid SetTypeMandatoryDefaultUnits
DayOfWeekIDThe day of the week to which the schedule applies Valid set: • Monday • Tuesday • Wednesday • Thursday • Friday • Saturday • Sundayxs:string (Enumeration)YesNoneN/A
Table 107: GasNonDisablementCalendar (sr:GasNonDisablementCalendar) data items
Data ItemDescription / Valid SetTypeMandatoryDefaultUnits
DayProfilesArray of up to 5 Day Profiles defining a Day ID and a list of 3 actions (script IDs) and start times during that day when an action (script ID) to either start or end a Non-Disablement period The actions (script IDs) applicable to this Service Request are: START STOPsr:GasNonDisablementDayProfilesYesNoneN/A
WeekProfilesArray of up to 2 elements within the group item, each including a Week ID and the Referemced Day Name associated to each day (Monday to Sunday) of that Week Namesr:GasWeekProfilesNonDisablementYesNoneN/A
SeasonProfilesArray of up to 3 elements, each including a Season Start Date and the Week ID associated to that Season.sr:GasSeasonsNonDisablementYesNoneN/A
SpecialDaysBetween 0 and 20 days when special Non- Disablement rules (rather than those defined in the Seasons) apply.sr:GasSpecialDaysNonDisablementYes If there are no Special Days, this XML element will be present, but empty, i.e. it will contain 0 SpecialDay elementsNoneN/A
Table 108: DayProfiles (sr:GasNonDisablementDayProfiles) data items
Data ItemDescription / Valid SetTypeMandatoryDefaultUnits
GasNonDisablementDayProfileArray of up to 5 Gas Non Disablement day Profilesr:GasNonDisablementDayProfile (minOccurs = 1, maxOccurs = 5)YesNoneN/A
Table 109: GasNonDisablementDayProfile (sr:GasNonDisablementDayProfile) data items
Data ItemDescription / Valid SetTypeMandatoryDefaultUnits
TimeStartActionList of Actions (script) to be taken and at what start timessr:GasNonDisablementTimeStartAction (minOccurs = 1, maxOccurs = 3)YesNoneN/A
GasDayNameIdentifier of the day to which the Time Start Action list appliessr:GasDayNameNonDisablement Restriction of xs:positiveInteger (minInclusive =1, maxInclusive = 5)YesNoneN/A
Table 110: TimeStartAction (sr:GasNonDisablementTimeStartAction) data items
Data ItemDescription / Valid SetTypeMandatoryDefaultUnits
StartTimeTime when a specific Action is to be taken The first one for each Day Profile has to be set to 00:00:00xs:timeYesNoneN/A
NonDisablementActionIdentifier of the Script to be run to apply or not apply Non-Disablement Valid set: START STOPRestriction of xs:string (Enumeration)YesNoneN/A
Table 111: WeekProfiles (sr:GasWeekProfilesNonDisablement) data items
Data ItemDescription / Valid SetTypeMandatoryDefaultUnits
WeekProfileArray of 2 Week Profile elementssr:WeekProfileGasNonDisablement (minOccurs = 1, maxOccurs = 2)YesNoneN/A
Table 112: WeekProfile (sr:WeekProfileGasNonDisablement) data items
Data ItemDescription / Valid SetTypeMandatoryDefaultUnits
WeekNameAn identifier for the week.sr:GasWeekName Restriction of xs:positiveInteger (minInclusive = 1, maxInclusive = 2)YesNoneN/A
ReferencedDayNameDay Identifier as defined abovesr:GasReferencedDayNameNonDisablement (minOccurs = 7 maxOccurs = 7) See Table 117Yes 7 elements, one for each day of the week (1: Monday, 7: Sunday)NoneN/A
Table 113: SeasonProfiles (sr:GasSeasonsNonDisablement) data items
Data ItemDescription / Valid SetTypeMandatoryDefaultUnits
SeasonArray of 3 Season elementssr:GasSeasonNonDisablement (minOccurs = 1, maxOccurs = 3)YesNoneN/A
Table 114: Season (sr:GasSeasonNonDisablement) data items
Data ItemDescription / Valid SetTypeMandatoryDefaultUnits
SeasonStartDateThe date from which this season is defined to startsr:GasDateWithWildcards See Table 319YesNoneN/A
ReferencedWeekNameWeekName as defined above in WeekProfileGas Definitionsr:GasWeekNameNonDisablement Restriction of xs:positiveInteger (minInclusive = 1, maxInclusive =2)YesNoneN/A
Table 115: SpecialDays (sr:GasSpecialDaysNonDisablement) data items
Data ItemDescription / Valid SetTypeMandatoryDefaultUnits
SpecialDayArray of between 0 and 20 Gas SpecialDay elementssr:GasSpecialDayNonDisablement minOccurs = 0 maxOccurs = 20NoNoneN/A
Table 116: SpecialDay (sr:GasSpecialDayNonDisablement) data items
Data ItemDescription / Valid SetTypeMandatoryDefaultUnits
DateThe date on which the special day appliessr:GasDateWithWildcards See Table 319YesNoneN/A
ReferencedDayNameGasDayNameas defined in GasNonDisablementDayProfile Definition abovesr:GasDayNameNonDisablementYesNoneN/A
Table 117: ReferencedDayName (sr:GasReferencedDayNameNonDisablement) data items
Data ItemDescription / Valid SetTypeMandatoryDefaultUnits
ReferencedDayNameDay Identifier Note that the attribute index provides an ordering for these elements.sr:GasDayNameNonDisablement (xs:positiveInteger minInclusive = 1, maxInclusive = 5)YesNoneN/A
IndexProvides an ordering for the ReferencedDayName elements Unique (may not be consecutive)sr:range_1_7 (positiveinteger minInclusive 1 maxInclusive 7)YesNoneN/A

Message Patterns & Examples

Pattern explorer

Open Message Patterns →

SMETS1 Supporting Requirements

Device-model variations and equivalent steps

Review the Section 18 requirements and their applicability across the documented manufacturer, Device Type, model, and firmware profiles.

Open S1SR Requirements →