Monta Partner API

https://docs.partner-api.monta.com
Admin
Monta Partner API enables developers to build custom use cases around Monta-managed charge points,...
Tokens:820,313
Snippets:1,922
Trust Score:10
Update:8 months ago
Show doc for...
Tokens:
Raw
### Get Webhook Configuration Response Example (JSON)

Source: https://docs.partner-api.monta.com/reference/webhooks

This is an example of a successful (200 OK) response when retrieving webhook configuration. It includes the webhook URL, secret, subscribed event types, and custom headers.

```json
{
  "webhookUrl": "https://partner1.com/webhooks/monta",
  "webhookSecret": "FEC64907-DE3A-4EEB-9DA8-843D45AFF00C",
  "eventTypes": [
    "charges",
    "team-members"
  ],
  "customHeaders": {
    "headers": {
      "x-plus": "123",
      "x-minus": "456"
    }
  }
}
```

--------------------------------

### Example Price Forecast JSON Output

Source: https://docs.partner-api.monta.com/docs/displaying-prices-on-your-pylon

Illustrates the structure of the JSON response from the `GET /prices/forecast` API endpoint, showing operator details, currency, and an array of hourly price forecasts.

```JSON
{
  "operator": {
    "id": 14,
    "name": "Monta",
    "identifier": "monta",
    "partnerId": 1,
    "vatNumber": "FOO-123-ABC"
  },
  "currency": {
    "identifier": "dkk",
    "name": "Danish krone",
    "decimals": 2
  },
  "priceGroup": {
    // ...
  },
  "forecasts": [
    {
      "time": "2025-10-22T13:00:00Z",
      "pricePerKwh": 5978,
      "name": "0.60 DKK/kWh"
    },
    {
      "time": "2025-10-22T14:00:00Z",
      "pricePerKwh": 3921,
      "name": "0.39 DKK/kWh"
    },
		// ...
    {
      "time": "2025-10-22T22:00:00Z",
      "pricePerKwh": 2100,
      "name": "0.21 DKK/kWh"
    },
    {
      "time": "2025-10-22T23:00:00Z",
      "pricePerKwh": 2040,
      "name": "0.20 DKK/kWh"
    }
  ]
}
```

--------------------------------

### GET /api/v1/installer-jobs/{installerJobId}

Source: https://docs.partner-api.monta.com/reference/get-installer-job

Retrieves the details of a specific installer job using its unique identifier. This endpoint requires read access to installer jobs.

```APIDOC
## GET /api/v1/installer-jobs/{installerJobId}

### Description
Retrieves a single installer job by its ID. This operation requires the `installer-jobs:read` scope.

### Method
GET

### Endpoint
/api/v1/installer-jobs/{installerJobId}

### Parameters
#### Path Parameters
- **installerJobId** (integer) - Required - The unique identifier of the installer job.

### Request Example
```json
{
  "example": "No request body for GET request"
}
```

### Response
#### Success Response (200)
- **id** (integer) - The unique identifier of the installer job.
- **siteId** (integer) - The ID of the site associated with the installer job.
- **operator** (object) - Information about the operator performing the installation.
  - **id** (integer) - The ID of the operator.
  - **name** (string) - The name of the operator.
  - **identifier** (string) - The identifier of the operator.
  - **partnerId** (integer, nullable) - The ID of the partner, if applicable.
  - **vatNumber** (string, nullable) - The VAT number of the operator.
- **teamId** (integer) - The ID of the team assigned to the installer job.
- **description** (string, nullable) - A description of the installer job, visible to the installer.
- **publicLink** (string) - A shareable public link for the installer job.
- **chargePointCount** (integer) - The number of charge points included in the installer job.
- **createdAt** (string) - The timestamp when the installer job was created.
- **tasks** (array) - A list of tasks associated with the installer job.

#### Response Example
```json
{
  "id": 42,
  "siteId": 22,
  "operator": {
    "id": 14,
    "name": "Monta",
    "identifier": "monta",
    "partnerId": 1,
    "vatNumber": "FOO-123-ABC"
  },
  "teamId": 4124,
  "description": "5",
  "publicLink": "https://app.monta.app/installer-page/149ffbb6-7b69-47a1-9698-90177c2027da",
  "chargePointCount": 1,
  "createdAt": "2023-01-01T10:00:00Z",
  "tasks": [
    {
      "id": 1,
      "description": "Install charge point",
      "completedAt": null
    }
  ]
}
```
```

--------------------------------

