Delete Acquisition
Delete an Acquisition
Path Parameters
- id string required
Possible values: Value must match regular expression
^[0-9]+$
The id of the relevant record
- 200
- 401
- 403
- 404
- 500
OK
Response Headers
- application/json
- Schema
- Example (from schema)
Schema
- id integer
Possible values:
>= 1
- vehicle_id integer
Possible values:
>= 1
- acquisition_type AcquisitionType
Possible values: [
loan
,lease
]The acquisition type of the asset.
- vendor_id NullableId
Possible values:
>= 1
- lender_id NullableId
Possible values:
>= 1
- first_payment_date date
The date of the first payment for the
Acquisition
, if applicable. - number_of_payments integer
For
lease
type Acquisitions, this number represents the number of months for which the vehicle is leased. Forloan
type Acquisitions, this number represents the number of payments until the loan is paid off. - mileage_cap integer
For
lease
type Acquisitions, this number represents the number of miles allowed each year, before additional charges will be incurred. - annual_percentage_rate float
For
loan
type Acquisitions, the annual percentage rate for the loan. - reference_number string
Optional data for collecting information such as the invoice number, transaction id, or receipt number.
- notes string
Optional free text field for additional notes.
- loan_amount float
For
loan
type Acquisitions, the total principal amount at the start of the loan. - down_payment_amount float
For
loan
type Acquisitions, the amount of the initial down payment. - monthly_cost float
Total amount that will be paid each month including any taxes and fees.
- capitalized_cost float
Capitalized cost per month of the
Vehicle
. - residual_value float
For
lease
type Acquisitions, the value of theVehicle
at the end of the lease. - purchase_price float
For
loan
type Acquisitions, the total purchase price of theVehicle
. - mileage_charge float
For
lease
type Acquisitions, the amount charged for each mile over the mileage cap. - acquisition_date date
The date on which the Acquisition occurred or began.
- vehicle object
The
Vehicle
related to the Acquisition. - lender object
The
Lender
related to the Acquisition. - vendor object
The
Vendor
related to the Acquisition.
{
"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": {}
}
Request could not be authenticated
- application/json
- Schema
- Example (from schema)
Schema
- status integer
Possible values:
>= 400
and<= 599
- title string
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.
- detail string
A human-readable explanation specific to this occurrence of the problem.
- instance string
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
{
"status": 0,
"title": "string",
"detail": "string",
"instance": "string"
}
Insufficient permission to perform this operation
- application/json
- Schema
- Example (from schema)
Schema
- status integer
Possible values:
>= 400
and<= 599
- title string
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.
- detail string
A human-readable explanation specific to this occurrence of the problem.
- instance string
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
{
"status": 0,
"title": "string",
"detail": "string",
"instance": "string"
}
The requested resource could not be located
- application/json
- Schema
- Example (from schema)
Schema
- status integer
Possible values:
>= 400
and<= 599
- title string
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.
- detail string
A human-readable explanation specific to this occurrence of the problem.
- instance string
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
{
"status": 0,
"title": "string",
"detail": "string",
"instance": "string"
}
Something unexpected happened
- application/json
- Schema
- Example (from schema)
Schema
- status integer
Possible values:
>= 400
and<= 599
- title string
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.
- detail string
A human-readable explanation specific to this occurrence of the problem.
- instance string
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
{
"status": 0,
"title": "string",
"detail": "string",
"instance": "string"
}