Energy Charge Intents

Set manual charge intent for an active charge session

POST

https://partner-api.monta.com

/api/v1/energy/sites/{siteId}/charges/{ocppChargeId}/charge-intent

Required scope: energy:write

🚧 BETA — This endpoint is currently in the BETA phase and its response structure may change in the future.

📘 Feature flag required — This endpoint is not available by default. It must be explicitly enabled for your operator account upon request. Please contact your Monta Business Partner to request access to this feature.

Set manual charge intent for an active charge session › path Parameters

siteId

integer · int64 · required

ocppChargeId

string · required

Set manual charge intent for an active charge session › Request Body

SetManualChargeIntentRequest

type

ChargeIntentType · enum · required

Enum values:

PRICE_OPTIMIZE

CHARGE_NOW

priority

integer · int32 · required

departureTime

string | null · date-time

object

Set manual charge intent for an active charge session › Responses

setManualChargeIntent 204 response

No data returned

Remove an EVSE's charge intent

DELETE

https://partner-api.monta.com

/api/v1/energy/sites/{siteId}/nodes/{nodeId}/evses/{chargingStationIdentity}/{connectorId}/charge-intent

Required scope: energy:delete

Removes the default charge intent set on the EVSE. Returns 404 when the EVSE is not on the given node of the site. Succeeds when the EVSE has no charge intent.

🚧 BETA — This endpoint is currently in the BETA phase and its response structure may change in the future.

Remove an EVSE's charge intent › path Parameters

siteId

integer · int64 · required

nodeId

integer · int64 · required

chargingStationIdentity

string · required

connectorId

integer · int64 · required

Remove an EVSE's charge intent › Responses

removeEvseChargeIntent 204 response

No data returned

Set RFID charge intent

POST

https://partner-api.monta.com

/api/v1/energy/sites/{siteId}/rfids/{rfid}

Required scope: energy:write

🚧 BETA — This endpoint is currently in the BETA phase and its response structure may change in the future.

Set RFID charge intent › path Parameters

siteId

integer · int64 · required

rfid

string · required

Set RFID charge intent › Request Body

CreateRfidChargeIntent

rfid

string · required

type

ChargeIntentType · enum · required

Enum values:

PRICE_OPTIMIZE

CHARGE_NOW

ScheduleOverride[] · required

departureTime

string | null · partial-time

object

Set RFID charge intent › Responses

setRfidChargeIntent 201 response

ChargeIntent

type

ChargeIntentType · enum · required

Enum values:

PRICE_OPTIMIZE

CHARGE_NOW

ScheduleOverride[] · required

departureTime

string | null · partial-time

object

priority

integer | null · int32

POST/api/v1/energy/sites/{siteId}/rfids/{rfid}

curl https://partner-api.monta.com/api/v1/energy/sites/:siteId/rfids/:rfid \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "rfid": "rfid",
  "type": "PRICE_OPTIMIZE",
  "departureTime": "departureTime",
  "target": {
    "soc": 0,
    "kwh": 0
  },
  "scheduleOverrides": [
    {
      "id": "id",
      "startDay": "MONDAY",
      "startTime": "startTime",
      "endDay": "MONDAY",
      "endTime": "endTime",
      "type": "PRICE_OPTIMIZE",
      "departureDay": "MONDAY",
      "departureTime": "departureTime",
      "target": {
        "soc": 0,
        "kwh": 0
      }
    }
  ]
}'

Example Request Body

{
  "rfid": "rfid",
  "type": "PRICE_OPTIMIZE",
  "departureTime": "departureTime",
  "target": {
    "soc": 0,
    "kwh": 0
  },
  "scheduleOverrides": [
    {
      "id": "id",
      "startDay": "MONDAY",
      "startTime": "startTime",
      "endDay": "MONDAY",
      "endTime": "endTime",
      "type": "PRICE_OPTIMIZE",
      "departureDay": "MONDAY",
      "departureTime": "departureTime",
      "target": {
        "soc": 0,
        "kwh": 0
      }
    }
  ]
}

json

Example Responses

{
  "type": "PRICE_OPTIMIZE",
  "departureTime": "departureTime",
  "target": {
    "soc": 0,
    "kwh": 0
  },
  "scheduleOverrides": [
    {
      "id": "id",
      "startDay": "MONDAY",
      "startTime": "startTime",
      "endDay": "MONDAY",
      "endTime": "endTime",
      "type": "PRICE_OPTIMIZE",
      "departureDay": "MONDAY",
      "departureTime": "departureTime",
      "target": {
        "soc": 0,
        "kwh": 0
      }
    }
  ],
  "priority": 0
}

json

application/json

