Get a customer by contract id

GET

customer

byContractId

{contractId}

curl --request GET \
  --url https://demo.enneo.ai/api/mind/customer/byContractId/{contractId} \
  --header 'Authorization: Bearer <token>'

{
  "id": 83771,
  "emailMatches": true,
  "business": false,
  "company": null,
  "firstname": "Tom",
  "lastname": "Mustermann",
  "address": "Hugo-Junkers-Str. 5",
  "phone": 49123456789,
  "email": "[email protected]",
  "tags": [
    {
      "id": 2,
      "color": "green",
      "name": "VIP"
    }
  ],
  "contracts": [
    {
      "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"
      }
    }
  ],
  "additionalData": {}
}

Authorizations

Authorization

string

header

required

JWT-based authentication

Path Parameters

contractId

string

required

The id of the contract for which the associated customer is requested

Response

object | null

Successful operation

integer

Example:

83771

emailMatches

boolean | null

If false, the customer sent the email from an account that doesn't match our records. Always returns 'null' when customer is retrieved by customerId and not by ticketId

Example:

true

business

boolean

Example:

false

company

string | null

Name of the company. Null when customer is not a business but private

Example:

null

firstname

string

Example:

"Tom"

lastname

string

Example:

"Mustermann"

address

string

Example:

"Hugo-Junkers-Str. 5"

phone

string

Example:

49123456789

string<email>

Example:

"[email protected]"

tags

object[]

Anzeigen untergeordnete attribute

tags.id

integer

Example:

2

tags.color

enum<string>

Verfügbare Optionen:

green,

yellow,

red,

blue,

grey

Example:

"green"

tags.name

string

Example:

"VIP"

contracts

object[]

Contracts that this customer has

Anzeigen untergeordnete attribute

contracts.id

integer

Example:

746839

contracts.orderId

integer

Example:

123

contracts.tenant

string | null

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

Example:

null

contracts.customerId

string

Example:

"123"

Example:

1661126400

contracts.status

string

Example:

"active"

contracts.statusCode

integer

Example:

5000

contracts.statusCodeTitle

string

Example:

"active"

contracts.energy

string

Example:

"electricity"

contracts.energyTypeId

integer

Example:

1

contracts.energySubTypeId

integer

Example:

1

contracts.email

string

Example:

"[email protected]"

contracts.firstname

string

Example:

"John"

contracts.lastname

string

Example:

"Doe"

contracts.deliveryAddress

string

Address where the electricity/gas is being delivered to

Example:

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

contracts.iban

string | null

Example:

"DE89370400440532013000"

contracts.monthlyDeposit

number<integer> | null

Example:

53

contracts.startDate

string<date> | null

Example:

1661990400

contracts.endDate

string | null

Example:

null

contracts.consumption

integer | null

Example:

3477

contracts.counterNumber

string | null

Example:

"1ESY1160669167"

contracts.productId

integer | null

Example:

1

contracts.productName

string | null

Example:

"Flex 24"

contracts.productCode

string | null

Example:

"flx_24"

contracts.campaignId

integer | null

Example:

1

contracts.salesChannelId

integer | null

Example:

1

contracts.unpaidDebt

number<float> | null

Example:

109.21

contracts.vatRate

number<float> | null

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

Example:

0.09

contracts.basePrice

number<float> | null

Example:

0.09

contracts.workingPrice

number<float> | null

Example:

0.09

contracts.billingAddress

string | null

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

Example:

"Rechnungssstraße 24, 10587 Berlin"

contracts.business

boolean | null

Example:

false

contracts.phone

string | null

Example:

491721041689

contracts.gridOperatorName

string | null

Example:

"E.ON Bayern AG"

contracts.gridOperatorCode

string | null

Example:

1000000000000

contracts.registers

object[] | null

contracts.erpUrls

object[] | null

Anzeigen untergeordnete attribute

contracts.erpUrls.url

string

Example:

"https://erp-system.com/contract/123"

contracts.erpUrls.logo

enum<string>

Logo the FE should show when processing an URL of this type

Verfügbare Optionen:

powercloud,

lynqtech,

sap

Example:

"powercloud"

contracts.rawData

object

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

Example:

null

contracts.agentPreview

object[]

Preview information shown to agents in the UI

Anzeigen untergeordnete attribute

contracts.agentPreview.label

string

Label text shown to the agent

Example:

"Tarif"

contracts.agentPreview.value

string

Value text shown to the agent

Example:

"Flex 24"

Optional tooltip shown on hover

Example:

"AP: 28.5 ct/kWh\nGP: 149.88 €/Jahr"

contracts.agentPreview.url

string | null

Optional URL that opens when clicking the preview item

Example:

"https://erp.example.com/contract/123"

contracts.tabPreview

object

Preview information shown in contract tabs

Anzeigen untergeordnete attribute

contracts.tabPreview.color

enum<string>

Color indicator for contract status

Verfügbare Optionen:

blue,

green,

red,

grey,

yellow,

purple,

orange,

teal

Example:

"green"

contracts.tabPreview.icon

enum<string>

Icon shown in the tab

Verfügbare Optionen:

electricity,

gas,

other

Example:

"electricity"

additionalData

object

Client-specific data objects can be included here

Zurück

Get a customer by ticket idGet a customer and associated contracts by ticket id. Tickets are mapped to customer using enneo.MIND's AI, or when manually assigned by a user

Weiter

⌘I

Get a customer by contract id

curl --request GET \
  --url https://demo.enneo.ai/api/mind/customer/byContractId/{contractId} \
  --header 'Authorization: Bearer <token>'

{
  "id": 83771,
  "emailMatches": true,
  "business": false,
  "company": null,
  "firstname": "Tom",
  "lastname": "Mustermann",
  "address": "Hugo-Junkers-Str. 5",
  "phone": 49123456789,
  "email": "[email protected]",
  "tags": [
    {
      "id": 2,
      "color": "green",
      "name": "VIP"
    }
  ],
  "contracts": [
    {
      "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"
      }
    }
  ],
  "additionalData": {}
}

Ticket

Conversation

Intent

AiAgent

AI Tools

AI Quality Check

Template

Profile

Team

Settings

Tag

Role

Customer

Contract

Wiki knowledge source

Wiki knowledge source structure

Partner

Event

Export

Report

Health

General

Storage

Cache

Executor Sandbox

Telephony

Debugging for AI Microservice Cortex

Authorizations

Path Parameters

Response