Electron

Facilitates seamless management of electricity related services.

Endpoints

Contract Management

Register Electricity Contract

Register an electricity contract for a specific customer living in a specific property.

POST https://<API_SERVER_URL>/electron/v1/contract/registration

Headers

Name	Type	Description
Authorization*	string	The bearer authentication header with value "Bearer <YOUR_ACCESS_TOKEN>"
Content-Type*	string	The content type with value "application/json"

Request Body

Name	Type	Description
customer*	Customer	Customer details. Refer to Customer
property*	Property	Property details. Refer to Property
poa*	PowerOfAttorney	Power of attorney details. Refer to PowerOfAttorney

curl

curl --request POST \
  --url https://<API_SERVER_URL>/electron/v1/contract/registration \
  --header 'Authorization: Bearer eyJhbGciOi...' \
  --header 'Content-Type: application/json' \
  --data '{
  "customer": {
    "id": "66e58007e78e7610e1a2b755",
    "email": "[email protected]",
    "first_name": "first_name",
    "last_name": "last_name",
    "phone": "0123456789",
    "soc_id": "19840613123"
  },
  "property": {
    "id": "66ec3f54e78e7610e1a2dd70",
    "address": "address",
    "city": "city",
    "zip_code": "12345",
    "property_number": "1305"
  },
  "poa": {
    "file_base64": "CiAgICAgIFNp...",
    "file_extension": "pdf",
    "type": "SWITCH"
  }
}'

200: OK Successful response.

{
  "id": "1",
  "status": 
  {
    "category": "PROCESSING",
    "state": "REGISTERED"
  }
}

400: Bad Request Request is malformed

401: Unauthorized Permission is denied

500: Internal Server Error Something is not working on our side

ContractRegistrationResponse

Get Contract Details

Returns details of a specific contract.

GET https://<API_SERVER_URL>/electron/v1/contract/{id}/details

Path Parameters

Name	Type	Description
id*	string	Unique contract identifier

Headers

Name	Type	Description
Authorization*	string	The bearer authentication header with value "Bearer <YOUR_ACCESS_TOKEN>"
Content-Type*	string	The content type with value "application/json"

cURL

curl --request GET \
  --url https://<API_SERVER_URL>/electron/v1/contract/1/details \
  --header 'Authorization: Bearer eyJhbGciOiJ...'

200: OK Successful response

{
  "id": "1",
  "status": {
    "category": "PROCESSING",
    "state": "DECLINED",
    "info": "Felaktig - Fel anläggningsadress"
  },
  "customer": {
    "id": "66e58007e78e7610e1a2b755",
    "email": "[email protected]",
    "first_name": "first_name",
    "last_name": "last_name",
    "phone": "0123456789",
    "soc_id": "19840613123"
  },
  "property": {
    "id": "66ec3f54e78e7610e1a2dd70",
    "address": "address",
    "city": "city",
    "zip_code": "12345",
    "property_number": "1305"
  },
  "poa": {
    "file_base64": "CiAgICAgIFNp...",
    "file_extension": "pdf",
    "type": "SWITCH"
  }
}

400: Bad Request Request is malformed

401: Unauthorized Permission is denied

404: Not Found Contract is not found

500: Internal Server Error Something is not working on our side

ContractDetailsResponse

Invoice Management

Get Invoices

Collects the list of monthly invoices that belongs to a specific customer living in a specific property.

GET https://<API_SERVER_URL>/electron/v1/invoice

Query Parameters

Name	Type	Description
from_date*	string	Filter result by period starting from this date (YYYY-MM-DD)
to_date	string	Filter result by period ending this date (YYYY-MM-DD). If not specified the result includes only invoice issued for <from_date>
customer_id*	string	Unique customer identifier
property_id*	string	Unique property identifier

Headers

Name	Type	Description
Content-Type*	string	The content type with value "application/json"
Authorization*	string	The bearer authentication header with value "Bearer <YOUR_ACCESS_TOKEN>"

200: OK Successful response

{
  "invoices":
  [
    {   
      "id": string,
      "bill_date": string,
      "status": string,
      "total_amount": long,
      "total_consumption": long,
      "due_date": string,
      "pdf_file_url": string
    }
  ]
}

401: Unauthorized Permission is denied

400: Bad Request Request is malformed

204: No Content No invoice is issued yet

404: Not Found Customer or property is not found

500: Internal Server Error Something is not working on our side

InvoiceResponse

Get Invoice Details

Returns details of a specific invoice.

