Team Member Profiles (Member Groups)

Retrieve a list of team member profiles (member groups)

GET

https://partner-api.monta.com

/api/v1/team-member-profiles

Required scope: team-members:read
Organization authorization: supported

Retrieve a list of team member profiles (member groups) › 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

teamId

integer | null · int64

Filter team member profiles by teamId

Example: 1

name

string | null

Filter team member profiles by the specified name

Example: expired

Retrieve a list of team member profiles (member groups) › Responses

List of team member profiles (Member group) that match the criteria

OffsetBasedResponse_63

TeamMemberProfile[] · required

MontaPage.Meta · required

GET/api/v1/team-member-profiles

curl https://partner-api.monta.com/api/v1/team-member-profiles \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "data": [
    {
      "id": 1,
      "teamId": 42,
      "name": "Example profile 1",
      "description": "description",
      "role": "admin",
      "priceGroupId": 1,
      "costGroupId": 1,
      "canPayWithTeamWallet": false,
      "canManageTeamWallet": false,
      "canDepositToWallet": true,
      "canWithdrawFromWallet": true,
      "canManageChargeKeys": true,
      "canRequestSponsoring": false,
      "canManageTeamMembers": false,
      "canConfigureChargePoints": false,
      "teamWalletChargePaymentType": "none",
      "canPayForChargesCountryIds": [
        1,
        2,
        3
      ],
      "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",
      "kwhPriceCapAc": 2.5,
      "kwhPriceCapDc": 5,
      "sponsoredPriceGroupId": 1,
      "autoApproveElectricityCost": false,
      "reimbursementEnabled": false,
      "reimbursementPayoutSchedule": "end-of-month",
      "reimbursementSubscription": false
    }
  ],
  "meta": {
    "itemCount": 0,
    "currentPage": 0,
    "perPage": 0,
    "totalPageCount": 0,
    "totalItemCount": 0
  }
}

json

application/json

Create a team member profile (member group)

POST

https://partner-api.monta.com

/api/v1/team-member-profiles

Create a team member profile so that it can be applied on a team

Required scope: team-members:write
Organization authorization: supported

Create a team member profile (member group) › Request Body

CreateTeamMemberProfile

name

string · required

The team member profile name

Example: Example profile 1

description

string · required

The team member profile description

Example: Example profile 1

role

string · enum · required

Role for team member profile

Enum values:

admin

user

other

Example: admin

teamWalletChargePaymentType

TeamWalletChargePaymentType · enum · required

On which chargers is the team member allowed to pay with Team Wallet?

* all - On any charger (including roaming chargers)
* partner - On chargers with the same partner as this team
* operator - On chargers with the same operator as this team
* team - On chargers belonging to this team
* team_and_parent - Own and parent account's chargers; no public or roaming
* selected_operators - On chargers from selected operators
* none - The team member is not allowed to pay with Team Wallet for any charge session

Enum values:

partner

operator

all

team

team_and_parent

selected_operators

none

Example: none

Default: none

canPayForChargesCountryIds

integer[] · required

List of country ids for which the team member can pay for charges

Example: [1,2,3]

teamId

integer · int64

Id of the team

Example: 1

priceGroupId

integer | null · int64

The price group, when not provided the default team price group will be applied

Example: 1

costGroupId

integer | null · int64

The cost group

Example: 1

canConfigureChargePoints

boolean

Allows the team applying member profile to configure charge points

Example: false

Default: false

canPayWithTeamWallet

boolean

Gives the team member applying this profile access to pay with the team wallet in the Monta shop (e.g. charge keys, stickers). Team wallet payment for charging sessions is controlled by teamWalletChargePaymentType

Example: false

Default: false

canRequestSponsoring

boolean

Allows the team applying member profile to request sponsoring from this team for their charge point

Example: false

Default: false

canManageTeamMembers

boolean

Allows the team applying member profile to view and manage other members settings

Example: false

Default: false

canDepositToWallet

boolean | null

Gives the team member permission to deposit to the team wallet

canWithdrawFromWallet

boolean | null

Gives the team member permission to withdraw from the team wallet

canManageChargeKeys

boolean | null

Gives the team member permission to manage charge keys for the team

kwhPriceCapAc

number | null