### Plan Service Configuration Example

Source: https://docs.partner-api.monta.com/reference/get-plan

Provides an example of the configuration for a plan service, including tax refund settings. This structure is used to define various aspects of a service plan.

```json
{
  "description": "Indicates whether the VAT is already included in the price",
  "example": true
}
```

--------------------------------

### Pricing and Fee Configurations

Source: https://docs.partner-api.monta.com/reference/getpricegroups

This section details the structure and parameters for configuring pricing and fees, including VAT, percentages, tariff IDs, and timestamps. It also covers the application of fees after a certain number of minutes.

```APIDOC
## Pricing and Fee Configurations

### Description
This section details the structure and parameters for configuring pricing and fees, including VAT, percentages, tariff IDs, and timestamps. It also covers the application of fees after a certain number of minutes.

### Parameters

#### Request Body Fields

- **vat** (boolean) - Optional - Used by Spot Price. True means it will add % of VAT on top the price calculations. Note: `vat` rates differ from country to country.
- **percentage** (number) - Optional - Used by Spot Price. It will multiply the fallback price by this percentage. Format: float.
- **tariffId** (integer) - Optional - The id of the selected Tariff. Format: int64.
- **updatedAt** (string) - Required - When the pricing was last updated. Format: date-time.
- **applyAfterMinutes** (integer) - Optional - Used by Charging, Minute and Idle Fees. After how many minutes the fee should start being applied. Format: int32.
- **price** (object) - Required - The price of this Fee or Master price.
  - **amount** (integer) - Required - The amount of money. Format: int64.
  - **currency** (object) - Required - Currency details.
    - **id** (integer) - Optional - id of the currency. Format: int64.
    - **master** (object) - Required - Master currency details.
```

--------------------------------

### GET /v1/installer-jobs/{id}

Source: https://docs.partner-api.monta.com/reference/get-installer-jobs

Retrieves a specific installer job by its ID.

```APIDOC
## GET /v1/installer-jobs/{id}

### Description
Retrieves a specific installer job by its ID.

### Method
GET

### Endpoint
/v1/installer-jobs/{id}

### Path Parameters
- **id** (integer) - Required - The unique identifier of the installer job.

### Response
#### Success Response (200)
- **id** (integer) - The unique identifier for the installer job.
- **completedAt** (string) - The date the installer job was completed (nullable).
- **createdAt** (string) - The date the installer job was created.
- **updatedAt** (string) - The date the installer job was last updated (nullable).
- **deletedAt** (string) - The date the installer job was deleted (nullable).

#### Response Example
```json
{
  "id": 1,
  "completedAt": null,
  "createdAt": "2022-05-12T15:56:45.99Z",
  "updatedAt": null,
  "deletedAt": null
}
```
```

--------------------------------

### Example Subscription Response JSON

Source: https://docs.partner-api.monta.com/reference/subscriptions

This is an example of a successful JSON response (HTTP 200 OK) when fetching subscriptions from the Monta Partner API. It details the structure of the 'data' array, with each object representing a subscription, and the 'meta' object providing pagination information.

```json
{
  "data": [
    {
      "id": 1,
      "state": "active",
      "nextPurchaseAt": "2023-05-12T15:56:45.99Z",
      "cancelledAt": "2023-05-12T15:56:45.99Z",
      "endAt": "2023-05-12T15:56:45.99Z",
      "discountPercentage": 7.5,
      "discountAbsolute": 7.5,
      "discountAmount": 7.5,
      "originalAmount": 7.5,
      "totalAmount": 7.5,
      "purchaseCount": 5,
      "chargePoints": 5,
      "customerId": 1,
      "customerType": "charge-point",
      "planId": 42,
      "serviceConfig": {
        "serviceType": "tax-refund",
        "payoutPerKwh": 1.29,
        "priceIncludesVat": true,
        "additionalFeeAbsolute": 0.5,
        "roamingAdditionalFeeAbsolute": 0.5
      },
      "createdAt": "2023-05-12T15:56:45.99Z",
      "updatedAt": "2023-05-12T15:56:45.99Z",
      "canCancel": true,
      "deletedAt": "2023-05-12T15:56:45.99Z"
    }
  ],
  "meta": {
    "itemCount": 0,
    "currentPage": 0,
    "perPage": 0,
    "totalPageCount": 0,
    "totalItemCount": 0
  }
}
```

--------------------------------

### GET /v1/installer-jobs