GET https://<API_SERVER_URL>/electron/v1/invoice/{id}/details

Path Parameters

Name	Type	Description
id*	string	Unique invoice identifier

Headers

Name	Type	Description
Authorization*	string	The bearer authentication header with value "Bearer <YOUR_ACCESS_TOKEN>"
Content-Type*	string	The content type with value "application/json"

200: OK Successful response

{
  "id": string,
  "bill_date": string,
  "status": string,
  "total_amount": long,
  "total_consumption": long,
  "due_date": string,
  "pdf_file_url": string,
  "customer":
  {
    "id": string,
    "first_name": string,
    "last_name": string,
    "soc_id": string,
    "email": string,
    "phone": string
  },
  "property":
  {
    "id": string,
    "address": string,
    "property_number": string,
    "zip_code": string,
    "city": string,
    "country": string
  }
}

404: Not Found Invoice is not found

401: Unauthorized Permission is denied

400: Bad Request Request is malformed

500: Internal Server Error Something is not working on our side

InvoiceDetailsResponse

Consumption Statistics

Get Hourly Consumption

Collects the list of hourly consumption for a specific date.

GET https://<API_SERVER_URL>/electron/v1/property/<property_id>/consumption/hourly

Query Parameters

Name	Type	Description
from_date*	string	Limit result to starting from this date, inclusive. Format YYYY-MM-DD
to_date	String	Limit result to ending at this date, exclusive. Format YYYY-MM-DD

Headers

Name	Type	Description
Authorization*	string	The bearer authentication header with value "Bearer <YOUR_ACCESS_TOKEN>"
Content-Type*	string	The content type with value "application/json"

cURL

curl --request GET \
  --url 'https://api.nibelaab.cloud/electron/v1/property/66c7441a51e2a335ed902891/consumption/hourly?from_date=2024-09-10' \
  --header 'Authorization: Bearer eyJhbGci...'

200: OK Successful response

[
  {
    "date": "2024-09-18",
    "unit": "kWh",
    "currency": "SEK",
    "consumption": [
      {
        "hour": "0",
        "price": "11.37",
        "volume": "0.091"
      },
      {
        "hour": "1",
        "price": "9.08",
        "volume": "0.09"
      },
      {
        "hour": "2",
        "price": "7.96",
        "volume": "0.076"
      },
      {
        "hour": "3",
        "price": "7.97",
        "volume": "0.111"
      },
      {
        "hour": "4",
        "price": "11.92",
        "volume": "0.082"
      },
      {
        "hour": "5",
        "price": "20.28",
        "volume": "0.087"
      },
      {
        "hour": "6",
        "price": "55.96",
        "volume": "0.102"
      },
      {
        "hour": "7",
        "price": "60.45",
        "volume": "0.142"
      },
      {
        "hour": "8",
        "price": "54.44",
        "volume": "0.125"
      },
      {
        "hour": "9",
        "price": "48.23",
        "volume": "0.127"
      },
      {
        "hour": "10",
        "price": "22.63",
        "volume": "0.109"
      },
      {
        "hour": "11",
        "price": "14.71",
        "volume": "0.097"
      },
      {
        "hour": "12",
        "price": "13.61",
        "volume": "0.085"
      },
      {
        "hour": "13",
        "price": "14.36",
        "volume": "0.093"
      },
      {
        "hour": "14",
        "price": "16.84",
        "volume": "0.09"
      },
      {
        "hour": "15",
        "price": "22.16",
        "volume": "0.087"
      },
      {
        "hour": "16",
        "price": "47.65",
        "volume": "0.096"
      },
      {
        "hour": "17",
        "price": "54.13",
        "volume": "0.24"
      },
      {
        "hour": "18",
        "price": "56.53",
        "volume": "0.161"
      },
      {
        "hour": "19",
        "price": "55.79",
        "volume": "0.176"
      },
      {
        "hour": "20",
        "price": "21.83",
        "volume": "0.103"
      },
      {
        "hour": "21",
        "price": "20.97",
        "volume": "0.088"
      },
      {
        "hour": "22",
        "price": "17.01",
        "volume": "0.087"
      },
      {
        "hour": "23",
        "price": "18.14",
        "volume": "0.097"
      }
    ]
  }
]

204: No Content There is no consumption available for this date

400: Bad Request Request is malformed

401: Unauthorized Permission is denied

404: Not Found Customer or property is not found

500: Internal Server Error Something is wrong on our side

HourlyConsumptionResponse