Update RFID charge intent

PATCH

https://partner-api.monta.com

/api/v1/energy/sites/{siteId}/rfids/{rfid}

Required scope: energy:write

🚧 BETA — This endpoint is currently in the BETA phase and its response structure may change in the future.

Update RFID charge intent › path Parameters

siteId

integer · int64 · required

rfid

string · required

Update RFID charge intent › Request Body

UpdateRfidChargeIntentRequest

ScheduleOverride[] · required

type

string · enum

Enum values:

PRICE_OPTIMIZE

CHARGE_NOW

departureTime

string | null · partial-time

object

Update RFID charge intent › Responses

updateRfidChargeIntent 200 response

ChargeIntent

type

ChargeIntentType · enum · required

Enum values:

PRICE_OPTIMIZE

CHARGE_NOW

ScheduleOverride[] · required

departureTime

string | null · partial-time

object

priority

integer | null · int32

PATCH/api/v1/energy/sites/{siteId}/rfids/{rfid}

curl https://partner-api.monta.com/api/v1/energy/sites/:siteId/rfids/:rfid \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "type": "PRICE_OPTIMIZE",
  "departureTime": "departureTime",
  "target": {
    "soc": 0,
    "kwh": 0
  },
  "scheduleOverrides": [
    {
      "id": "id",
      "startDay": "MONDAY",
      "startTime": "startTime",
      "endDay": "MONDAY",
      "endTime": "endTime",
      "type": "PRICE_OPTIMIZE",
      "departureDay": "MONDAY",
      "departureTime": "departureTime",
      "target": {
        "soc": 0,
        "kwh": 0
      }
    }
  ]
}'

Example Request Body

{
  "type": "PRICE_OPTIMIZE",
  "departureTime": "departureTime",
  "target": {
    "soc": 0,
    "kwh": 0
  },
  "scheduleOverrides": [
    {
      "id": "id",
      "startDay": "MONDAY",
      "startTime": "startTime",
      "endDay": "MONDAY",
      "endTime": "endTime",
      "type": "PRICE_OPTIMIZE",
      "departureDay": "MONDAY",
      "departureTime": "departureTime",
      "target": {
        "soc": 0,
        "kwh": 0
      }
    }
  ]
}

json

Example Responses

{
  "type": "PRICE_OPTIMIZE",
  "departureTime": "departureTime",
  "target": {
    "soc": 0,
    "kwh": 0
  },
  "scheduleOverrides": [
    {
      "id": "id",
      "startDay": "MONDAY",
      "startTime": "startTime",
      "endDay": "MONDAY",
      "endTime": "endTime",
      "type": "PRICE_OPTIMIZE",
      "departureDay": "MONDAY",
      "departureTime": "departureTime",
      "target": {
        "soc": 0,
        "kwh": 0
      }
    }
  ],
  "priority": 0
}

json

application/json

Delete RFID charge intent

DELETE

https://partner-api.monta.com

/api/v1/energy/sites/{siteId}/rfids/{rfid}

Required scope: energy:delete

🚧 BETA — This endpoint is currently in the BETA phase and its response structure may change in the future.

Delete RFID charge intent › path Parameters

siteId

integer · int64 · required

rfid

string · required

Delete RFID charge intent › Responses

deleteRfidChargeIntent 204 response

No data returned

Set team charge intent

POST

https://partner-api.monta.com

/api/v1/energy/sites/{siteId}/teams/{teamId}

Required scope: energy:write

Only type is required; the minimal body is {"type": "CHARGE_NOW"}. PRICE_OPTIMIZE also requires target and departureTime. Omitted scheduleOverrides default to none.

🚧 BETA — This endpoint is currently in the BETA phase and its response structure may change in the future.

Set team charge intent › path Parameters

siteId

integer · int64 · required

teamId

integer · int64 · required

Set team charge intent › Request Body

SetTeamChargeIntentRequest

type

string | null · enum · required

Charge intent type. PRICE_OPTIMIZE also requires target and departureTime.

Enum values:

PRICE_OPTIMIZE

CHARGE_NOW

Example: CHARGE_NOW

departureTime

string | null

Daily departure time (local time).

Example: 07:30:00

object

Charging target.

array | null

Schedule overrides. Defaults to none.

priority

integer | null · int32

Intent priority. Defaults to 0.

Set team charge intent › Responses

setTeamChargeIntent 201 response

ChargeIntent

type

ChargeIntentType · enum · required

Enum values:

PRICE_OPTIMIZE

CHARGE_NOW

ScheduleOverride[] · required

departureTime

string | null · partial-time

object

priority

integer | null · int32

