MOmonta
Team Member Profiles (Member Groups)

Create a team member profile (member group)

Changed on

Create a team member profile so that it can be applied on a team</br></br>Required scope: team-members:write </br>Organization authorization: supported

post/api/v1/team-member-profiles

Request

  • Base URL
    https://partner-api.monta.com
  • URL
    https://partner-api.monta.com/api/v1/team-member-profiles
  • Auth
    HTTP bearer

Request body

teamIdinteger

Id of the team

namestring required

The team member profile name

descriptionstring required

The team member profile description

role'admin' | 'user' | 'other' required
priceGroupIdinteger nullable

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

costGroupIdinteger nullable

The cost group

canConfigureChargePointsboolean

Allows the team applying member profile to configure charge points

canPayWithTeamWalletboolean

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

canRequestSponsoringboolean

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

canManageTeamMembersboolean

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

teamWalletChargePaymentType'partner' | 'operator' | 'all' | 'team' | 'team_and_parent' | 'selected_operators' | 'none' required

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

canManageTeamWalletboolean

Deprecated: use canDepositToWallet and canWithdrawFromWallet instead. When set to true, automatically grants both deposit and withdraw permissions.

canDepositToWalletboolean nullable

Gives the team member permission to deposit to the team wallet

canWithdrawFromWalletboolean nullable

Gives the team member permission to withdraw from the team wallet

canManageChargeKeysboolean nullable

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

canPayForChargesCountryIdsinteger[] required

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

kwhPriceCapAcnumber nullable

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

kwhPriceCapDcnumber nullable

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

sponsoredPriceGroupIdinteger nullable

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).

autoApproveElectricityCostboolean

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

reimbursementEnabledboolean

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

reimbursementPayoutSchedule'end-of-month' | 'realtime' | 'other'
reimbursementSubscriptionboolean

Whether the operator reimburses the charge-point subscription price.

Example request

{
  "teamId": 1,
  "name": "Example profile 1",
  "description": "Example profile 1",
  "priceGroupId": 1,
  "costGroupId": 1,
  "teamWalletChargePaymentType": "none",
  "canPayForChargesCountryIds": [
    1,
    2,
    3
  ],
  "kwhPriceCapAc": 2.5,
  "kwhPriceCapDc": 5,
  "sponsoredPriceGroupId": 1
}

Response

Team member profile (Member group) created

idinteger required

Id of the team member profile

teamIdinteger

Team id of team member profile

namestring required

The team member profile name

descriptionstring nullable

The team member profile description

role'admin' | 'user' | 'other' required
priceGroupIdinteger nullable

The price group for this team member profile

costGroupIdinteger nullable

The cost group for this team member profile

canPayWithTeamWalletboolean

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

canManageTeamWalletboolean

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

canDepositToWalletboolean nullable

Indicates if team member profile can deposit to team wallet

canWithdrawFromWalletboolean nullable

Indicates if team member profile can withdraw from team wallet

canManageChargeKeysboolean nullable

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

canRequestSponsoringboolean

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

canManageTeamMembersboolean

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

canConfigureChargePointsboolean

Indicates that the team member profile can configure charge points

teamWalletChargePaymentType'partner' | 'operator' | 'all' | 'team' | 'team_and_parent' | 'selected_operators' | 'none' required

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

canPayForChargesCountryIdsinteger[] nullable

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

createdAtstring date-time nullable

Date the team member profile was created

updatedAtstring date-time nullable

Date the team member profile was updated

deletedAtstring date-time nullable

Date the team member profile was deleted

kwhPriceCapAcnumber nullable

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

kwhPriceCapDcnumber nullable

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

sponsoredPriceGroupIdinteger nullable

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.

autoApproveElectricityCostboolean

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

reimbursementEnabledboolean

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

reimbursementPayoutSchedule'end-of-month' | 'realtime' | 'other'
reimbursementSubscriptionboolean

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

Example response

{
  "id": 1,
  "teamId": 42,
  "name": "Example profile 1",
  "description": "description",
  "priceGroupId": 1,
  "costGroupId": 1,
  "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
}

Changes

  • 0ca400461c52Revision changes
    • warning

      added the new team_and_parent enum value to the response property for the response status

    • info

      added the new team_and_parent enum value to the request property