Zum Hauptinhalt springen
GET
/
contract
/
{contractId}
Get contract by id
curl --request GET \
  --url https://demo.enneo.ai/api/mind/contract/{contractId} \
  --header 'Authorization: Bearer <token>'
{
  "id": 746839,
  "orderId": 123,
  "tenant": null,
  "customerId": "123",
  "signupDate": 1661126400,
  "status": "active",
  "statusCode": 5000,
  "statusCodeTitle": "active",
  "energy": "electricity",
  "energyTypeId": 1,
  "energySubTypeId": 1,
  "email": "[email protected]",
  "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"
  }
}

Autorisierungen

​
Authorization
string
header
erforderlich

JWT-based authentication

Pfadparameter

​
contractId
string
erforderlich

The id of the contract to retrieve

Abfrageparameter

​
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

Antwort

Successful operation

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

​
id
integer
Beispiel:

746839

​
orderId
integer
Beispiel:

123

​
tenant
string | null

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

Beispiel:

null

​
customerId
string
Beispiel:

"123"

​
signupDate
string<date>
Beispiel:

1661126400

​
status
string
Beispiel:

"active"

​
statusCode
integer
Beispiel:

5000

​
statusCodeTitle
string
Beispiel:

"active"

​
energy
string
Beispiel:

"electricity"

​
energyTypeId
integer
Beispiel:

1

​
energySubTypeId
integer
Beispiel:

1

​
email
string
​
firstname
string
Beispiel:

"John"

​
lastname
string
Beispiel:

"Doe"

​
deliveryAddress
string

Address where the electricity/gas is being delivered to

Beispiel:

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

​
iban
string | null
Beispiel:

"DE89370400440532013000"

​
monthlyDeposit
number<integer> | null
Beispiel:

53

​
startDate
string<date> | null
Beispiel:

1661990400

​
endDate
string | null
Beispiel:

null

​
consumption
integer | null
Beispiel:

3477

​
counterNumber
string | null
Beispiel:

"1ESY1160669167"

​
productId
integer | null
Beispiel:

1

​
productName
string | null
Beispiel:

"Flex 24"

​
productCode
string | null
Beispiel:

"flx_24"

​
campaignId
integer | null
Beispiel:

1

​
salesChannelId
integer | null
Beispiel:

1

​
unpaidDebt
number<float> | null
Beispiel:

109.21

​
vatRate
number<float> | null

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

Beispiel:

0.09

​
basePrice
number<float> | null
Beispiel:

0.09

​
workingPrice
number<float> | null
Beispiel:

0.09

​
billingAddress
string | null

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

Beispiel:

"Rechnungssstraße 24, 10587 Berlin"

​
business
boolean | null
Beispiel:

false

​
phone
string | null
Beispiel:

491721041689

​
gridOperatorName
string | null
Beispiel:

"E.ON Bayern AG"

​
gridOperatorCode
string | null
Beispiel:

1000000000000

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

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

Beispiel:

null

​
agentPreview
object[]

Preview information shown to agents in the UI

​
tabPreview
object

Preview information shown in contract tabs