Source: https://docs.partner-api.monta.com/reference/get-installer-jobs

Retrieves a list of installer jobs. Supports filtering and pagination.

```APIDOC
## GET /v1/installer-jobs

### Description
Retrieves a list of installer jobs. Supports filtering and pagination.

### Method
GET

### Endpoint
/v1/installer-jobs

### Query Parameters
- **page** (integer) - Optional - The page number for pagination.
- **limit** (integer) - Optional - The number of items to return per page.
- **sort** (string) - Optional - The field to sort the results by.
- **filter** (string) - Optional - Filter criteria for the jobs.

### Response
#### Success Response (200)
- **data** (array) - An array of installer job objects.
  - **id** (integer) - The unique identifier for the installer job.
  - **completedAt** (string) - The date the installer job was completed (nullable).
  - **createdAt** (string) - The date the installer job was created.
  - **updatedAt** (string) - The date the installer job was last updated (nullable).
  - **deletedAt** (string) - The date the installer job was deleted (nullable).
- **meta** (object) - Metadata for the pagination.
  - **itemCount** (integer) - The total number of items returned in the current response.
  - **currentPage** (integer) - The current page number.
  - **perPage** (integer) - The number of items per page.
  - **totalItemCount** (integer) - The total number of items available.
  - **totalPageCount** (integer) - The total number of pages available.

#### Response Example
```json
{
  "data": [
    {
      "id": 1,
      "completedAt": null,
      "createdAt": "2022-05-12T15:56:45.99Z",
      "updatedAt": null,
      "deletedAt": null
    }
  ],
  "meta": {
    "itemCount": 1,
    "currentPage": 1,
    "perPage": 10,
    "totalItemCount": 1,
    "totalPageCount": 1
  }
}
```
```

--------------------------------

### Pricing and Fee Configuration

Source: https://docs.partner-api.monta.com/reference/patch-sponsored-charge-point

This section details the structure and parameters for configuring pricing and fees, including VAT, percentages, tariff IDs, and timestamps.

```APIDOC
## Pricing and Fee Configuration Details

### Description
This documentation outlines the parameters used for configuring pricing and fees within the system. It covers fields related to VAT application, percentage multipliers, tariff identification, and update timestamps, as well as specific details for charging, minute, and idle fees.

### Method
N/A (This describes data structures, not a specific endpoint)

### Endpoint
N/A

### Parameters
#### Request Body Fields (Examples)
- **vat** (boolean) - Optional - Used by Spot Price. True means it will add % of VAT on top the price calculations. Note: `vat` rates differ from country to country.
- **percentage** (number) - Optional - Used by Spot Price. It will multiply the fallback price by this percentage. Format: float.
- **tariffId** (integer) - Optional - The id of the selected Tariff. Format: int64.
- **updatedAt** (string) - Required - When the pricing was last updated. Format: date-time.
- **applyAfterMinutes** (integer) - Optional - Used by Charging, Minute and Idle Fees. After how many minutes the fee should start being applied. Format: int32.
- **price** (object) - The price of this Fee or Master price.
  - **amount** (integer) - Required - The amount of money. Format: int64.
  - **currency** (object) - Currency details.
    - **decimals** (integer) - Required - The number of decimal places for the currency.
    - **identifier** (string) - Required - The currency identifier (e.g., 'EUR').

### Request Example
```json
{
  "vat": false,
  "percentage": 10.2,
  "tariffId": 5,
  "updatedAt": "2023-03-16T15:37:23Z",
  "applyAfterMinutes": 30,
  "price": {
    "amount": 12312,
    "currency": {
      "decimals": 2,
      "identifier": "EUR"
    }
  }
}
```

### Response
#### Success Response (200)
- **vat** (boolean) - Indicates if VAT is applied.
- **percentage** (number) - The percentage multiplier for prices.
- **tariffId** (integer) - The ID of the associated tariff.
- **updatedAt** (string) - Timestamp of the last update.
- **applyAfterMinutes** (integer) - Delay in minutes before applying fees.
- **price** (object) - Object containing price details.
  - **amount** (integer) - The price amount.
  - **currency** (object) - Object containing currency details.
    - **decimals** (integer) - Number of decimal places for the currency.
    - **identifier** (string) - Currency identifier.

#### Response Example
```json
{
  "vat": false,
  "percentage": 10.2,
  "tariffId": 5,
  "updatedAt": "2023-03-16T15:37:23Z",
  "applyAfterMinutes": 30,
  "price": {
    "amount": 12312,
    "currency": {
      "decimals": 2,
      "identifier": "EUR"
    }
  }
}
```
```

