v1

latestOpenAPI 3.0.12026-07-243686491.1 MB

Charge Points

Patch an existing charge point

Required scope: charge-points:write </br>Organization authorization: supported

patch/api/v1/charge-points/{chargePointId}

Path parameters

chargePointIdinteger required

Request body

siteIdinteger nullable

Id of the site the charge point belongs to.

namestring nullable

Name of the charge point.

maxKwnumber double nullable

Max Kw (Max Power) the charge point can output.

visibility'private' | 'public'

definitions:

private - Indicates the charge point access is private, only available to users from operator umbrella.
public - Indicates the charge point access is public.

type'ac' | 'dc' | 'other'

definitions:

ac - Indicates the charge point use ac (alternating current) as electric current.
dc - Indicates the charge point use ac (direct current) as electric current.
other - Indicates the team member has only access to the selected charge points.

activeboolean nullable

Indicates the charge point is active.

showOnMapboolean nullable

        Indicates the charge point should be displayed on map.

        By setting this to false, the charge point will not be shown on the app's map,
        but will still be fully functional for users of the charge point.

notestring nullable

A note (instructions, warning, information) you have entered for this charge point

latitudenumber nullable

        Latitude coordinate for the charge point location.
        When provided along with longitude, overrides the site's location.

longitudenumber nullable

        Longitude coordinate for the charge point location.
        When provided along with latitude, overrides the site's location.

partnerExternalIdstring nullable

External Id of this entity, managed by you.

meterIdstring nullable

Meter id of the charge point.

roamingboolean nullable

Indicates if the charge point is roaming enabled.

roamingPriceGroupIdinteger nullable

The id of the roaming price group for this charge point.</br>Note: This field is required if the roaming field is set to true and the charge point doesn't have an associated roaming price group id.

smartChargeSetting'off' | 'optional' | 'forced' | 'forced-setting' nullable

        Smart charging setting for this charge point.
        - `off`: Smart charging is disabled, rules cannot be created
        - `optional`: Smart charging is optional, rules can be created and applied
        - `forced`: Smart charging is forced, rules will always be applied
        - `forced-setting`: Smart charging setting is forced

userIdinteger nullable

Id of the user that owns this charge point. Can only be set or updated, not removed.

autoRegisterRfidboolean nullable

Whether RFID tags are auto-registered when scanned at this charge point.

Example request

{
  "siteId": 20,
  "name": "CP - CPH Office",
  "maxKw": 22,
  "active": true,
  "showOnMap": true,
  "note": "In order to access this charge point enter 0000 as code at the gate.",
  "latitude": 55.6761,
  "longitude": 12.5683,
  "partnerExternalId": "ACME-12345",
  "meterId": "2200019107351",
  "roaming": true,
  "roamingPriceGroupId": 10,
  "smartChargeSetting": "optional",
  "userId": 42,
  "autoRegisterRfid": true
}

Response

Charge point updated

idinteger required

Id of this charge point.

teamIdinteger required

Id of the team.

partnerExternalIdstring nullable

External Id of this entity, managed by you.

partnerCustomPayloadobject[] nullable

Custom JSON payload for this entity, managed by you.

siteIdinteger nullable

Id of the site.

createdAtstring date-time required

Creation date of this charge point.

updatedAtstring date-time required

Date this charge point was last updated.

deletedAtstring date-time nullable

Date this charge point was deleted.

activeAtstring date-time nullable

Last date when charge point was activated.

serialNumberstring nullable

Serial number of this charge point.

namestring nullable

Name of the charge point.

visibility'private' | 'public' required

Indicates if this charge point is public or private.

maxKWnumber double nullable

Deprecated (will be removed by 01.04.24), use maxKw field instead.

maxKwnumber double nullable

Max KW available at this charge point.

type'ac' | 'dc' nullable

Type of charge point (AC / DC).

notestring nullable

A note you have entered for this charge point, e.g. via our Portal.

operatorNotestring nullable

An operator note you have entered for this charge point, e.g. via our Portal.

Various types of Charge Point states. Definitions:

available - The charge point is available for charging.
busy - The charge point is currently in use.
busy-blocked - The charge point is currently in use and blocked.
busy-charging - The charge point is currently in use and charging.
busy-non-charging - The charge point is currently in use and not charging.
busy-non-released - The charge point is currently in use and not released.
busy-reserved - The charge point is currently in use and reserved.
busy-scheduled - The charge point is currently in use and scheduled.
error - The charge point is in an error state.
disconnected - The charge point is disconnected from Monta.
passive - The charge point is in a passive state, charging can only be controlled locally.
maintenance - The charge point is in maintenance mode.
exempt - The charge point is exempt from downtime reporting due to external factors.

lastMeterReadingKwhnumber double nullable

Last meter reading (KWH) for this charge point.

meterIdstring nullable

Meter Id of this charge point.

cablePluggedInboolean required

Indicates if a cable is plugged in (true).

chargePointModelIdinteger nullable

The ID of the charge point model for this charge point.

brandNamestring nullable

Brand name for this charge point.

modelNamestring nullable

Model name for this charge point.

firmwareVersionstring nullable

Current firmware version for this charge point.

integrationType'oicp' | 'ocpi' | 'ocpp' | 'other'

definitions:

oicp - Indicates the current integration is OICP.
ocpi - Indicates the current integration is OCPI.
ocpp - Indicates the current integration is OCPP.
other - Fallback value, Indicates a new type was added but is not mapped/unknown on this API yet.

