Create, retrieve, update, and search metering points.
List Metering Points by Invoice Group
Returns an overview of all metering points and their current contracts for the specified invoice group.
path Parameters
guid^([0-9A-Fa-f]{32}$|^… · requiredThe invoice group ID.
UC Identifier
query Parameters
showallWhen true, includes reverted and ended metering points.
limitThe maximum number of metering points to return.
List Metering Points by Invoice Group › Responses
Returns a simplified overview of the metering points and their current contracts
List Metering Points by Third-Party Invoice Group ID
Returns a simplified overview of all metering points and their current contracts for the invoice group identified by the given ID in a third-party system.
path Parameters
idThe invoice group ID in the third-party system.
tpidThe third-party system identifier.
query Parameters
showallWhen true, includes reverted and ended metering points.
limitThe maximum number of metering points to return.
List Metering Points by Third-Party Invoice Group ID › Responses
Returns a simplified overview of the metering points and their current contracts
List Contracts by Invoice Group and Metering Point
Returns all contracts on the specified metering point that belong to the specified invoice group.
path Parameters
guid^([0-9A-Fa-f]{32}$|^… · requiredThe invoice group ID.
UC Identifier
acid^([0-9A-Fa-f]{32}$|^… · requiredThe metering point ID.
List Contracts by Invoice Group and Metering Point › Responses
Returns all contracts belonging to the invoice group on the metering point
List Contracts by Third-Party Invoice Group and Metering Point
Returns all contracts on the specified metering point that belong to the invoice group identified by the given ID in a third-party system.
path Parameters
idThe invoice group ID in the third-party system.
tpidThe third-party system identifier.
acidThe metering point ID.
List Contracts by Third-Party Invoice Group and Metering Point › Responses
Returns all contracts belonging to the invoice group on the metering point
List Metering Points
Create Metering Point
Creates a new metering point for the tenant.
Headers
servicetypeThe service type of the metering point.
Create Metering Point › Request Body
RequestId^([0-9A-Fa-f]{32}$|^… · requiredRequest ID, must be unique
IdentificationThe accounting point identifier
VatCodeEstimatedAnnualConsumptionEstimatedAnnualProductionCreate Metering Point › Responses
Request accepted
MessageList Metetering Points by GSRN
Get Metering Point
Returns the metering point with the specified ID.
path Parameters
guid^([0-9A-Fa-f]{32}$|^… · requiredThe metering point ID.
UC Identifier
Get Metering Point › Responses
Returns the metering point
VatCodeEstimatedAnnualProductionThe estimated annual production
IdentificationThe accounting point identifier
Guid^([0-9A-Fa-f]{32}$|^…UC Identifier
EstimatedAnnualConsumptionThe estimated annual consumption
MeteringGridAreaUsedDomainLocationIdentificationLastMeterReadingDateGridOwnerReplace Metering Point
Replaces the updatable fields of the specified metering point with the values provided in the request body.
path Parameters
guid^([0-9A-Fa-f]{32}$|^… · requiredThe metering point ID.
UC Identifier
Replace Metering Point › Request Body
RequestId^([0-9A-Fa-f]{32}$|^… · requiredRequest ID, must be unique
VatCodeEstimatedAnnualConsumptionEstimatedAnnualProductionReplace Metering Point › Responses
Request accepted
MessageUpdate Metering Point
Updates one or more fields of the specified metering point.
path Parameters
guid^([0-9A-Fa-f]{32}$|^… · requiredThe metering point ID.
UC Identifier
Update Metering Point › Request Body
RequestId^([0-9A-Fa-f]{32}$|^… · requiredRequest ID, must be unique
VatCodeEstimatedAnnualConsumptionEstimatedAnnualProductionUpdate Metering Point › Responses
Request accepted
MessageUpdate VAT and ElCert Share
Updates the VAT code and electricity certificate share on the specified metering point. Each value applies from a given start date, so several values can be set to take effect on different dates.
If the submitted values for VAT code or electricity certificate share differ from the current ones, they replace the existing values in full; an unchanged set is ignored. At least one of the two must contain a change, otherwise the request is rejected. Each value must have a value and a valid start date, and two values with the same start date are not allowed.
The update is processed asynchronously. A 202 response confirms the request was accepted, not that it has been applied. Requires super-user permissions.
path Parameters
guid^([0-9A-Fa-f]{32}$|^… · requiredThe metering point GSRN identification number.
UC Identifier
Update VAT and ElCert Share › Request Body
RequestId^([0-9A-Fa-f]{32}$|^… · requiredRequest ID, must be unique
Update VAT and ElCert Share › Responses
Request accepted
MessageList Contracts by Metering Point
Returns all contracts on the specified metering point, optionally filtered by status or date.
path Parameters
guid^([0-9A-Fa-f]{32}$|^… · requiredThe metering point ID.
UC Identifier
query Parameters
filterFilters the contracts by status. Possible values: all, active, past, future.
dateUnix timestamp. Returns only contracts active at this point in time.
List Contracts by Metering Point › Responses
Returns all contracts on the metering point
Replace Metering Point by GSRN
Replaces the updatable fields of the metering point identified by its 18-digit GSRN identification number.
path Parameters
idThe metering point GSRN identification number (18 digits).
Replace Metering Point by GSRN › Request Body
RequestId^([0-9A-Fa-f]{32}$|^… · requiredRequest ID, must be unique
ServiceTypeKeyVatCodeEstimatedAnnualConsumptionEstimatedAnnualProductionReplace Metering Point by GSRN › Responses
Request accepted
MessageUpdate Metering Point by GSRN
Updates one or more fields of the metering point identified by its 18-digit GSRN identification number.
path Parameters
idThe metering point GSRN identification number (18 digits).
Update Metering Point by GSRN › Request Body
RequestId^([0-9A-Fa-f]{32}$|^… · requiredRequest ID, must be unique
ServiceTypeKeyVatCodeEstimatedAnnualConsumptionEstimatedAnnualProductionUpdate Metering Point by GSRN › Responses
Request accepted
MessageList Events by Metering Point
Returns all events registered on the specified metering point, sorted by timestamp. Results include both contract module events (contract requests and state changes) and market process events (market hub messages such as start and end of supply). Events are returned in two separate arrays: CM for contract module events, and MWE for market process events.
path Parameters
idThe metering point GSRN identification number (18 digits).
List Events by Metering Point › Responses
Returns all events on the accounting point
Get Event Payload
Returns the full payload of a specific event on the specified metering point. The event may originate from the contract module (contract requests or state changes) or from the market process engine (market hub messages).
path Parameters
idThe metering point GSRN identification number (18 digits).
eidThe event ID.
Get Event Payload › Responses
Returns the payload of the event
PayloadList Metering Points Summary by Customer
Returns a simplified overview of all metering points and their current contracts across all invoice groups for the specified customer.
path Parameters
guid^([0-9A-Fa-f]{32}$|^… · requiredThe customer ID.
UC Identifier
query Parameters
showallWhen true, includes reverted and ended metering points.
limitThe maximum number of metering points to return.
List Metering Points Summary by Customer › Responses
Returns a simplified overview of the accounting points and their current contract
List Contracts by Customer and Metering Point
Returns all contracts on the specified metering point that belong to the specified customer.
path Parameters
guid^([0-9A-Fa-f]{32}$|^… · requiredThe customer ID.
UC Identifier
acid^([0-9A-Fa-f]{32}$|^… · requiredThe metering point ID.
List Contracts by Customer and Metering Point › Responses
Returns all contracts belonging to the customer on the metering point
Set Metering Point Nickname
Sets a customer-defined nickname on the specified metering point.
path Parameters
guid^([0-9A-Fa-f]{32}$|^… · requiredThe customer ID.
UC Identifier
Set Metering Point Nickname › Request Body
NicknameAccountingPointIdentificationThe accounting point identifier
AccountingPointGuid^([0-9A-Fa-f]{32}$|^…UC Identifier
RequestId^([0-9A-Fa-f]{32}$|^…Request ID, must be unique
Set Metering Point Nickname › Responses
Request accepted
MessageSearch Metering Points
Searches for metering points whose GSRN identification or ID matches the supplied query string, scoped to the given service type.
When CheckStatus is true, each result also indicates whether the metering point currently has an active contract and the associated customer.
Results are paginated. A query string shorter than three characters returns an empty result set.
query Parameters
limitThe maximum number of results to return.
pageThe page number.
Search Metering Points › Request Body
RequestId^([0-9A-Fa-f]{32}$|^… · requiredRequest ID, must be unique
QueryStringIdentification, Guid, etc
ServiceTypeKeyCheckStatusSearch Metering Points › Responses
Results found
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object | |
| type = object |