--------------------------------

### GET /v1/installer-jobs/{id}/tasks

Source: https://docs.partner-api.monta.com/reference/get-installer-jobs

Retrieves all tasks associated with a specific installer job.

```APIDOC
## GET /v1/installer-jobs/{id}/tasks

### Description
Retrieves all tasks associated with a specific installer job.

### Method
GET

### Endpoint
/v1/installer-jobs/{id}/tasks

### Path Parameters
- **id** (integer) - Required - The unique identifier of the installer job.

### Response
#### Success Response (200)
- **data** (array) - An array of installer job task objects.
  - **id** (integer) - The unique identifier for the installer job task.
  - **installerJobId** (integer) - The ID of the associated installer job.
  - **connectorId** (integer) - The connector ID of the charge point to install.
  - **note** (string) - A note for this installer job task, visible to the installer (nullable).
  - **installerNote** (string) - A note provided by the installer during this task (nullable).
  - **activeAt** (string) - The date this installer job task became active (nullable).
  - **createdAt** (string) - The creation date of this installer job task.
  - **updatedAt** (string) - The date this installer job task was last updated (nullable).
  - **deletedAt** (string) - The date this installer job task was deleted (nullable).

#### Response Example
```json
{
  "data": [
    {
      "id": 1,
      "installerJobId": 1,
      "connectorId": 1,
      "note": "1",
      "installerNote": "1",
      "activeAt": "2022-05-12T15:56:45.99Z",
      "createdAt": "2022-05-12T15:56:45.99Z",
      "updatedAt": null,
      "deletedAt": null
    }
  ]
}
```
```

--------------------------------

### API Response Example (JSON)

Source: https://docs.partner-api.monta.com/reference/block-charge-auth-token

This snippet shows an example of a 'NOT_FOUND' response from the Partner API. It includes fields for status, message, a user-friendly message, an error code, and context.

```json
{
  "type": "object",
  "example": {
    "status": "NOT_FOUND",
    "message": "Requested entity/entity provided in body was not found",
    "readableMessage": "user friendly message",
    "errorCode": "RESOURCE_NOT_FOUND",
    "context": "context"
  }
}
```

--------------------------------

### GET /installer-jobs

Source: https://docs.partner-api.monta.com/reference/get-installer-jobs

Retrieves a list of installer jobs. This endpoint requires the 'installer-jobs:read' scope to be authorized.

```APIDOC
## GET /installer-jobs

### Description
Retrieves a list of installer jobs. This endpoint requires the 'installer-jobs:read' scope to be authorized.

### Method
GET

### Endpoint
/installer-jobs

### Parameters
#### Query Parameters
- **scope** (string) - Required - The required scope for accessing this endpoint is `installer-jobs:read`.

### Request Example
```
GET /installer-jobs?scope=installer-jobs:read
```

### Response
#### Success Response (200)
- **jobs** (array) - A list of installer job objects.
  - **job_id** (string) - The unique identifier for the job.
  - **status** (string) - The current status of the job (e.g., 'pending', 'in_progress', 'completed', 'failed').
  - **created_at** (string) - The timestamp when the job was created.
  - **updated_at** (string) - The timestamp when the job was last updated.

#### Response Example
```json
{
  "jobs": [
    {
      "job_id": "job_12345",
      "status": "completed",
      "created_at": "2023-10-27T10:00:00Z",
      "updated_at": "2023-10-27T10:30:00Z"
    },
    {
      "job_id": "job_67890",
      "status": "in_progress",
      "created_at": "2023-10-27T11:00:00Z",
      "updated_at": "2023-10-27T11:15:00Z"
    }
  ]
}
```
```

--------------------------------

### GET /websites/partner-api_monta/installer-jobs/{jobId}

Source: https://docs.partner-api.monta.com/reference/get-installer-job

Retrieves the details of a single installer job. Requires the `installer-jobs:read` scope.

