Skip to main content

Create Charging Entry

Creates a new Charging Entry

Request Body

  • 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.

  • custom_fields object

    *Full details on working with Custom Fields here.

  • discount_cents integer

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

  • documents_attributes object[]

    An array of one or more document objects to add to the record. Follow our Attaching Documents and Images guide to upload to our third party storage provider in order to obtain file_url.

  • name string

    Possible values: <= 255 characters

    The name to give the file which will be shown in the UI.

  • file_url string

    Possible values: <= 255 characters

    The URL obtained from our storage provider that points to the file.

  • file_mime_type string

    Possible values: <= 255 characters

    The MIME type of the file. For example, application/pdf.

  • file_name string

    Possible values: <= 255 characters

    The name of the file.

  • file_size integer

    The size of the file in bytes.

  • 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
  • images_attributes object[]

    An array of one or more image objects to add to the record. Follow our Attaching Documents and Images guide to upload to our third party storage provider in order to obtain file_url.

  • name string

    Possible values: <= 255 characters

    The name to give the image which will be shown in the UI.

  • file_url string

    Possible values: <= 255 characters

    The URL obtained from our storage provider that points to the image.

  • file_mime_type string

    Possible values: <= 255 characters

    The MIME type of the image. For example, image/png.

  • file_name string

    Possible values: <= 255 characters

    The name of the image.

  • file_size integer

    The size of the image file in bytes.

  • meter_entry_attributes object

    Each Charging Entry can have an associated Meter Entry

  • value float

    The value is the actual number on the meter that increments over time. The unit is determined by the configured meter_unit on the associated Vehicle.

  • void boolean

    If you attempt to save a meter value, which is too high or too low, Fleetio's validation rules will reject it. If you need to bypass this validation, you may mark an entry as void.

  • personal boolean

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

  • price_per_kwh_cents float

    The unit price per kilowatt hour for the Charging Entry.

  • reference string

    A reference number or identifier for this Charging Entry. This field is often used to store a receipt number or other unique identifier.

  • started_at date-time

    We recommend using ISO-8601 formatted dates to avoid ambiguity.

  • 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 float

    The total kilowatt hours of the Charging Entry.

  • vehicle_id integer required

    Possible values: >= 1

  • vendor_id integer

    Possible values: >= 1

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

Responses

OK

Response Headers

    Schema

    • 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.

    • comments object[]

      Comments associated with this Charging Entry.

    • documents object[]

      Documents associated with this Charging Entry.

    • images object[]

      Images associated with this Charging Entry.

    Loading...