Maximum price per kWh in the team currency that the team will cover when charging on AC.

Example: 2.5

kwhPriceCapDc

number | null

Maximum price per kWh in the team currency that the team will cover when charging on DC.

Example: 5

sponsoredPriceGroupId

integer | null · int64

Price group used to reimburse members in this profile for home charging. Omit or set null to use the employee's own cost price group (cloned at SCP creation time).

Example: 1

autoApproveElectricityCost

boolean

When true, employee-submitted electricity costs are auto-approved for SCPs created for members in this profile.

Example: false

Default: false

reimbursementEnabled

boolean

Master switch — whether members in this profile participate in home reimbursement.

Example: false

Default: false

reimbursementPayoutSchedule

string · enum

Default payout schedule applied to sponsored charge points created for members in this profile.

Enum values:

end-of-month

realtime

other

Example: end-of-month

reimbursementSubscription

boolean

Whether the operator reimburses the charge-point subscription price.

Example: false

Default: false

Create a team member profile (member group) › Responses

Team member profile (Member group) created

TeamMemberProfile

id

integer · int64 · required

Id of the team member profile

Example: 1

name

string · required

The team member profile name

Example: Example profile 1

role

string · enum · required

Role of the this team member profile

Enum values:

admin

user

other

Example: admin

teamWalletChargePaymentType

TeamWalletChargePaymentType · enum · required

Enum values:

partner

operator

all

team

team_and_parent

selected_operators

none

Example: none

Default: none

teamId

integer · int64

Team id of team member profile

Example: 42

description

string | null

The team member profile description

Example: description

priceGroupId

integer | null · int64

The price group for this team member profile

Example: 1

costGroupId

integer | null · int64

The cost group for this team member profile

Example: 1

canPayWithTeamWallet

boolean

Indicates if the team member profile gives access to pay with the team wallet in the Monta shop (e.g. charge keys, stickers). Team wallet payment for charging sessions is controlled by teamWalletChargePaymentType

Example: false

Default: false

canManageTeamWallet

boolean

Indicates if team member profile has access to withdraw and deposit from your team wallet to your bank account

Example: false

Default: false

canDepositToWallet

boolean | null

Indicates if team member profile can deposit to team wallet

canWithdrawFromWallet

boolean | null

Indicates if team member profile can withdraw from team wallet

canManageChargeKeys

boolean | null

Indicates if team member profile can manage charge keys for the team

canRequestSponsoring

boolean

Indicates if the team member profile is allowed to request sponsoring from this team for their charge point

Example: false

Default: false

canManageTeamMembers

boolean

Indicates that the team member profile can view and manage other members settings

Example: false

Default: false

canConfigureChargePoints

boolean

Indicates that the team member profile can configure charge points

Example: false

Default: false

canPayForChargesCountryIds

array | null

List of country ids for which the team member can pay for charges

Example: [1,2,3]

object

Operator of this team member

createdAt

string | null · date-time

Date the team member profile was created

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

updatedAt

string | null · date-time

Date the team member profile was updated

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

deletedAt

string | null · date-time

Date the team member profile was deleted

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

kwhPriceCapAc

number | null

Maximum price per kWh in the team currency that the team will cover when charging on AC.

Example: 2.5

kwhPriceCapDc

number | null

Maximum price per kWh in the team currency that the team will cover when charging on DC.

Example: 5

sponsoredPriceGroupId

integer | null · int64

Price group used to reimburse members in this profile for home charging. null means the employee's own cost price group is cloned at SCP creation time.

Example: 1

autoApproveElectricityCost

boolean

When true, employee-submitted electricity costs are auto-approved for SCPs created for members in this profile.

Example: false

Default: false

reimbursementEnabled

boolean

Master switch — whether members in this profile participate in home reimbursement.

Example: false

Default: false

reimbursementPayoutSchedule

string · enum

Default payout schedule applied to sponsored charge points created for members in this profile.

Enum values:

end-of-month

realtime

other

Example: end-of-month

reimbursementSubscription

boolean

Whether the operator reimburses the charge-point subscription price for members in this profile.

Example: false

Default: false

POST/api/v1/team-member-profiles