evseIdstring required

The EVSE id for this charge point.

priceGroupIdinteger nullable

The id of the public price group for this charge point.

costGroupIdinteger nullable

The id of the cost price group for this charge point.

roamingPriceGroupIdinteger nullable

The id of the roaming price group for this charge point.

sponsoredPriceGroupIdinteger nullable

The id of the sponsored price group for this charge point.

scheduleIdinteger nullable

The id of the schedule assigned to this charge point.

isActiveboolean required

Indicates if this charge point is active (true) or not (false). Active = fully onboarded to Monta.

reservableboolean required

Indicates if the charge point can be reserved.

reservationTimeinteger nullable

The max duration(in minutes) that this Charge Point can be reserved for</br>null indicates that reservation is not supported.

roamingboolean required

Indicates whether roaming is enabled for this charge point.

lastConnectedAtstring date-time nullable

The last date/time this charge point was reported as connected.

disconnectedAtstring date-time nullable

The date/time this charge point was reported as disconnected.

occupiedboolean nullable

Indicates if the Charge Point is currently occupied. Note: At the moment this is only determined by a charge point sensor attached to it.

showOnMapboolean required

Indicates if this charge point should be displayed on the map.

smartChargeSetting'off' | 'optional' | 'forced' | 'forced-setting' nullable

        Smart charging setting for this charge point.
        - `off`: Smart charging is disabled, rules cannot be created
        - `optional`: Smart charging is optional, rules can be created and applied
        - `forced`: Smart charging is forced, rules will always be applied
        - `forced-setting`: Smart charging setting is forced

autoStart'on' | 'off' | 'not-available'

Auto-start status values

userIdinteger nullable

Id of the user that owns this charge point.

autoRegisterRfidboolean nullable

Whether RFID tags are auto-registered when scanned at this charge point.

Example response

{
  "id": 1,
  "teamId": 1,
  "partnerExternalId": "ACME-12345",
  "siteId": 42,
  "operator": {
    "id": 14,
    "name": "Monta",
    "identifier": "monta",
    "partnerId": 1,
    "vatNumber": "FOO-123-ABC"
  },
  "createdAt": "2022-05-12T15:56:45.99Z",
  "updatedAt": "2022-05-12T16:56:45.99Z",
  "deletedAt": "2022-05-12T16:56:45.99Z",
  "activeAt": "2022-05-12T15:56:45.91Z",
  "name": "Monta CPH HQ",
  "visibility": "public",
  "maxKW": 150,
  "maxKw": 150,
  "type": "ac",
  "note": "In order to access this charge point enter 0000 as code at the gate.",
  "operatorNote": "Installer note: XYZ",
  "state": "available",
  "location": {
    "coordinates": {
      "latitude": 55.6760968,
      "longitude": 12.5683371
    },
    "addressLabel": "Strandboulevarden 122, 5. sal, 2100 København, Denmark",
    "address": {
      "address1": "Strandboulevarden 122",
      "address2": "København",
      "address3": "5. sal",
      "zip": "2100",
      "city": "Copenhagen",
      "province": "Lombardy",
      "country": "Denmark",
      "countryAreaId": 1
    }
  },
  "connectors": [
    {
      "id": 1,
      "identifier": "ccs",
      "name": "CCS"
    }
  ],
  "lastMeterReadingKwh": 913.2,
  "meterId": "2200019107351",
  "cablePluggedIn": true,
  "chargePointModelId": 42,
  "brandName": "Easee",
  "modelName": "Easee - Home",
  "firmwareVersion": "v1",
  "evseId": "DK*MON*E2",
  "priceGroupId": 42,
  "costGroupId": 42,
  "roamingPriceGroupId": 42,
  "sponsoredPriceGroupId": 42,
  "scheduleId": 42,
  "isActive": true,
  "reservable": true,
  "simCard": {
    "imsi": "310150123456789",
    "iccid": "8931501234567890123"
  },
  "roaming": true,
  "lastConnectedAt": "2023-01-18T00:00:00Z",
  "disconnectedAt": "2023-01-01T00:00:00Z",
  "occupied": true,
  "protocolData": {
    "ocpp": {
      "updatedAt": "2025-02-27T15:56:45.91Z"
    }
  },
  "metadata": {
    "busCompatible": true,
    "motorcycleCompatible": true,
    "lorryCompatible": true,
    "personalVehicleCompatible": true,
    "additionalParkingFeesPolicy": true,
    "customersOnlyPolicy": true,
    "evOnlyPolicy": true,
    "parkingOnlyWhileChargingPolicy": true,
    "floorLevel": "first",
    "cableLength": 100,
    "behindBarrierPolicy": true,
    "hdvParkingSpot": {
      "height": 400,
      "width": 300,
      "length": 600,
      "weight": 5000,
      "angledOrientation": true,
      "turningRadius": 3.5,
      "cpPosition": "null"
    },
    "dangerousGoodsAllowed": true,
    "rigidVehiclesAllowed": true,
    "vehicleAccessibility": "wheelchair_accessible",
    "overnightParkingAllowed": true,
    "accessConditions": "permit_required",
    "barrier": true,
    "trailerPullThrough": true
  },
  "smartChargeSetting": "optional",
  "userId": 42,
  "autoRegisterRfid": true
}