Monta
Monta API
Monta API

Sponsored Charge Points

Retrieve a list of sponsored charge points

GET
https://partner-api.monta.com
/api/v1/sponsored-charge-points

Required scope: sponsored-charge-points:read
Organization authorization: supported

Retrieve a list of sponsored charge points › 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
chargePointId
​integer | null · int64

Allows to filter list of sponsored charge points by a charge point id

Example: 13
teamId
​integer | null · int64

Allows to filter list of sponsored charge points by a team id.

Example: 19
includeDeleted
​boolean

Filter to include deleted entities in the response

Example: false

Retrieve a list of sponsored charge points › Responses

List of sponsored charges points that match the criteria

OffsetBasedResponse_56
​SponsoredChargePoint[] · required
​MontaPage.Meta · required

Create a sponsored charge point

POST
https://partner-api.monta.com
/api/v1/sponsored-charge-points

Creates a sponsored charge point for a given user, the sponsorship is automatically approved.

Note: a charge point can only be sponsored to one user_id
Required scope: sponsored-charge-points:write
Organization authorization: supported

Create a sponsored charge point › Request Body

CreateSponsoredChargePointDto
payoutSchedule
​string · enum · required

The payout schedule for this sponsored charge point

Enum values:
end-of-month
realtime
other
Example: realtime
sponsoringTeamId
​integer · int64

Id of the team that is sponsoring this charge point

Example: 1
chargePointId
​integer · int64

Id of the charge point to be sponsored

Example: 1
userId
​integer · int64

Id of the user to have a charge point sponsored

Example: 1
priceGroupId
​integer | null · int64

The price group for this sponsorship, Only price groups of type reimbursement or sponsored are allowed

Note: if the priceGroupId is null the charge point cost price group will be used instead, if the charge point has no cost price group set the request will fail, please ensure that charge point has a valid cost group assigned when not providing a priceGroupId

Example: 1
payForSubscriptions
​boolean

Indicates that company pay for subscriptions

Example: false
Default: false
autoApproveElectricityCost
​boolean | null

When true, employee-submitted electricity costs on this sponsored charge point are auto-approved without manual review. When omitted, the value is inherited from the team member's (or team-member-profile's) auto_approve_electricity_cost setting.

Example: false
note
​string | null

Note for the sponsored charge point

Example: This is a note
sendEmailNotification
​boolean | null

Whether to email the charge point owner that their reimbursement is set up. Defaults to true. Set to false to suppress it, e.g. when migrating existing customers from another CPMS.

Default: true

Create a sponsored charge point › Responses

Sponsored charge point created

SponsoredChargePoint
payout
​string · enum · required

The payout frequency for this sponsored charge point

Enum values:
end-of-month
realtime
other
Example: realtime
​object · required

The charge point being sponsored

createdAt
​string · date-time · required

Creation date of this sponsored charge point

Example: 2022-05-12T15:56:45.99Z
updatedAt
​string · date-time · required

Date this sponsored charge point was last updated

Example: 2022-05-12T16:56:45.99Z
id
​integer · int64

Id of this sponsored charge point

Example: 1
teamId
​integer · int64

Id of the team of this sponsored charge point

Example: 1
note
​string | null

Note for the sponsored charge point

Example: This is a note
payForSubscriptions
​boolean

Indicates the company pays for the subscriptions

Example: true
autoApproveElectricityCost
​boolean

When true, employee-submitted electricity costs on this sponsored charge point are auto-approved without manual review.

Example: false
Default: false
​object

Operator of this sponsored charge point

acceptedAt
​string | null · date-time

Date the sponsorship was accepted

Example: 2022-05-12T16:56:45.99Z
deletedAt
​string | null · date-time

Date this sponsored charge point was deleted

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

Approve a sponsored charge point

POST
https://partner-api.monta.com
/api/v1/sponsored-charge-points/approve

Approves one or more pending sponsored charge points. Mirrors the internal Portal2 endpoint.

Required scope: sponsored-charge-points:write
Organization authorization: supported

Approve a sponsored charge point › Request Body

SponsoredChargePointApprove
sponsoredChargePointIds
​integer[] · minItems: 1 · required

List of sponsored charge point ids to approve

Example: [1,2,3]
payout
​string · enum · required

Payout schedule used after approval

Enum values:
end-of-month
realtime
other
payForSubscriptions
​boolean · required

Whether the sponsor pays for the sponsored user's subscription fees

Example: true
sponsoredPriceGroupId
​integer | null · int64

Optional price group id to apply to the approved sponsorship. If omitted, the price group already attached to the sponsored charge point is used.

Example: 42
sendEmailNotification
​boolean

Whether to send an email notification to the charge point owner about the approval

Example: false
Default: false

Approve a sponsored charge point › Responses

Sponsored charge point(s) approved

No data returned

Approve cost changes

POST
https://partner-api.monta.com
/api/v1/sponsored-charge-points/approve-cost-changes

Required scope: sponsored-charge-points:write
Organization authorization: supported

Approve cost changes › Request Body

SponsoredChargePointCostChangesReview
sponsoredChargePointIds
​integer[] · minItems: 1 · required

List of charge point ids that are selected for cost changes review

Example: [1,2,3]
sendEmailNotification
​boolean

Indicates if an email notification should be sent to the charge point owner about the cost changes review

Example: true
Default: false

Approve cost changes › Responses

Cost changes approved

No data returned

Reject sponsored charge points

POST
https://partner-api.monta.com
/api/v1/sponsored-charge-points/reject

Rejects (deletes) the provided sponsored charge points.

Required scope: sponsored-charge-points:delete
Organization authorization: supported