curl https://partner-api.monta.com/api/v1/team-member-profiles \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "teamId": 1,
  "name": "Example profile 1",
  "description": "Example profile 1",
  "role": "admin",
  "priceGroupId": 1,
  "costGroupId": 1,
  "canConfigureChargePoints": false,
  "canPayWithTeamWallet": false,
  "canRequestSponsoring": false,
  "canManageTeamMembers": false,
  "teamWalletChargePaymentType": "none",
  "canManageTeamWallet": false,
  "canDepositToWallet": true,
  "canWithdrawFromWallet": true,
  "canManageChargeKeys": true,
  "canPayForChargesCountryIds": [
    1,
    2,
    3
  ],
  "kwhPriceCapAc": 2.5,
  "kwhPriceCapDc": 5,
  "sponsoredPriceGroupId": 1,
  "autoApproveElectricityCost": false,
  "reimbursementEnabled": false,
  "reimbursementPayoutSchedule": "end-of-month",
  "reimbursementSubscription": false
}'

Example Request Body

{
  "teamId": 1,
  "name": "Example profile 1",
  "description": "Example profile 1",
  "role": "admin",
  "priceGroupId": 1,
  "costGroupId": 1,
  "canConfigureChargePoints": false,
  "canPayWithTeamWallet": false,
  "canRequestSponsoring": false,
  "canManageTeamMembers": false,
  "teamWalletChargePaymentType": "none",
  "canManageTeamWallet": false,
  "canDepositToWallet": true,
  "canWithdrawFromWallet": true,
  "canManageChargeKeys": true,
  "canPayForChargesCountryIds": [
    1,
    2,
    3
  ],
  "kwhPriceCapAc": 2.5,
  "kwhPriceCapDc": 5,
  "sponsoredPriceGroupId": 1,
  "autoApproveElectricityCost": false,
  "reimbursementEnabled": false,
  "reimbursementPayoutSchedule": "end-of-month",
  "reimbursementSubscription": false
}

json

Example Responses

{
  "id": 1,
  "teamId": 42,
  "name": "Example profile 1",
  "description": "description",
  "role": "admin",
  "priceGroupId": 1,
  "costGroupId": 1,
  "canPayWithTeamWallet": false,
  "canManageTeamWallet": false,
  "canDepositToWallet": true,
  "canWithdrawFromWallet": true,
  "canManageChargeKeys": true,
  "canRequestSponsoring": false,
  "canManageTeamMembers": false,
  "canConfigureChargePoints": false,
  "teamWalletChargePaymentType": "none",
  "canPayForChargesCountryIds": [
    1,
    2,
    3
  ],
  "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",
  "kwhPriceCapAc": 2.5,
  "kwhPriceCapDc": 5,
  "sponsoredPriceGroupId": 1,
  "autoApproveElectricityCost": false,
  "reimbursementEnabled": false,
  "reimbursementPayoutSchedule": "end-of-month",
  "reimbursementSubscription": false
}

json

application/json

Retrieve a team member profile (member group) by id

GET

https://partner-api.monta.com

/api/v1/team-member-profiles/{id}

Required scope: team-members:read
Organization authorization: supported

Retrieve a team member profile (member group) by id › path Parameters

id

integer · int64 · required

Retrieve a team member profile (member group) by id › Responses

Team member profile (Member group) with provided id

TeamMemberProfile

id

integer · int64 · required

Id of the team member profile

Example: 1

name

string · required

The team member profile name

Example: Example profile 1

role

string · enum · required

Role of the this team member profile

Enum values:

admin

user

other

Example: admin

teamWalletChargePaymentType

TeamWalletChargePaymentType · enum · required

Enum values:

partner

operator

all

team

team_and_parent

selected_operators

none

Example: none

Default: none

teamId

integer · int64

Team id of team member profile

Example: 42

description

string | null

The team member profile description

Example: description

priceGroupId

integer | null · int64

The price group for this team member profile

Example: 1

costGroupId

integer | null · int64

The cost group for this team member profile

Example: 1

canPayWithTeamWallet

boolean

Example: false

Default: false

canManageTeamWallet

boolean

Indicates if team member profile has access to withdraw and deposit from your team wallet to your bank account

Example: false

Default: false

canDepositToWallet

boolean | null

Indicates if team member profile can deposit to team wallet

canWithdrawFromWallet

boolean | null

