List Purchase Details

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

Returns a list of Purchase Details 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
The fields, operations, and values to filter the records by.
vehicle_id object
eqstringrequired
vendor_id object
eqstringrequired
date object
oneOf
EqFilter
eqstringrequired
LtFilter
ltstringrequired
LteFilter
ltestringrequired
GtFilter
gtstringrequired
GteFilter
gtestringrequired
created_at object
oneOf
LtFilter
ltstringrequired
LteFilter
ltestringrequired
GtFilter
gtstringrequired
GteFilter
gtestringrequired
updated_at object
oneOf
LtFilter
ltstringrequired
LteFilter
ltestringrequired
GtFilter
gtstringrequired
GteFilter
gtestringrequired
sort object

The fields and direction to sort the results by.

idSortAscDescDefaultDesc (string)

Possible values: [asc, desc]

Default value: desc

dateSortAscDesc (string)

Possible values: [asc, desc]

created_atSortAscDesc (string)

Possible values: [asc, desc]

updated_atSortAscDesc (string)

Possible values: [asc, desc]

Responses

200

OK

application/json

Schema

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[]
The filters applied to the returned record set.
Array [
anyOf
MOD1
vehicle_id object
eqstringrequired
MOD2
vendor_id object
eqstringrequired
MOD3
date object
oneOf
EqFilter
eqstringrequired
LtFilter
ltstringrequired
LteFilter
ltestringrequired
GtFilter
gtstringrequired
GteFilter
gtestringrequired
MOD4
created_at object
oneOf
LtFilter
ltstringrequired
LteFilter
ltestringrequired
GtFilter
gtstringrequired
GteFilter
gtestringrequired
MOD5
updated_at object
oneOf
LtFilter
ltstringrequired
LteFilter
ltestringrequired
GtFilter
gtstringrequired
GteFilter
gtestringrequired
]
sorted_by object[]
The sorts applied to the returned record set.
Array [
anyOf
MOD1
updated_atSortAscDesc (string)
Possible values: [asc, desc]
MOD2
dateSortAscDesc (string)
Possible values: [asc, desc]
MOD3
created_atSortAscDesc (string)
Possible values: [asc, desc]
MOD4
idSortAscDesc (string)
Possible values: [asc, desc]
]
records object[]
Array [
idintegerrequired
created_atdate-timerequired
updated_atdate-timerequired
commentstringnullablerequired
Any additional information about the purchase.
datestringnullablerequired
The date of the purchase.
meter_entry_valuefloatnullable
The meter value at the time of purchase.
vehicle_idintegernullablerequired
vendor_idintegernullablerequired
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.
price_centsintegernullablerequired
The price of the Vehicle.
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
vendor objectnullable
A Vendor
namestringrequired
The name of the Vendor.
phonestringnullablerequired
The phone number of the Vendor.
citystringnullablerequired
The city of the Vendor.
regionstringnullablerequired
The region, state, province, or territory of the Vendor.
postal_codestringnullablerequired
The postal code or ZIP code of the Vendor.
countrystringnullablerequired
The country of the Vendor.
external_idstringnullablerequired
The external identifier of the Vendor.
vehicle object
A Vehicle
idintegerrequired
namestringrequired
This vehicle's name.
colorstringnullable
The color of this Vehicle.
license_platestringnullable
The license plate number of this Vehicle.
vinstringnullable
The Vehicle Identification Number of this Vehicle.
yearstringnullable
This Vehicle's model year.
makestringnullable
The name of this Vehicle's manufacturer.
modelstringnullable
The name of the model of this Vehicle.
trimstringnullable
The trim level of this Vehicle.
registration_expiration_monthintegernullable
The month in which this Vehicle's registration expires.
Possible values: >= 0 and <= 12
registration_statestringnullable
The state, province, or territory in which this Vehicle is registered.
default_image_url_smallstringnullable
The URL of a small-sized version of the default image for this Vehicle.
custom_fieldsobjectnullablerequired
*Full details on working with Custom Fields here.
]

Example (auto)

{
  "start_cursor": "string",
  "next_cursor": "string",
  "per_page": 0,
  "estimated_remaining_count": 0,
  "filtered_by": [
    {
      "vehicle_id": {
        "eq": "string"
      }
    },
    {
      "vendor_id": {
        "eq": "string"
      }
    },
    {
      "date": {
        "eq": "string"
      }
    },
    {
      "created_at": {
        "lt": "string"
      }
    },
    {
      "updated_at": {
        "lt": "string"
      }
    }
  ],
  "sorted_by": [
    {
      "updated_at": "asc"
    },
    {
      "date": "asc"
    },
    {
      "created_at": "asc"
    },
    {
      "id": "asc"
    }
  ],
  "records": [
    {
      "id": 0,
      "created_at": "2024-07-29T15:51:28.071Z",
      "updated_at": "2024-07-29T15:51:28.071Z",
      "comment": "string",
      "date": "string",
      "meter_entry_value": 0,
      "vehicle_id": 0,
      "vendor_id": 0,
      "warranty_expiration_date": "string",
      "warranty_expiration_meter_value": 0,
      "price_cents": 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"
      },
      "vendor": {
        "name": "string",
        "phone": "string",
        "city": "string",
        "region": "string",
        "postal_code": "string",
        "country": "string",
        "external_id": "string"
      },
      "vehicle": {
        "id": 0,
        "name": "string",
        "color": "string",
        "license_plate": "string",
        "vin": "string",
        "year": "string",
        "make": "string",
        "model": "string",
        "trim": "string",
        "registration_expiration_month": 0,
        "registration_state": "string",
        "default_image_url_small": "string"
      },
      "custom_fields": {}
    }
  ]
}

400

The format or parameters of the request was invalid

application/json

Schema

Schema

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

Example (auto)

{
  "errors": {}
}

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

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/purchase_details' \
-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

start_cursor — query

per_page — query

filter — query

vehicle_ideq

vendor_ideq

dateeqltltegtgte

created_atltltegtgte

updated_atltltegtgte

sort — query

id---ascdesc

date---ascdesc

created_at---ascdesc

updated_at---ascdesc

ResponseClear

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