Create Acquisition

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

Creates a new Acquisition

Request

application/json

Body

acquisition_typeAcquisitionType (string)required

The acquisition type of the asset.

Possible values: [loan, lease]

vehicle_idId (integer)required

Possible values: >= 1

vendor_idNullableId (integer)nullable

Possible values: >= 1

lender_idNullableId (integer)nullable

Possible values: >= 1

monthly_costfloat

Total amount that will be paid each month including any taxes and fees.

capitalized_costfloat

Capitalized cost per month of the Vehicle.

down_payment_amountfloat

For loan type Acquisitions, the amount of the initial down payment.

residual_valuefloat

For lease type Acquisitions, the value of the Vehicle at the end of the lease.

purchase_pricefloat

For loan type Acquisitions, the total purchase price of the Vehicle.

acquisition_datedate

The date on which the Acquisition occurred or began.

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

Example: 2023-03-14

first_payment_datedate

The date of the first payment for the Acquisition, if applicable.

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

Example: 2023-03-14

number_of_paymentsinteger

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_capinteger

For lease type Acquisitions, this number represents the number of miles allowed each year, before additional charges will be incurred.

loan_amountfloat

For loan type Acquisitions, the total principal amount at the start of the loan.

mileage_chargefloat

For lease type Acquisitions, the amount charged for each mile over the mileage cap.

annual_percentage_ratefloat

For loan type acquisitions, the annual percentage rate for the loan.

reference_numberstring

Optional data for collecting information such as the invoice number, transaction id, or receipt number.

Possible values: <= 255 characters

notesstring

Optional free text field for additional notes.

Responses

200

OK

Response Headers

application/json

Schema

Schema

idId (integer)

Possible values: >= 1

vehicle_idId (integer)required

Possible values: >= 1

acquisition_typeAcquisitionType (string)required

The acquisition type of the asset.

Possible values: [loan, lease]

vendor_idNullableId (integer)nullablerequired

Possible values: >= 1

lender_idNullableId (integer)nullablerequired

Possible values: >= 1

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_ratefloatnullablerequired

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_amountfloatnullablerequired

For loan type Acquisitions, the total principal amount at the start of the loan.

down_payment_amountfloatnullablerequired

For loan type Acquisitions, the amount of the initial down payment.

monthly_costfloatnullablerequired

Total amount that will be paid each month including any taxes and fees.

capitalized_costfloatnullablerequired

Capitalized cost per month of the Vehicle.

residual_valuefloatnullablerequired

For lease type Acquisitions, the value of the Vehicle at the end of the lease.

purchase_pricefloatnullablerequired

For loan type Acquisitions, the total purchase price of the Vehicle.

mileage_chargefloatnullablerequired

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

vehicleobjectnullablerequired

The Vehicle related to the Acquisition.

lenderobjectnullablerequired

The Lender related to the Acquisition.

vendorobjectnullablerequired

The Vendor related to the Acquisition.

Example (auto)

{
  "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": 0,
  "reference_number": "string",
  "notes": "string",
  "loan_amount": 0,
  "down_payment_amount": 0,
  "monthly_cost": 0,
  "capitalized_cost": 0,
  "residual_value": 0,
  "purchase_price": 0,
  "mileage_charge": 0,
  "acquisition_date": "2023-03-14",
  "vehicle": {},
  "lender": {},
  "vendor": {}
}

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

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

curl -L 'https://secure.fleetio.com/api/v1/acquisitions' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Token <Authorization>' \
-H 'Account-Token: <Authorization>' \
-d '{
  "acquisition_type": "loan",
  "vehicle_id": 0,
  "vendor_id": 0,
  "lender_id": 0,
  "monthly_cost": 0,
  "capitalized_cost": 0,
  "down_payment_amount": 0,
  "residual_value": 0,
  "purchase_price": 0,
  "acquisition_date": "2023-03-14",
  "first_payment_date": "2023-03-14",
  "number_of_payments": 0,
  "mileage_cap": 0,
  "loan_amount": 0,
  "mileage_charge": 0,
  "annual_percentage_rate": 0,
  "reference_number": "string",
  "notes": "string"
}'

Request Collapse all

Base URL

https://secure.fleetio.com/api

Auth

apiKey

accountToken

Body

{
  "acquisition_type": "loan",
  "vehicle_id": 0,
  "vendor_id": 0,
  "lender_id": 0,
  "monthly_cost": 0,
  "capitalized_cost": 0,
  "down_payment_amount": 0,
  "residual_value": 0,
  "purchase_price": 0,
  "acquisition_date": "2023-03-14",
  "first_payment_date": "2023-03-14",
  "number_of_payments": 0,
  "mileage_cap": 0,
  "loan_amount": 0,
  "mileage_charge": 0,
  "annual_percentage_rate": 0,
  "reference_number": "string",
  "notes": "string"
}

ResponseClear

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