Indicates if team member profile can withdraw from team wallet

canManageChargeKeys

boolean | null

Indicates if team member profile can manage charge keys for the team

canRequestSponsoring

boolean

Indicates if the team member profile is allowed to request sponsoring from this team for their charge point

Example: false

Default: false

canManageTeamMembers

boolean

Indicates that the team member profile can view and manage other members settings

Example: false

Default: false

canConfigureChargePoints

boolean

Indicates that the team member profile can configure charge points

Example: false

Default: false

canPayForChargesCountryIds

array | null

List of country ids for which the team member can pay for charges

Example: [1,2,3]

object

Operator of this team member

createdAt

string | null · date-time

Date the team member profile was created

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

updatedAt

string | null · date-time

Date the team member profile was updated

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

deletedAt

string | null · date-time

Date the team member profile was deleted

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

kwhPriceCapAc

number | null

Maximum price per kWh in the team currency that the team will cover when charging on AC.

Example: 2.5

kwhPriceCapDc

number | null

Maximum price per kWh in the team currency that the team will cover when charging on DC.

Example: 5

sponsoredPriceGroupId

integer | null · int64

Price group used to reimburse members in this profile for home charging. null means the employee's own cost price group is cloned at SCP creation time.

Example: 1

autoApproveElectricityCost

boolean

When true, employee-submitted electricity costs are auto-approved for SCPs created for members in this profile.

Example: false

Default: false

reimbursementEnabled

boolean

Master switch — whether members in this profile participate in home reimbursement.

Example: false

Default: false

reimbursementPayoutSchedule

string · enum

Default payout schedule applied to sponsored charge points created for members in this profile.

Enum values:

end-of-month

realtime

other

Example: end-of-month

reimbursementSubscription

boolean

Whether the operator reimburses the charge-point subscription price for members in this profile.

Example: false

Default: false

GET/api/v1/team-member-profiles/{id}

curl https://partner-api.monta.com/api/v1/team-member-profiles/:id \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "id": 1,
  "teamId": 42,
  "name": "Example profile 1",
  "description": "description",
  "role": "admin",
  "priceGroupId": 1,
  "costGroupId": 1,
  "canPayWithTeamWallet": false,
  "canManageTeamWallet": false,
  "canDepositToWallet": true,
  "canWithdrawFromWallet": true,
  "canManageChargeKeys": true,
  "canRequestSponsoring": false,
  "canManageTeamMembers": false,
  "canConfigureChargePoints": false,
  "teamWalletChargePaymentType": "none",
  "canPayForChargesCountryIds": [
    1,
    2,
    3
  ],
  "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",
  "kwhPriceCapAc": 2.5,
  "kwhPriceCapDc": 5,
  "sponsoredPriceGroupId": 1,
  "autoApproveElectricityCost": false,
  "reimbursementEnabled": false,
  "reimbursementPayoutSchedule": "end-of-month",
  "reimbursementSubscription": false
}

json

application/json

Patch a team member profile (member group)

PATCH

https://partner-api.monta.com

/api/v1/team-member-profiles/{id}

Required scope: team-members:write
Organization authorization: supported

Patch a team member profile (member group) › path Parameters

id

integer · int64 · required

Patch a team member profile (member group) › Request Body

PatchTeamMemberProfile

name

string | null

Name for the team member profile

Example: seasonal offer

description

string | null

Description for the team member profile

Example: detail description

role

string | null · enum

Role for the team member profile

Enum values:

admin

user

other

Example: admin

priceGroupId

integer | null · int64

The price group for the team member profile

Example: 1

costGroupId

integer | null · int64

The cost group for the team member profile

Example: 1

canPayWithTeamWallet

boolean | null

Example: false

Default: false

canDepositToWallet

boolean | null

Gives the team member permission to deposit to the team wallet

canWithdrawFromWallet

boolean | null

Gives the team member permission to withdraw from the team wallet

canManageChargeKeys

boolean | null

Gives the team member permission to manage charge keys for the team

canRequestSponsoring

boolean | null

Allows the team member to request sponsoring from this team for their charge point

Example: false

Default: false

canManageTeamMembers

boolean | null

Allows the team member to view and manage other members settings

Example: false

Default: false

teamWalletChargePaymentType

