Search for contracts

GET

contract

curl --request GET \
  --url https://demo.enneo.ai/api/mind/contract/search \
  --header 'Authorization: Bearer <token>'

[
  {
    "id": 123,
    "similarity": 123,
    "contract": {
      "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"
      }
    }
  }
]

Authorizations

Authorization

string

header

required

JWT-based authentication

Query Parameters

contractId

string

The ID of the contract, e.g. 829211

customerId

string

The ID of the customer, e.g. 101020120

firstname

string

The first name to search for, e.g. John

lastname

string

The last name to search for, e.g. Smith

fullname

string

The full name to search for, e.g. John Smith

birthday

string

The birthday to search for, e.g. 1980-01-01

company

string

The company to search for, e.g. enneo GmbH

string

The email to search for, e.g. [email protected]

meterNumber

string

The meter number to search for, e.g. 1ESY1160669167

address

string

The address to search for. Format is e.g. Eppendorfer Landstr. 32, 20249 Hamburg

postalCode

string

The postal code to search for, e.g. 20249

city

string

The city to search for, e.g. Hamburg

includeRawData

boolean

default:false

If yes, then the raw source data coming from the ERP is included in the response

Response

Successful operation

integer

similarity

number<float>

How well the contract fits to the search parameters. Exact match on contractId always returns 1 (=100%)

contract

object

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

Anzeigen untergeordnete attribute

contract.id

integer

Example:

746839

contract.orderId

integer

Example:

123

contract.tenant

string | null

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

Example:

null

contract.customerId

string

Example:

"123"

Example:

1661126400

contract.status

string

Example:

"active"

contract.statusCode

integer

Example:

5000

contract.statusCodeTitle

string

Example:

"active"

contract.energy

string

Example:

"electricity"

contract.energyTypeId

integer

Example:

1

contract.energySubTypeId

integer

Example:

1

contract.email

string

Example:

"[email protected]"

contract.firstname

string

Example:

"John"

contract.lastname

string

Example:

"Doe"

contract.deliveryAddress

string

Address where the electricity/gas is being delivered to

Example:

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

contract.iban

string | null

Example:

"DE89370400440532013000"

contract.monthlyDeposit

number<integer> | null

Example:

53

contract.startDate

string<date> | null

Example:

1661990400

contract.endDate

string | null

Example:

null

contract.consumption

integer | null

Example:

3477

contract.counterNumber

string | null

Example:

"1ESY1160669167"

contract.productId

integer | null

Example:

1

contract.productName

string | null

Example:

"Flex 24"

contract.productCode

string | null

Example:

"flx_24"

contract.campaignId

integer | null

Example:

1

contract.salesChannelId

integer | null

Example:

1

contract.unpaidDebt

number<float> | null

Example:

109.21

contract.vatRate

number<float> | null

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

Example:

0.09

contract.basePrice

number<float> | null

Example:

0.09

contract.workingPrice

number<float> | null

Example:

0.09

contract.billingAddress

string | null

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

Example:

"Rechnungssstraße 24, 10587 Berlin"

contract.business

boolean | null

Example:

false

contract.phone

string | null

Example:

491721041689

contract.gridOperatorName

string | null

Example:

"E.ON Bayern AG"

contract.gridOperatorCode

string | null

Example:

1000000000000

contract.registers

object[] | null

contract.erpUrls

object[] | null

Anzeigen untergeordnete attribute

contract.erpUrls.url

string

Example:

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

contract.erpUrls.logo

enum<string>

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

Verfügbare Optionen:

powercloud,

lynqtech,

sap

Example:

"powercloud"

contract.rawData

object

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

Example:

null

contract.agentPreview

object[]

Preview information shown to agents in the UI

Anzeigen untergeordnete attribute

contract.agentPreview.label

string

Label text shown to the agent

Example:

"Tarif"

contract.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"

contract.agentPreview.url

string | null

Optional URL that opens when clicking the preview item

Example:

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

contract.tabPreview

object

Preview information shown in contract tabs

Anzeigen untergeordnete attribute

contract.tabPreview.color

enum<string>

Color indicator for contract status

Verfügbare Optionen:

blue,

green,

red,

grey,

yellow,

purple,

orange,

teal

Example:

"green"

contract.tabPreview.icon

enum<string>

Icon shown in the tab

Verfügbare Optionen:

electricity,

gas,

other

Example:

"electricity"

Zurück

Get knowledgeSource

Weiter

⌘I

Search for contracts

curl --request GET \
  --url https://demo.enneo.ai/api/mind/contract/search \
  --header 'Authorization: Bearer <token>'

[
  {
    "id": 123,
    "similarity": 123,
    "contract": {
      "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"
      }
    }
  }
]

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

Query Parameters

Response