```APIDOC
## GET /websites/partner-api_monta/installer-jobs/{jobId}

### Description
Retrieves the details of a single installer job using its unique identifier. This operation requires the caller to have the `installer-jobs:read` scope.

### Method
GET

### Endpoint
/websites/partner-api_monta/installer-jobs/{jobId}

### Parameters
#### Path Parameters
- **jobId** (string) - Required - The unique identifier of the installer job to retrieve.

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **jobId** (string) - The unique identifier of the installer job.
- **status** (string) - The current status of the job (e.g., 'pending', 'in_progress', 'completed', 'failed').
- **createdAt** (string) - The timestamp when the job was created.
- **updatedAt** (string) - The timestamp when the job was last updated.

#### Response Example
```json
{
  "jobId": "job_12345abc",
  "status": "completed",
  "createdAt": "2023-10-27T10:00:00Z",
  "updatedAt": "2023-10-27T10:30:00Z"
}
```
```

--------------------------------

### API Versioning

Source: https://docs.partner-api.monta.com/docs/api-versioning

This section explains how to specify the API version for your requests using the `Monta-Version` header. It also details the current beta version and the default version if none is specified.

```APIDOC
## API Versioning

### Description
This section explains how to specify the API version for your requests using the `Monta-Version` header. It also details the current beta version and the default version if none is specified.

### Method
All HTTP Methods (GET, POST, PUT, DELETE, etc.)

### Endpoint
All API Endpoints

### Headers
- **Monta-Version** (string) - Required - Specifies the API version to use. Example: `2024-07-01`

### Notes
- The version `2024-07-01` is currently in `beta` and may be subject to change.
- If the `Monta-Version` header is not specified, the API will default to version `2024-01-18`.
- Beta versions are not guaranteed to be backward compatible and may change without notice.
```

--------------------------------

### GET /api/v1/installer-jobs

Source: https://docs.partner-api.monta.com/reference/installer-jobs

Retrieves a list of installer jobs associated with the partner account. Requires the `installer-jobs:read` scope.

```APIDOC
## GET /api/v1/installer-jobs

### Description
Retrieves a list of installer jobs. This endpoint is useful for partners to manage and track installation tasks.

### Method
GET

### Endpoint
https://partner-api.monta.com/api/v1/installer-jobs

### Parameters
#### Query Parameters
(No query parameters are explicitly documented in the provided text, but common parameters like pagination or filtering might be available.)

#### Request Body
This endpoint does not typically require a request body for a GET request.

### Request Example
(No specific request example provided, but a basic GET request would look like this):
```bash
curl -X GET \
  https://partner-api.monta.com/api/v1/installer-jobs \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN'
```

### Response
#### Success Response (200)
- **jobs** (array) - A list of installer job objects.
  - **job_id** (string) - The unique identifier for the installer job.
  - **status** (string) - The current status of the job (e.g., 'pending', 'in_progress', 'completed').
  - **created_at** (string) - The timestamp when the job was created.
  - **updated_at** (string) - The timestamp when the job was last updated.
  - **customer_name** (string) - The name of the customer associated with the job.
  - **address** (string) - The installation address for the job.

#### Response Example
```json
{
  "jobs": [
    {
      "job_id": "job_12345",
      "status": "completed",
      "created_at": "2024-07-25T10:00:00Z",
      "updated_at": "2024-07-25T14:30:00Z",
      "customer_name": "John Doe",
      "address": "123 Main St, Anytown"
    },
    {
      "job_id": "job_67890",
      "status": "pending",
      "created_at": "2024-07-26T09:00:00Z",
      "updated_at": "2024-07-26T09:00:00Z",
      "customer_name": "Jane Smith",
      "address": "456 Oak Ave, Otherville"
    }
  ]
}
```

### Authentication
Requires a Bearer token with the `installer-jobs:read` scope.
```

--------------------------------

### Pricing and Fee Configuration

Source: https://docs.partner-api.monta.com/reference/getpricegroup

This section details the structure and parameters for configuring pricing and fees, including spot prices, charging fees, and idle fees.

