Installer Jobs

Retrieve a list of installer jobs

GET

https://partner-api.monta.com

/api/v1/installer-jobs

Required scope: installer-jobs:read

Retrieve a list of installer jobs › query Parameters

page

integer · int32

page number to retrieve (starts with 0)

Default: 0

perPage

integer · int32

number of items per page (between 1 and 100, default 10)

Default: 10

from

string · date

Filter installer jobs created on or after this date (YYYY-MM-DD)

to

string · date

Filter installer jobs created on or before this date (YYYY-MM-DD)

siteId

integer | null · int64

Allows to filter list of installer jobs by a site id

Example: 13

teamId

integer | null · int64

Allows to filter list of installer jobs by a team id.

Example: 19

includeDeleted

boolean | null

If true, deleted installer jobs will be included in the response.

Example: true

Retrieve a list of installer jobs › Responses

List of installer jobs that match the criteria

OffsetBasedResponse_30

InstallerJob[] · required

MontaPage.Meta · required

GET/api/v1/installer-jobs

curl https://partner-api.monta.com/api/v1/installer-jobs \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "data": [
    {
      "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": 5,
      "chargePointActiveCount": 3,
      "email": "installer@acme.org",
      "tasks": [
        {
          "id": 42,
          "installerJobId": 5,
          "chargePointId": 21,
          "serialNumber": "1",
          "connector": 1,
          "note": "1",
          "installerNote": "1",
          "activeAt": "2022-05-12T15:56:45.99Z",
          "createdAt": "2022-05-12T15:56:45.99Z",
          "updatedAt": "2022-05-12T15:56:45.99Z",
          "deletedAt": "2022-05-12T15:56:45.99Z"
        }
      ],
      "completedAt": "2022-05-12T15:56:45.99Z",
      "createdAt": "2022-05-12T15:56:45.99Z",
      "updatedAt": "2022-05-12T15:56:45.99Z",
      "deletedAt": "2022-05-12T15:56:45.99Z"
    }
  ],
  "meta": {
    "itemCount": 0,
    "currentPage": 0,
    "perPage": 0,
    "totalPageCount": 0,
    "totalItemCount": 0
  }
}

json

application/json

Create an installer job

POST

https://partner-api.monta.com

/api/v1/installer-jobs

Create an installer job for a charge point site.
Required scope: installer-jobs:write

Create an installer job › Request Body

CreateInstallerJobDto

siteId

integer · int64 · required

Site id of the site where the installer job will be created.

Example: 13

description

string | null

A description of the installer job, visible for the installer.

Example: You will find the site in Parking Lot 2A. You can contact the site manager at 123456789.

email

string | null

The email of the installer. If provided, an email will be sent to the installerwith the description of the installer job.

Example: installer@acme.com

Create an installer job › Responses

Installer job created

InstallerJob

object · required

The operator of this installer job

publicLink

string · required

Public link of this installer job, shareable with the installer

Example: https://app.monta.app/installer-page/149ffbb6-7b69-47a1-9698-90177c2027da

InstallerJobTask[] · required

List of tasks of this installer job

createdAt

string · date-time · required

Date this installer job was created

Example: 2022-05-12T15:56:45.99Z

id

integer · int64

Id of this installer job

Example: 42

siteId

integer · int64

Id of the site related to this installer job

Example: 22

teamId

integer · int64

Id of the team of this installer job

Example: 4124

description

string | null

Description of this installer job, will be visible to the installer

Example: 5

chargePointCount

integer · int32

Number of charge points included in this installer job

Example: 5

chargePointActiveCount

integer · int32

Number of active (finished) charge points in this installer job

Example: 3

email

string | null

Email of the installer assigned to this job.

Example: installer@acme.org

completedAt

string | null · date-time

Date this installer job was completed

Example: 2022-05-12T15:56:45.99Z

updatedAt

string | null · date-time

Date this installer job was updated

Example: 2022-05-12T15:56:45.99Z

deletedAt

string | null · date-time

Date this installer job was deleted

Example: 2022-05-12T15:56:45.99Z

POST/api/v1/installer-jobs

curl https://partner-api.monta.com/api/v1/installer-jobs \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "siteId": 13,
  "description": "You will find the site in Parking Lot 2A. You can contact the site manager at 123456789.",
  "email": "installer@acme.com"
}'

Example Request Body

{
  "siteId": 13,
  "description": "You will find the site in Parking Lot 2A. You can contact the site manager at 123456789.",
  "email": "installer@acme.com"
}

json

Example Responses

