Sign in

v1

latestOpenAPI 3.0.12026-07-243686491.1 MB
Sponsored Charge Points

Create a sponsored charge point

Creates a sponsored charge point for a given user, the sponsorship is automatically approved.</br></br>Note: a charge point can only be sponsored to one user_id</br>Required scope: sponsored-charge-points:write </br>Organization authorization: supported

post/api/v1/sponsored-charge-points

Request body

sponsoringTeamIdinteger

Id of the team that is sponsoring this charge point

chargePointIdinteger

Id of the charge point to be sponsored

userIdinteger

Id of the user to have a charge point sponsored

priceGroupIdinteger nullable

The price group for this sponsorship, Only price groups of type reimbursement or sponsored are allowed</br></br>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

payoutSchedule'end-of-month' | 'realtime' | 'other' required
payForSubscriptionsboolean

Indicates that company pay for subscriptions

autoApproveElectricityCostboolean nullable

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.

notestring nullable

Note for the sponsored charge point

Example request

{
  "sponsoringTeamId": 1,
  "chargePointId": 1,
  "userId": 1,
  "priceGroupId": 1,
  "note": "This is a note"
}

Response

Sponsored charge point created

idinteger

Id of this sponsored charge point

teamIdinteger

Id of the team of this sponsored charge point

payout'end-of-month' | 'realtime' | 'other' required
notestring nullable

Note for the sponsored charge point

payForSubscriptionsboolean

Indicates the company pays for the subscriptions

autoApproveElectricityCostboolean

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

acceptedAtstring date-time nullable

Date the sponsorship was accepted

createdAtstring date-time required

Creation date of this sponsored charge point

updatedAtstring date-time required

Date this sponsored charge point was last updated

deletedAtstring date-time nullable

Date this sponsored charge point was deleted