List Charging Entries

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

Returns a list of Charging Entries belonging to your account.

Request

Query Parameters

start_cursor string

The start cursor for Keyset pagination.

per_page integer

Possible values: >= 2 and <= 100

The number of records per page to return.

Default value: 50

filter object

sort object

Responses

application/json

Schema
Example (auto)

Schema

start_cursorstringnullable

The current start cursor of the records returned.

next_cursorstringnullable

The next cursor to retrieve the next page of records.

per_pageinteger

The maxumum number of records returned.

estimated_remaining_countinteger

The number of remaining records including the returned records, up to a maximum of 500.

filtered_by object[]

sorted_by object[]

records Charging Entry[]

Array [

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

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.

]

{
  "start_cursor": "string",
  "next_cursor": "string",
  "per_page": 0,
  "estimated_remaining_count": 0,
  "filtered_by": [
    {
      "created_at": {
        "lt": "string"
      }
    },
    {
      "ended_at": {
        "lt": "string"
      }
    },
    {
      "started_at": {
        "lt": "string"
      }
    },
    {
      "updated_at": {
        "lt": "string"
      }
    },
    {
      "vehicle_id": {
        "include": "string"
      }
    },
    {
      "vendor_id": {
        "include": "string"
      }
    }
  ],
  "sorted_by": [
    {
      "created_at": "asc"
    },
    {
      "ended_at": "asc"
    },
    {
      "id": "asc"
    },
    {
      "started_at": "asc"
    },
    {
      "updated_at": "asc"
    }
  ],
  "records": [
    {
      "additional_fees_cents": 0,
      "approved_at": "2024-07-29T15:51:28.071Z",
      "approved_by_id": 0,
      "cost_per_hr": "string",
      "cost_per_km": "string",
      "cost_per_mi": "string",
      "discount_cents": 0,
      "duration_seconds": 0,
      "ended_at": "2023-03-14T13:46:27-06:00",
      "geolocation": {
        "gps_device": "string",
        "original_vendor": "string",
        "exception_distance_in_mi": 0,
        "exception_distance_in_km": 0
      },
      "km_per_kwh": "string",
      "mi_per_kwh": "string",
      "personal": false,
      "price_per_kwh_cents": "string",
      "reference": "string",
      "started_at": "2023-03-14T13:46:27-06:00",
      "status": "manually_completed",
      "total_amount_cents": 0,
      "total_kwh": "string",
      "usage_in_hr": "string",
      "usage_in_km": "string",
      "usage_in_mi": "string",
      "vehicle_id": 0,
      "vendor_id": 0,
      "comments_count": 0,
      "documents_count": 0,
      "images_count": 0
    }
  ]
}

The format or parameters of the request was invalid

application/json

Schema
Example (auto)

Schema

errors object

{
  "errors": {}
}

Request could not be authenticated

application/json

Schema
Example (auto)

Schema

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

Something unexpected happened

application/json

Schema
Example (auto)

Schema

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

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

ResponseClear

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

List Charging Entries

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

Request​

Query Parameters

Responses​

Authorization: Authorization

Request

Responses