POST/api/v1/energy/sites/{siteId}/teams/{teamId}

curl https://partner-api.monta.com/api/v1/energy/sites/:siteId/teams/:teamId \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "type": "CHARGE_NOW",
  "departureTime": "07:30:00",
  "target": {
    "soc": 0,
    "kwh": 0
  },
  "scheduleOverrides": [
    {
      "id": "id",
      "startDay": "MONDAY",
      "startTime": "startTime",
      "endDay": "MONDAY",
      "endTime": "endTime",
      "type": "PRICE_OPTIMIZE",
      "departureDay": "MONDAY",
      "departureTime": "departureTime",
      "target": {
        "soc": 0,
        "kwh": 0
      }
    }
  ],
  "priority": 0
}'

Example Request Body

{
  "type": "CHARGE_NOW",
  "departureTime": "07:30:00",
  "target": {
    "soc": 0,
    "kwh": 0
  },
  "scheduleOverrides": [
    {
      "id": "id",
      "startDay": "MONDAY",
      "startTime": "startTime",
      "endDay": "MONDAY",
      "endTime": "endTime",
      "type": "PRICE_OPTIMIZE",
      "departureDay": "MONDAY",
      "departureTime": "departureTime",
      "target": {
        "soc": 0,
        "kwh": 0
      }
    }
  ],
  "priority": 0
}

json

Example Responses

{
  "type": "PRICE_OPTIMIZE",
  "departureTime": "departureTime",
  "target": {
    "soc": 0,
    "kwh": 0
  },
  "scheduleOverrides": [
    {
      "id": "id",
      "startDay": "MONDAY",
      "startTime": "startTime",
      "endDay": "MONDAY",
      "endTime": "endTime",
      "type": "PRICE_OPTIMIZE",
      "departureDay": "MONDAY",
      "departureTime": "departureTime",
      "target": {
        "soc": 0,
        "kwh": 0
      }
    }
  ],
  "priority": 0
}

json

application/json

Delete team charge intent

DELETE

https://partner-api.monta.com

/api/v1/energy/sites/{siteId}/teams/{teamId}

Required scope: energy:delete

🚧 BETA — This endpoint is currently in the BETA phase and its response structure may change in the future.

Delete team charge intent › path Parameters

siteId

integer · int64 · required

teamId

integer · int64 · required

Delete team charge intent › Responses

deleteTeamChargeIntent 204 response

No data returned

Set user charge intent

POST

https://partner-api.monta.com

/api/v1/energy/sites/{siteId}/users/{userId}

Required scope: energy:write

Only type is required, e.g. {"type": "CHARGE_NOW"}. PRICE_OPTIMIZE additionally requires target and departureTime; scheduleOverrides defaults to an empty list and priority to 0.

🚧 BETA — This endpoint is currently in the BETA phase and its response structure may change in the future.

Set user charge intent › path Parameters

siteId

integer · int64 · required

userId

integer · int64 · required

Set user charge intent › Request Body

Charge intent for a user. Only `type` is required; `target` and `departureTime` are required for `PRICE_OPTIMIZE`.

SetUserChargeIntentRequest

type

string · enum · pattern: ^(PRICE_OPTIMIZE|CHA… · required

Charge intent type

Enum values:

PRICE_OPTIMIZE

CHARGE_NOW

Example: CHARGE_NOW

departureTime

string | null

Departure time (local time of the site). Required for PRICE_OPTIMIZE.

Example: 07:30:00

object

Charging target. Required for PRICE_OPTIMIZE.

array | null

Schedule overrides. Defaults to an empty list.

priority

integer | null · int32

Priority of the charge intent. Defaults to 0.

Example: 0

Set user charge intent › Responses

setUserChargeIntent 201 response

ChargeIntent

type

ChargeIntentType · enum · required

Enum values:

PRICE_OPTIMIZE

CHARGE_NOW

ScheduleOverride[] · required

departureTime

string | null · partial-time

object

priority

integer | null · int32

POST/api/v1/energy/sites/{siteId}/users/{userId}

curl https://partner-api.monta.com/api/v1/energy/sites/:siteId/users/:userId \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "type": "CHARGE_NOW",
  "departureTime": "07:30:00",
  "target": {
    "soc": 0,
    "kwh": 0
  },
  "scheduleOverrides": [
    {
      "id": "id",
      "startDay": "MONDAY",
      "startTime": "startTime",
      "endDay": "MONDAY",
      "endTime": "endTime",
      "type": "PRICE_OPTIMIZE",
      "departureDay": "MONDAY",
      "departureTime": "departureTime",
      "target": {
        "soc": 0,
        "kwh": 0
      }
    }
  ],
  "priority": 0
}'

