Retrieve Vehicle Purchase Details

GET 
https://secure.fleetio.com/api/v1/vehicles/:id/purchase_detail

Retrieve the details of a Vehicle's Purchase Detail.

Request

Path Parameters

id stringrequired

The Fleetio ID of the relevant Vehicle.

You may also look up Vehicles by their VIN, license plate, or other external ID. See the guide on External Vehicle Ids for information on how to set this up.

Responses

200

OK

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

commentstringnullablerequired

Any additional information about the purchase.

datestringnullablerequired

The date of the purchase.

meter_entry_valuefloatnullablerequired

The meter value at the time of purchase.

meter_entry objectnullable

A Meter Entry

idinteger

created_atdate-time

updated_atdate-time

auto_voided_atdate-timenullable

The date and time at which this Meter Entry was automatically voided. Formatted according to ISO-8601 in User's local time.

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

categorystringnullable

A category to describe the function of this Meter Entry.

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

meter_typestringnullable

Indicates whether or not this Meter is a secondary Meter.

Possible values: [secondary]

meterable_idNullableId (integer)nullable

Possible values: >= 1

meterable_typestringnullable

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

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

valuestring

The current value of the meter.

vehicle_idNullableId (integer)nullable

Possible values: >= 1

voidboolean

Indicates whether or not this Meter Entry has been voided.

Default value: false

typestringnullable

Possible values: [GpsMeterEntry]

datedate

The date on which this Meter Entry was recorded. Formatted according to ISO-8601.

Example: 2023-03-14

vehicle_idNullableId (integer)nullablerequired

Possible values: >= 1

vehicle_namestringnullablerequired

The name of the Vehicle.

vendor_idNullableId (integer)nullablerequired

Possible values: >= 1

vendor_namestringnullablerequired

The name of the Vendor.

warranty_expiration_datestringnullablerequired

The expiration date of the warranty, if applicable.

warranty_expiration_meter_valueintegernullablerequired

The meter value at which the warranty would expire, if applicable.

pricefloatnullablerequired

The price of the Vehicle.

custom_fieldsobjectnullablerequired

*Full details on working with Custom Fields here.

Example (auto)

{
  "id": 0,
  "created_at": "2023-03-14T13:46:27-06:00",
  "updated_at": "2023-03-14T13:46:27-06:00",
  "comment": "string",
  "date": "string",
  "meter_entry_value": 0,
  "meter_entry": {
    "id": 0,
    "created_at": "2024-07-29T15:51:28.071Z",
    "updated_at": "2024-07-29T15:51:28.071Z",
    "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,
    "type": "GpsMeterEntry",
    "date": "2023-03-14"
  },
  "vehicle_id": 0,
  "vehicle_name": "string",
  "vendor_id": 0,
  "vendor_name": "string",
  "warranty_expiration_date": "string",
  "warranty_expiration_meter_value": 0,
  "price": 0,
  "custom_fields": {}
}

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"
}

403

Insufficient permission to perform this operation

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"
}

404

The requested resource could not be located

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"
}

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

curl -L 'https://secure.fleetio.com/api/v1/vehicles/:id/purchase_detail' \
-H 'Accept: application/json' \
-H 'Authorization: Token <Authorization>' \
-H 'Account-Token: <Authorization>'

Request Collapse all

Base URL

https://secure.fleetio.com/api

Auth

apiKey

accountToken

Parameters

id — pathrequired

ResponseClear

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