```APIDOC
## Pricing and Fee Configuration

### Description
This section details the structure and parameters for configuring pricing and fees, including spot prices, charging fees, and idle fees. It outlines the various fields available for setting prices, currencies, VAT, and other relevant fee parameters.

### Parameters
#### Request Body Fields
- **vat** (boolean) - Optional - Used by Spot Price. True means it will add % of VAT on top the price calculations. Note: `vat` rates differ from country to country.
- **percentage** (number) - Optional - Used by Spot Price. It will multiply the fallback price by this percentage. Format: float.
- **tariffId** (integer) - Optional - The id of the selected Tariff. Format: int64.
- **updatedAt** (string) - Required - When the pricing was last updated. Format: date-time.
- **applyAfterMinutes** (integer) - Optional - Used by Charging, Minute and Idle Fees. After how many minutes the fee should start being applied. Format: int32.
- **price** (object) - Required - The price of this Fee or Master price.
  - **amount** (integer) - Required - The amount of money. Format: int64.
  - **currency** (object) - Required - Currency details.
    - **decimals** (integer) - Required - The number of decimals the currency has.
    - **identifier** (string) - Required - The identifier of the currency (e.g. EUR).
    - **id** (integer) - Optional - id of the currency. Format: int64.
    - **master** (boolean) - Optional - Whether the currency is master or not, master meaning the default currency.

### Request Example
```json
{
  "vat": false,
  "percentage": 10.2,
  "tariffId": 5,
  "updatedAt": "2023-03-16T15:37:23Z",
  "applyAfterMinutes": 30,
  "price": {
    "amount": 12312,
    "currency": {
      "decimals": 2,
      "identifier": "EUR",
      "id": 1,
      "master": true
    }
  }
}
```

### Response
#### Success Response (200)
- **vat** (boolean) - Indicates if VAT is applied.
- **percentage** (number) - The percentage multiplier for spot prices.
- **tariffId** (integer) - The ID of the selected tariff.
- **updatedAt** (string) - Timestamp of the last update.
- **applyAfterMinutes** (integer) - Minutes after which a fee is applied.
- **price** (object) - The price object containing amount and currency details.
  - **amount** (integer) - The monetary amount.
  - **currency** (object) - Currency details.
    - **decimals** (integer) - Number of decimal places for the currency.
    - **identifier** (string) - Currency code (e.g., EUR).
    - **id** (integer) - Currency ID.
    - **master** (boolean) - Flag indicating if it's the master currency.

#### Response Example
```json
{
  "vat": false,
  "percentage": 10.2,
  "tariffId": 5,
  "updatedAt": "2023-03-16T15:37:23Z",
  "applyAfterMinutes": 30,
  "price": {
    "amount": 12312,
    "currency": {
      "decimals": 2,
      "identifier": "EUR",
      "id": 1,
      "master": true
    }
  }
}
```
```

--------------------------------

### Pricing and Fee Configurations

Source: https://docs.partner-api.monta.com/reference/patch-sponsored-charge-point

This section details the structure and parameters for configuring pricing and fees within the Partner API. It includes information on VAT, percentage-based pricing, tariff IDs, and fee application timings.

```APIDOC
## Pricing and Fee Configuration Details

### Description
Provides details on how pricing and fees are structured and configured within the API. This includes settings for VAT, percentage adjustments, tariff selection, and the timing of fee application.

### Method
N/A (This describes data structures, not a specific endpoint)

### Endpoint
N/A

### Parameters
#### Request Body (Example Structure)
- **vat** (boolean) - Optional - Used by Spot Price. True means it will add % of VAT on top the price calculations. Note: `vat` rates differ from country to country.
- **percentage** (number) - Optional - Used by Spot Price. It will multiply the fallback price by this percentage. Format: float.
- **tariffId** (integer) - Optional - The id of the selected Tariff. Format: int64.
- **updatedAt** (string) - Required - When the pricing was last updated. Format: date-time.
- **applyAfterMinutes** (integer) - Optional - Used by Charging, Minute and Idle Fees. After how many minutes the fee should start being applied. Format: int32.
- **price** (object) - Required - The price of this Fee or Master price.
  - **amount** (integer) - Required - The amount of money. Format: int64.
  - **currency** (object) - Required - Currency details.
    - **decimals** (integer) - Required - The number of decimal places for the currency.
    - **identifier** (string) - Required - The currency identifier (e.g., 'EUR').

### Request Example
```json
{
  "vat": false,
  "percentage": 10.2,
  "tariffId": 5,
  "updatedAt": "2023-03-16T15:37:23Z",
  "applyAfterMinutes": 30,
  "price": {
    "amount": 12312,
    "currency": {
      "decimals": 2,
      "identifier": "EUR"
    }
  }
}
```

### Response
#### Success Response (200)
- **vat** (boolean) - Indicates if VAT is applied.
- **percentage** (number) - The percentage multiplier for pricing.
- **tariffId** (integer) - The ID of the selected tariff.
- **updatedAt** (string) - Timestamp of the last update.
- **applyAfterMinutes** (integer) - Minutes after which a fee is applied.
- **price** (object) - The price object containing amount and currency details.
  - **amount** (integer) - The monetary amount.
  - **currency** (object) - Currency details including decimals and identifier.

#### Response Example
```json
{
  "vat": false,
  "percentage": 10.2,
  "tariffId": 5,
  "updatedAt": "2023-03-16T15:37:23Z",
  "applyAfterMinutes": 30,
  "price": {
    "amount": 12312,
    "currency": {
      "decimals": 2,
      "identifier": "EUR"
    }
  }
}
```
```