Example Request Body

{
  "type": "CHARGE_NOW",
  "departureTime": "07:30:00",
  "target": {
    "soc": 0,
    "kwh": 0
  },
  "scheduleOverrides": [
    {
      "id": "id",
      "startDay": "MONDAY",
      "startTime": "startTime",
      "endDay": "MONDAY",
      "endTime": "endTime",
      "type": "PRICE_OPTIMIZE",
      "departureDay": "MONDAY",
      "departureTime": "departureTime",
      "target": {
        "soc": 0,
        "kwh": 0
      }
    }
  ],
  "priority": 0
}

json

Example Responses

{
  "type": "PRICE_OPTIMIZE",
  "departureTime": "departureTime",
  "target": {
    "soc": 0,
    "kwh": 0
  },
  "scheduleOverrides": [
    {
      "id": "id",
      "startDay": "MONDAY",
      "startTime": "startTime",
      "endDay": "MONDAY",
      "endTime": "endTime",
      "type": "PRICE_OPTIMIZE",
      "departureDay": "MONDAY",
      "departureTime": "departureTime",
      "target": {
        "soc": 0,
        "kwh": 0
      }
    }
  ],
  "priority": 0
}

json

application/json

Delete user charge intent

DELETE

https://partner-api.monta.com

/api/v1/energy/sites/{siteId}/users/{userId}

Required scope: energy:delete

🚧 BETA — This endpoint is currently in the BETA phase and its response structure may change in the future.

Delete user charge intent › path Parameters

siteId

integer · int64 · required

userId

integer · int64 · required

Delete user charge intent › Responses

deleteUserChargeIntent 204 response

No data returned

Create a vehicle ID intent

POST

https://partner-api.monta.com

/api/v1/energy/sites/{siteId}/vehicles

Required scope: energy:write

🚧 BETA — This endpoint is currently in the BETA phase and its response structure may change in the future.

Create a vehicle ID intent › path Parameters

siteId

integer · int64 · required

Create a vehicle ID intent › Request Body

CreateVehicleIdIntent

vehicleIdTag

string · minLength: 1 · required

batteryCapacityKwh

number · double · required

type

ChargeIntentType · enum · required

Enum values:

PRICE_OPTIMIZE

CHARGE_NOW

ScheduleOverride[] · required

vehicleId

integer | null · int64

departureTime

string | null · partial-time

object

Create a vehicle ID intent › Responses

createVehicleIdIntent 201 response

Vehicle

vehicleIdTag

string · required

ChargeIntent · required

vehicleId

integer | null · int64

batteryCapacityKwh

number | null · double

integrationCapacityKwh

number | null · double

maxKwAc

number | null · double

maxKwDc

number | null · double

POST/api/v1/energy/sites/{siteId}/vehicles

curl https://partner-api.monta.com/api/v1/energy/sites/:siteId/vehicles \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "vehicleIdTag": "vehicleIdTag",
  "vehicleId": 0,
  "batteryCapacityKwh": 0,
  "type": "PRICE_OPTIMIZE",
  "departureTime": "departureTime",
  "target": {
    "soc": 0,
    "kwh": 0
  },
  "scheduleOverrides": [
    {
      "id": "id",
      "startDay": "MONDAY",
      "startTime": "startTime",
      "endDay": "MONDAY",
      "endTime": "endTime",
      "type": "PRICE_OPTIMIZE",
      "departureDay": "MONDAY",
      "departureTime": "departureTime",
      "target": {
        "soc": 0,
        "kwh": 0
      }
    }
  ]
}'

Example Request Body

{
  "vehicleIdTag": "vehicleIdTag",
  "vehicleId": 0,
  "batteryCapacityKwh": 0,
  "type": "PRICE_OPTIMIZE",
  "departureTime": "departureTime",
  "target": {
    "soc": 0,
    "kwh": 0
  },
  "scheduleOverrides": [
    {
      "id": "id",
      "startDay": "MONDAY",
      "startTime": "startTime",
      "endDay": "MONDAY",
      "endTime": "endTime",
      "type": "PRICE_OPTIMIZE",
      "departureDay": "MONDAY",
      "departureTime": "departureTime",
      "target": {
        "soc": 0,
        "kwh": 0
      }
    }
  ]
}

json

Example Responses