string · enum

Enum values:

partner

operator

all

team

team_and_parent

selected_operators

none

Example: none

Default: none

canConfigureChargePoints

boolean | null

Allows the team member profile to configure charge points

Example: false

Default: false

canPayForChargesCountryIds

array | null

List of country ids for which the team member can pay for charges

Example: [1,2,3]

kwhPriceCapAc

number | null

Maximum price per kWh in the team currency that the team will cover when charging on AC.

Example: 2.5

kwhPriceCapDc

number | null

Maximum price per kWh in the team currency that the team will cover when charging on DC.

Example: 5

sponsoredPriceGroupId

integer | null · int64

Price group used to reimburse members in this profile for home charging. Send null to clear and fall back to the employee's own cost price group; omit to leave unchanged.

Example: 1

autoApproveElectricityCost

boolean | null

When true, employee-submitted electricity costs are auto-approved for SCPs created for members in this profile.

Example: false

reimbursementEnabled

boolean | null

Master switch — whether members in this profile participate in home reimbursement.

Example: false

reimbursementPayoutSchedule

string · enum

Default payout schedule applied to sponsored charge points created for members in this profile.

Enum values:

end-of-month

realtime

other

Example: end-of-month

reimbursementSubscription

boolean | null

Whether the operator reimburses the charge-point subscription price.

Example: false

costCenterId

integer | null · int32

The cost center id to assign to the team member profile.
Note: Send null to clear the assignment; omit the field to leave it unchanged.

Example: 1

Patch a team member profile (member group) › Responses

Updated team member profile (Member group) with provided id

TeamMemberProfile

id

integer · int64 · required

Id of the team member profile

Example: 1

name

string · required

The team member profile name

Example: Example profile 1

role

string · enum · required

Role of the this team member profile

Enum values:

admin

user

other

Example: admin

teamWalletChargePaymentType

TeamWalletChargePaymentType · enum · required

Enum values:

partner

operator

all

team

team_and_parent

selected_operators

none

Example: none

Default: none

teamId

integer · int64

Team id of team member profile

Example: 42

description

string | null

The team member profile description

Example: description

priceGroupId

integer | null · int64

The price group for this team member profile

Example: 1

costGroupId

integer | null · int64

The cost group for this team member profile

Example: 1

canPayWithTeamWallet

boolean

Example: false

Default: false

canManageTeamWallet

boolean

Indicates if team member profile has access to withdraw and deposit from your team wallet to your bank account

Example: false

Default: false

canDepositToWallet

boolean | null

Indicates if team member profile can deposit to team wallet

canWithdrawFromWallet

boolean | null

Indicates if team member profile can withdraw from team wallet

canManageChargeKeys

boolean | null

Indicates if team member profile can manage charge keys for the team

canRequestSponsoring

boolean

Indicates if the team member profile is allowed to request sponsoring from this team for their charge point

Example: false

Default: false

canManageTeamMembers

boolean

Indicates that the team member profile can view and manage other members settings

Example: false

Default: false

canConfigureChargePoints

boolean

Indicates that the team member profile can configure charge points

Example: false

Default: false

canPayForChargesCountryIds

array | null

List of country ids for which the team member can pay for charges

Example: [1,2,3]

object

Operator of this team member

createdAt

string | null · date-time

Date the team member profile was created

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

updatedAt

string | null · date-time

Date the team member profile was updated

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

deletedAt

string | null · date-time

Date the team member profile was deleted

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

kwhPriceCapAc

number | null

Maximum price per kWh in the team currency that the team will cover when charging on AC.

Example: 2.5

kwhPriceCapDc

number | null

Maximum price per kWh in the team currency that the team will cover when charging on DC.

Example: 5

sponsoredPriceGroupId

integer | null · int64

Price group used to reimburse members in this profile for home charging. null means the employee's own cost price group is cloned at SCP creation time.

Example: 1

autoApproveElectricityCost

boolean

When true, employee-submitted electricity costs are auto-approved for SCPs created for members in this profile.

Example: false

Default: false

reimbursementEnabled

boolean

Master switch — whether members in this profile participate in home reimbursement.

Example: false

Default: false

reimbursementPayoutSchedule

string · enum

Default payout schedule applied to sponsored charge points created for members in this profile.