{
  "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": 5,
  "chargePointActiveCount": 3,
  "email": "installer@acme.org",
  "tasks": [
    {
      "id": 42,
      "installerJobId": 5,
      "chargePointId": 21,
      "serialNumber": "1",
      "connector": 1,
      "note": "1",
      "installerNote": "1",
      "activeAt": "2022-05-12T15:56:45.99Z",
      "createdAt": "2022-05-12T15:56:45.99Z",
      "updatedAt": "2022-05-12T15:56:45.99Z",
      "deletedAt": "2022-05-12T15:56:45.99Z"
    }
  ],
  "completedAt": "2022-05-12T15:56:45.99Z",
  "createdAt": "2022-05-12T15:56:45.99Z",
  "updatedAt": "2022-05-12T15:56:45.99Z",
  "deletedAt": "2022-05-12T15:56:45.99Z"
}

json

application/json

Retrieve a single installer job

GET

https://partner-api.monta.com

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

Required scope: installer-jobs:read

Retrieve a single installer job › path Parameters

installerJobId

integer · int64 · required

Retrieve a single installer job › Responses

Installer job with provided id

InstallerJob

object · required

The operator of this installer job

publicLink

string · required

Public link of this installer job, shareable with the installer

Example: https://app.monta.app/installer-page/149ffbb6-7b69-47a1-9698-90177c2027da

InstallerJobTask[] · required

List of tasks of this installer job

createdAt

string · date-time · required

Date this installer job was created

Example: 2022-05-12T15:56:45.99Z

id

integer · int64

Id of this installer job

Example: 42

siteId

integer · int64

Id of the site related to this installer job

Example: 22

teamId

integer · int64

Id of the team of this installer job

Example: 4124

description

string | null

Description of this installer job, will be visible to the installer

Example: 5

chargePointCount

integer · int32

Number of charge points included in this installer job

Example: 5

chargePointActiveCount

integer · int32

Number of active (finished) charge points in this installer job

Example: 3

email

string | null

Email of the installer assigned to this job.

Example: installer@acme.org

completedAt

string | null · date-time

Date this installer job was completed

Example: 2022-05-12T15:56:45.99Z

updatedAt

string | null · date-time

Date this installer job was updated

Example: 2022-05-12T15:56:45.99Z

deletedAt

string | null · date-time

Date this installer job was deleted

Example: 2022-05-12T15:56:45.99Z

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

curl https://partner-api.monta.com/api/v1/installer-jobs/:installerJobId \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "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": 5,
  "chargePointActiveCount": 3,
  "email": "installer@acme.org",
  "tasks": [
    {
      "id": 42,
      "installerJobId": 5,
      "chargePointId": 21,
      "serialNumber": "1",
      "connector": 1,
      "note": "1",
      "installerNote": "1",
      "activeAt": "2022-05-12T15:56:45.99Z",
      "createdAt": "2022-05-12T15:56:45.99Z",
      "updatedAt": "2022-05-12T15:56:45.99Z",
      "deletedAt": "2022-05-12T15:56:45.99Z"
    }
  ],
  "completedAt": "2022-05-12T15:56:45.99Z",
  "createdAt": "2022-05-12T15:56:45.99Z",
  "updatedAt": "2022-05-12T15:56:45.99Z",
  "deletedAt": "2022-05-12T15:56:45.99Z"
}

json

application/json

Delete an existing installer job

DELETE

https://partner-api.monta.com

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

Required scope: installer-jobs:delete

Delete an existing installer job › path Parameters

installerJobId

integer · int64 · required

Delete an existing installer job › Responses

Installer Job deleted

No data returned

Archive an installer job

POST

https://partner-api.monta.com

/api/v1/installer-jobs/{installerJobId}/archive

Archive an installer job. Archiving is idempotent: re-archiving an already archived job leaves it unchanged.
Required scope: installer-jobs:write

Archive an installer job › path Parameters

installerJobId

integer · int64 · required

Archive an installer job › Responses

The archived installer job

InstallerJob

object · required

The operator of this installer job

publicLink

string · required

Public link of this installer job, shareable with the installer

Example: https://app.monta.app/installer-page/149ffbb6-7b69-47a1-9698-90177c2027da

InstallerJobTask[] · required

List of tasks of this installer job

createdAt

string · date-time · required

Date this installer job was created

Example: 2022-05-12T15:56:45.99Z

id

integer · int64

Id of this installer job

Example: 42

siteId

integer · int64

Id of the site related to this installer job

Example: 22

teamId

