List contracts

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

customerNumber

string

required

Customer number

Query Parameters

offset

integer<int32>

default:0

Offset of the page.

limit

integer<int32>

default:10

Size of the page.

Response

200 - application/json

API response DTO with a list of items.

isSuccess

boolean

read-only

Success status of the operation based on status code (2xx range).

Example:

true

message

string | null

Optional message to provide additional information about the operation result.

Example:

null

error

object[] | null

Optional error details in case of an error(s).

Hide child attributes

error.severity

enum<string>

Severity of the error.

Available options:

Error,

Warning,

Notice

Example:

"Error"

error.code

string

Internal error code for client processing.

Example:

"validation-failed"

error.message

string

Error message.

Example:

"First name is required for non-business customers."

error.details

string | null

Additional details about the error.

Example:

null

refUri

string<uri> | null

read-only

Optional reference URI to point to the resulting resource.

data

object[]

Returned data instance.

Hide child attributes

data.contractNumber

string

required

Contract number

data.tariffName

string

required

Tariff name

Example:

"Rabot.smart"

data.contractState

enum<string>

required

Contract state

Available options:

Open,

Delivery,

Unspecified,

PendingDelivery,

Cancelled,

Rejected,

Revoked,

Processing

Example:

"Open"

data.name

string | null

Contract name, if added by the user to differentiate multiple contracts

Example:

"Home"

data.deliveryAddress

object

Delivery address - the location where the meter is installed

Hide child attributes

data.deliveryAddress.title

string | null

Academic title or NULL if none

Example:

"Dr."

data.deliveryAddress.firstName

string | null

First name or NULL if business address

Example:

"Thomas"

data.deliveryAddress.lastName

string | null

Last name or NULL if business address

Example:

"Mustermann"

data.deliveryAddress.businessName

string | null

Business name in case of business address or NULL if person

Example:

null

data.deliveryAddress.gender

enum<string>

Gender of the address holder

Available options:

Male,

Female,

Other

data.deliveryAddress.extension

string | null

Address extension

Example:

null

data.deliveryAddress.streetName

string

Street name

Example:

"Grüner Weg"

data.deliveryAddress.houseNumber

string

House number or NULL if none

Example:

"42"

data.deliveryAddress.city

string

Name of the city

Example:

"Berlin"

data.deliveryAddress.postCode

string

Postcode in valid format

Example:

"14109"

data.deliveryAddress.countryCode

string

ISO 3166 A2 code of the country

Example:

"DE"

data.billingAddress

object

Billing address

Hide child attributes

data.billingAddress.title

string | null

Academic title or NULL if none

Example:

"Dr."

data.billingAddress.firstName

string | null

First name or NULL if business address

Example:

"Thomas"

data.billingAddress.lastName

string | null

Last name or NULL if business address

Example:

"Mustermann"

data.billingAddress.businessName

string | null

Business name in case of business address or NULL if person

Example:

null

data.billingAddress.gender

enum<string>

Gender of the address holder

Available options:

Male,

Female,

Other

data.billingAddress.extension

string | null

Address extension

Example:

null

data.billingAddress.streetName

string

Street name

Example:

"Grüner Weg"

data.billingAddress.houseNumber

string

House number or NULL if none

Example:

"42"

data.billingAddress.city

string

Name of the city

Example:

"Berlin"

data.billingAddress.postCode

string

Postcode in valid format

Example:

"14109"

data.billingAddress.countryCode

string

ISO 3166 A2 code of the country

Example:

"DE"

data.bankDetail

object

Bank details

Hide child attributes

data.bankDetail.accountHolder

string | null

Name of the account holder. When used to create an order, if the value is not provided, the name of the customer from billing address (or delivery address, when billing address is not provided) will be used.

Example:

"Thomas Heinrich Mustermann"

data.bankDetail.iban

string

IBAN of the account.

Example:

"DE89370400440532013000"

data.bankDetail.bic

string | null

BIC of the account.

Example:

"DEUTDEFF"

data.bankDetail.bankName

string | null

Name of the bank.

Example:

"Deutsche Bank"

data.bankDetail.hasAcceptedDirectDebit

boolean

Flags, if the direct debit has been accepted.

Example:

true

data.meterNumber

string | null

Meter number

Example:

"12LN6786454"

data.meLoIdentifier

string | null

Meter location id

Example:

"DE12345678901234567890"

data.maLoIdentifier

string | null

Meter location id

Example:

"99987999749"

data.actualDateOfDelivery

string<date> | null

Start of delivery for this contract

Example:

"2025-03-01"

data.endDateOfDelivery

string<date> | null

End date of delivery, null if contract is not cancelled

Example:

null

data.cancellationPeriod

integer<int32> | null

Cancellation period

Example:

1

data.cancellationPeriodUnit

string | null

Cancellation period unit

Example:

"Month"

data.durationPeriod

integer<int32> | null

Minimum duration of the contract

Example:

1

data.durationPeriodUnit

string | null

Duration period unit

Example:

"Month"

data.renewalPeriod

integer<int32> | null

Renewal period - for how long the contract extends when not cancelled

Example:

1

data.renewalPeriodUnit

string | null

Renewal period unit

Example:

"Month"

data.expectedAnnualConsumptionInKwhPerYear

integer<int32> | null

Expected annual consumption in kWh per year

Example:

3500

data.accountingMethod

string | null

Meter config type

Example:

"IMSy (TAF7)"

data.distributionSystemOperatorCode

string | null

Code of Distribution System Operator

Example:

"9907248000001"

data.distributionSystemOperatorName

string | null

Name of Distribution System Operator

Example:

"SWM Infrastruktur GmbH & Co. KG"

data.previousSupplierCode

string | null

Code of previous supplier

Example:

"9910660000004"

data.previousSupplierName

string | null

Name of previous supplier

Example:

"Octopus Energy Germany"

data.paragraph14AInfo

object

Paragraph §14a information

Hide child attributes

data.paragraph14AInfo.isModule1InUse

boolean

required

Module 1 in a use flag.

data.paragraph14AInfo.isModule2InUse

boolean

required

Module 2 in a use flag.

data.paragraph14AInfo.isModule3InUse

boolean

required

Module 3 in a use flag.

count

integer<int32>

read-only

Number of items returned in the list.

Example:

10

hasMoreItems

boolean

Indicates, whether there are more items to be returned in the list, that are not included in the limit of this request.

Example:

true

Introduction

Get Started

Quickstart

Guides

Updates

API reference

Authorizations

Path Parameters

Query Parameters

Response

Introduction

Get Started

Quickstart

Guides

Updates

API reference

Documentation Index

Authorizations

Path Parameters

Query Parameters

Response