Skip to main content

Retrieve Charging Entry

GET 
https://secure.fleetio.com/api/charging_entries/:id

Retrieve the details of an existing Charging Entry.

Request​

Path Parameters

    id stringrequired

    Possible values: Value must match regular expression ^[0-9]+$

    The id of the relevant record

Responses​

OK

Schema
    additional_fees_centsintegernullablerequired

    The amount, in cents, of any fees applied to the Charging Entry.

    approved_atdate-timenullablerequired

    The time a Charging Entry was approved.

    approved_by_idintegernullablerequired

    The ID associated with the User who approved this Charging Entry.

    cost_per_hrstringnullablerequired

    The automatically calculated cost per hour since the last Charging Entry.

    cost_per_kmstringnullablerequired

    The automatically calculated cost per kilometer since the last Charging Entry.

    cost_per_mistringnullablerequired

    The automatically calculated cost per mile since the last Charging Entry.

    discount_centsintegernullablerequired

    The amount, in cents, of any discounts applied to the Charging Entry, must be a negative number.

    duration_secondsintegerrequired

    The duration, in seconds, between the Charging Entry start and end events. If started_at and ended_at are provided, it will automatically calculate the duration_seconds using those attributes.

    Possible values: >= 0

    ended_atdate-timenullablerequired

    The date and time at which the Charging Entry ended.

    Example: 2023-03-14T13:46:27-06:00
    geolocation objectnullablerequired
    gps_devicestringnullable
    original_vendorstringnullable
    exception_distance_in_minumbernullable
    exception_distance_in_kmnumbernullable
    km_per_kwhstringrequired

    The automatically calculated kilometers per kilowatt hour since the last Charging Entry.

    mi_per_kwhstringrequired

    The automatically calculated miles per kilowatt hour since the last Charging Entry.

    personalbooleanrequired

    Indicates whether this Charging Entry was for personal use. This field is false if not provided.

    Default value: false
    price_per_kwh_centsstringnullablerequired

    The unit price per kilowatt hour for the Charging Entry.

    referencestringnullablerequired

    Optional data field for collecting information such as the invoice number, transaction id, or receipt number, for example.

    started_atdate-timerequired

    The date and time at which this Charging Entry started.

    Example: 2023-03-14T13:46:27-06:00
    statusstringrequired

    The status of the Charging Entry. This field is "manually_completed" if not provided.

    Possible values: [in_progress, target_reached, ready_for_review, manually_completed, approved, auto_approved, unknown]

    Default value: manually_completed
    total_amount_centsintegernullablerequired

    The total cost, in cents, of the Charging Entry.

    total_kwhstringrequired

    The total kilowatt hours of the Charging Entry.

    usage_in_hrstringnullablerequired

    The automatically calculated usage in hours since the most recent Charging Entry.

    usage_in_kmstringnullablerequired

    The automatically calculated usage in kilometers since the most recent Charging Entry.

    usage_in_mistringnullablerequired

    The automatically calculated usage in miles since the most recent Charging Entry.

    vehicle_idintegerrequired

    The Fleetio id of the Vehicle associated with this Charging Entry.

    Possible values: >= 1

    vendor_idintegernullablerequired

    The Fleetio id of the Vendor associated with this Charging Entry.

    Possible values: >= 1

    comments_countintegerrequired

    The number of comments on this Charging Entry.

    documents_countintegerrequired

    The number of documents added to this Charging Entry.

    images_countintegerrequired

    The number of images added to this Charging Entry.

    commentsobject[]

    Comments associated with this Charging Entry.

    documentsobject[]

    Documents associated with this Charging Entry.

    imagesobject[]

    Images associated with this Charging Entry.

Authorization: Authorization

name: Authorizationtype: apiKeyin: headerdescription: Prefix the value with "Token", for example: "Token 76cbe06c49a64".
You can generate a new API key [here](https://secure.fleetio.com/api_keys).
name: Account-Tokentype: apiKeyin: headerdescription: You can find your Account-Token [here](https://secure.fleetio.com/api_keys)
curl -L 'https://secure.fleetio.com/api/charging_entries/:id' \
-H 'Accept: application/json' \
-H 'Authorization: Token <Authorization>' \
-H 'Account-Token: <Authorization>'
Request Collapse all
Base URL
https://secure.fleetio.com/api
Auth
Parameters
— pathrequired
ResponseClear

Click the Send API Request button above and see the response here!