List Acquisitions

GET 
https://secure.fleetio.com/api/v1/acquisitions

Returns a list of your Acquisitions.

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.
acquisition_type object
eqstringrequired
Possible values: [loan, lease]
reference_number object
oneOf
LikeFilter
likestringrequired
EqFilter
eqstringrequired
vehicle_id object
eqstringrequired
lender_id object
eqstringrequired
vendor_id object
eqstringrequired
acquisition_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

acquisition_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
acquisition_type object
eqstringrequired
Possible values: [loan, lease]
MOD2
reference_number object
oneOf
LikeFilter
likestringrequired
EqFilter
eqstringrequired
MOD3
vehicle_id object
eqstringrequired
MOD4
lender_id object
eqstringrequired
MOD5
vendor_id object
eqstringrequired
MOD6
acquisition_date object
oneOf
EqFilter
eqstringrequired
LtFilter
ltstringrequired
LteFilter
ltestringrequired
GtFilter
gtstringrequired
GteFilter
gtestringrequired
MOD7
created_at object
oneOf
LtFilter
ltstringrequired
LteFilter
ltestringrequired
GtFilter
gtstringrequired
GteFilter
gtestringrequired
MOD8
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
created_atSortAscDesc (string)
Possible values: [asc, desc]
MOD3
idSortAscDesc (string)
Possible values: [asc, desc]
]
records object[]
Array [
idinteger
vehicle_idintegerrequired
acquisition_typestringrequired
Possible values: [loan, lease]
vendor_idintegernullablerequired
lender_idintegernullablerequired
first_payment_datedatenullablerequired
The date of the first payment for the Acquisition, if applicable.
Example: 2023-03-14
number_of_paymentsintegernullablerequired
For lease type Acquisitions, this number represents the number of months for which the vehicle is leased. For loan type Acquisitions, this number represents the number of payments until the loan is paid off.
mileage_capintegernullablerequired
For lease type Acquisitions, this number represents the number of miles allowed each year, before additional charges will be incurred.
annual_percentage_ratestringnullablerequired
For loan type Acquisitions, the annual percentage rate for the loan.
reference_numberstringnullablerequired
Optional data for collecting information such as the invoice number, transaction id, or receipt number.
notesstringnullablerequired
Optional free text field for additional notes.
loan_amount_centsintegernullablerequired
For loan type Acquisitions, the total principal amount at the start of the loan.
down_payment_amount_centsintegernullablerequired
For loan type Acquisitions, the amount of the initial down payment.
monthly_cost_centsintegernullablerequired
Total amount that will be paid each month including any taxes and fees.
capitalized_cost_centsintegernullablerequired
Capitalized cost per month of the Vehicle.
residual_value_centsintegernullablerequired
For lease type Acquisitions, the value of the Vehicle at the end of the lease.
purchase_price_centsintegernullablerequired
For loan type Acquisitions, the total purchase price of the Vehicle.
mileage_charge_centsintegernullablerequired
For lease type Acquisitions, the amount charged for each mile over the mileage cap.
acquisition_datedatenullablerequired
The date on which the Acquisition occurred or began.
Example: 2023-03-14
vehicle objectrequired
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.
lender objectnullablerequired
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.
vendor objectnullablerequired
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.
]

Example (auto)

{
  "start_cursor": "string",
  "next_cursor": "string",
  "per_page": 0,
  "estimated_remaining_count": 0,
  "filtered_by": [
    {
      "acquisition_type": {
        "eq": "loan"
      }
    },
    {
      "reference_number": {
        "like": "string"
      }
    },
    {
      "vehicle_id": {
        "eq": "string"
      }
    },
    {
      "lender_id": {
        "eq": "string"
      }
    },
    {
      "vendor_id": {
        "eq": "string"
      }
    },
    {
      "acquisition_date": {
        "eq": "string"
      }
    },
    {
      "created_at": {
        "lt": "string"
      }
    },
    {
      "updated_at": {
        "lt": "string"
      }
    }
  ],
  "sorted_by": [
    {
      "updated_at": "asc"
    },
    {
      "created_at": "asc"
    },
    {
      "id": "asc"
    }
  ],
  "records": [
    {
      "id": 0,
      "vehicle_id": 0,
      "acquisition_type": "loan",
      "vendor_id": 0,
      "lender_id": 0,
      "first_payment_date": "2023-03-14",
      "number_of_payments": 0,
      "mileage_cap": 0,
      "annual_percentage_rate": "string",
      "reference_number": "string",
      "notes": "string",
      "loan_amount_cents": 0,
      "down_payment_amount_cents": 0,
      "monthly_cost_cents": 0,
      "capitalized_cost_cents": 0,
      "residual_value_cents": 0,
      "purchase_price_cents": 0,
      "mileage_charge_cents": 0,
      "acquisition_date": "2023-03-14",
      "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"
      },
      "lender": {
        "name": "string",
        "phone": "string",
        "city": "string",
        "region": "string",
        "postal_code": "string",
        "country": "string",
        "external_id": "string"
      },
      "vendor": {
        "name": "string",
        "phone": "string",
        "city": "string",
        "region": "string",
        "postal_code": "string",
        "country": "string",
        "external_id": "string"
      }
    }
  ]
}

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/v1/acquisitions' \
-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

acquisition_typeeq

reference_numberlikeeq

vehicle_ideq

lender_ideq

vendor_ideq

acquisition_dateeqltltegtgte

created_atltltegtgte

updated_atltltegtgte

sort — query

id---ascdesc

acquisition_date---ascdesc

created_at---ascdesc

updated_at---ascdesc

ResponseClear

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