# Gasell SOAP API Documentation

## Overview

The Gasell SOAP API provides three endpoints:

| Endpoint | URL | Description |
|---|---|---|
| Public API | `/webservices/api.php` | Main integration API for customer, site, and contract management |
| Website API | `/webservices/api_web.php` | Customer-facing website services (invoices, meters, readings, pricing) |
| Private API | `/webservices/api_private.php` | Internal lookups (net area, electricity area by zip code) |

WSDL is available by appending `?wsdl` to any endpoint URL.

All methods require `userName` and `passwd` as the first two parameters for authentication. These are omitted from the parameter tables below for brevity.

---

## Endpoint 1: Public API (`api.php`)

### Customer Methods

#### `addNewCustomer`

Creates a new customer.

| Parameter | Type | Required | Description |
|---|---|---|---|
| `firstName` | string | Yes | Customer first name |
| `lastName` | string | Yes | Customer last name |
| `customerPersonalIdentityNumber` | string | Yes | Social security number / org number |
| `companyName` | string | Yes* | Company name (pass empty string if private person) |
| `customerAddress` | string | Yes | Street address |
| `customerZipCode` | string | Yes | Postal code |
| `customerCity` | string | Yes | City |
| `email` | string | No | Email address |
| `phoneNumberDay` | string | No | Daytime phone number |
| `phoneNumberNight` | string | No | Evening phone number |
| `phoneNumberCellPhone` | string | No | Mobile phone number |
| `customerCareOfAddress` | string | No | Care-of address |
| `protectedIdentity` | int | No | 0 = normal, 1 = protected identity |
| `foreignIdentity` | int | No | 1 = Swedish, 2 = foreign (disables social ID validation) |
| `contactPersonSocIdTypeId` | string | No | Social ID type (default: 1) |
| `communicationCategoryId` | string | No | Preferred communication category |

**Returns:** `int` — the new customer ID

**Errors:**
- `SOAP_REQUIRED_CUSTOMER_PARAMETERS_MISSING` — required fields are empty
- `SOAP_FAILED_SAVING_CUSTOMER` — save failed
- `SOAP_FAILED_SAVING_CUSTOMER_CUSTOMER_ALREADY_EXIST` — duplicate customer (if configured)

---

#### `getCustomerById`

Retrieves a customer by ID.

| Parameter | Type | Required | Description |
|---|---|---|---|
| `customerId` | int | Yes | Customer ID |