Reject sponsored charge points › Request Body

SponsoredChargePointReject
sponsoredChargePointIds
​integer[] · minItems: 1 · required

List of sponsored charge point ids to reject (the underlying sponsorship will be removed)

Example: [1,2,3]

Reject sponsored charge points › Responses

Sponsored charge points rejected

No data returned

Reject cost changes

POST
https://partner-api.monta.com
/api/v1/sponsored-charge-points/reject-cost-changes

Required scope: sponsored-charge-points:write
Organization authorization: supported

Reject cost changes › Request Body

SponsoredChargePointCostChangesReview
sponsoredChargePointIds
​integer[] · minItems: 1 · required

List of charge point ids that are selected for cost changes review

Example: [1,2,3]
sendEmailNotification
​boolean

Indicates if an email notification should be sent to the charge point owner about the cost changes review

Example: true
Default: false

Reject cost changes › Responses

Cost changes rejected

No data returned

Retrieve a single sponsored charge point

GET
https://partner-api.monta.com
/api/v1/sponsored-charge-points/{sponsoredChargePointId}

Required scope: sponsored-charge-points:read
Organization authorization: supported

Retrieve a single sponsored charge point › path Parameters

sponsoredChargePointId
​integer · int64 · required

Retrieve a single sponsored charge point › Responses

Sponsored charge point with provided id

SponsoredChargePoint
payout
​string · enum · required

The payout frequency for this sponsored charge point

Enum values:
end-of-month
realtime
other
Example: realtime
​object · required

The charge point being sponsored

createdAt
​string · date-time · required

Creation date of this sponsored charge point

Example: 2022-05-12T15:56:45.99Z
updatedAt
​string · date-time · required

Date this sponsored charge point was last updated

Example: 2022-05-12T16:56:45.99Z
id
​integer · int64

Id of this sponsored charge point

Example: 1
teamId
​integer · int64

Id of the team of this sponsored charge point

Example: 1
note
​string | null

Note for the sponsored charge point

Example: This is a note
payForSubscriptions
​boolean

Indicates the company pays for the subscriptions

Example: true
autoApproveElectricityCost
​boolean

When true, employee-submitted electricity costs on this sponsored charge point are auto-approved without manual review.

Example: false
Default: false
​object

Operator of this sponsored charge point

acceptedAt
​string | null · date-time

Date the sponsorship was accepted

Example: 2022-05-12T16:56:45.99Z
deletedAt
​string | null · date-time

Date this sponsored charge point was deleted

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

Update a sponsored charge point

PATCH
https://partner-api.monta.com
/api/v1/sponsored-charge-points/{sponsoredChargePointId}

Required scope: sponsored-charge-points:write
Organization authorization: supported

Update a sponsored charge point › path Parameters

sponsoredChargePointId
​integer · int64 · required

Update a sponsored charge point › Request Body

Note: Only use Optional for fields that can bet set null. Optional will insure jackson can differentiate between a field that was set to NULL X Field that was never present on the request.
PatchSponsoredChargePoint
priceGroupId
​integer | null · int64

The price group for this sponsorship, Only price groups of type reimbursement or sponsored are allowed
Note: if the priceGroupId is null the charge point cost price group will be used instead, if the charge point has no cost price group set the request will fail

Example: 1
payoutSchedule
​string · enum

The payout schedule for this sponsored charge point

Enum values:
end-of-month
realtime
other
Example: 1
payForSubscriptions
​boolean | null

Indicates that company pay for subscriptions

Example: false
autoApproveElectricityCost
​boolean | null

When true, employee-submitted electricity costs on this sponsored charge point are auto-approved without manual review.

Example: false
note
​string | null

Note for the sponsored charge point

Example: This is a note
sendEmailNotification
​boolean | null

Whether to email the charge point owner that their reimbursement settings changed. Defaults to true. Set to false to suppress it, e.g. when migrating existing customers from another CPMS.

Default: true

Update a sponsored charge point › Responses

Updated sponsored charge point with provided id

SponsoredChargePoint
payout
​string · enum · required

The payout frequency for this sponsored charge point

Enum values:
end-of-month
realtime
other
Example: realtime
​object · required

The charge point being sponsored

createdAt
​string · date-time · required

Creation date of this sponsored charge point

Example: 2022-05-12T15:56:45.99Z
updatedAt
​string · date-time · required

Date this sponsored charge point was last updated

Example: 2022-05-12T16:56:45.99Z
id
​integer · int64

Id of this sponsored charge point

Example: 1
teamId
​integer · int64

Id of the team of this sponsored charge point

Example: 1
note
​string | null

Note for the sponsored charge point

Example: This is a note
payForSubscriptions
​boolean

Indicates the company pays for the subscriptions

Example: true
autoApproveElectricityCost
​boolean

When true, employee-submitted electricity costs on this sponsored charge point are auto-approved without manual review.

Example: false
Default: false
​object

Operator of this sponsored charge point

acceptedAt
​string | null · date-time

Date the sponsorship was accepted

Example: 2022-05-12T16:56:45.99Z
deletedAt
​string | null · date-time

Date this sponsored charge point was deleted

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

Delete an existing sponsored charge point

DELETE
https://partner-api.monta.com
/api/v1/sponsored-charge-points/{sponsoredChargePointId}

Required scope: sponsored-charge-points:delete
Organization authorization: supported

Delete an existing sponsored charge point › path Parameters

sponsoredChargePointId
​integer · int64 · required

Delete an existing sponsored charge point › Responses

Sponsored Charge Point deleted

No data returned
Split BillingSubscription Purchases