GET
/
contract
/
{contractId}
curl --request GET \
  --url https://demo.enneo.ai/api/mind/contract/{contractId}
{
  "id": 746839,
  "orderId": 123,
  "tenant": null,
  "customerId": 123,
  "signupDate": 1661126400,
  "status": "active",
  "statusCode": 5000,
  "statusCodeTitle": "active",
  "energy": "electricity",
  "energyTypeId": 1,
  "energySubTypeId": 1,
  "email": "johndoe@example.com",
  "firstname": "John",
  "lastname": "Doe",
  "deliveryAddress": "Hugo-Junkers-Str. 5, 82031 Grünwald",
  "iban": "DE89370400440532013000",
  "monthlyDeposit": 53,
  "startDate": 1661990400,
  "endDate": null,
  "consumption": 3477,
  "counterNumber": "1ESY1160669167",
  "productId": 1,
  "productName": "Flex 24",
  "productCode": "flx_24",
  "campaignId": 1,
  "salesChannelId": 1,
  "unpaidDebt": 109.21,
  "vatRate": 0.09,
  "basePrice": 0.09,
  "workingPrice": 0.09,
  "billingAddress": "Rechnungssstraße 24, 10587 Berlin",
  "business": false,
  "phone": 491721041689,
  "gridOperatorName": "E.ON Bayern AG",
  "gridOperatorCode": 1000000000000,
  "registers": [
    {}
  ],
  "erpUrls": [
    {
      "url": "https://erp-system.com/contract/123",
      "logo": "powercloud"
    }
  ],
  "rawData": null,
  "agentPreview": [
    {
      "label": "Tarif",
      "value": "Flex 24",
      "tooltip": "AP: 28.5 ct/kWh\nGP: 149.88 €/Jahr",
      "url": "https://erp.example.com/contract/123"
    }
  ],
  "tabPreview": {
    "color": "green",
    "icon": "electricity"
  }
}

Authorizations

connect.sid
string
cookie
required

Cookie-based authentication

Path Parameters

contractId
integer
required

The id of the contract to retrieve

Query Parameters

includeRawData
boolean

If set to true, then the raw response from the ERP system will be included

refresh
boolean

If set to true, then enneo will fetch the data from the underlying ERP system first

Response

200
application/json
Successful operation

A contract of a customer. Either electricity or gas. IDs match the backend system (powercloud)

id
integer
Example:

746839

orderId
integer
Example:

123

tenant
string | null

If a customer has multiple tenants/brands, this is the tenant name. Currently only used for SAP

Example:

null

customerId
integer
Example:

123

signupDate
string
Example:

1661126400

status
string
Example:

"active"

statusCode
integer
Example:

5000

statusCodeTitle
string
Example:

"active"

energy
string
Example:

"electricity"

energyTypeId
integer
Example:

1

energySubTypeId
integer
Example:

1

email
string
Example:

"johndoe@example.com"

firstname
string
Example:

"John"

lastname
string
Example:

"Doe"

deliveryAddress
string

Address where the electricity/gas is being delivered to

Example:

"Hugo-Junkers-Str. 5, 82031 Grünwald"

iban
string | null
Example:

"DE89370400440532013000"

monthlyDeposit
number | null
Example:

53

startDate
string | null
Example:

1661990400

endDate
string | null
Example:

null

consumption
integer | null
Example:

3477

counterNumber
string | null
Example:

"1ESY1160669167"

productId
integer | null
Example:

1

productName
string | null
Example:

"Flex 24"

productCode
string | null
Example:

"flx_24"

campaignId
integer | null
Example:

1

salesChannelId
integer | null
Example:

1

unpaidDebt
number | null
Example:

109.21

vatRate
number | null

VAT Rate, usually 0.19 (=19%) for electricity and 0.07 (=7%) for gas

Example:

0.09

basePrice
number | null
Example:

0.09

workingPrice
number | null
Example:

0.09

billingAddress
string | null

Address where written communication should be sent to. NULL if same as delivery address

Example:

"Rechnungssstraße 24, 10587 Berlin"

business
boolean | null
Example:

false

phone
string | null
Example:

491721041689

gridOperatorName
string | null
Example:

"E.ON Bayern AG"

gridOperatorCode
string | null
Example:

1000000000000

registers
object[] | null
erpUrls
object[] | null
rawData
object | null

Raw source data from the originating ERP system in the ERP-proprietary format is included here. Only provided on request.

Example:

null

agentPreview
object[]

Preview information shown to agents in the UI

tabPreview
object | null

Preview information shown in contract tabs