[beta] Create an electric purchase transaction.

post

https://api.samsara.com/electric-purchase

Create an electric charging purchase transaction, measured in kilowatt hours.

Rate limit: 100 requests/min (learn more about rate limits here).

To use this endpoint, select Write Fuel Purchase under the Fuel & Energy category when creating or editing an API token. Learn More.

Submit Feedback: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Request payload for creating a new electric charging purchase transaction.

discount

object

The amount of money discounted from the gross price of the charging transaction in the currency of the country where the transaction occurred.

driverId

string

Samsara ID of the driver.

energyKilowattHours

string

required

The amount of energy delivered in kilowatt hours, as a decimal string greater than 0.

merchantName

string

Name of the charging network or operator. For example: ChargePoint, Electrify America.

source

string

length ≤ 255

The integration provider. For example: Customer, ChargePoint Integration

transactionLocation

string

required

The full street address of the charger, as it might be recognized by Google Maps (example: 1 De Haro St, San Francisco, CA 94107, United States). Alternatively, exact latitude/longitude can be provided (example: 40.748441, -73.985664).

transactionPrice

object

required

The gross price of the charging transaction in the currency of the country where the transaction occurred.

transactionReference

string

required

length between 1 and 32

^[a-zA-Z0-9\-]+$

The charging transaction reference. This is the transaction identifier, such as the receipt or charging session number.

transactionTime

string

required

The time of the charging transaction in RFC 3339 format. Timezone must be specified. For example, 2022-07-13T14:20:50.52-07:00 is a time in Pacific Daylight Time.

vehicleId

string

Samsara ID of the vehicle that was charged.

Responses

Language

Credentials

Bearer

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK response.

401Unauthorized response.

404Not Found response.

405Method Not Allowed response.

409Conflict response.

413Content Too Large response.

429Too Many Requests response.

500Internal Server Error response.

501Not Implemented response.

502Bad Gateway response.

503Service Unavailable response.

504Gateway Timeout response.

defaultBad Request response.