Skip to main content

List Charging Entries

Returns a list of Charging Entries belonging to your account.

Query Parameters
  • start_cursor string

    The start cursor for Keyset pagination.

  • per_page integer

    Possible values: >= 2 and <= 100

    Default value: 50

    The number of records per page to return.

  • filter object

    The fields, operations, and values to filter the records by.

    • created_at object
      oneOf
    • lt string required
    • ended_at object
      oneOf
    • lt string required
    • started_at object
      oneOf
    • lt string required
    • vehicle_id object
    • eq string required
    • vendor_id object
    • eq string required
    • updated_at object
      oneOf
    • lt string required
  • sort object

    The fields and direction to sort the results by.

    • created_at string

      Possible values: [asc, desc]

    • ended_at string

      Possible values: [asc, desc]

    • started_at string

      Possible values: [asc, desc]

    • updated_at string

      Possible values: [asc, desc]

    • id string

      Possible values: [asc, desc]

      Default value: desc

Responses

OK

Schema

  • start_cursor string

    The current start cursor of the records returned.

  • next_cursor string

    The next cursor to retrieve the next page of records.

  • per_page integer

    The maxumum number of records returned.

  • estimated_remaining_count integer

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

  • filtered_by object[]

    The filters applied to the returned record set.

    anyOf
  • created_at object
    oneOf
  • lt string
  • sorted_by object[]

    The sorts applied to the returned record set.

    anyOf
  • created_at string

    Possible values: [asc, desc]

  • records Charging Entry[]
  • additional_fees_cents integer

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

  • approved_at date-time

    The time a Charging Entry was approved.

  • approved_by_id integer

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

  • cost_per_hr string

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

  • cost_per_km string

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

  • cost_per_mi string

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

  • discount_cents integer

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

  • duration_seconds integer

    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.

  • ended_at date-time

    The date and time at which the Charging Entry ended.

  • geolocation object
  • gps_device string
  • original_vendor string
  • exception_distance_in_mi number
  • exception_distance_in_km number
  • km_per_kwh string

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

  • mi_per_kwh string

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

  • personal boolean

    Default value: false

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

  • price_per_kwh_cents string

    The unit price per kilowatt hour for the Charging Entry.

  • reference string

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

  • started_at date-time

    The date and time at which this Charging Entry started.

  • status string

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

    Default value: manually_completed

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

  • total_amount_cents integer

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

  • total_kwh string

    The total kilowatt hours of the Charging Entry.

  • usage_in_hr string

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

  • usage_in_km string

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

  • usage_in_mi string

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

  • vehicle_id integer

    Possible values: >= 1

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

  • vendor_id integer

    Possible values: >= 1

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

  • comments_count integer

    The number of comments on this Charging Entry.

  • documents_count integer

    The number of documents added to this Charging Entry.

  • images_count integer

    The number of images added to this Charging Entry.

Loading...