Enneo

Contract

Search for contracts

GET /contract/search

GET /contract/search

Query parameters

contractIdstringquery

The ID of the contract, e.g. 829211

customerIdstringquery

The ID of the customer, e.g. 101020120

firstnamestringquery

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

lastnamestringquery

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

fullnamestringquery

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

birthdaystringquery

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

companystringquery

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

emailstringquery

The email to search for, e.g. john@smith.com

meterNumberstringquery

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

addressstringquery

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

postalCodestringquery

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

citystringquery

The city to search for, e.g. Hamburg

includeRawDatabooleanquery

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

Responses

200 — Successful operation

Response Example

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

400 — Bad request