Create Meter Entry

POST 
https://secure.fleetio.com/api/v1/meter_entries

Create a new Meter Entry. If you need to create many Meter Entries at once, use the Bulk API to avoid Rate Limiting errors.

Request

application/json

Body

vehicle_idId (integer)required

Possible values: >= 1

valuefloatrequired

The value of the meter. The unit can be configured at the Account level, or overridden at the Vehicle level.

datedate-timerequired

Meter Entries must follow the correct sequence, incrementing in value by date. For each entry, Fleetio validates to ensure that the value falls between any entries logged before and/or after. We recommend using ISO-8601 formatted dates to avoid ambiguity.

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

voidboolean

Whether to mark this Meter Entry void or not. See Voiding Meter Entries.

Default value: false

meter_typestringnullable

If this is a secondary meter reading, use this field.

If the vehicle's secondary meter is disabled, secondary meter values will be hidden in the web and mobile views until enabled.

Possible values: [secondary]

Responses

201

OK

Response Headers

application/json

Schema

Schema

idId (integer)required

Possible values: >= 1

created_atdate-time

The date and time at which this record was created.

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

updated_atdate-time

The date and time at which this record was most recently updated.

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

account_idId (integer)required

Possible values: >= 1

auto_voided_atdate-timenullablerequired

The date and time at which this Meter Entry was automatically voided.

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

categorystringnullablerequired

A category to describe the function of this Meter Entry.

Possible values: [starting, ending, nightly, manual]

meter_typestringnullablerequired

Indicates whether this Meter Entry is for a secondary meter.

Possible values: [secondary]

meterable_idNullableId (integer)nullablerequired

Possible values: >= 1

meterable_typestringnullablerequired

The type of the object with which this Meter Entry is associated.

Possible values: [FuelEntry, Issue, PurchaseDetail, ServiceEntry, SubmittedInspectionItem, VehicleAssignment, WorkOrder]

valuestringrequired

The current value of the meter.

vehicle_idNullableId (integer)nullablerequired

Possible values: >= 1

voidbooleanrequired

Indicates whether or not this Meter Entry has been voided.

Default value: false

gps_providerobjectnullablerequired

The GPS provider that submitted this Meter Entry.

datedaterequired

The date on which this Meter Entry was recorded.

Example: 2023-03-14

vehicle_archived_atdate-timenullable

The date and time at which the Vehicle associated with this Meter Entry was archived, if applicable.

auto_void_reasonstringnullable

The reason this Meter Entry was automatically voided.

is_sampleboolean

Indicates whether or not this Meter Entry is sample data.

Default value: false

gps_device_idNullableId (integer)nullable

Possible values: >= 1

sourcestringnullable

The source of this Meter Entry.

active_meter_conflicts_caused_countinteger

The number of active meter conflicts caused by this Meter Entry.

Example (auto)

{
  "id": 0,
  "created_at": "2023-03-14T13:46:27-06:00",
  "updated_at": "2023-03-14T13:46:27-06:00",
  "account_id": 0,
  "auto_voided_at": "2023-03-14T13:46:27-06:00",
  "category": "starting",
  "meter_type": "secondary",
  "meterable_id": 0,
  "meterable_type": "FuelEntry",
  "value": "string",
  "vehicle_id": 0,
  "void": false,
  "gps_provider": {},
  "date": "2023-03-14",
  "vehicle_archived_at": "2024-07-29T15:51:28.071Z",
  "auto_void_reason": "string",
  "is_sample": false,
  "gps_device_id": 0,
  "source": "string",
  "active_meter_conflicts_caused_count": 0
}

401

Request could not be authenticated

application/json

Schema

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.

Example (auto)

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

422

Unprocessable Entity

application/json

Schema

Schema

errors object
property name* string[]
Array [
string
]

Example (auto)

{
  "errors": {}
}

Example

{
  "errors": {
    "field1": [
      "error1",
      "error2"
    ],
    "field2": [
      "error3"
    ]
  }
}

500

Something unexpected happened

application/json

Schema

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.

Example (auto)

{
  "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
• ruby
• python
• csharp
• go
• java
• nodejs
• php

• CURL

Request Collapse all

Base URL

https://secure.fleetio.com/api

Auth

apiKey

accountToken

Body

{
  "vehicle_id": 0,
  "value": 0,
  "date": "2023-03-14T13:46:27-06:00",
  "void": false,
  "meter_type": "secondary"
}

ResponseClear

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