Schemas

cm_contract_cm_GetAccount400

Error

string · enum

Enum values:

Invalid Guid

Tenant missing in headers

Example: Invalid Guid

cm_contract_cm_account_404

Error

string · enum

Enum values:

Account not found

Example: Account not found

cm_contract_cm_GetAccount500

Error

string · enum

Enum values:

DBError

Example: DBError

cm_contract_cm_UpdateAccountInput

RequestId

cm_contract_cm_req_id · pattern: ^([0-9A-Fa-f]{32}$|^…

Request ID, must be unique

Example: ff175a44-90e6-4579-87f1-7e9aa07d57ac

cm_contract_cm_Address[] · minItems: 1 · maxItems: 2

The account's addresses

The account's communication objects

Name

string

InvoiceTag

string

cm_contract_cm_202Default

Message

string · enum

Enum values:

Request accepted

Example: Request accepted

cm_contract_cm_PatchAccount400

Error

string · enum

Enum values:

Invalid Guid

Tenant missing in headers

Missing Addresses and/or Communication

Example: Invalid Guid

cm_contract_cm_403Default

Error

string · enum

Enum values:

Duplicate request

Example: Duplicate request

cm_contract_cm_PatchAccount500

Error

string · enum

Enum values:

DBError

Missing servicebus settings

Example: DBError

cm_contract_cm_GetCustomerAndAccounts200

cm_contract_cm_SimpleContract[]

cm_contract_cm_Account[]

object[]

cm_contract_cm_GetCustomerAndAccounts400

Error

string · enum

Enum values:

Invalid Guid

Tenant missing in headers

Example: Invalid Guid

cm_contract_cm_GetCustomerAndAccounts500

Error

string · enum

Enum values:

DBError

Example: DBError

cm_contract_cm_GetAccountAccountingPointsDisplay200

cm_contract_cm_GetAccountAccountingPointsDisplay400

Error

string · enum

Enum values:

Invalid Guid

Tenant missing in headers

Example: Invalid Guid

cm_contract_cm_GetAccountAccountingPointsDisplay500

Error

string · enum

Enum values:

DBError

Example: DBError

cm_contract_cm_GetAccountAccountingPointContracts200

cm_contract_cm_Contract[]

cm_contract_cm_GetAccountAccountingPointContracts400

Error

string · enum

Enum values:

Invalid Guid

Tenant missing in headers

Example: Invalid Guid

cm_contract_cm_GetAccountAccountingPointContracts500

Error

string · enum

Enum values:

DBError

Example: DBError

cm_contract_cm_EraseAccountInput

RequestId

cm_contract_cm_req_id · pattern: ^([0-9A-Fa-f]{32}$|^…

Request ID, must be unique

Example: ff175a44-90e6-4579-87f1-7e9aa07d57ac

Comment

string

An explanation from the clerk

UserId

string

The id of the user who requested the termination

DeleteInCRM

boolean

DeleteInBE

boolean

cm_contract_cm_EraseAccount400

Error

string · enum

Enum values:

Invalid Guid

Tenant missing in headers

Missing RequestId

Example: Invalid Guid

cm_contract_cm_EraseAccount500

Error

string · enum

Enum values:

DBError

Missing servicebus settings

Example: DBError

cm_contract_cm_GetAccountingPoints200

cm_contract_cm_AccountingPoint[]

cm_contract_cm_GetAccountingPoints400

Error

string · enum

Enum values:

Tenant missing in headers

Example: Tenant missing in headers

cm_contract_cm_GetAccountingPoints500

Error

string · enum

Enum values:

DBError

Example: DBError

cm_contract_cm_PostAccountingPointsRequestBody

RequestId

cm_contract_cm_req_id · pattern: ^([0-9A-Fa-f]{32}$|^… · required

Request ID, must be unique

Example: ff175a44-90e6-4579-87f1-7e9aa07d57ac

Identification

string · required

The accounting point identifier

Example: 700050700700770005

VatCode

string

EstimatedAnnualConsumption

string

EstimatedAnnualProduction

string

object

cm_contract_cm_MeterIndex[]

cm_contract_cm_PostAccountingPoints400

Error

string · enum

Enum values:

Missing RequestId

Invalid RequestId

Missing Identification

Tenant missing in headers

Servicetype missing in headers

Failed to find service type in the database

Failed ap validation

Example: Missing RequestId

cm_contract_cm_PostAccountingPoints500

Error

string · enum

Enum values:

DBError

Servicebus error

Failed to fetch service types from the database

Example: DBError

cm_contract_cm_SearchAccountingPointGuidsRequestBody

AccountingPoints

string[] · required

cm_contract_cm_SearchAccountingPointGuids200

object[] · required

cm_contract_cm_SearchAccountingPointGuids400

Error

string · enum

Enum values:

Empty Customers list

Example: Empty Customers list

cm_contract_cm_SearchAccountingPointGuids500

Error

string · enum

Enum values:

DBError

Example: DBError

cm_contract_cm_GetAccountingPoint200

cm_contract_cm_Scheme[]

VatCode

string · enum

Enum values:

S

E

object

EstimatedAnnualProduction

string

The estimated annual production

Example: 10000

object

Identification

string

The accounting point identifier

Example: 700050700700770005

Guid

cm_contract_cm_guid · pattern: ^([0-9A-Fa-f]{32}$|^…

UC Identifier

Example: ff175a44-90e6-4579-87f1-7e9aa07d57ac

EstimatedAnnualConsumption

string

The estimated annual consumption

Example: 10000

MeteringGridAreaUsedDomainLocationIdentification

string

object

object[]

LastMeterReadingDate

string

GridOwner

string

cm_contract_cm_GetAccountingPoint400

Error

string · enum

Enum values:

Invalid Guid

Tenant missing in headers

Example: Invalid Guid

cm_contract_cm_GetAccountingPoint404

Error

string · enum

Enum values:

AccountingPoint not found

Example: AccountingPoint not found

cm_contract_cm_GetAccountingPoint500

Error

string · enum

Enum values:

DBError

Example: DBError

cm_contract_cm_PutAccountingPointRequestBody

RequestId

cm_contract_cm_req_id · pattern: ^([0-9A-Fa-f]{32}$|^… · required

Request ID, must be unique

Example: ff175a44-90e6-4579-87f1-7e9aa07d57ac

VatCode

string

EstimatedAnnualConsumption

string

EstimatedAnnualProduction

string

object

cm_contract_cm_PutAccountingPoint400

Error

string · enum

Enum values:

Invalid Guid

Tenant missing in headers

ServiceType missing in headers

No update

Failed to find service type in the database

Failed to fetch service types from the database

Failed ap validation

Example: Invalid Guid

cm_contract_cm_PutAccountingPoint404

Error

string · enum

Enum values:

AccountingPoint not found

Example: AccountingPoint not found

cm_contract_cm_PutAccountingPoint500

Error

string · enum

Enum values:

DBError

Connection Error

Servicebus error

Example: DBError

cm_contract_cm_PatchAccountingPointRequestBody

RequestId

cm_contract_cm_req_id · pattern: ^([0-9A-Fa-f]{32}$|^… · required

Request ID, must be unique

Example: ff175a44-90e6-4579-87f1-7e9aa07d57ac

VatCode

string

EstimatedAnnualConsumption

string

EstimatedAnnualProduction

string

object

cm_contract_cm_PatchAccountingPoint400

Error

string · enum

Enum values:

Invalid Guid

Tenant missing in headers

ServiceType missing in headers

No update

Failed to find service type in the database

Failed to fetch service types from the database

Failed ap validation

Example: Invalid Guid

cm_contract_cm_PatchAccountingPoint404

Error

string · enum

Enum values:

AccountingPoint not found

Example: AccountingPoint not found

cm_contract_cm_PatchAccountingPoint500

Error

string · enum

Enum values:

DBError

Connection Error

Servicebus error

Example: DBError

cm_contract_cm_PutTimeSeriesRequestBody

RequestId

cm_contract_cm_req_id · pattern: ^([0-9A-Fa-f]{32}$|^… · required

Request ID, must be unique

Example: ff175a44-90e6-4579-87f1-7e9aa07d57ac

object · required

cm_contract_cm_PutTimeSeries400

Error

string · enum

Enum values:

Missing RequestId

Invalid RequestId

Super user permission required

Missing TimeSeries in request body

Missing TimeSeries.VatCode or TimeSeries.ElcertificateShare in request body

Example: Missing RequestId

cm_contract_cm_GetAccountingPointContracts200

cm_contract_cm_Contract[]

cm_contract_cm_GetAccountingPointContracts400

Error

string · enum

Enum values:

Tenant missing in headers

Example: Tenant missing in headers

cm_contract_cm_GetAccountingPointContracts500

Error

string · enum

Enum values:

DBError

Example: DBError

cm_contract_cm_PutAccountingPointWithIdRequestBody

RequestId

cm_contract_cm_req_id · pattern: ^([0-9A-Fa-f]{32}$|^… · required

Request ID, must be unique

Example: ff175a44-90e6-4579-87f1-7e9aa07d57ac

ServiceTypeKey

string

VatCode

string

EstimatedAnnualConsumption

string

EstimatedAnnualProduction

string

object

cm_contract_cm_PatchAccountingPointWithIdRequestBody

RequestId

cm_contract_cm_req_id · pattern: ^([0-9A-Fa-f]{32}$|^… · required

Request ID, must be unique

Example: ff175a44-90e6-4579-87f1-7e9aa07d57ac

ServiceTypeKey

string

VatCode

string

EstimatedAnnualConsumption

string

EstimatedAnnualProduction

string

object

cm_contract_cm_SimpleEvent[]

cm_contract_cm_GetAccountingPointEvents200

cm_contract_cm_GetAccountingPointEvents400

Error

string · enum

Enum values:

Tenant missing in headers

Invalid Accounting Point ID

Example: Invalid Accounting Point ID

cm_contract_cm_GetAccountingPointEvents500

Error

string · enum

Enum values:

StorageTableError

Example: StorageTableError

cm_contract_cm_GetAccountingPointEventPayload200

Payload

object

cm_contract_cm_GetAccountingPointEventPayload400

Error

string · enum

Enum values:

Tenant missing in headers

Invalid Accounting Point ID

Example: Invalid Accounting Point ID

cm_contract_cm_GetAccountingPointEventPayload404

Error

string

cm_contract_cm_GetAccountingPointEventPayload500

Error

string · enum

Enum values:

StorageTableError

Example: StorageTableError

cm_contract_cm_GetContracts200

Count

number

cm_contract_cm_Contract[]

cm_contract_cm_GetContracts400

Error

string · enum

Enum values:

Tenant missing in headers

Example: Tenant missing in headers

cm_contract_cm_GetContracts500

Error

string · enum

Enum values:

DBError

Example: DBError

cm_contract_cm_PostContractsInput

RequestId

cm_contract_cm_req_id · pattern: ^([0-9A-Fa-f]{32}$|^… · required

Request ID, must be unique

Example: ff175a44-90e6-4579-87f1-7e9aa07d57ac

OwnerId

string · required

cm_contract_cm_Customer · required

cm_contract_cm_Product_input[] · required

object

StartDate

string · date-time

If empty, then according to market requirements. Can be overriden according to market expectations and standards.

Example: 2019-10-14T22:00:00Z

Default: 2019-10-14T22:00:00Z

EndDate

string · date-time

StartOfSupplyDate

string · date-time

StartOfSupplyRequestID

cm_contract_cm_req_id · pattern: ^([0-9A-Fa-f]{32}$|^…

Request ID, must be unique

Example: ff175a44-90e6-4579-87f1-7e9aa07d57ac

CreateANewAccountForEachAccountingPoint

boolean

object

cm_contract_cm_pc_accounting_point[]

cm_contract_cm_pc_accounting_point

cm_contract_fi_el_properties

cm_contract_cm_PostContracts400

Error

string · enum

Enum values:

Tenant missing in headers

RequestId not set

RequestId not valid

OwnerId not set

Customer missing

Customer.Identification missing

Customer.Identification must be a number of length 9 or 11

GivenName and FamilyName is required for a private customer

Example: Tenant missing in headers

cm_contract_cm_PostContracts500

Error

string · enum

Enum values:

DBError

Example: DBError

cm_contract_cm_GetProcessAlternatives_RequestBody

RequestId

cm_contract_cm_req_id · pattern: ^([0-9A-Fa-f]{32}$|^…

Request ID, must be unique

Example: ff175a44-90e6-4579-87f1-7e9aa07d57ac

ServiceType

string

object

cm_contract_cm_GetProcessAlternatives_200

Process

string · enum

Enum values:

MoveIn

ProductChange

EarliestDate

string

LatestDate

string

DateLocked

boolean

cm_contract_cm_GetProcessAlternatives_400

Error

string · enum

Enum values:

Invalid Guid

Tenant missing in headers

Missing RequestId

cm_contract_cm_GetProcessAlternatives_500

Error

string · enum

Enum values:

DBError

ConnectionError

cm_contract_cm_TerminateContractsRequestBody

RequestId

cm_contract_cm_req_id · pattern: ^([0-9A-Fa-f]{32}$|^… · required

Request ID, must be unique

Example: ff175a44-90e6-4579-87f1-7e9aa07d57ac

CustomerIdentification

string · required

AccountingPointId

string · required

ServiceTypeKey

string · required

EndDate

string · date-time · required

Reason

string · enum · required

Enum values:

CustomerRequestedMove

CustomerRequestedMoveOut

RetailerTerminatesContract

CustomerTerminatesContract

CustomerReportedDeceased

CustomerReportedBankrupt

cm_contract_cm_Address[] · minItems: 1 · maxItems: 2

Comment

string

An explanation from the clerk

UserId

string

The id of the user who requested the termination

EndOfSupplyRequestID

Third party id

Example: ff175a44-90e6-4579-87f1-7e9aa07d57ac

cm_contract_cm_TerminateContract400

Error

string · enum

Enum values:

Tenant missing in headers

Missing EndDate

Invalid EndDate

Missing Reason

Addresses are mandatory for 'CustomerRequestedMove'

Example: Tenant missing in headers

cm_contract_cm_TerminateContract500

Error

string · enum

Enum values:

DBError

Missing servicebus settings

Example: DBError

cm_contract_cm_RevertContractsRequestBody

RequestId

cm_contract_cm_req_id · pattern: ^([0-9A-Fa-f]{32}$|^… · required

Request ID, must be unique

Example: ff175a44-90e6-4579-87f1-7e9aa07d57ac

CustomerIdentification

string · required

AccountingPointId

string · required

ServiceTypeKey

string · required

Type

string · enum · required

Enum values:

RevertTermination

RevertActivation

RevertProductChange

SkipRequestStartOfSupplyRevertFromMarket

boolean

SkipRequestEndOfSupplyFromMarket

boolean

SkipRequestEndOfSupplyRevertFromMarket

boolean

cm_contract_cm_RevertContract400

Error

string · enum

Enum values:

Tenant missing in headers

Invalid Guid

Missing ReqeuestId

Invalid ReqeuestId

Example: Tenant missing in headers

cm_contract_cm_RevertContract500

Error

string · enum

Enum values:

DBError

Missing servicebus settings

Example: DBError

cm_contract_cm_GetContract200

cm_contract_cm_Account · required

cm_contract_cm_AccountingPoint · required

cm_contract_cm_Customer · required

cm_contract_cm_Product[] · required

Guid

cm_contract_cm_guid · pattern: ^([0-9A-Fa-f]{32}$|^…

UC Identifier

Example: ff175a44-90e6-4579-87f1-7e9aa07d57ac

StartDate

string · date-time

EndDate

string | null · date-time

Status

string · enum

Enum values:

Active

Ended

Pending

Halted

UnderRevertion

UnderTermination

Reverted

UnderReactivation

Example: Active

cm_contract_cm_GetContract400

Error

string · enum

Enum values:

Tenant missing in headers

Invalid Guid

Example: Tenant missing in headers

cm_contract_cm_contract_404

Error

string · enum

Enum values:

Contract not found

Example: Contract not found

cm_contract_cm_GetContract500

Error

string · enum

Enum values:

DBError

Example: DBError

cm_contract_cm_PatchContractsInput

RequestId

cm_contract_cm_req_id · pattern: ^([0-9A-Fa-f]{32}$|^… · required

Request ID, must be unique

Example: ff175a44-90e6-4579-87f1-7e9aa07d57ac

cm_contract_cm_UpdateContractCommand[] · required

cm_contract_cm_PatchContracts400

Error

string · enum

Enum values:

Invalid guid

RequestId missing

Invalid RequestId

Tenant missing in headers

No valid commands found

Example: Tenant missing in headers

cm_contract_cm_PatchContracts500

Error

string · enum

Enum values:

DBError

Missing servicebus settings

Servicebus error

Example: DBError

cm_contract_cm_PostForceActivateContractInput

RequestId

cm_contract_cm_req_id · pattern: ^([0-9A-Fa-f]{32}$|^… · required

Request ID, must be unique

Example: ff175a44-90e6-4579-87f1-7e9aa07d57ac

Comment

string · required

UserId

string · required

StartDate

string · date-time

SkipRequestStartOfSupplyFromMarket

boolean

SkipRequestEndOfSupplyRevertFromMarket

boolean

StartOfSupplyDate

string · date-time

StartOfSupplyRequestID

Third party id

Example: ff175a44-90e6-4579-87f1-7e9aa07d57ac

cm_contract_cm_PostForceActivateContract400

Error

string · enum

Enum values:

Invalid Guid

Tenant missing in headers

Missing Addresses and/or Communication

Example: Invalid Guid

cm_contract_cm_action_not_permitted

Error

string · enum

Enum values:

Action not permitted

Example: Action not permitted

cm_contract_cm_PostForceActivateContract500

Error

string · enum

Enum values:

DBError

Missing servicebus settings

Example: DBError

cm_contract_cm_PostForceEndContractInput

RequestId

cm_contract_cm_req_id · pattern: ^([0-9A-Fa-f]{32}$|^… · required

Request ID, must be unique

Example: ff175a44-90e6-4579-87f1-7e9aa07d57ac

Comment

string · required

UserId

string · required

EndDate

string · date-time

SkipRequestEndOfSupplyFromMarket

boolean

DeactivatedType

string

cm_contract_cm_PostForceEndContract400

Error

string · enum

Enum values:

Invalid Guid

Tenant missing in headers

Missing Addresses and/or Communication

Example: Invalid Guid

cm_contract_cm_PostForceEndContract500

Error

string · enum

Enum values:

DBError

Missing servicebus settings

Example: DBError

cm_contract_cm_PostForceEraseContractInput

RequestId

cm_contract_cm_req_id · pattern: ^([0-9A-Fa-f]{32}$|^… · required

Request ID, must be unique

Example: ff175a44-90e6-4579-87f1-7e9aa07d57ac

Comment

string · required

UserId

string · required

cm_contract_cm_PostForceEraseContract400

Error

string · enum

Enum values:

Invalid Guid

Tenant missing in headers

Missing Addresses and/or Communication

Example: Invalid Guid

cm_contract_cm_PostForceEraseContract500

Error

string · enum

Enum values:

DBError

Missing servicebus settings

Example: DBError

cm_contract_cm_PostForceRevertContractInput

RequestId

cm_contract_cm_req_id · pattern: ^([0-9A-Fa-f]{32}$|^… · required

Request ID, must be unique

Example: ff175a44-90e6-4579-87f1-7e9aa07d57ac

Comment

string · required

UserId

string · required

SkipRequestStartOfSupplyRevertFromMarket

boolean

cm_contract_cm_PostForceRevertContract400

Error

string · enum

Enum values:

Invalid Guid

Tenant missing in headers

Missing Addresses and/or Communication

Example: Invalid Guid

cm_contract_cm_PostForceRevertContract500

Error

string · enum

Enum values:

DBError

Missing servicebus settings

Example: DBError

cm_contract_cm_PostForceTerminateContractInput

RequestId

cm_contract_cm_req_id · pattern: ^([0-9A-Fa-f]{32}$|^… · required

Request ID, must be unique

Example: ff175a44-90e6-4579-87f1-7e9aa07d57ac

Comment

string · required

UserId

string · required

Reason

string

EndDate

string · date-time

EndOfSupplyRequestID

Third party id

Example: ff175a44-90e6-4579-87f1-7e9aa07d57ac

SkipRequestEndOfSupplyFromMarket

boolean

DeactivatedType

string

cm_contract_cm_PostForceTerminateContract400

Error

string · enum

Enum values:

Invalid Guid

Tenant missing in headers

Missing Addresses and/or Communication

Example: Invalid Guid

cm_contract_cm_PostForceTerminateContract500

Error

string · enum

Enum values:

DBError

Missing servicebus settings

Example: DBError

cm_contract_cm_TerminateContractRequestBody

RequestId

cm_contract_cm_req_id · pattern: ^([0-9A-Fa-f]{32}$|^… · required

Request ID, must be unique

Example: ff175a44-90e6-4579-87f1-7e9aa07d57ac

EndDate

string · date-time · required

Reason

string · enum · required

Enum values:

CustomerRequestedMove

CustomerRequestedMoveOut

RetailerTerminatesContract

CustomerTerminatesContract

CustomerReportedDeceased

CustomerReportedBankrupt

cm_contract_cm_Address[] · minItems: 1 · maxItems: 2

Comment

string

An explanation from the clerk

UserId

string

The id of the user who requested the termination

EndOfSupplyRequestID

Third party id

Example: ff175a44-90e6-4579-87f1-7e9aa07d57ac

cm_contract_cm_RevertContractRequestBody

RequestId

cm_contract_cm_req_id · pattern: ^([0-9A-Fa-f]{32}$|^… · required

Request ID, must be unique

Example: ff175a44-90e6-4579-87f1-7e9aa07d57ac

SkipRequestStartOfSupplyRevertFromMarket

boolean

SkipRequestEndOfSupplyFromMarket

boolean

SkipRequestEndOfSupplyRevertFromMarket

boolean

cm_contract_cm_GetCustomers200

Count

number

cm_contract_cm_Customer[]

cm_contract_cm_GetCustomers400

Error

string · enum

Enum values:

Tenant missing in headers

Example: Tenant missing in headers

cm_contract_cm_customer_404

Error

string · enum

Enum values:

Customer not found

Example: Customer not found

cm_contract_cm_GetCustomers500

Error

string · enum

Enum values:

DBError

Example: DBError

cm_contract_cm_PatchCustomerInput2

RequestId

cm_contract_cm_req_id · pattern: ^([0-9A-Fa-f]{32}$|^… · required

Request ID, must be unique

Example: ff175a44-90e6-4579-87f1-7e9aa07d57ac

object · required

cm_contract_cm_PatchCustomer400

Error

string · enum

Enum values:

DefaultAccount missing

Invalid DefaultAccount

Invalid Customer Guid

Tenant missing in headers

Missing RequestId

Invalid RequestId

Customer type conversion is not allowed

Example: Invalid Customer Guid

cm_contract_cm_PatchCustomer500

Error

string · enum

Enum values:

Connection Error

DBError

Missing servicebus settings

Servicebus error

Example: Connection Error

cm_contract_cm_PostCustomersRequestBody

RequestId

cm_contract_cm_req_id · pattern: ^([0-9A-Fa-f]{32}$|^… · required

Request ID, must be unique

Example: ff175a44-90e6-4579-87f1-7e9aa07d57ac

cm_contract_cm_Invoice_Details

cm_contract_cm_Account

cm_contract_cm_PostCustomers400

Error

string · enum

Enum values:

Tenant missing in headers

RequestId not set

RequestId not valid

Example: Tenant missing in headers

cm_contract_cm_PostCustomers500

Error

string · enum

Enum values:

DBError

Example: DBError

cm_contract_cm_GetCustomersSlim200

Count

number

cm_contract_cm_SlimCustomer[]

cm_contract_cm_GetCustomersWithPhoneNumberRequestBody

PhoneNumber

string · required

Email

string

cm_contract_cm_GetCustomersWithPhoneNumber200

CustomerGuids

cm_contract_cm_guid[]

cm_contract_cm_GetCustomersWithPhoneNumber400

Error

string · enum

Enum values:

Tenant missing in headers

Example: Tenant missing in headers

cm_contract_cm_GetCustomersWithPhoneNumber500

Error

string · enum

Enum values:

DBError

Example: DBError

cm_contract_cm_SearchCustomerGuidsRequestBody

Customers

string[] · required

cm_contract_cm_SearchCustomerGuids200

object[] · required

cm_contract_cm_SearchCustomerGuids400

Error

string · enum

Enum values:

Empty Customers list

Example: Empty Customers list

cm_contract_cm_SearchCustomerGuids500

Error

string · enum

Enum values:

DBError

Example: DBError

cm_contract_cm_GetCustomer200

Identification

string

SSN/Org number

Example: 11068911778

Guid

cm_contract_cm_guid · pattern: ^([0-9A-Fa-f]{32}$|^…

UC Identifier

Example: ff175a44-90e6-4579-87f1-7e9aa07d57ac

DefaultAccount

cm_contract_cm_guid · pattern: ^([0-9A-Fa-f]{32}$|^…

UC Identifier

Example: ff175a44-90e6-4579-87f1-7e9aa07d57ac

BirthDate

string

Name

string

The name of the company

Example: Weyland-Yutani Corporation

FamilyName

string

Last name

Example: Aandal

GivenName

string

First name

Example: Carine

Tags

string[]

object

cm_contract_cm_GetCustomer400

Error

string · enum

Enum values:

Tenant missing in headers

Example: Tenant missing in headers

cm_contract_cm_GetCustomer500

Error

string · enum

Enum values:

DBError

Example: DBError

cm_contract_cm_PatchCustomerInput

RequestId

cm_contract_cm_req_id · pattern: ^([0-9A-Fa-f]{32}$|^… · required

Request ID, must be unique

Example: ff175a44-90e6-4579-87f1-7e9aa07d57ac

object · required

cm_contract_cm_PostContactsRequestBody

GivenName

string · required

FamilyName

string · required

RequestId

cm_contract_cm_req_id · pattern: ^([0-9A-Fa-f]{32}$|^… · required

Request ID, must be unique

Example: ff175a44-90e6-4579-87f1-7e9aa07d57ac

CustomerGuid

cm_contract_cm_guid · pattern: ^([0-9A-Fa-f]{32}$|^…

UC Identifier

Example: ff175a44-90e6-4579-87f1-7e9aa07d57ac

Identifiers in other systems

Email

string

Mobile

string

Roles

string[]

cm_contract_cm_PostContacts400

Error

string

cm_contract_cm_PostContacts500

Error

string

cm_contract_cm_GetOffers200

Count

number

cm_contract_cm_Offer[]

cm_contract_cm_GetCustomerOffers400

Error

string

cm_contract_cm_GetCustomerOffers500

Error

string

cm_contract_cm_GetCustomerByRequestID200

cm_contract_cm_Account

cm_contract_cm_GetCustomerByRequestID400

Error

string · enum

Enum values:

Tenant missing in headers

Example: Tenant missing in headers

cm_contract_cm_GetCustomerByRequestID500

Error

string · enum

Enum values:

DBError

Example: DBError

cm_contract_cm_GetCustomerAccounts200

cm_contract_cm_Account[]

object[]

cm_contract_cm_GetCustomerAccounts400

Error

string · enum

Enum values:

Tenant missing in headers

Example: Tenant missing in headers

cm_contract_cm_GetCustomerAccounts500

Error

string · enum

Enum values:

DBError

Example: DBError

cm_contract_cm_PostCustomerAccountsInput

RequestId

cm_contract_cm_req_id · pattern: ^([0-9A-Fa-f]{32}$|^… · required

Request ID, must be unique

Example: ff175a44-90e6-4579-87f1-7e9aa07d57ac

cm_contract_cm_Communication[] · required

cm_contract_cm_Address[] · required

Name

string | null

Account name

Example: Region east

cm_contract_cm_Invoice_Details

InvoiceTag

string

Ask BE

CreateInCRM

boolean

Whether to create a crm account or use the default crm account

Example: false

cm_contract_cm_PostCustomerAccounts400

Error

string · enum

Enum values:

Invalid Customer Guid

Tenant missing in headers

Addresses missing

Communication missing

No valid address object found

Email|Mobile|Phone|Telefax missing in Customer.Communication

Example: Invalid Customer Guid

cm_contract_cm_PostCustomerAccounts500

Error

string · enum

Enum values:

DBError

Missing servicebus settings

Example: DBError

cm_contract_cm_GetCustomerAccountingPointsDisplay200

object[]

cm_contract_cm_PostAccountingPointNicknameRequestBody

Nickname

string · required

AccountingPointIdentification

string

The accounting point identifier

AccountingPointGuid

cm_contract_cm_guid · pattern: ^([0-9A-Fa-f]{32}$|^…

UC Identifier

Example: ff175a44-90e6-4579-87f1-7e9aa07d57ac

RequestId

cm_contract_cm_req_id · pattern: ^([0-9A-Fa-f]{32}$|^…

Request ID, must be unique

Example: ff175a44-90e6-4579-87f1-7e9aa07d57ac

cm_contract_cm_PostCustomerAccountingPoint400

Error

string · enum

Enum values:

Tenant missing in headers

Nickname missing in body

AccountingPoint identification missing in body

Invalid AccountingPoint identification

Customer not found

Accounting point not found

Example: Tenant missing in headers

cm_contract_cm_PostCustomerAccountingPoint404

Error

string · enum

Enum values:

Customer not found

Accounting point not found

Example: Customer not found

cm_contract_cm_PostCustomerAccountingPoint500

Error

string · enum

Enum values:

DBError

Missing Servicebus settings

Servicebus error

Example: DBError

cm_contract_cm_PostCustomerContractsRequestBody

object · required

RequestedChannel

string · enum · required

Enum values:

Web

Organic Search

Email

Phone

Chat

Web Order Form

App

MyPage

Example: Chat

RequestId

cm_contract_cm_req_id · pattern: ^([0-9A-Fa-f]{32}$|^… · required

Request ID, must be unique

Example: ff175a44-90e6-4579-87f1-7e9aa07d57ac

cm_contract_cm_Product[] · required

StartDate

string · date-time · required

Must be in the future

Example: 2019-11-14T23:00:00.000Z

object

cm_contract_cm_PostCustomerContracts400

Error

string · enum

Enum values:

Tenant missing in headers

Channel missing

AccountingPointIdentification missing

Invalid AccountingPointIdentification

Customer not found

Example: Tenant missing in headers

cm_contract_cm_PostCustomerContracts500

Error

string · enum

Enum values:

DBError

Missing Servicebus settings

Servicebus error

Example: DBError

cm_contract_cm_PatchCustomerAccountRequestBody

RequestId

cm_contract_cm_req_id · pattern: ^([0-9A-Fa-f]{32}$|^… · required

Request ID, must be unique

Example: ff175a44-90e6-4579-87f1-7e9aa07d57ac

Name

string

cm_contract_cm_Address[]

cm_contract_cm_AccountingPoint[]

cm_contract_cm_PatchCustomerAccount400

Error

string · enum

Enum values:

Invalid Guid

Tenant missing in headers

Missing Addresses and/or Communication

Example: Invalid Guid

cm_contract_cm_PatchCustomerAccount500

Error

string · enum

Enum values:

DBError

Missing servicebus settings

Example: DBError

cm_contract_cm_EraseCustomer_RequestBody

RequestId

cm_contract_cm_req_id · pattern: ^([0-9A-Fa-f]{32}$|^…

Request ID, must be unique

Example: ff175a44-90e6-4579-87f1-7e9aa07d57ac

Comment

string

cm_contract_cm_EraseCustomer400

Error

string · enum

Enum values:

Invalid Guid

Tenant missing in headers

Missing RequestId

Invalid RequestId

Example: Tenant missing in headers

cm_contract_cm_EraseCustomer500

Error

string · enum

Enum values:

Connection Error

DBError

Example: Connection Error

cm_contract_cm_change_customer_status_req_body

Status

string · enum

Enum values:

Deceased

Example: Deceased

RequestId

cm_contract_cm_req_id · pattern: ^([0-9A-Fa-f]{32}$|^…

Request ID, must be unique

Example: ff175a44-90e6-4579-87f1-7e9aa07d57ac

Reason

string · enum

Enum values:

Deceased

Example: Deceased

Inheritor

cm_contract_cm_guid · pattern: ^([0-9A-Fa-f]{32}$|^…

UC Identifier

Example: ff175a44-90e6-4579-87f1-7e9aa07d57ac

cm_contract_cm_change_customer_status_400

Message

string · enum

Enum values:

Missing inheritor

Missing reason

Missing status

Invalid Customer Guid

Tenant missing in headers

Invalid RequestId

Missing RequestId

Example: Missing reason

cm_contract_cm_change_customer_status_500

Error

string · enum

Enum values:

DBError

Example: DBError

cm_contract_cm_SyncCustomerRequestBody

RequestId

cm_contract_cm_req_id · pattern: ^([0-9A-Fa-f]{32}$|^… · required

Request ID, must be unique

Example: ff175a44-90e6-4579-87f1-7e9aa07d57ac

Casing

string · enum

Enum values:

AllCaps

TitleCase

Example: TitleCase

cm_contract_cm_SyncCustomer400

Error

string · enum

Enum values:

Invalid Guid

Example: Invalid Guid

cm_contract_cm_SyncCustomer500

Error

string · enum

Enum values:

DBError

Missing servicebus settings

Example: DBError

cm_contract_cm_GetOpportunity200

Opportunity

string

cm_contract_cm_GetOpportunity400

Error

string · enum

Enum values:

Invalid Guid

Tenant missing in headers

Example: Invalid Guid

cm_contract_cm_GetOpportunity404

Error

string

cm_contract_cm_tp_accept_offer_500

Error

string · enum

Enum values:

DBError

Example: DBError

cm_contract_cm_SearchCustomersRequestBody

RequestId

cm_contract_cm_req_id · pattern: ^([0-9A-Fa-f]{32}$|^… · required

Request ID, must be unique

Example: ff175a44-90e6-4579-87f1-7e9aa07d57ac

CountryCode

string

QueryString

string

Phone numbers, Guid, etc

Example: 99999999

SearchInCRM

boolean

Search in the crm system

Example: true

Default: false

SearchInBrReg

boolean

Search in the entity registry

Example: false

Default: true

SearchPhoneRegistries

boolean

Search in the phone registries

Example: false

Default: true

SearchInternally

boolean

Search in uc databases

Example: false

Default: true

cm_contract_cm_SearchCustomers200

object[]

cm_contract_cm_SearchCustomers400

Error

string · enum

Enum values:

RequestId missing

Invalid RequestId

QueryString missing

Example: RequestId missing

cm_contract_cm_SearchCustomers404

Error

string · enum

Enum values:

No customer data found

Example: No customer data found

cm_contract_cm_SearchCustomers500

Error

string · enum

Enum values:

DBError

Connection Error

Example: DBError

cm_contract_cm_SearchAccountingPointsRequestBody

RequestId

cm_contract_cm_req_id · pattern: ^([0-9A-Fa-f]{32}$|^… · required

Request ID, must be unique

Example: ff175a44-90e6-4579-87f1-7e9aa07d57ac

QueryString

string · required

Identification, Guid, etc

Example: 99999999

ServiceTypeKey

string · required

CheckStatus

boolean

Default: false

cm_contract_cm_SearchAccountingPoints200_a

cm_contract_cm_SearchAccountingPoints200_b

object[]

cm_contract_cm_SearchAccountingPoints400

Error

string · enum

Enum values:

Tenant missing in headers

RequestId missing

Invalid RequestId

QueryString missing

Invalid QueryString

Missing ServiceTypeKey

Example: Invalid RequestId

cm_contract_cm_SearchAccountingPoints500

Error

string · enum

Enum values:

DB Error

Connection Error

Example: DB Error

cm_contract_cm_archive_customer_req_body

RequestId

cm_contract_cm_req_id · pattern: ^([0-9A-Fa-f]{32}$|^…

Request ID, must be unique

Example: ff175a44-90e6-4579-87f1-7e9aa07d57ac

Reason

string · enum

Enum values:

Deceased

Forgotten

Merged

Example: Deceased

Inheritor

cm_contract_cm_guid · pattern: ^([0-9A-Fa-f]{32}$|^…

UC Identifier

Example: ff175a44-90e6-4579-87f1-7e9aa07d57ac

cm_contract_cm_archive_customer_status_400

Message

string · enum

Enum values:

Missing inheritor

Missing reason

Missing status

Invalid Customer Guid

Tenant missing in headers

Invalid RequestId

Missing RequestId

Example: Missing reason

cm_contract_cm_archive_customer_status_500

Error

string · enum

Enum values:

DBError

Example: DBError

cm_contract_cm_GetOffers400

Error

string

cm_contract_cm_GetOffers500

Error

string

cm_contract_cm_PostOffersInput

RequestId

cm_contract_cm_req_id · pattern: ^([0-9A-Fa-f]{32}$|^… · required

Request ID, must be unique

Example: ff175a44-90e6-4579-87f1-7e9aa07d57ac

OwnerId

string · required

cm_contract_cm_Customer · required

cm_contract_cm_Product_input[] · required

TextTemplateGuid

string

object

StartDate

string · date-time

If empty, then according to market requirements. Can be overriden according to market expectations and standards.

Example: 2019-10-14T22:00:00Z

Default: 2019-10-14T22:00:00Z

EndDate

string · date-time

StartOfSupplyDate

string · date-time

StartOfSupplyRequestID

cm_contract_cm_req_id · pattern: ^([0-9A-Fa-f]{32}$|^…

Request ID, must be unique

Example: ff175a44-90e6-4579-87f1-7e9aa07d57ac

CreateANewAccountForEachAccountingPoint

boolean

object

cm_contract_cm_pc_accounting_point[]

cm_contract_cm_pc_accounting_point

cm_contract_fi_el_properties

cm_contract_cm_PostOffers200

OfferGuid

cm_contract_cm_guid · pattern: ^([0-9A-Fa-f]{32}$|^…

UC Identifier

Example: ff175a44-90e6-4579-87f1-7e9aa07d57ac

cm_contract_cm_PostOffers400

Error

string · enum

Enum values:

Tenant missing in headers

RequestId not set

RequestId not valid

OwnerId not set

Customer missing

Customer.Identification missing

Customer.Identification must be a number of length 9 or 11

GivenName and FamilyName is required for a private customer

Example: Tenant missing in headers

cm_contract_cm_PostOffers500

Error

string

cm_contract_cm_Offer

object[]

CustomerGuid

cm_contract_cm_guid · pattern: ^([0-9A-Fa-f]{32}$|^…

UC Identifier

Example: ff175a44-90e6-4579-87f1-7e9aa07d57ac

Guid

cm_contract_cm_guid · pattern: ^([0-9A-Fa-f]{32}$|^…

UC Identifier

Example: ff175a44-90e6-4579-87f1-7e9aa07d57ac

RequestedChannel

string

Status

string

cm_contract_cm_GetOffer400

Error

string

cm_contract_cm_GetOffer_404

Error

string

cm_contract_cm_GetOffer500

Error

string

cm_contract_cm_EraseOfferInput

RequestId

cm_contract_cm_req_id · pattern: ^([0-9A-Fa-f]{32}$|^…

Request ID, must be unique

Example: ff175a44-90e6-4579-87f1-7e9aa07d57ac

Comment

string

An explanation from the clerk

RequestedChannel

string

cm_contract_cm_EraseOffer400

Error

string

cm_contract_cm_EraseOffer_404

Error

string

cm_contract_cm_EraseOffer500

Error

string

cm_contract_cm_GetProduct200

cm_contract_cm_internal_product

cm_contract_cm_GetProduct404

Error

string

cm_contract_cm_GetProduct500

Error

string

cm_contract_cm_PatchProductRequestBody

RequestId

cm_contract_cm_req_id · pattern: ^([0-9A-Fa-f]{32}$|^…

Request ID, must be unique

Example: ff175a44-90e6-4579-87f1-7e9aa07d57ac

ID

string

Name

string

PrimaryProduct

boolean

EnabledForWebOrder

boolean

Visible

boolean

PriceAreas

string[]

InteractiveFields

string[]

EndDate

string · date-time

ProductIdDefault

string

ValidPeriod

string

IsDisabled

boolean

object

WebOrderSubProducts

string[]

object

ServiceTypes

string[]

TextTemplateGuid

string

cm_contract_cm_PatchProduct400

Error

string

cm_contract_cm_PatchProduct500

Error

string

cm_contract_cm_GetProducts200

cm_contract_cm_internal_product[]

cm_contract_cm_internal_product

ID

string

Name

string

PrimaryProduct

boolean

EnabledForWebOrder

boolean

Visible

boolean

PriceAreas

string[]

InteractiveFields

string[]

EndDate

string · date-time

ProductIdDefault

string

ValidPeriod

string

IsDisabled

boolean

object

WebOrderSubProducts

string[]

object

ServiceTypes

string[]

TextTemplateGuid

string

cm_contract_cm_GetProducts500

Error

string

cm_contract_cm_Account

Guid

cm_contract_cm_guid · pattern: ^([0-9A-Fa-f]{32}$|^…

UC Identifier

Example: ff175a44-90e6-4579-87f1-7e9aa07d57ac

CustomerGuid

cm_contract_cm_guid · pattern: ^([0-9A-Fa-f]{32}$|^…

UC Identifier

Example: ff175a44-90e6-4579-87f1-7e9aa07d57ac

Identifiers in other systems

cm_contract_cm_Address[] · minItems: 1 · maxItems: 2

The account's addresses

The account's communication objects

cm_contract_cm_Customer

Identification

string

SSN/Org number

Example: 11068911778

Guid

cm_contract_cm_guid · pattern: ^([0-9A-Fa-f]{32}$|^…

UC Identifier

Example: ff175a44-90e6-4579-87f1-7e9aa07d57ac

DefaultAccount

cm_contract_cm_guid · pattern: ^([0-9A-Fa-f]{32}$|^…

UC Identifier

Example: ff175a44-90e6-4579-87f1-7e9aa07d57ac

BirthDate

string

Name

string

The name of the company

Example: Weyland-Yutani Corporation

FamilyName

string

Last name

Example: Aandal

GivenName

string

First name

Example: Carine

Tags

string[]

object

cm_contract_cm_req_id

string · pattern: ^([0-9A-Fa-f]{32}$|^…

Request ID, must be unique

Example: ff175a44-90e6-4579-87f1-7e9aa07d57ac

cm_contract_cm_Address

StreetName

string · required

BuildingNumber

string · required

PostCode

string · required

CityName

string · required

CountryCode

string · required

Type

string · enum

Address type, either postaladr or invoiceadr

Enum values:

postaladr

invoiceadr

Example: postaladr

FloorIdentification

string

RoomIdentification

string

MunicipalityCode

string

FreeForm

string

PostofficeBox

string

CareOf

string

AttentionOf

string

OnBehalfOf

string

CitySubDivisionName

string

StreetCode

string

cm_contract_cm_Communication

Channel

string · required

Communication channel types, e.g: email, mobile, phone, telefax

Example: Email

Value

string · required

Value

Example: john_thomas_stevenson@gmail.com

Description

string

Textual description from clerk

Example: Email address for customer

cm_contract_cm_SourceIdentification

Source

string

Identification

string

Description

string

cm_contract_cm_Contact

CustomerGuid

cm_contract_cm_guid · pattern: ^([0-9A-Fa-f]{32}$|^…

UC Identifier

Example: ff175a44-90e6-4579-87f1-7e9aa07d57ac

Identifiers in other systems

GivenName

string

FamilyName

string

Email

string

Mobile

string

Roles

string[]

cm_contract_cm_SimpleContract

cm_contract_cm_MeterIndex[]

Status

string · enum

Enum values:

Active

Ended

Pending

Halted

UnderRevertion

UnderTermination

Reverted

UnderReactivation

AccountingPointIdentification

string

The accounting point identifier

Example: 700050700700770005

object

AccountGuid

cm_contract_cm_guid · pattern: ^([0-9A-Fa-f]{32}$|^…

UC Identifier

Example: ff175a44-90e6-4579-87f1-7e9aa07d57ac

AccountingPointGuid

cm_contract_cm_guid · pattern: ^([0-9A-Fa-f]{32}$|^…

UC Identifier

Example: ff175a44-90e6-4579-87f1-7e9aa07d57ac

AccountingPointNickname

string

The customers nickname on the accounting point

Example: The lodge

ContractGuid

cm_contract_cm_guid · pattern: ^([0-9A-Fa-f]{32}$|^…

UC Identifier

Example: ff175a44-90e6-4579-87f1-7e9aa07d57ac

StartDate

string · date-time

EndDate

string | null · date-time

TotalAmount

number

cm_contract_cm_Product[]

object

EstimatedAnnualConsumption

string · number

object

cm_contract_cm_Contract

cm_contract_cm_Account · required

cm_contract_cm_AccountingPoint · required

cm_contract_cm_Customer · required

cm_contract_cm_Product[] · required

Guid

cm_contract_cm_guid · pattern: ^([0-9A-Fa-f]{32}$|^…

UC Identifier

Example: ff175a44-90e6-4579-87f1-7e9aa07d57ac

StartDate

string · date-time

EndDate

string | null · date-time

Status

string · enum

Enum values:

Active

Ended

Pending

Halted

UnderRevertion

UnderTermination

Reverted

UnderReactivation

Example: Active

cm_contract_cm_AccountingPoint

cm_contract_cm_Scheme[]

VatCode

string · enum

Enum values:

S

E

object

EstimatedAnnualProduction

string

The estimated annual production

Example: 10000

object

Identification

string

The accounting point identifier

Example: 700050700700770005

Guid

cm_contract_cm_guid · pattern: ^([0-9A-Fa-f]{32}$|^…

UC Identifier

Example: ff175a44-90e6-4579-87f1-7e9aa07d57ac

EstimatedAnnualConsumption

string

The estimated annual consumption

Example: 10000

MeteringGridAreaUsedDomainLocationIdentification

string

object

object[]

LastMeterReadingDate

string

GridOwner

string

cm_contract_cm_MeterIndex[]

GridOwnerGLN

string

GridOwnerNam

string

GridOwnerOrgNr

string

MGACode

string

MGAName

string

MGAType

string

PriceArea

string

PriceAreaName

string

cm_contract_cm_time_series_value

Value

string · required

From

string · date-time · required

To

string · date-time

cm_contract_cm_SimpleEvent

Category

string

CorrelationID

cm_contract_cm_guid · pattern: ^([0-9A-Fa-f]{32}$|^…

UC Identifier

Example: ff175a44-90e6-4579-87f1-7e9aa07d57ac

EventID

cm_contract_cm_guid · pattern: ^([0-9A-Fa-f]{32}$|^…

UC Identifier

Example: ff175a44-90e6-4579-87f1-7e9aa07d57ac

EventName

string

The name of the event

Example: ContractCreated

ReferenceEventID

cm_contract_cm_guid · pattern: ^([0-9A-Fa-f]{32}$|^…

UC Identifier

Example: ff175a44-90e6-4579-87f1-7e9aa07d57ac

RequestId

cm_contract_cm_req_id · pattern: ^([0-9A-Fa-f]{32}$|^…

Request ID, must be unique

Example: ff175a44-90e6-4579-87f1-7e9aa07d57ac

Source

string

Timestamp

string · date-time

cm_contract_cm_Invoice_Details

InvoicePaymentTerms

number

InvoiceDistributionChannel

string

InvoiceYourReference

string

InvoicePostingInfo

string

PrintFee

boolean

ManualApproval

string

InvoiceDesign

string

InvoiceMinLimit

number

InvoiceInterval

number

Principle

number

InvoiceOpenJournalEntries

number

AdministrationFee

boolean

SecretLocation

boolean

DueDaySettingType

number

cm_contract_cm_pc_accounting_point

Identification

string

707057500093637788

Example: Must be a verified accounting Point Id

EstimatedAnnualConsumption

string

cm_contract_cm_Product_input

ProductName

string · required

The name of the product

Example: Green energy

ProductId

string · required

Identifier

Example: f3eb38f8ff8b4612a9bbbfc2917fb851

PrimaryProduct

boolean

Whether this is a primary product or supplementary product

Example: true

StartDate

string · date-time

EndDate

string · date-time

object[]

cm_contract_fi_el_properties

ContactType

string

CustomerNote

string

DeliveryContract

string

InvoicingChannel

string

InvoicingMethod

string

NoticeBasis

string

NoticeDays

string

TaxCategory

string

TimeLimited

string

TransferContractNeeded

string

OriginalBusinessDocumentReference

string

OriginalBusinessDocumentSender

string

ContractConfirm

string

NoticePeriodStart

string · date-time

NoticePeriodEnd

string · date-time

FixedContractEnd

string · date-time

FixedContractStart

string · date-time

object

cm_contract_cm_UpdateContractCommand

CommandName

string · enum

Enum values:

RemoveProduct

AddProduct

MoveContract

SetEndDate

UpdateMoveInDate

cm_contract_cm_tp_id

string

Third party id

Example: ff175a44-90e6-4579-87f1-7e9aa07d57ac

cm_contract_cm_SlimCustomer

Guid

cm_contract_cm_guid · pattern: ^([0-9A-Fa-f]{32}$|^…

UC Identifier

Example: ff175a44-90e6-4579-87f1-7e9aa07d57ac

Identification

string

SSN/Org number

Example: 11068911778

FamilyName

string

Last name

Example: Aandal

MiddleName

string

Middle name

Example: Anne

GivenName

string

First name

Example: Carine

Name

string

Companyname

Example: UtilityCloud AS

cm_contract_cm_SimpleContract2

Status

string · enum

Enum values:

Active

Ended

Pending

Halted

UnderRevertion

UnderTermination

Reverted

UnderReactivation

cm_contract_cm_Scheme[]

AccountingPointIdentification

string

The accounting point identifier

object

AccountingPointGuid

cm_contract_cm_guid · pattern: ^([0-9A-Fa-f]{32}$|^…

UC Identifier

Example: ff175a44-90e6-4579-87f1-7e9aa07d57ac

AccountingPointNickname

string

The customers nickname on the accounting point

Example: The lodge

ContractGuid

cm_contract_cm_guid · pattern: ^([0-9A-Fa-f]{32}$|^…

UC Identifier

Example: ff175a44-90e6-4579-87f1-7e9aa07d57ac

StartDate

string · date-time

EndDate

string | null · date-time

cm_contract_cm_Product[]

TotalAmount

number

object

EstimatedAnnualConsumption

string · number

object

cm_contract_cm_Product

ProductName

string · required

The name of the product

Example: Green energy

ProductId

string · required

Identifier

Example: f3eb38f8ff8b4612a9bbbfc2917fb851

PrimaryProduct

boolean

Whether this is a primary product or supplementary product

Example: true

StartDate

string · date-time

EndDate

string · date-time

object

cm_contract_cm_internal_product

ID

string

Name

string

PrimaryProduct

boolean

EnabledForWebOrder

boolean

Visible

boolean

PriceAreas

string[]

InteractiveFields

string[]

EndDate

string · date-time

ProductIdDefault

string

ValidPeriod

string

IsDisabled

boolean

object

WebOrderSubProducts

string[]

object

ServiceTypes

string[]

TextTemplateGuid

string

cm_contract_cm_Scheme

SchemeId

string

ValidFrom

string

ValidTo

string

cm_contract_cm_MeterIndex

TimeStamp

string · date-time

Value

string

cm_contract_cm_RemoveProductCommand

ProductId

pattern: ^([0-9A-Fa-f]{32})$ · required

_id

string

The unique product id, in case there are multiple subproducts with the same id

Index

number

index in the product array, in case there are multiple subproducts with the same id

cm_contract_cm_AddProductCommand

StartDate

string · date-time · required

ProductId

string · pattern: ^([0-9A-Fa-f]{32})$ · required

ProductName

string · required

EndDate

string · date-time

object[]

cm_contract_cm_MoveContractCommand

AccountGuid

cm_contract_cm_guid · pattern: ^([0-9A-Fa-f]{32}$|^…

UC Identifier

Example: ff175a44-90e6-4579-87f1-7e9aa07d57ac

cm_contract_cm_Address[] · minItems: 1 · maxItems: 2

The account's addresses