integer · int64

Id of the team of this installer job

Example: 4124

description

string | null

Description of this installer job, will be visible to the installer

Example: 5

chargePointCount

integer · int32

Number of charge points included in this installer job

Example: 5

chargePointActiveCount

integer · int32

Number of active (finished) charge points in this installer job

Example: 3

email

string | null

Email of the installer assigned to this job.

Example: installer@acme.org

completedAt

string | null · date-time

Date this installer job was completed

Example: 2022-05-12T15:56:45.99Z

updatedAt

string | null · date-time

Date this installer job was updated

Example: 2022-05-12T15:56:45.99Z

deletedAt

string | null · date-time

Date this installer job was deleted

Example: 2022-05-12T15:56:45.99Z

POST/api/v1/installer-jobs/{installerJobId}/archive

curl https://partner-api.monta.com/api/v1/installer-jobs/:installerJobId/archive \
  --request POST \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "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": 5,
  "chargePointActiveCount": 3,
  "email": "installer@acme.org",
  "tasks": [
    {
      "id": 42,
      "installerJobId": 5,
      "chargePointId": 21,
      "serialNumber": "1",
      "connector": 1,
      "note": "1",
      "installerNote": "1",
      "activeAt": "2022-05-12T15:56:45.99Z",
      "createdAt": "2022-05-12T15:56:45.99Z",
      "updatedAt": "2022-05-12T15:56:45.99Z",
      "deletedAt": "2022-05-12T15:56:45.99Z"
    }
  ],
  "completedAt": "2022-05-12T15:56:45.99Z",
  "createdAt": "2022-05-12T15:56:45.99Z",
  "updatedAt": "2022-05-12T15:56:45.99Z",
  "deletedAt": "2022-05-12T15:56:45.99Z"
}

json

application/json

Retrieve the charge points of an installer job

GET

https://partner-api.monta.com

/api/v1/installer-jobs/{installerJobId}/charge-points

Required scope: installer-jobs:read

Retrieve the charge points of an installer job › path Parameters

installerJobId

integer · int64 · required

Retrieve the charge points of an installer job › query Parameters

page

integer · int32

page number to retrieve (starts with 0)

Default: 0

perPage

integer · int32

number of items per page (between 1 and 100, default 10)

Default: 10

Retrieve the charge points of an installer job › Responses

List of charge points belonging to the installer job

OffsetBasedResponse_31

InstallerJobTask[] · required

MontaPage.Meta · required

GET/api/v1/installer-jobs/{installerJobId}/charge-points

curl https://partner-api.monta.com/api/v1/installer-jobs/:installerJobId/charge-points \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "data": [
    {
      "id": 42,
      "installerJobId": 5,
      "chargePointId": 21,
      "serialNumber": "1",
      "connector": 1,
      "note": "1",
      "installerNote": "1",
      "activeAt": "2022-05-12T15:56:45.99Z",
      "createdAt": "2022-05-12T15:56:45.99Z",
      "updatedAt": "2022-05-12T15:56:45.99Z",
      "deletedAt": "2022-05-12T15:56:45.99Z"
    }
  ],
  "meta": {
    "itemCount": 0,
    "currentPage": 0,
    "perPage": 0,
    "totalPageCount": 0,
    "totalItemCount": 0
  }
}

json

application/json

Update an installer job charge point

PATCH

https://partner-api.monta.com

/api/v1/installer-jobs/{installerJobId}/charge-points/{chargePointId}

Update a charge point of an installer job. Provide exactly one of: serialNumber (optionally with connector), note, or isActive.
Required scope: installer-jobs:write

Update an installer job charge point › path Parameters

installerJobId

integer · int64 · required

chargePointId

integer · int64 · required

Update an installer job charge point › Request Body

UpdateInstallerJobChargePointDto

serialNumber

string | null

Serial number to set on the charge point. Mutually exclusive with note and isActive.

Example: SN-1234

connector

integer | null · int32

Connector id to set on the charge point. Mutually exclusive with note and isActive.

Example: 1

note

string | null

Operator note for the charge point. Mutually exclusive with serialNumber, connector and isActive.

Example: Mounted on the north wall

isActive

boolean | null

Activate or deactivate the charge point. Mutually exclusive with serialNumber, connector and note.

Example: true

Update an installer job charge point › Responses

Installer job charge point updated

InstallerJobTask

createdAt

string · date-time · required

Creation date of this installer job task

Example: 2022-05-12T15:56:45.99Z

id

integer · int64

Id of this installer job task

Example: 42