--------------------------------

### Retrieve Installer Job by ID (OpenAPI)

Source: https://docs.partner-api.monta.com/reference/get-installer-job

This snippet defines the OpenAPI specification for retrieving a single installer job using its unique ID. It specifies the HTTP GET method, path parameters, required scopes, and the structure of the successful response, including details about the installer job, operator, and associated tasks.

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "MONTA Partner API",
    "description": "             see https://docs.partner-api.monta.com             ",
    "contact": {
      "name": "Partner API Support",
      "url": "https://www.monta.com/uk/contact",
      "email": "partner-api@monta.com"
    },
    "version": "2024-01-18"
  },
  "servers": [
    {
      "url": "https://partner-api.monta.com",
      "description": "Production"
    }
  ],
  "security": [],
  "paths": {
    "/api/v1/installer-jobs/{installerJobId}": {
      "get": {
        "tags": [
          "Installer Jobs"
        ],
        "summary": "Retrieve a single installer job",
        "description": "Required scope: `installer-jobs:read`",
        "operationId": "get-installer-job",
        "parameters": [
          {
            "name": "installerJobId",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Installer job with provided id",
            "content": {
              "application/json": {
                "schema": {
                  "required": [
                    "createdAt",
                    "operator",
                    "publicLink",
                    "tasks"
                  ],
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "integer",
                      "description": "Id of this installer job",
                      "format": "int64",
                      "example": 42
                    },
                    "siteId": {
                      "type": "integer",
                      "description": "Id of the site related to this installer job",
                      "format": "int64",
                      "example": 22
                    },
                    "operator": {
                      "description": "The operator of this installer job",
                      "allOf": [
                        {
                          "required": [
                            "identifier",
                            "name"
                          ],
                          "type": "object",
                          "properties": {
                            "id": {
                              "type": "integer",
                              "description": "ID of the operator",
                              "format": "int64",
                              "example": 14
                            },
                            "name": {
                              "type": "string",
                              "description": "Name of operator",
                              "example": "Monta"
                            },
                            "identifier": {
                              "type": "string",
                              "description": "Identifier of operator",
                              "example": "monta"
                            },
                            "partnerId": {
                              "type": "integer",
                              "description": "Id of the partner",
                              "format": "int64",
                              "nullable": true,
                              "example": 1
                            },
                            "vatNumber": {
                              "type": "string",
                              "description": "VAT number",
                              "nullable": true,
                              "example": "FOO-123-ABC"
                            }
                          },
                          "x-readme-ref-name": "Operator"
                        },
                        {}
                      ]
                    },
                    "teamId": {
                      "type": "integer",
                      "description": "Id of the team of this installer job",
                      "format": "int64",
                      "example": 4124
                    },
                    "description": {
                      "type": "string",
                      "description": "Description of this installer job, will be visible to the installer",
                      "nullable": true,
                      "example": "5"
                    },
                    "publicLink": {
                      "type": "string",
                      "description": "Public link of this installer job, shareable with the installer",
                      "example": "https://app.monta.app/installer-page/149ffbb6-7b69-47a1-9698-90177c2027da"
                    },
                    "chargePointCount": {
                      "type": "integer",
                      "description": "Number of charge points included in this installer job"
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}
```

--------------------------------

### Entity Retrieval (Example)

Source: https://docs.partner-api.monta.com/reference/get-all-tariffs

This section details an example endpoint for retrieving an entity, including success and error responses.

```APIDOC
## GET /websites/partner-api_monta/{id}

### Description
Retrieves a specific entity by its ID.

### Method
GET

### Endpoint
/websites/partner-api_monta/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the entity to retrieve.

### Request Example
(No request body for GET requests)

### Response
#### Success Response (200)
- **entityData** (object) - Contains the details of the requested entity.
  - **field1** (string) - Description of field1.
  - **field2** (integer) - Description of field2.

#### Response Example
```json
{
  "entityData": {
    "field1": "exampleValue",
    "field2": 123
  }
}
```

#### Error Response (404)
- **status** (string) - The status code of the error (e.g., "NOT_FOUND").
- **message** (string) - A description of the error.
- **readableMessage** (string) - A user-friendly error message.
- **errorCode** (string) - A specific error code.
- **context** (string) - Additional context for the error.

#### Response Example
```json
{
  "status": "NOT_FOUND",
  "message": "Requested entity/entity provided in body was not found",
  "readableMessage": "The entity you are looking for could not be found.",
  "errorCode": "RESOURCE_NOT_FOUND",
  "context": "entityId: 123e4567-e89b-12d3-a456-426614174000"
}
```
```

--------------------------------

### Pricing Configuration

Source: https://docs.partner-api.monta.com/reference/get-prices-forecast

This section details the structure and parameters for configuring pricing, including time-based applicability, tag IDs, interval settings, and grace periods.

```APIDOC
## Pricing Configuration Details

### Description
Provides details on how to configure pricing, including time constraints, associated tags, interval resolutions, and grace periods for fee application.

### Method
N/A (Schema Definition)

### Endpoint
N/A (Schema Definition)

### Parameters
#### Pricing Object
- **from** (string) - Optional - DateTime from which this pricing should apply.
- **to** (string) - Optional - DateTime to which this pricing should apply.
- **tagId** (integer) - Optional - The id of the charge pricing tag for this pricing.
- **interval** (string) - Optional - Specifies the time resolution used for spot price calculations. Possible values: "hourly", "quarterHourly".
- **gracePeriods** (array) - Optional - Grace periods during which idle fees are not applied.
  - **startTime** (string) - Required - Start time for the grace period (e.g., "09:00:00").
  - **endTime** (string) - Required - End time for the grace period (e.g., "17:00:00").

### Request Example
```json
{
  "from": "2023-03-16T15:37:23Z",
  "to": "2023-03-17T15:37:23Z",
  "tagId": 109,
  "interval": "hourly",
  "gracePeriods": [
    {
      "startTime": "09:00:00",
      "endTime": "17:00:00"
    }
  ]
}
```

### Response
#### Success Response (200)
- **Pricing Object Structure**: Returns the defined pricing configuration.

#### Response Example
```json
{
  "from": "2023-03-16T15:37:23Z",
  "to": "2023-03-17T15:37:23Z",
  "tagId": 109,
  "interval": "hourly",
  "gracePeriods": [
    {
      "startTime": "09:00:00",
      "endTime": "17:00:00"
    }
  ]
}
```
```

--------------------------------

### GET /api/v1/installer-jobs

Source: https://docs.partner-api.monta.com/reference/get-installer-jobs

Retrieve a list of installer jobs. This endpoint allows filtering by site ID, team ID, and inclusion of deleted jobs.

```APIDOC
## GET /api/v1/installer-jobs

### Description
Retrieve a list of installer jobs. This endpoint allows filtering by site ID, team ID, and inclusion of deleted jobs.

### Method
GET

### Endpoint
/api/v1/installer-jobs

### Parameters
#### Query Parameters
- **page** (integer) - Optional - page number to retrieve (starts with 0). Default: 0.
- **perPage** (integer) - Optional - number of items per page (between 1 and 100, default 10). Default: 10.
- **siteId** (integer) - Optional - Allows to filter list of installer jobs by a site id.
- **teamId** (integer) - Optional - Allows to filter list of installer jobs by a team id.
- **includeDeleted** (boolean) - Optional - If true, deleted installer jobs will be included in the response.

### Response
#### Success Response (200)
- **data** (array) - List of installer jobs.
- **meta** (object) - Metadata about the response.

##### Data Item Schema
- **id** (integer) - Id of this installer job.
- **siteId** (integer) - Id of the site related to this installer job.
- **operator** (object) - The operator of this installer job.
  - **id** (integer) - ID of the operator.
  - **name** (string) - Name of operator.
- **createdAt** (string) - Timestamp of when the installer job was created.
- **publicLink** (string) - Public link for the installer job.
- **tasks** (array) - List of tasks associated with the installer job.

#### Response Example
```json
{
  "data": [
    {
      "id": 42,
      "siteId": 22,
      "operator": {
        "id": 14,
        "name": "Monta"
      },
      "createdAt": "2023-10-29T10:00:00Z",
      "publicLink": "https://example.com/job/abc123xyz",
      "tasks": [
        {
          "id": 101,
          "type": "INSTALLATION",
          "status": "PENDING"
        }
      ]
    }
  ],
  "meta": {
    "total": 1,
    "page": 0,
    "perPage": 10
  }
}
```
```
Tokens:
Raw