- IntegrationEventContract.proto
- Charges and charge prices events
- Charge link events
- Charge link requests and replies
Charges domain related integration events.
Note: The integration events adhere to the architecture decision record (ADR-0008), which among other things defines the integration event's meta data.
Represents the creation of a new charge.
Represents the update of a charge period.
| Field | Type | Label | Description |
|---|---|---|---|
| ChargeId | string | required | A charge identifier provided by the Market Participant. Combined with Charge Owner and Charge Type it becomes unique |
| ChargeType | enum | required | The type of charge; tariff, fee or subscription |
| ChargeOwner | string | required | A charge owner identification, e.g. the Market Participant's GLN or EIC number |
| ChargePeriod | ChargePeriod | required | Contains the charge's changed validity period |
Represents a charge period.
| Field | Type | Label | Description |
|---|---|---|---|
| StartDateTime | Timestamp | required | In UTC. The charge period's valid from date and time |
| EndDateTime | Timestamp | optional with default value | In UTC. The charge period's valid to date and time. The default value will be the equivalent to 9999-12-31T23:59:59Z without milliseconds |
The Timestamp type is documented here.
Represents the discontinuation of a charge.
| Field | Type | Label | Description |
|---|---|---|---|
| ChargeId | string | required | A charge identifier provided by the Market Participant. Combined with Charge Owner and Charge Type it becomes unique |
| ChargeType | enum | required | The type of charge; tariff, fee or subscription |
| ChargeOwner | string | required | A charge owner identification, e.g. the Market Participant's GLN or EIC number |
| EndDateTime | Timestamp | required | In UTC. The date and time the charge is discontinued |
Represents the cancellation of the charge discontinuation.
| Field | Type | Label | Description |
|---|---|---|---|
| ChargeId | string | required | A charge identifier provided by the Market Participant. Combined with Charge Owner and Charge Type it becomes unique |
| ChargeType | enum | required | The type of charge; tariff, fee or subscription |
| ChargeOwner | string | required | A charge owner identification, e.g. the Market Participant's GLN or EIC number |
| CancelledEndDateTime | Timestamp | required | In UTC. The date and time that the cancellation applies (expected to hit a previous discontinuation) |
Represents the creation and update of one or more charge prices.
Represents the creation of a new charge link
Represents the update of one or more charge links.
| Field | Type | Label | Description |
|---|---|---|---|
| ChargeLinkId | string | required | An identifier for the charge link event. Provided by the Market Participant. Uniqueness cannot be guaranteed |
| MeteringPointId | string | required | A unique metering point identifier |
| ChargeId | string | required | A charge identifier. Combined with Charge Owner and Charge Type it becomes unique |
| ChargeType | enum | required | The type of charge; tariff, fee or subscription |
| ChargeOwner | string | required | A charge owner identification, e.g. the Market Participant's GLN or EIC number |
| UpdatedPeriodStartDateTime | Timestamp | required | In UTC. Time interval covering the entire period of charge link updates within this event. The start equals the StartDateTime of the earliest charge link in the Periods list |
| UpdatedPeriodEndDateTime | Timestamp | required | In UTC. Time interval covering the entire period of charge link updates within this event. The end equals the EndDateTime of the latest charge link in the Periods list |
| Periods | ChargeLinkPeriod | required | A list of charge link periods and factor values |
Represents a charge link period.
| Field | Type | Label | Description |
|---|---|---|---|
| StartDateTime | Timestamp | required | In UTC. The charge link period's valid from date and time |
| EndDateTime | Timestamp | optional with default value | In UTC. The charge link period's valid to date and time. The default value will be the equivalent to 9999-12-31T23:59:59Z without milliseconds |
| Factor | int | required | Indicates the number of times the same fee or subscription must be collected. Always 1 for tariffs |
This request is used by the Metering Point domain as part of the 'Create metering point' process to request the Charges domain to link default charges for the newly created metering point and to create messages containing the default charge links and make them available to the relevant Market Participants.
The Charges domain will use this reply to inform the Metering Point domain when the CreateDefaultChargeLinks request has been processed.