**Returns:** [`CustomerResponse`](#customerresponse)

---

#### `getCustomerByPersonalIdentityNumber`

Retrieves a customer by social security number.

| Parameter | Type | Required | Description |
|---|---|---|---|
| `personalIdentityNumber` | string | Yes | Social security number / org number |

**Returns:** [`CustomerResponse`](#customerresponse)

---

#### `getCustomerBySiteId`

Retrieves the customer associated with a site.

| Parameter | Type | Required | Description |
|---|---|---|---|
| `siteId` | int | Yes | Site ID |

**Returns:** [`CustomerResponse`](#customerresponse)

---

#### `getCustomersBySiteIdList`

Retrieves customers for multiple sites.

| Parameter | Type | Required | Description |
|---|---|---|---|
| `siteIdList` | array | Yes | Array of site IDs |

**Returns:** `CustomerResponse[]` — array of [CustomerResponse](#customerresponse)

---

#### `updateCustomerInformation`

Updates customer contact information.

| Parameter | Type | Required | Description |
|---|---|---|---|
| `customerId` | int | Yes | Customer ID |
| `customerAddress` | string | Yes | Street address |
| `customerZipCode` | string | Yes | Postal code |
| `customerCity` | string | Yes | City |
| `email` | string | No | Email address |
| `phoneNumberDay` | string | No | Daytime phone |
| `phoneNumberNight` | string | No | Evening phone |
| `phoneNumberCellPhone` | string | No | Mobile phone |
| `customerCareOfAddress` | string | No | Care-of address |

**Returns:** `int` — the customer ID

---

#### `getCustomerAdditionalInfoByCustomerId`

Retrieves additional info fields for a customer.

| Parameter | Type | Required | Description |
|---|---|---|---|
| `customerId` | int | Yes | Customer ID |

**Returns:** `array` — key-value pairs of additional info

---

#### `getOrganizationId`

Returns the organization ID for a customer.

| Parameter | Type | Required | Description |
|---|---|---|---|
| `customerId` | int | No | Customer ID (optional) |

**Returns:** `int` — organization ID

---

### Site Methods

#### `addNewSite`

Creates a new site with a contract.

| Parameter | Type | Required | Description |
|---|---|---|---|
| `customerId` | int | Yes | Customer ID to associate with |
| `siteAddress` | string | Yes | Street address |
| `siteZipCode` | string | Yes | Postal code |
| `siteCity` | string | Yes | City |
| `contractCancellationDate` | string | No | Cancellation/regret date (YYYY-MM-DD). Auto-generated if not provided. |
| `netArea` | string | No | Net area code. Auto-discovered from zip code if not provided. |
| `transactionType` | string | No | `"L"` = Change of supplier (default), `"LK"` = Move in |
| `contractSourceId` | string | No | Contract source ID (default: 1) |
| `organizationId` | int | No | Organization ID |
| `startDate` | string | No | Contract start date (YYYY-MM-DD) |
| `moveOutDate` | string | No | Move-out date (YYYY-MM-DD) |
| `siteElectricityTypeId` | string | No | Electricity type ID |

**Returns:** `int` — the new site ID

**Errors:**
- `SOAP_REQUIRED_SITE_PARAMETERS_MISSING` — required fields missing or invalid customer
- `SOAP_REQUIRED_CUSTOMER_PARAMETERS_MISSING` — customer not found or is deidentified
- `SOAP_FAILED_SAVING_SITE` — save failed

---

#### `getSiteById`

Retrieves full site information.

| Parameter | Type | Required | Description |
|---|---|---|---|
| `siteId` | int | Yes | Site ID |

**Returns:** [`SiteResponse`](#siteresponse)

---

#### `getSitesBySiteIdList`

Retrieves multiple sites at once.

| Parameter | Type | Required | Description |
|---|---|---|---|
| `siteIdList` | array | Yes | Array of site IDs |

**Returns:** `SiteResponse[]` — array of [SiteResponse](#siteresponse)

---

#### `getSitesByCustomerId`

Retrieves all sites for a customer.

| Parameter | Type | Required | Description |
|---|---|---|---|
| `customerId` | int | Yes | Customer ID |

**Returns:** `SiteResponse[]` — array of [SiteResponse](#siteresponse)

---

#### `getSiteIdList`

Retrieves site IDs filtered by creation date and state.

| Parameter | Type | Required | Description |
|---|---|---|---|
| `validFromDate` | string | No | Start date filter (YYYY-MM-DD) |
| `validToDate` | string | No | End date filter (YYYY-MM-DD) |
| `completedSitesOnly` | bool | No | Only completed sites (default: true) |
| `sitesWithError` | bool | No | Include sites with errors (default: false) |
| `importSource` | int | No | Filter by import source (default: 0) |

**Returns:** `int[]` — array of site IDs

---

#### `getSitesByStateId`

Retrieves all site IDs currently in a specific state.

| Parameter | Type | Required | Description |
|---|---|---|---|
| `stateId` | int | Yes | State ID (see [State IDs](#state-ids)) |

**Returns:** `int[]` — array of site IDs

---

#### `updateSiteInformation`

Updates site address information.

| Parameter | Type | Required | Description |
|---|---|---|---|
| `siteId` | int | Yes | Site ID |
| `siteAddress` | string | Yes | Street address |
| `siteZipCode` | string | Yes | Postal code |
| `siteCity` | string | Yes | City |

**Returns:** `bool`

---

#### `addSiteInfo`

Adds supplementary information to a site (object ID, consumption, net area, start date, transaction type).

| Parameter | Type | Required | Description |
|---|---|---|---|
| `siteId` | int | Yes | Site ID |
| `startDate` | string | No | Contract start date (YYYY-MM-DD) |
| `objectId` | string | No | Metering point ID |
| `netArea` | string | No | Net area code |
| `consumption` | string | No | Yearly consumption (kWh) |
| `transactionType` | string | No | `"L"` = Change of supplier, `"LK"` = Move in |

**Returns:** `bool`

---

#### `setSiteAdditionalInfo`

Sets an additional info value on a site.

| Parameter | Type | Required | Description |
|---|---|---|---|
| `siteId` | int | Yes | Site ID |
| `additionalInfoCategoryId` | int | Yes | Category ID |
| `value` | string | Yes | Value to set |

**Returns:** `bool`

---

#### `getSiteAdditionalInfoBySiteId`

Retrieves all additional info for a site.

| Parameter | Type | Required | Description |
|---|---|---|---|
| `siteId` | int | Yes | Site ID |

**Returns:** `array` — key-value pairs (category name → value)

---

#### `setCustomerAdditionalInfo`

Sets an additional info value on a customer.

| Parameter | Type | Required | Description |
|---|---|---|---|
| `customerId` | int | Yes | Customer ID |
| `additionalInfoCategoryId` | int | Yes | Category ID |
| `value` | string | Yes | Value to set |

**Returns:** `bool`

---

### Site State Methods

#### `setSiteStatusToReadyForExport`

Transitions a site to the "Ready for Export" state.

| Parameter | Type | Required | Description |
|---|---|---|---|
| `siteId` | int | Yes | Site ID |
| `stateReasonId` | int | Yes | State reason (see [State Reason IDs](#state-reason-ids)) |

**Returns:** `bool`

---

#### `setSiteStatusToExported`

Transitions a site to the "Exported" state.

| Parameter | Type | Required | Description |
|---|---|---|---|
| `siteIdToExport` | int | Yes | Site ID |

**Returns:** `bool`

**Errors:**
- `SOAP_INVALID_TRANSITION_TO_STATE_EXPORTED` — transition not allowed from current state

---

#### `setSiteToCancelled`

Cancels a site (within the regret period).

| Parameter | Type | Required | Description |
|---|---|---|---|
| `siteId` | int | Yes | Site ID |

**Returns:** `bool`

**Errors:**
- `SOAP_REGRET_PERIOD_EXPIRED` — cancellation date has passed
- `SOAP_SITE_STATE_ALREADY_READY_FOR_EXPORT` — already in Ready for Export state

---

#### `isSiteCancelled`

Checks if a site has been cancelled (state reason = 58 / SITE_CANCELLED).

| Parameter | Type | Required | Description |
|---|---|---|---|
| `siteId` | int | Yes | Site ID |

**Returns:** `bool`

---

#### `isSiteExported`

Checks if a site is in the Exported state (state ID = 23).

| Parameter | Type | Required | Description |
|---|---|---|---|
| `siteId` | int | Yes | Site ID |

**Returns:** `bool`

---

#### `getSiteCancellationDate`

Returns the contract cancellation/regret date for a site.

| Parameter | Type | Required | Description |
|---|---|---|---|
| `siteId` | int | Yes | Site ID |

**Returns:** `string` — date (YYYY-MM-DD)

---

#### `setCustomerConfirmation`

Initiates the state process after customer confirmation (triggers POA/net owner flow).

| Parameter | Type | Required | Description |
|---|---|---|---|
| `siteId` | int | Yes | Site ID |

**Returns:** `bool`

---

#### `initiateStateProcess`

Manually triggers the state machine process for a site.

| Parameter | Type | Required | Description |
|---|---|---|---|
| `siteId` | int | Yes | Site ID |

**Returns:** `bool`

---

#### `initiateMoveInProcess`

Initiates the move-in workflow for a site.

| Parameter | Type | Required | Description |
|---|---|---|---|
| `siteId` | int | Yes | Site ID |

**Returns:** `bool`

---

### Power of Attorney Methods

#### `uploadPowerOfAttorney`

Uploads a power of attorney document for a site.

| Parameter | Type | Required | Description |
|---|---|---|---|
| `siteId` | int | Yes | Site ID |
| `format` | string | Yes | File format: `"html"`, `"pdf"`, or `"url"` |
| `data` | string | Yes | Base64-encoded file content (or URL if format = "url") |
| `poaTypeId` | int | No | POA type ID (default: 4) |

**Returns:** `bool`

**Errors:**
- `SOAP_POA_EXISTS_ON_SITE` — POA already exists and state is not Registered/Manual
- `SOAP_POA_FILE_TO_BIG` — file exceeds size limit
- `SOAP_POA_FORMAT_DONT_CORRESPOND_TO_TYPE` — format mismatch for POA type

---

#### `hasSitePowerOfAttorney`

Checks if a site has an active power of attorney.

| Parameter | Type | Required | Description |
|---|---|---|---|
| `siteId` | int | Yes | Site ID |

**Returns:** `bool`

---

### Contract & Pricing Methods

#### `addNewContractElectricPriceGroupPeriod`

Assigns a price group to a site's contract.

| Parameter | Type | Required | Description |
|---|---|---|---|
| `priceGroupId` | int | Yes | Price group ID |
| `siteId` | int | Yes | Site ID |
| `validFrom` | string | Yes | Start date (YYYY-MM-DD) |

**Returns:** `bool`

---

#### `setContractAccessories`

Sets contract accessories for a site.

| Parameter | Type | Required | Description |
|---|---|---|---|
| `siteId` | int | Yes | Site ID |
| `accessoriesId` | int | Yes | Accessories ID |

**Returns:** `bool`

---

#### `setPreferredPaymentTypeId`

Sets the preferred payment method for a site.

| Parameter | Type | Required | Description |
|---|---|---|---|
| `siteId` | int | Yes | Site ID |
| `paymentTypeId` | int | Yes | Payment type ID |

**Returns:** `bool`

---

#### `getActivePriceGroupList`

Returns all active electricity price groups.

**Returns:** [`ElectricPriceGroupResponse[]`](#electricpricegroupresponse) — array of price groups

---

#### `getAccessoriesList`

Returns all available contract accessories.

**Returns:** [`AccessoriesApiResponse[]`](#accessoriesapiresponse) — array of accessories

---

### Document Methods

#### `uploadDocumentToCustomer`

Uploads a document attached to a customer.

| Parameter | Type | Required | Description |
|---|---|---|---|
| `customerId` | int | Yes | Customer ID |
| `filename` | string | Yes | File name with extension |
| `base64EncodedFile` | string | Yes | Base64-encoded file content |
| `comment` | string | Yes | Description/comment |

**Returns:** `bool`

---

#### `uploadDocumentToSite`

Uploads a document attached to a site.

| Parameter | Type | Required | Description |
|---|---|---|---|
| `siteId` | int | Yes | Site ID |
| `filename` | string | Yes | File name with extension |
| `base64EncodedFile` | string | Yes | Base64-encoded file content |
| `comment` | string | Yes | Description/comment |

**Returns:** `bool`

---

### Lookup Methods

#### `getAllStates`

Returns all site state names available via the API.

**Returns:** `string[]` — array of state names

The returned subset includes: Registered, Sent to Netowner, Sent to Supplier, Wait Cancellation, Wait Customer, Manual, Send Netowner, Send Supplier, Ready for Export, Exported.

See [State IDs](#state-ids) for the complete list.

---

#### `getAllStateReasons`

Returns all active state reason names.

**Returns:** `string[]` — array of state reason names

See [State Reason IDs](#state-reason-ids) for the complete list.

---

#### `getAllStartDates`

Returns all distinct contract start dates for the authenticated user's organizations.

**Returns:** `string[]` — array of dates (YYYY-MM-DD)

---

#### `getAllExportDates`

Returns all distinct months when sites were exported.

**Returns:** `string[]` — array of months (YYYY-MM)

---

#### `authenticateWebserviceUser`

Tests if credentials are valid.

**Returns:** `bool`

---

## Endpoint 2: Website API (`api_web.php`)

The Website API includes all methods from the Base API (getCustomerById, getCustomerByPersonalIdentityNumber, etc.) plus the following additional methods.

### Site Methods

#### `getSiteById`

Same as Public API but returns more fields unconditionally (no organization setting checks).

**Returns:** [`SiteResponse`](#siteresponse)

---

#### `getSiteIdListByCustomerId`

Returns site IDs for a customer.

| Parameter | Type | Required | Description |
|---|---|---|---|
| `customerId` | int | Yes | Customer ID |

**Returns:** `int[]` — array of site IDs

---

#### `addNewSite`

Creates a new site (extended version with objectId, consumption, sitePartnerId).

| Parameter | Type | Required | Description |
|---|---|---|---|
| `customerId` | int | Yes | Customer ID |
| `siteAddress` | string | Yes | Street address |
| `siteZipCode` | string | Yes | Postal code |
| `siteCity` | string | Yes | City |
| `contractCancellationDate` | string | No | Cancellation date (YYYY-MM-DD) |
| `netArea` | string | No | Net area code |
| `objectId` | string | No | Metering point ID |
| `consumption` | float | No | Yearly consumption (kWh) |
| `startDate` | string | No | Contract start date (YYYY-MM-DD) |
| `transactionType` | string | No | `"L"` = Change of supplier, `"LK"` = Move in |
| `contractSourceId` | string | No | Contract source ID |
| `sitePartnerId` | int | No | Partner ID |
| `organizationId` | int | No | Organization ID |
| `siteElectricityTypeId` | string | No | Electricity type ID |

**Returns:** `int` — new site ID

---

#### `addNewCustomer`

Creates a new customer (extended with `customerPartnerId`).

Same parameters as Public API `addNewCustomer` plus:

| Parameter | Type | Required | Description |
|---|---|---|---|
| `customerPartnerId` | int | No | Partner ID (default: 0) |

**Returns:** `int` — new customer ID

---

#### `setSitePartner`

Associates a partner with a site.

| Parameter | Type | Required | Description |
|---|---|---|---|
| `siteId` | int | Yes | Site ID |
| `sitePartnerId` | int | Yes | Partner ID |

**Returns:** `bool`

---

#### `setSiteStatusToComplete`

Triggers state process to advance site towards completion.

| Parameter | Type | Required | Description |
|---|---|---|---|
| `siteId` | int | Yes | Site ID |

**Returns:** `bool`

---

#### `setSiteStatusToUncomplete`

Reverts a site state back to Registered.

| Parameter | Type | Required | Description |
|---|---|---|---|
| `siteId` | int | Yes | Site ID |

**Returns:** `bool`

---

### Contract Methods

#### `getContractById`

Retrieves contract details.

| Parameter | Type | Required | Description |
|---|---|---|---|
| `contractId` | int | Yes | Contract ID |

**Returns:** [`ContractResponse`](#contractresponse)

---

#### `getContractIdListBySiteId`

Returns contract IDs for a site.

| Parameter | Type | Required | Description |
|---|---|---|---|
| `siteId` | int | Yes | Site ID |

**Returns:** `int[]` — array of contract IDs

---

#### `getNewestContractIdBySiteId`

Returns the most recent contract ID for a site.

| Parameter | Type | Required | Description |
|---|---|---|---|
| `siteId` | int | Yes | Site ID |

**Returns:** `int` — contract ID

---

#### `setContractCancellation`

Sets the termination date on a contract.

| Parameter | Type | Required | Description |
|---|---|---|---|
| `contractId` | int | Yes | Contract ID |
| `validTo` | string | Yes | Termination date (YYYY-MM-DD) |

**Returns:** `bool`

---

#### `addNewContractElectricPriceGroupPeriod`

Assigns a price group to a contract.

| Parameter | Type | Required | Description |
|---|---|---|---|
| `priceGroupId` | int | Yes | Price group ID |
| `contractId` | int | Yes | Contract ID |
| `validFrom` | string | Yes | Start date (YYYY-MM-DD) |

**Returns:** `bool`

---

#### `getContractPriceGroupPeriodListByContractId`

Returns price group periods for a contract.

| Parameter | Type | Required | Description |
|---|---|---|---|
| `contractId` | int | Yes | Contract ID |

**Returns:** [`ContractElectricPriceGroupPeriodResponse[]`](#contractelectricpricegroupperiodresponse)

---

#### `getContractPriceGroupPeriodPriceListListByContractElectricPricePeriodId`

Returns price lists within a contract price group period.

| Parameter | Type | Required | Description |
|---|---|---|---|
| `contractElectricPriceGroupPeriodId` | int | Yes | Period ID |

**Returns:** [`ContractElectricPriceGroupPeriodPriceListResponse[]`](#contractelectricpricegroupperiodpricelistresponse)

---

### Invoice Methods

#### `getInvoiceIdListBySiteId`

Returns invoice IDs for a site.

| Parameter | Type | Required | Description |
|---|---|---|---|
| `siteId` | int | Yes | Site ID |

**Returns:** `int[]` — array of invoice IDs

---

#### `getInvoiceIdListByCustomerId`

Returns invoice IDs for a customer.

| Parameter | Type | Required | Description |
|---|---|---|---|
| `customerId` | int | Yes | Customer ID |

**Returns:** `int[]` — array of invoice IDs

---

#### `getInvoiceById`

Retrieves invoice details.

| Parameter | Type | Required | Description |
|---|---|---|---|
| `invoiceId` | int | Yes | Invoice ID |

**Returns:** [`InvoiceResponse`](#invoiceresponse)

---

#### `getInvoiceLinesByInvoiceId`

Returns line items for an invoice.

| Parameter | Type | Required | Description |
|---|---|---|---|
| `invoiceId` | int | Yes | Invoice ID |

**Returns:** [`InvoiceLineResponse[]`](#invoicelineresponse)

---

#### `getInvoiceSettlementByInvoiceId`

Returns settlement/breakdown data for an invoice.

| Parameter | Type | Required | Description |
|---|---|---|---|
| `invoiceId` | int | Yes | Invoice ID |

**Returns:** [`InvoiceSettlementResponse[]`](#invoicesettlementresponse)

---

#### `getHourlyVolumesByInvoiceId`

Returns hourly consumption volumes for an invoice.

| Parameter | Type | Required | Description |
|---|---|---|---|
| `invoiceId` | int | Yes | Invoice ID |

**Returns:** `array` — hourly volume data

---

#### `getHourlyPricesByInvoiceId`

Returns hourly prices for an invoice.

| Parameter | Type | Required | Description |
|---|---|---|---|
| `invoiceId` | int | Yes | Invoice ID |

**Returns:** `array` — hourly price data

---

### Meter & Reading Methods

#### `getMeterListBySiteId`

Returns meters for a site.

| Parameter | Type | Required | Description |
|---|---|---|---|
| `siteId` | int | Yes | Site ID |

**Returns:** [`MeterResponse[]`](#meterresponse)

---

#### `getRegisterIdListByMeterId`

Returns register IDs for a meter.

| Parameter | Type | Required | Description |
|---|---|---|---|
| `meterId` | int | Yes | Meter ID |

**Returns:** `int[]` — array of register IDs

---

#### `getReadingListByRegisterId`

Returns readings for a register.

| Parameter | Type | Required | Description |
|---|---|---|---|
| `registerId` | int | Yes | Register ID |
| `validFrom` | string | No | Start date filter (YYYY-MM-DD) |
| `validTo` | string | No | End date filter (YYYY-MM-DD) |

**Returns:** [`ReadingResponse[]`](#readingresponse)

---

### Net Owner Methods

#### `getNetOwnerBySiteId`

Returns the net owner (grid operator) for a site.

| Parameter | Type | Required | Description |
|---|---|---|---|
| `siteId` | int | Yes | Site ID |

**Returns:** [`NetOwnerResponse`](#netownerresponse)

---

### Pricing Methods

#### `getPriceGroupPrice`

Returns pricing information for a price group in a specific electricity area.

| Parameter | Type | Required | Description |
|---|---|---|---|
| `priceGroupId` | int | Yes | Price group ID |
| `electricityAreaId` | int | Yes | Electricity area ID |
| `consumption` | int | No | Yearly consumption for price calculation |
| `date` | string | No | Date for price lookup |

**Returns:** [`ElectricPriceGroupPriceResponse`](#electricpricegrouppriceresponse)

---

#### `getPriceGroupPriceListPrice`

Returns pricing from a specific price list.

| Parameter | Type | Required | Description |
|---|---|---|---|
| `priceGroupPriceListId` | int | Yes | Price list ID |
| `electricityAreaId` | int | Yes | Electricity area ID |
| `date` | string | No | Date for price lookup |

**Returns:** [`ElectricPriceGroupPriceListPriceResponse`](#electricpricegrouppricelistpriceresponse)

---

#### `getPriceGroupFee`

Returns fee information for a price group.

| Parameter | Type | Required | Description |
|---|---|---|---|
| `epGroupId` | int | Yes | Price group ID |

**Returns:** [`ElectricPricePeriodFeeResponse[]`](#electricpriceperfeeresponse)

---

#### `getAssumedElectricityAreaByZipCode`

Returns the electricity area for a zip code.

| Parameter | Type | Required | Description |
|---|---|---|---|
| `zipCode` | string | Yes | Postal code |

**Returns:** [`ElectricityAreaResponse`](#electricityarearesponse)

---

### Payment Methods

#### `getActivePaymentType`

Returns the active payment type for a site.

| Parameter | Type | Required | Description |
|---|---|---|---|
| `siteId` | int | Yes | Site ID |

**Returns:** `string` — payment type name

---

#### `getPreferredPaymentTypeBySiteId`

Returns the preferred payment type for a site.

| Parameter | Type | Required | Description |
|---|---|---|---|
| `siteId` | int | Yes | Site ID |

**Returns:** `array` — payment type information

---

#### `setDirectDebitConsent`

Registers direct debit consent for a customer.

| Parameter | Type | Required | Description |
|---|---|---|---|
| `customerId` | int | Yes | Customer ID |
| `personalIdentityNumber` | string | Yes | Social security number |
| `clearingNumber` | string | Yes | Bank clearing number |
| `bankAccount` | string | Yes | Bank account number |
| `siteId` | int | Yes | Site ID |

**Returns:** `bool`

---

#### `setElectronicInvoiceConsent`

Registers electronic invoice consent.

| Parameter | Type | Required | Description |
|---|---|---|---|
| `customerId` | int | Yes | Customer ID |
| `personalIdentityNumber` | string | Yes | Social security number |
| `bankId` | int | Yes | Bank ID |
| `siteId` | int | Yes | Site ID |

**Returns:** `bool`

---

#### `getDirectDebitConsentType`

Returns available direct debit consent types.

**Returns:** `array`

---

#### `getBanks`

Returns available banks.

**Returns:** `array`

---

### Communication Methods

#### `getInfoMailListBySiteId`

Returns sent info mails for a site.

| Parameter | Type | Required | Description |
|---|---|---|---|
| `siteId` | int | Yes | Site ID |

**Returns:** [`InfoMailResponse[]`](#infomailresponse)

---

### Other Methods

#### `updateCustomerInformation`

Extended version with `customerPartnerId` parameter.

Same as Public API version plus:

| Parameter | Type | Required | Description |
|---|---|---|---|
| `customerPartnerId` | int | No | Partner ID (default: 0) |

**Returns:** `bool`

---

## Endpoint 3: Private API (`api_private.php`)

#### `getAssumedNetAreaIdByZipCode`

Returns the most probable net area ID for a zip code.

| Parameter | Type | Required | Description |
|---|---|---|---|
| `zipCode` | string | Yes | Postal code |
| `probabilityOrderPosition` | int | No | Position in probability list (default: 0 = most probable) |

**Returns:** `int` — net area ID (0 if not found)

---

#### `getAssumedElectricityAreaIdByZipCode`

Returns the electricity area ID for a zip code.

| Parameter | Type | Required | Description |
|---|---|---|---|
| `zipCode` | string | Yes | Postal code |

**Returns:** `int` — electricity area ID (0 if not found)

---

---

## Response Types

### CustomerResponse

| Field | Type | Description |
|---|---|---|
| `customerId` | int | Customer identifier |
| `firstName` | string | First name |
| `lastName` | string | Last name |
| `companyName` | string | Company name |
| `customerAddress` | string | Street address |
| `customerZipCode` | string | Postal code |
| `customerCity` | string | City |
| `customerPersonalIdentityNumber` | string | Social security / org number |
| `email` | string | Email address |
| `phoneNumberDay` | string | Daytime phone |
| `phoneNumberNight` | string | Evening phone |
| `phoneNumberCellPhone` | string | Mobile phone |
| `customerCareOfAddress` | string | Care-of address |

---

### SiteResponse

| Field | Type | Description |
|---|---|---|
| `siteId` | int | Site identifier |
| `customerId` | int | Associated customer ID |
| `siteAddress` | string | Street address |
| `siteZipCode` | string | Postal code |
| `siteCity` | string | City |
| `organization` | string | Organization name |
| `stateId` | int | Current state ID (see [State IDs](#state-ids)) |
| `stateName` | string | Current state name |
| `stateReasonId` | int | Current state reason ID (see [State Reason IDs](#state-reason-ids)) |
| `stateReason` | string | Current state reason name |
| `previousStateReasonId` | int | Last "Ready for Export" state reason ID |
| `previousStateReason` | string | Last "Ready for Export" state reason name |
| `createDate` | string | Site creation date |
| `exportDate` | string | Export date (YYYY-MM), only set when state = Exported |
| `objectId` | string | Metering point ID |
| `netAreaCode` | string | Net area code |
| `startDate` | string | Contract start date |
| `netOwnerId` | int | Grid owner ID |
| `netOwnerName` | string | Grid owner company name |
| `supplierId` | int | Electricity supplier ID |
| `supplierName` | string | Supplier company name |
| `contractStartTypeId` | int | Transaction type (see [Transaction Types](#transaction-types)) |
| `consumption` | string | Yearly consumption (kWh) |
| `moveOutDate` | string | Move-out date (YYYY-MM-DD) |
| `agreementBrokerName` | string | POA broker name |
| `product` | string | Price group product name |
| `price` | string | Current electricity price |
| `fee` | float | Periodic fee amount |
| `duration` | string | Binding period (months or end date) |
| `periodOfNotice` | string | Notice period name |
| `cancellationRangeName` | string | Supplier cancellation notice period |
| `lastNoticeDate` | string | Last notice date for cancellation |
| `siteError` | string | Concatenated error messages |
| `memberId` | string | Member ID (additional info) |
| `delegate` | string | Delegate name (additional info) |
| `campaign` | string | Campaign name (additional info) |
| `accessories` | array | List of accessory names |

**Note:** Some fields (objectId, netAreaCode, startDate, netOwnerId, netOwnerName, supplierId, supplierName, siteError, pricing fields) are only populated when the site has passed through the "Ready for Export - OK" state or when the `exportAlwaysAllowed` setting is active. Otherwise these fields return empty strings.

---

### ContractResponse

| Field | Type | Description |
|---|---|---|
| `contractId` | int | Contract identifier |
| `siteId` | int | Associated site ID |
| `customerId` | int | Associated customer ID |
| `startDate` | string | Contract start date (YYYY-MM-DD) |
| `terminationDate` | string | Termination date |
| `createDate` | string | Contract creation date |
| `contractSourceId` | int | Source of contract |
| `contractSourceName` | string | Source name |
| `invoicingPeriodicityId` | int | Invoicing frequency ID |
| `invoicingPeriodicityName` | string | Invoicing frequency name |
| `contractCancellationDate` | string | Cancellation/regret date |
| `transactionTypeId` | int | Transaction type (see [Transaction Types](#transaction-types)) |
| `transactionType` | string | Transaction type name |
| `campaignId` | int | Campaign ID |
| `campaignName` | string | Campaign name |
| `contractStatusName` | string | Contract status name |
| `contractStatusCategoryId` | int | Status category (see [Contract Status Categories](#contract-status-categories)) |
| `contractStatusCategoryName` | string | Status category name |
| `accessories` | array | Contract accessories |
| `duration` | string | Binding period |
| `price` | string | Current price |
| `product` | string | Product name |
| `fee` | float | Periodic fee |

---

### InvoiceResponse

| Field | Type | Description |
|---|---|---|
| `invoiceId` | int | Invoice identifier |
| `contractId` | int | Associated contract ID |
| `invoiceNumber` | int | Invoice number |
| `dueDate` | string | Payment due date |
| `createDate` | string | Invoice creation date |
| `totalAmount` | int | Total amount (in minor units) |
| `ocr` | string | OCR reference number |
| `urlToInvoicePdf` | string | URL to invoice PDF |
| `invoiceStatusId` | int | Invoice status ID |
| `invoiceStatusName` | string | Invoice status name |

---

### InvoiceLineResponse

| Field | Type | Description |
|---|---|---|
| `itemId` | int | Line item identifier |
| `itemName` | string | Item name |
| `itemDescription` | string | Detailed description |
| `volume` | float | Quantity/volume |
| `price` | float | Unit price |
| `amount` | float | Total amount (volume x price) |
| `unit` | string | Unit of measurement (e.g. kWh) |

---

### InvoiceSettlementResponse

| Field | Type | Description |
|---|---|---|
| `totalSum` | float | Total settlement sum |
| `invoicedMonth` | InvoiceSettlementMonthApi[] | Monthly breakdown |

**InvoiceSettlementMonthApi:**

| Field | Type | Description |
|---|---|---|
| `invoicedMonth` | string | Month identifier |
| `item` | ItemApi[] | Line items for the month |

---

### ElectricPriceGroupResponse

| Field | Type | Description |
|---|---|---|
| `priceGroupId` | int | Price group identifier |
| `description` | string | Price group description |
| `productId` | int | Product ID |
| `product` | string | Product name |
| `productLength` | string | Binding period in months |
| `selectableFrom` | string | Available from date |
| `selectableTo` | string | Available to date |
| `feeTypeId` | int | Fee type ID |
| `feeType` | string | Fee type name |
| `availableElectricityAreas` | ElectricityAreaApi[] | Available electricity areas |
| `periodOfNotice` | string | Notice period name |

---

### ElectricPriceGroupPriceResponse

| Field | Type | Description |
|---|---|---|
| `priceGroupId` | int | Price group ID |
| `productId` | int | Product ID |
| `product` | string | Product name |
| `productInformation` | string | Product description |
| `fixedElectricPrice` | float | Fixed electricity price |
| `supplementPrice` | float | Supplement/markup price |
| `certificatePrice` | float | Certificate price |
| `selectableFrom` | string | Available from date |
| `selectableTo` | string | Available to date |
| `totalPriceWithNormalTax` | float | Total price including normal tax |
| `totalPriceWithLowTax` | float | Total price including low tax |
| `spotPrice` | float | Spot market price |
| `feeTypeId` | int | Fee type ID |
| `feeType` | string | Fee type name |
| `lowTax` | float | Low tax rate |
| `normalTax` | float | Normal tax rate |

---

### ElectricPriceGroupPriceListPriceResponse

| Field | Type | Description |
|---|---|---|
| `priceGroupId` | int | Price group ID |
| `productId` | int | Product ID |
| `product` | string | Product name |
| `productInformation` | string | Product description |
| `fixedElectricPrice` | float | Fixed electricity price |
| `supplementPrice` | float | Supplement/markup price |
| `certificatePrice` | float | Certificate price |
| `selectableFrom` | string | Available from date |
| `selectableTo` | string | Available to date |
| `totalPriceWithNormalTax` | float | Total price including normal tax |
| `totalPriceWithLowTax` | float | Total price including low tax |
| `spotPrice` | float | Spot market price |
| `lowTax` | float | Low tax rate |
| `normalTax` | float | Normal tax rate |

---

### ElectricPricePeriodFeeResponse

| Field | Type | Description |
|---|---|---|
| `electricPricePeriodFeeId` | int | Fee ID |
| `price` | int | Fee amount |
| `validFrom` | string | Valid from date |
| `validTo` | string | Valid to date |
| `minConsumption` | float | Minimum consumption threshold |
| `maxConsumption` | float | Maximum consumption threshold |
| `epGroupPeriodFeeTypeId` | int | Fee type ID |
| `epGroupPeriodFeeTypeName` | string | Fee type name |

---

### ContractElectricPriceGroupPeriodResponse

| Field | Type | Description |
|---|---|---|
| `contractElectricPriceGroupPeriodId` | int | Period ID |
| `electricpriceGroupId` | int | Price group ID |
| `validFrom` | string | Valid from date |
| `validTo` | string | Valid to date |

---

### ContractElectricPriceGroupPeriodPriceListResponse

| Field | Type | Description |
|---|---|---|
| `contractElectricPriceGroupPeriodId` | int | Period ID |
| `electricPriceGroupPriceListId` | int | Price list ID |
| `validFrom` | string | Valid from date |
| `validTo` | string | Valid to date |

---

### ElectricityAreaResponse

| Field | Type | Description |
|---|---|---|
| `electricityAreaId` | int | Electricity area identifier |
| `name` | string | Area name (e.g. SE1, SE2, SE3, SE4) |
| `description` | string | Area description |

---

### NetOwnerResponse

| Field | Type | Description |
|---|---|---|
| `netOwnerId` | int | Net owner/grid operator identifier |
| `netArea` | string | Net area code |
| `objectId` | string | Grid point identifier |
| `name` | string | Company name |
| `phone` | string | Contact phone |
| `email` | string | Contact email |
| `url` | string | Website URL |

---

### MeterResponse

| Field | Type | Description |
|---|---|---|
| `meterId` | int | Meter identifier |
| `siteId` | int | Associated site ID |
| `meterNumber` | string | Meter serial number |
| `numberOfRegisters` | int | Number of measurement registers |
| `validFrom` | string | Meter validity start date |
| `validTo` | string | Meter validity end date |

---

### ReadingResponse

| Field | Type | Description |
|---|---|---|
| `readingId` | int | Reading identifier |
| `registerId` | int | Register ID |
| `readingDate` | string | Date of reading |
| `reading` | float | Reading value |
| `createDate` | string | Record creation date |
| `senderRegistrationDate` | string | Sender registration date |
| `readingTypeId` | int | Reading type ID |

---

### AccessoriesApiResponse

| Field | Type | Description |
|---|---|---|
| `accessoriesId` | int | Accessories identifier |
| `accessoriesName` | string | Accessories name |
| `price` | float | Price |
| `accessoriesCategoryId` | int | Category ID |
| `accessoriesCategoryName` | string | Category name |
| `validFrom` | string | Valid from date |
| `validTo` | string | Valid to date |

---

### InfoMailResponse

| Field | Type | Description |
|---|---|---|
| `infoMailId` | int | Info mail identifier |
| `sentDate` | string | Date sent |
| `typeId` | int | Mail type ID |
| `subject` | string | Email subject |
| `urlToInfoMail` | string | URL to view the mail |

---

---

## Enumeration Values

### State IDs

These are the possible values for `stateId` / `stateName` in the SiteResponse:

| ID | Constant | Description |
|---|---|---|
| 1 | REGISTERED | Site newly registered |
| 2 | FLYER_SENT | Flyer sent to customer |
| 3 | SENT_TO_NETOWNER | POA sent to grid owner |
| 4 | SENT_TO_SUPPLIER | POA sent to supplier |
| 5 | WAIT_CANCELLATION | Waiting for cancellation confirmation |
| 6 | WAIT_START | Waiting for contract start date |
| 7 | ACTIVE | Contract active, delivery ongoing |
| 8 | MOVED | Customer moved |
| 9 | MANUAL | Requires manual handling |
| 10 | WAIT_CUSTOMER | Waiting for customer action |
| 11 | NOT_CUSTOMER | No longer a customer |
| 12 | WAIT_Z04 | Waiting for Z04 EDIEL message |
| 13 | CHANGE_SUPPLIER | Supplier change in progress |
| 14 | CANCELLATION | Cancellation in progress |
| 15 | WAIT_Z03 | Waiting for Z03 EDIEL message |
| 16 | SEND_NETOWNER | Ready to send POA to grid owner |
| 17 | SEND_SUPPLIER | Ready to send POA to supplier |
| 18 | SEND_FLYER | Ready to send flyer |
| 19 | TERMINATED | Contract terminated |
| 20 | PROSPECT | Prospect (not yet customer) |
| 22 | READY_FOR_EXPORT | Ready for FTP/file export |
| 23 | EXPORTED | Site data exported |
| 24 | LOST | Customer lost |
| 25 | DECEASED | Customer deceased |
| 26 | SEND_CANCEL_CONTRACT | Ready to send contract cancellation |
| 27 | WAIT_CANCEL_CONTRACT | Waiting for cancellation confirmation |
| 28 | AWAIT_CUST_CONFIRM | Awaiting customer confirmation |
| 29 | WAIT_Z01 | Waiting for Z01 EDIEL message |
| 30 | WAIT_CANCELLATION_Z03C | Waiting for cancellation Z03C |
| 31 | WAIT_Z02 | Waiting for Z02 EDIEL message |
| 32 | ZAVANN_WATCHING | Under Zavann monitoring |
| 33 | REPLACED | Replaced by another site |
| 34 | MOVE_OUT_REQUEST | Move-out requested |
| 35 | WAIT_Z05 | Waiting for Z05 EDIEL message |
| 36 | ACQUIREMENT_IN_PROGRESS | Customer acquirement in progress |
| 37 | ACQUIREMENT_TERMINATED | Acquirement terminated |

---

### State Reason IDs

These are the possible values for `stateReasonId` / `stateReason` in the SiteResponse.

Only state reasons with active status are returned by `getAllStateReasons()`.

#### OK / Success Reasons

| ID | Constant | Description |
|---|---|---|
| 52 | OK_MOVING_IN | OK - moving in |
| 53 | OK_NOT_CONFIRMED | OK - not confirmed |
| 54 | OK_FUTURE_DELIVERY_START | OK - future delivery start |
| 55 | OK_ALREADY_CUSTOMER | OK - already customer |
| 56 | OK | OK |
| 211 | OK_LONG_START_DATE | OK - long start date |
| 225 | OK_MOVE_OUT | OK - move out |
| 226 | OK_MOVE_OUT_APPLIED | OK - move out applied |
| 272 | OK_PRICE_INFORMATION_POWER_OF_ATTORNEY | OK - price information POA |

#### Cancellation / Regret Reasons

| ID | Constant | Description |
|---|---|---|
| 58 | SITE_CANCELLED | Site cancelled |
| 151 | RIGHTS_OF_REGRET | Rights of regret exercised |
| 152 | RIGHTS_OF_REGRET_PRICE | Rights of regret (price) |

#### Error / Problem Reasons

| ID | Constant | Description |
|---|---|---|
| 15 | DUPLICATE | Duplicate registration |
| 23 | NOT_READY_FOR_POA_TO_NETOWNER | POA not ready for grid owner |
| 24 | POA_NOT_READY_SUPPLIER | POA not ready for supplier |
| 25 | ERROR_POA_TO_NETOWNER | Error sending POA to grid owner |
| 26 | ERROR_POA_TO_SUPPLIER | Error sending POA to supplier |
| 27 | Z04_RECEIVED | Z04 EDIEL message received |
| 29 | UNAPPROVED_CREDIT | Credit not approved |
| 35 | UNABLE_TO_REGISTER | Unable to register |
| 38 | ERROR_UPLOAD_POA | Error uploading POA |
| 46 | ID_NEGATIVE_APERAK | Negative APERAK received |
| 51 | REQUESTED_DISCONNECTION_DELIV_STARTED | Requested disconnection - delivery started |
| 59 | OTHER | Other reason |
| 60 | NO_NET_CONTRACT | No grid contract |
| 61 | GRID_CONTRACT_NO_ADDRESS | Grid contract - no address |
| 62 | CUSTOMER_LACKS_ELECTRICITY_CONTRACT | Customer lacks electricity contract |
| 63 | GRID_OWNER_ITK_ERROR | Grid owner ITK error |
| 64 | SUPPLIER_ITK_ERROR | Supplier ITK error |
| 65 | GRID_OWNER_OA_ERROR | Grid owner OA error |
| 66 | SUPPLIER_OA_ERROR | Supplier OA error |
| 67 | GRID_OWNER_NF_ERROR | Grid owner NF error |
| 68 | SUPPLIER_NF_ERROR | Supplier NF error |
| 69 | NO_RETURN_OF_POA_AFTER_GRID | No POA return from grid owner |
| 70 | NO_RETURN_OF_POA_AFTER_SUPPLIER | No POA return from supplier |
| 71 | INVALID_SOC_ID | Invalid social security number |
| 72 | HIDDEN_SOC_ID | Protected/hidden social security number |
| 73 | INVALID_POWER_OF_ATTORNEY | Invalid power of attorney |
| 75 | ERROR_REMOVED | Error removed |
| 76 | READY_FOR_EXPORT_DUPLICATE | Ready for export - duplicate |
| 77 | INVALID_ZIP_CODE | Invalid zip code |
| 78 | MISSING_CUSTOMER_CONFIRMATION | Missing customer confirmation |
| 80 | ERROR_ALREADY_CUSTOMER_READY_FOR_EXPO | Already customer - ready for export |
| 81 | NOT_VALID_CUST_DATA_READY_FOR_EXPORT | Invalid customer data - ready for export |
| 82 | ERROR_MANDATORY_SITE_DATA_MISSING | Mandatory site data missing |
| 84 | FORCED_EXPORT | Forced export |
| 85 | CONTACT_CUSTOMER | Contact customer required |
| 86 | ERROR_MAX_START_DATE | Start date exceeds maximum |
| 88 | ERROR_FUTURE_DELIVERY_START | Future delivery start error |
| 89 | PRICE_INFORMATION_POWER_OF_ATTORNEY | Price information on POA |
| 150 | CREDIT_NOT_APPROVED | Credit rating not approved |
| 188 | UNAPPROVED_CREDIT_RATING | Unapproved credit rating |
| 194 | INCORRECT_DATA_IMPORT | Incorrect data import |
| 195 | MISSING_CONTRACT_TYPE | Missing contract type |
| 196 | MOVE_IN_CUSTOMER | Move-in customer |
| 197 | NOT_COMPLETE_SITE_DATA | Incomplete site data |
| 199 | ERROR_FTP_EXPORT | FTP export error |
| 200 | COUNTER_POA_MANUAL | Counter POA (manual) |
| 201 | COUNTER_POA | Counter POA |
| 202 | MISSING_SITE_DATA | Missing site data |
| 203 | ELECTR_AREA_NOT_AVAIL_FOR_PRICE_GROUP | Electricity area not available for price group |
| 204 | NOT_VALID_START_DATE | Invalid start date |
| 205 | INCORRECT_START_DATE_EXPORT | Incorrect start date for export |
| 231 | MISSING_PRICE_GROUP | Missing price group |
| 232 | DISCONNECTED_BY_NET_WAIT_START | Disconnected by grid - waiting start |
| 233 | DISCONNECTED_BY_NET_DELIVERY_START | Disconnected by grid - delivery start |
| 234 | DISCONNECTED_BY_NET_TERMINATED | Disconnected by grid - terminated |
| 240 | WAIT_INTERNAL_CHANGE_OF_SUPPLIER | Waiting for internal supplier change |
| 241 | INCORRECT_ANSWER_POA_GRID_CONTRACT | Incorrect answer on POA grid contract |
| 261 | ERROR_ELECTRICITY_INCLUDED_IN_RENT | Electricity included in rent |
| 266 | MISSING_SITE_ADDRESS | Missing site address |
| 270 | ERROR_NOT_ELIGIBLE_FOR_CONTRACT | Not eligible for contract |
| 281 | ERROR_COULD_NOT_SEND_EDIEL | Could not send EDIEL message |
| 285 | CUSTOMER_BANNED | Customer banned |
| 287 | NO_NET_CONTRACT_COLLECTIVELY_MEASURED | No grid contract - collectively measured |
| 289 | NO_NET_CONTRACT_COLLECTIVELY_MEASURED_MOVE_IN | No grid contract - collectively measured, move in |
| 293 | DENIES_POWER_OF_ATTORNEY | Customer denies POA |
| 295 | CUSTOMER_APPROVAL_IS_MISSING | Customer approval is missing |

#### Manual Handling Reasons

These mirror the error reasons above but indicate that manual handling is required:

| ID | Constant | Description |
|---|---|---|
| 154 | MANUAL_STATE_ERROR_FUTURE_DELIVERY_START_DATE | Manual - future delivery start date |
| 159 | OTHER_MANUAL | Manual - other |
| 160 | NO_NET_CONTRACT_MANUAL | Manual - no grid contract |
| 161 | MISSING_SITE_ADDRESS_MANUAL | Manual - missing site address |
| 163 | GRID_OWNER_ITK_ERROR_MANUAL | Manual - grid owner ITK error |
| 164 | SUPPLIER_ITK_ERROR_MANUAL | Manual - supplier ITK error |
| 167 | GRID_OWNER_NF_ERROR_MANUAL | Manual - grid owner NF error |
| 168 | SUPPLIER_NF_ERROR_MANUAL | Manual - supplier NF error |
| 169 | NO_RETURN_OF_POA_AFTER_GRID_MANUAL | Manual - no POA return from grid |
| 170 | NO_RETURN_OF_POA_AFTER_SUPPLIER_MANUAL | Manual - no POA return from supplier |
| 171 | INVALID_SOC_ID_MANUAL | Manual - invalid social ID |
| 172 | HIDDEN_SOC_ID_MANUAL | Manual - hidden social ID |
| 173 | INVALID_POWER_OF_ATTORNEY_MANUAL | Manual - invalid POA |
| 176 | MS_DUPLICATE | Manual - duplicate |
| 177 | INVALID_ZIP_CODE_MANUAL | Manual - invalid zip code |
| 180 | ERROR_ALREADY_CUSTOMER_MANUAL | Manual - already customer |
| 181 | NOT_VALID_CUST_DATA | Manual - invalid customer data |
| 182 | NOT_VALID_SITE_DATA | Manual - invalid site data |
| 184 | ERROR_MAX_START_DATE_MANUAL | Manual - max start date exceeded |
| 189 | INCORRECT_CUSTOMER_INFORMATION | Manual - incorrect customer info |
| 206 | INCORRECT_START_DATE_MANUAL | Manual - incorrect start date |
| 250 | HIDDEN_SOC_ID_CUSTOMER_ID | Manual - hidden social ID on customer |
| 276 | INACCURATE_CS_CANNOT_REACH_CUSTOMER | Manual - cannot reach customer |
| 282 | INCORRECT_CONNECTED_CUSTOMER | Manual - incorrect connected customer |
| 283 | INCORRECT_PAPER_AGREEMENTS_DISPATCHED | Manual - incorrect paper agreements |
| 284 | INCORRECT_KSN_USED_RIGHTS_OF_REGRET | Manual - incorrect KSN, rights of regret |
| 286 | NO_NET_CONTRACT_COLLECTIVELY_MEASURED_MANUAL | Manual - no grid contract, collectively measured |
| 288 | NO_NET_CONTRACT_COLLECTIVELY_MEASURED_MOVE_IN_MANUAL | Manual - no grid contract, collectively measured, move in |
| 292 | INCORRECT_CLOSED_IN_ENORO | Manual - incorrect close in Enoro |
| 294 | DENIES_POWER_OF_ATTORNEY_MANUAL | Manual - denies POA |

#### Grid Contract Reasons

| ID | Constant | Description |
|---|---|---|
| 212 | GRID_CONTRACT_OTHER_USER | Grid contract registered to other user |
| 213 | GRID_CONTRACT_OTHER_DATE | Grid contract has different start date |
| 214 | GRID_CONTRACT_OTHER_USER_DATE | Grid contract: other user and date |
| 215 | GRID_CONTRACT_NO_START_DATE | Grid contract: no start date |
| 216 | GRID_CONTRACT_PASSED_START_DATE | Grid contract: start date has passed |
| 217 | GRID_CONTRACT_NO_RESPONSE | Grid contract: no response received |
| 218 | GRID_CONTRACT_OTHER_USER_MANUAL | Manual - grid contract other user |
| 219 | GRID_CONTRACT_OTHER_DATE_MANUAL | Manual - grid contract other date |
| 220 | GRID_CONTRACT_OTHER_USER_DATE_MANUAL | Manual - grid contract other user/date |
| 221 | GRID_CONTRACT_NO_ADDRESS_MANUAL | Manual - grid contract no address |
| 222 | GRID_CONTRACT_NO_START_DATE_MANUAL | Manual - grid contract no start date |
| 223 | GRID_CONTRACT_PREV_STARTDATE_MANUAL | Manual - grid contract previous start date |
| 224 | GRID_CONTRACT_NO_RESPONSE_MANUAL | Manual - grid contract no response |

#### Move-out Reasons

| ID | Constant | Description |
|---|---|---|
| 251 | CONFIRMATION_ON_NEW_MOVE_OUT_DATE | Confirmation on new move-out date |
| 252 | CONFIRMATION_ON_MOVE_OUT_DATE | Confirmation on move-out date |
| 253 | NO_MOVE_OUT_DATE | No move-out date |
| 254 | NO_MOVE_OUT_POA | No move-out POA |
| 255 | ERROR_MOVE_OUT_ALREADY_APPLIED | Move-out already applied |
| 256 | NO_MOVE_OUT_DATE_MANUAL | Manual - no move-out date |
| 257 | NO_MOVE_OUT_POA_MANUAL | Manual - no move-out POA |

---

### Transaction Types

Values for `contractStartTypeId` / `transactionTypeId`:

| ID | Name | Description |
|---|---|---|
| 1 | CHANGE_OF_SUPPLIER | Change of electricity supplier (Leverantörsbyte) |
| 2 | MOVE_IN | Customer moving in (Inflytt) |

---

### Contract Status Categories

Values for `contractStatusCategoryId`:

| ID | Name | Description |
|---|---|---|
| 1 | INACTIVE | Contract not yet active |
| 2 | ACTIVE | Contract currently active |
| 3 | CANCELLED | Contract cancelled |