Enum values:

end-of-month

realtime

other

Example: end-of-month

reimbursementSubscription

boolean

Whether the operator reimburses the charge-point subscription price for members in this profile.

Example: false

Default: false

PATCH/api/v1/team-member-profiles/{id}

curl https://partner-api.monta.com/api/v1/team-member-profiles/:id \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "name": "seasonal offer",
  "description": "detail description",
  "role": "admin",
  "priceGroupId": 1,
  "costGroupId": 1,
  "canPayWithTeamWallet": false,
  "canManageTeamWallet": true,
  "canDepositToWallet": true,
  "canWithdrawFromWallet": true,
  "canManageChargeKeys": true,
  "canRequestSponsoring": false,
  "canManageTeamMembers": false,
  "teamWalletChargePaymentType": "none",
  "canConfigureChargePoints": false,
  "canPayForChargesCountryIds": [
    1,
    2,
    3
  ],
  "kwhPriceCapAc": 2.5,
  "kwhPriceCapDc": 5,
  "sponsoredPriceGroupId": 1,
  "autoApproveElectricityCost": false,
  "reimbursementEnabled": false,
  "reimbursementPayoutSchedule": "end-of-month",
  "reimbursementSubscription": false,
  "costCenterId": 1
}'

Example Request Body

{
  "name": "seasonal offer",
  "description": "detail description",
  "role": "admin",
  "priceGroupId": 1,
  "costGroupId": 1,
  "canPayWithTeamWallet": false,
  "canManageTeamWallet": true,
  "canDepositToWallet": true,
  "canWithdrawFromWallet": true,
  "canManageChargeKeys": true,
  "canRequestSponsoring": false,
  "canManageTeamMembers": false,
  "teamWalletChargePaymentType": "none",
  "canConfigureChargePoints": false,
  "canPayForChargesCountryIds": [
    1,
    2,
    3
  ],
  "kwhPriceCapAc": 2.5,
  "kwhPriceCapDc": 5,
  "sponsoredPriceGroupId": 1,
  "autoApproveElectricityCost": false,
  "reimbursementEnabled": false,
  "reimbursementPayoutSchedule": "end-of-month",
  "reimbursementSubscription": false,
  "costCenterId": 1
}

json

Example Responses

{
  "id": 1,
  "teamId": 42,
  "name": "Example profile 1",
  "description": "description",
  "role": "admin",
  "priceGroupId": 1,
  "costGroupId": 1,
  "canPayWithTeamWallet": false,
  "canManageTeamWallet": false,
  "canDepositToWallet": true,
  "canWithdrawFromWallet": true,
  "canManageChargeKeys": true,
  "canRequestSponsoring": false,
  "canManageTeamMembers": false,
  "canConfigureChargePoints": false,
  "teamWalletChargePaymentType": "none",
  "canPayForChargesCountryIds": [
    1,
    2,
    3
  ],
  "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",
  "kwhPriceCapAc": 2.5,
  "kwhPriceCapDc": 5,
  "sponsoredPriceGroupId": 1,
  "autoApproveElectricityCost": false,
  "reimbursementEnabled": false,
  "reimbursementPayoutSchedule": "end-of-month",
  "reimbursementSubscription": false
}

json

application/json

Delete an existing team member profile (member group)

DELETE

https://partner-api.monta.com

/api/v1/team-member-profiles/{id}

Required scope: team-members:delete
Organization authorization: supported

Delete an existing team member profile (member group) › path Parameters

id

integer · int64 · required

Delete an existing team member profile (member group) › Responses

Team member profile (Member Group) deleted

No data returned

Update members in a team member profile (member group)

POST

https://partner-api.monta.com

/api/v1/team-member-profiles/{id}/members

Add or remove team members from a profile. Required scope: team-members:write
Organization authorization: supported

Update members in a team member profile (member group) › path Parameters

id

integer · int64 · required

Update members in a team member profile (member group) › Request Body

UpdateProfileMembersDto

action

UpdateProfileMembersAction · enum · required

Action to perform on team members in the profile
* add - Add team members to the profile
* remove - Remove team members from the profile

Enum values:

add

remove

Example: add

team_member_ids

array | null · maxItems: 500

Update members in a team member profile (member group) › Responses