installerJobId

integer · int64

Id of the installer job of this installer job task

Example: 5

chargePointId

integer · int64

Id of the charge point to install

Example: 21

serialNumber

string | null

Serial number of the charge point to install

Example: 1

connector

integer · int32

Connector ID of the charge point to install

Example: 1

note

string | null

Note of this installer job task, will be visible to the installer

Example: 1

installerNote

string | null

Note provided by installer during this installer job task

Example: 1

activeAt

string | null · date-time

Date this installer job task was active

Example: 2022-05-12T15:56:45.99Z

updatedAt

string | null · date-time

Date this installer job task was last updated

Example: 2022-05-12T15:56:45.99Z

deletedAt

string | null · date-time

Date this installer job task was deleted

Example: 2022-05-12T15:56:45.99Z

PATCH/api/v1/installer-jobs/{installerJobId}/charge-points/{chargePointId}

curl https://partner-api.monta.com/api/v1/installer-jobs/:installerJobId/charge-points/:chargePointId \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "serialNumber": "SN-1234",
  "connector": 1,
  "note": "Mounted on the north wall",
  "isActive": true
}'

Example Request Body

{
  "serialNumber": "SN-1234",
  "connector": 1,
  "note": "Mounted on the north wall",
  "isActive": true
}

json

Example Responses

{
  "id": 42,
  "installerJobId": 5,
  "chargePointId": 21,
  "serialNumber": "1",
  "connector": 1,
  "note": "1",
  "installerNote": "1",
  "activeAt": "2022-05-12T15:56:45.99Z",
  "createdAt": "2022-05-12T15:56:45.99Z",
  "updatedAt": "2022-05-12T15:56:45.99Z",
  "deletedAt": "2022-05-12T15:56:45.99Z"
}

json

application/json

Mark an installer job as complete

POST

https://partner-api.monta.com

/api/v1/installer-jobs/{installerJobId}/mark-complete

Mark an installer job as complete. Activates the site's charge points when the job is configured to do so.
Required scope: installer-jobs:write

Mark an installer job as complete › path Parameters

installerJobId

integer · int64 · required

Mark an installer job as complete › Responses

Installer job marked as complete

InstallerJob

object · required

The operator of this installer job

publicLink

string · required

Public link of this installer job, shareable with the installer

Example: https://app.monta.app/installer-page/149ffbb6-7b69-47a1-9698-90177c2027da

InstallerJobTask[] · required

List of tasks of this installer job

createdAt

string · date-time · required

Date this installer job was created

Example: 2022-05-12T15:56:45.99Z

id

integer · int64

Id of this installer job

Example: 42

siteId

integer · int64

Id of the site related to this installer job

Example: 22

teamId

integer · int64

Id of the team of this installer job

Example: 4124

description

string | null

Description of this installer job, will be visible to the installer

Example: 5

chargePointCount

integer · int32

Number of charge points included in this installer job

Example: 5

chargePointActiveCount

integer · int32

Number of active (finished) charge points in this installer job

Example: 3

email

string | null

Email of the installer assigned to this job.

Example: installer@acme.org

completedAt

string | null · date-time

Date this installer job was completed

Example: 2022-05-12T15:56:45.99Z

updatedAt

string | null · date-time

Date this installer job was updated

Example: 2022-05-12T15:56:45.99Z

deletedAt

string | null · date-time

Date this installer job was deleted

Example: 2022-05-12T15:56:45.99Z

POST/api/v1/installer-jobs/{installerJobId}/mark-complete

curl https://partner-api.monta.com/api/v1/installer-jobs/:installerJobId/mark-complete \
  --request POST \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "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": 5,
  "chargePointActiveCount": 3,
  "email": "installer@acme.org",
  "tasks": [
    {
      "id": 42,
      "installerJobId": 5,
      "chargePointId": 21,
      "serialNumber": "1",
      "connector": 1,
      "note": "1",
      "installerNote": "1",
      "activeAt": "2022-05-12T15:56:45.99Z",
      "createdAt": "2022-05-12T15:56:45.99Z",
      "updatedAt": "2022-05-12T15:56:45.99Z",
      "deletedAt": "2022-05-12T15:56:45.99Z"
    }
  ],
  "completedAt": "2022-05-12T15:56:45.99Z",
  "createdAt": "2022-05-12T15:56:45.99Z",
  "updatedAt": "2022-05-12T15:56:45.99Z",
  "deletedAt": "2022-05-12T15:56:45.99Z"
}

json

application/json

Insights Invoices