{
  "vehicleId": 0,
  "vehicleIdTag": "vehicleIdTag",
  "batteryCapacityKwh": 0,
  "chargeIntent": {
    "type": "PRICE_OPTIMIZE",
    "departureTime": "departureTime",
    "target": {
      "soc": 0,
      "kwh": 0
    },
    "scheduleOverrides": [
      {
        "id": "id",
        "startDay": "MONDAY",
        "startTime": "startTime",
        "endDay": "MONDAY",
        "endTime": "endTime",
        "type": "PRICE_OPTIMIZE",
        "departureDay": "MONDAY",
        "departureTime": "departureTime",
        "target": {
          "soc": 0,
          "kwh": 0
        }
      }
    ],
    "priority": 0
  },
  "integrationCapacityKwh": 0,
  "maxKwAc": 0,
  "maxKwDc": 0
}

json

application/json

Update a vehicle ID intent

PATCH

https://partner-api.monta.com

/api/v1/energy/sites/{siteId}/vehicles/{vehicleIdTag}

Required scope: energy:write

🚧 BETA — This endpoint is currently in the BETA phase and its response structure may change in the future.

Update a vehicle ID intent › path Parameters

siteId

integer · int64 · required

vehicleIdTag

string · required

Update a vehicle ID intent › Request Body

UpdateVehicleIdIntentRequest

vehicleIdTag

string | null · pattern: .*\S.*

vehicleId

integer | null · int64

batteryCapacityKwh

number | null · double

type

string · enum

Enum values:

PRICE_OPTIMIZE

CHARGE_NOW

departureTime

string | null · partial-time

object

array | null

Update a vehicle ID intent › Responses

updateVehicleIdIntent 200 response

Vehicle

vehicleIdTag

string · required

ChargeIntent · required

vehicleId

integer | null · int64

batteryCapacityKwh

number | null · double

integrationCapacityKwh

number | null · double

maxKwAc

number | null · double

maxKwDc

number | null · double

PATCH/api/v1/energy/sites/{siteId}/vehicles/{vehicleIdTag}

curl https://partner-api.monta.com/api/v1/energy/sites/:siteId/vehicles/:vehicleIdTag \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "vehicleIdTag": "vehicleIdTag",
  "vehicleId": 0,
  "batteryCapacityKwh": 0,
  "type": "PRICE_OPTIMIZE",
  "departureTime": "departureTime",
  "target": {
    "soc": 0,
    "kwh": 0
  },
  "scheduleOverrides": [
    {
      "id": "id",
      "startDay": "MONDAY",
      "startTime": "startTime",
      "endDay": "MONDAY",
      "endTime": "endTime",
      "type": "PRICE_OPTIMIZE",
      "departureDay": "MONDAY",
      "departureTime": "departureTime",
      "target": {
        "soc": 0,
        "kwh": 0
      }
    }
  ]
}'

Example Request Body

{
  "vehicleIdTag": "vehicleIdTag",
  "vehicleId": 0,
  "batteryCapacityKwh": 0,
  "type": "PRICE_OPTIMIZE",
  "departureTime": "departureTime",
  "target": {
    "soc": 0,
    "kwh": 0
  },
  "scheduleOverrides": [
    {
      "id": "id",
      "startDay": "MONDAY",
      "startTime": "startTime",
      "endDay": "MONDAY",
      "endTime": "endTime",
      "type": "PRICE_OPTIMIZE",
      "departureDay": "MONDAY",
      "departureTime": "departureTime",
      "target": {
        "soc": 0,
        "kwh": 0
      }
    }
  ]
}

json

Example Responses

{
  "vehicleId": 0,
  "vehicleIdTag": "vehicleIdTag",
  "batteryCapacityKwh": 0,
  "chargeIntent": {
    "type": "PRICE_OPTIMIZE",
    "departureTime": "departureTime",
    "target": {
      "soc": 0,
      "kwh": 0
    },
    "scheduleOverrides": [
      {
        "id": "id",
        "startDay": "MONDAY",
        "startTime": "startTime",
        "endDay": "MONDAY",
        "endTime": "endTime",
        "type": "PRICE_OPTIMIZE",
        "departureDay": "MONDAY",
        "departureTime": "departureTime",
        "target": {
          "soc": 0,
          "kwh": 0
        }
      }
    ],
    "priority": 0
  },
  "integrationCapacityKwh": 0,
  "maxKwAc": 0,
  "maxKwDc": 0
}

json

application/json

Delete a vehicle ID intent

DELETE

https://partner-api.monta.com

/api/v1/energy/sites/{siteId}/vehicles/{vehicleIdTag}

Required scope: energy:delete

🚧 BETA — This endpoint is currently in the BETA phase and its response structure may change in the future.

Delete a vehicle ID intent › path Parameters

siteId

integer · int64 · required

vehicleIdTag

string · required

Delete a vehicle ID intent › Responses

deleteVehicleIdIntent 204 response

No data returned

Energy Change Log Energy Monitoring