Manage contracts lifecycle, create, update, and terminate.
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 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
List Contracts
Create Contract
Initiates the creation of a new contract for a customer and metering point. The request is validated for required fields including customer identification, metering point identification, and product IDs.
Create Contract › Request Body
RequestId^([0-9A-Fa-f]{32}$|^… · requiredRequest ID, must be unique
OwnerIdStartDateIf empty, then according to market requirements. Can be overriden according to market expectations and standards.
EndDateStartOfSupplyDateStartOfSupplyRequestID^([0-9A-Fa-f]{32}$|^…Request ID, must be unique
CreateANewAccountForEachAccountingPointCreate Contract › Responses
Valid request
MessageGet Contract Process Alternatives
Returns the available process alternatives for a given customer and metering point combination. Used to determine whether a supplier switch, new supply, or other process is applicable before initiating a contract.
Get Contract Process Alternatives › Request Body
RequestId^([0-9A-Fa-f]{32}$|^…Request ID, must be unique
ServiceTypeGet Contract Process Alternatives › Responses
Valid request
ProcessEarliestDateLatestDateDateLockedTerminate Contract
Initiates termination of the active contract on the specified metering point for the given customer. The contract is looked up by customer identification, metering point ID, and service type key. Returns 428 if the requested end date is prior to the contract's start date.
Terminate Contract › Request Body
RequestId^([0-9A-Fa-f]{32}$|^… · requiredRequest ID, must be unique
CustomerIdentificationAccountingPointIdServiceTypeKeyEndDateReasonCommentAn explanation from the clerk
UserIdThe id of the user who requested the termination
EndOfSupplyRequestIDThird party id
Terminate Contract › Responses
Request accepted
MessageRevert Contract
Reverts a contract action on the specified metering point for the given customer.
The reversion type must be one of: RevertTermination, RevertActivation, or RevertProductChange.
Returns 428 if revert is not an available action on the contract in its current state.
Revert Contract › Request Body
RequestId^([0-9A-Fa-f]{32}$|^… · requiredRequest ID, must be unique
CustomerIdentificationAccountingPointIdServiceTypeKeyTypeSkipRequestStartOfSupplyRevertFromMarketSkipRequestEndOfSupplyFromMarketSkipRequestEndOfSupplyRevertFromMarketRevert Contract › Responses
Request accepted
MessageGet Contract
Returns the contract with the specified ID, including customer, invoice group, metering point, and product details.
path Parameters
guid^([0-9A-Fa-f]{32}$|^… · requiredThe contract ID.
UC Identifier
Get Contract › Responses
Returns the contract
Guid^([0-9A-Fa-f]{32}$|^…UC Identifier
StartDateEndDateStatusUpdate Contract
Applies one or more commands to update the specified contract.
Supported commands: RemoveProduct, AddProduct, MoveContract, SetEndDate, UpdateMoveInDate.
path Parameters
guid^([0-9A-Fa-f]{32}$|^… · requiredThe contract ID.
UC Identifier
Update Contract › Request Body
RequestId^([0-9A-Fa-f]{32}$|^… · requiredRequest ID, must be unique
Update Contract › Responses
Valid request
MessageForce Activate Contract
Manually activates the specified contract, bypassing normal market process requirements. This is an administrative action intended for corrective use.
path Parameters
guid^([0-9A-Fa-f]{32}$|^… · requiredThe contract ID.
UC Identifier
Force Activate Contract › Request Body
RequestId^([0-9A-Fa-f]{32}$|^… · requiredRequest ID, must be unique
CommentUserIdStartDateSkipRequestStartOfSupplyFromMarketSkipRequestEndOfSupplyRevertFromMarketStartOfSupplyDateStartOfSupplyRequestIDThird party id
Force Activate Contract › Responses
Valid request
MessageForce End Contract
Manually ends the specified contract, bypassing normal market process requirements. This is an administrative action intended for corrective use.
path Parameters
guid^([0-9A-Fa-f]{32}$|^… · requiredThe contract ID.
UC Identifier
Force End Contract › Request Body
RequestId^([0-9A-Fa-f]{32}$|^… · requiredRequest ID, must be unique
CommentUserIdEndDateSkipRequestEndOfSupplyFromMarketDeactivatedTypeForce End Contract › Responses
Valid request
MessageForce Delete Contract
Permanently erases the specified contract and its associated data, bypassing normal process requirements. This is an administrative action intended for corrective use and is irreversible.
path Parameters
guid^([0-9A-Fa-f]{32}$|^… · requiredThe contract ID.
UC Identifier
Force Delete Contract › Request Body
RequestId^([0-9A-Fa-f]{32}$|^… · requiredRequest ID, must be unique
CommentUserIdForce Delete Contract › Responses
Valid request
MessageForce Revert Contract
Manually reverts the specified contract, bypassing normal market process requirements. This is an administrative action intended for corrective use.
path Parameters
guid^([0-9A-Fa-f]{32}$|^… · requiredThe contract ID.
UC Identifier
Force Revert Contract › Request Body
RequestId^([0-9A-Fa-f]{32}$|^… · requiredRequest ID, must be unique
CommentUserIdSkipRequestStartOfSupplyRevertFromMarketForce Revert Contract › Responses
Valid request
MessageForce Terminate Contract
Manually terminates the specified contract, bypassing normal market process requirements. This is an administrative action intended for corrective use.
path Parameters
guid^([0-9A-Fa-f]{32}$|^… · requiredThe contract ID.
UC Identifier
Force Terminate Contract › Request Body
RequestId^([0-9A-Fa-f]{32}$|^… · requiredRequest ID, must be unique
CommentUserIdReasonEndDateEndOfSupplyRequestIDThird party id
SkipRequestEndOfSupplyFromMarketDeactivatedTypeForce Terminate Contract › Responses
Valid request
MessageGet Contract by Request ID
Returns the contract associated with the specified request ID, used to look up a contract created by a known request.
path Parameters
corid^([0-9A-Fa-f]{32}$|^… · requiredThe request ID used when the contract was created.
UC Identifier
Get Contract by Request ID › Responses
Returns the contract
Guid^([0-9A-Fa-f]{32}$|^…UC Identifier
StartDateEndDateStatusGet Customer and Invoice Groups by Correlation Request ID
Returns the customer and all associated invoice groups for the contract identified by the specified correlation ID.
path Parameters
id^([0-9A-Fa-f]{32}$|^… · requiredThe correlation ID of the contract.
Get Customer and Invoice Groups by Correlation Request ID › Responses
Returns the customer and invoice groups
Terminate Contract by ID
Terminates the specified contract. Supports the same termination reasons as POST /contracts/terminate, but targets a contract directly by ID rather than by customer identification and metering point.
path Parameters
guid^([0-9A-Fa-f]{32}$|^… · requiredThe contract ID.
UC Identifier
Terminate Contract by ID › Request Body
RequestId^([0-9A-Fa-f]{32}$|^… · requiredRequest ID, must be unique
EndDateReasonCommentAn explanation from the clerk
UserIdThe id of the user who requested the termination
EndOfSupplyRequestIDThird party id
Terminate Contract by ID › Responses
Request accepted
MessageRevert Contract by ID
Reverts the specified contract. Supports skipping market process messages via optional flags in the request body.
path Parameters
guid^([0-9A-Fa-f]{32}$|^… · requiredThe contract ID.
UC Identifier
Revert Contract by ID › Request Body
RequestId^([0-9A-Fa-f]{32}$|^… · requiredRequest ID, must be unique
SkipRequestStartOfSupplyRevertFromMarketSkipRequestEndOfSupplyFromMarketSkipRequestEndOfSupplyRevertFromMarketRevert Contract by ID › Responses
Request accepted
MessageList 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
Create a new contract or change the product on an accounting point
path Parameters
guid^([0-9A-Fa-f]{32}$|^… · requiredThe uc id of the customer
UC Identifier
Create a new contract or change the product on an accounting point › Request Body
RequestedChannelRequestId^([0-9A-Fa-f]{32}$|^… · requiredRequest ID, must be unique
StartDateMust be in the future
Create a new contract or change the product on an accounting point › Responses
Request accepted
MessageApply Contract Commands
Applies one or more commands to update the specified contract, verifying that the contract belongs to the specified customer before processing.
Supported commands: RemoveProduct, AddProduct, MoveContract, SetEndDate, UpdateMoveInDate.
path Parameters
guid^([0-9A-Fa-f]{32}$|^… · requiredThe customer ID.
UC Identifier
cguid^([0-9A-Fa-f]{32}$|^… · requiredThe contract ID.
UC Identifier
Apply Contract Commands › Request Body
RequestId^([0-9A-Fa-f]{32}$|^… · requiredRequest ID, must be unique
Apply Contract Commands › Responses
Valid request
MessageGet Opportunity
Returns the opportunity ID associated with the specified customer, used to retrieve the CRM opportunity created during contract initiation.
path Parameters
guid^([0-9A-Fa-f]{32}$|^… · requiredThe customer ID.
UC Identifier
Get Opportunity › Responses
Opportunity found
Opportunity