Updated team member profile (Member group)

TeamMemberProfile

id

integer · int64 · required

Id of the team member profile

Example: 1

name

string · required

The team member profile name

Example: Example profile 1

role

string · enum · required

Role of the this team member profile

Enum values:

admin

user

other

Example: admin

teamWalletChargePaymentType

TeamWalletChargePaymentType · enum · required

Enum values:

partner

operator

all

team

team_and_parent

selected_operators

none

Example: none

Default: none

teamId

integer · int64

Team id of team member profile

Example: 42

description

string | null

The team member profile description

Example: description

priceGroupId

integer | null · int64

The price group for this team member profile

Example: 1

costGroupId

integer | null · int64

The cost group for this team member profile

Example: 1

canPayWithTeamWallet

boolean

Example: false

Default: false

canManageTeamWallet

boolean

Indicates if team member profile has access to withdraw and deposit from your team wallet to your bank account

Example: false

Default: false

canDepositToWallet

boolean | null

Indicates if team member profile can deposit to team wallet

canWithdrawFromWallet

boolean | null

Indicates if team member profile can withdraw from team wallet

canManageChargeKeys

boolean | null

Indicates if team member profile can manage charge keys for the team

canRequestSponsoring

boolean

Indicates if the team member profile is allowed to request sponsoring from this team for their charge point

Example: false

Default: false

canManageTeamMembers

boolean

Indicates that the team member profile can view and manage other members settings

Example: false

Default: false

canConfigureChargePoints

boolean

Indicates that the team member profile can configure charge points

Example: false

Default: false

canPayForChargesCountryIds

array | null

List of country ids for which the team member can pay for charges

Example: [1,2,3]

object

Operator of this team member

createdAt

string | null · date-time

Date the team member profile was created

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

updatedAt

string | null · date-time

Date the team member profile was updated

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

deletedAt

string | null · date-time

Date the team member profile was deleted

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

kwhPriceCapAc

number | null

Maximum price per kWh in the team currency that the team will cover when charging on AC.

Example: 2.5

kwhPriceCapDc

number | null

Maximum price per kWh in the team currency that the team will cover when charging on DC.

Example: 5

sponsoredPriceGroupId

integer | null · int64

Price group used to reimburse members in this profile for home charging. null means the employee's own cost price group is cloned at SCP creation time.

Example: 1

autoApproveElectricityCost

boolean

When true, employee-submitted electricity costs are auto-approved for SCPs created for members in this profile.

Example: false

Default: false

reimbursementEnabled

boolean

Master switch — whether members in this profile participate in home reimbursement.

Example: false

Default: false

reimbursementPayoutSchedule

string · enum

Default payout schedule applied to sponsored charge points created for members in this profile.

Enum values:

end-of-month

realtime

other

Example: end-of-month

reimbursementSubscription

boolean

Whether the operator reimburses the charge-point subscription price for members in this profile.

Example: false

Default: false

POST/api/v1/team-member-profiles/{id}/members

curl https://partner-api.monta.com/api/v1/team-member-profiles/:id/members \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "action": "add",
  "team_member_ids": [
    0
  ]
}'

Example Request Body

{
  "action": "add",
  "team_member_ids": [
    0
  ]
}

json

Example Responses

{
  "id": 1,
  "teamId": 42,
  "name": "Example profile 1",
  "description": "description",
  "role": "admin",
  "priceGroupId": 1,
  "costGroupId": 1,
  "canPayWithTeamWallet": false,
  "canManageTeamWallet": false,
  "canDepositToWallet": true,
  "canWithdrawFromWallet": true,
  "canManageChargeKeys": true,
  "canRequestSponsoring": false,
  "canManageTeamMembers": false,
  "canConfigureChargePoints": false,
  "teamWalletChargePaymentType": "none",
  "canPayForChargesCountryIds": [
    1,
    2,
    3
  ],
  "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",
  "kwhPriceCapAc": 2.5,
  "kwhPriceCapDc": 5,
  "sponsoredPriceGroupId": 1,
  "autoApproveElectricityCost": false,
  "reimbursementEnabled": false,
  "reimbursementPayoutSchedule": "end-of-month",
  "reimbursementSubscription": false
}

json

application/json

Team Member Fees Team Members