Vehicle Acquisitions

Update Acquisition

Changed on

Update a Acquisition

patch/acquisitions/{id}

Request

Path parameters

idstring required

The id of the relevant record

Request body

acquisition_type'loan' | 'lease'

The acquisition type of the asset.

vehicle_idinteger
vendor_idinteger nullable
lender_idinteger nullable
monthly_costnumber float

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

capitalized_costnumber float

Capitalized cost per month of the Vehicle.

down_payment_amountnumber float

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

residual_valuenumber float

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

purchase_pricenumber float

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

acquisition_datestring date

The date on which the Acquisition occurred or began.

acquisition_end_datestring date

The date on which the Acquisition ends or is scheduled to end.

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

first_payment_datestring date

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

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

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_amountnumber float

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

mileage_chargenumber float

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

annual_percentage_ratenumber float

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.

notesstring

Optional free text field for additional notes.

Example request

{
  "acquisition_date": "2023-03-14",
  "acquisition_end_date": "2026-03-14",
  "first_payment_date": "2023-03-14"
}

Response

OK

idinteger
vehicle_idinteger required
acquisition_type'loan' | 'lease' required

The acquisition type of the asset.

vendor_idinteger nullable required
lender_idinteger nullable required
first_payment_datestring date nullable required

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

number_of_paymentsinteger nullable required

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 nullable required

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

annual_percentage_ratenumber float nullable required

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

reference_numberstring nullable required

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

notesstring nullable required

Optional free text field for additional notes.

loan_amountnumber float nullable required

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

down_payment_amountnumber float nullable required

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

monthly_costnumber float nullable required

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

capitalized_costnumber float nullable required

Capitalized cost per month of the Vehicle.

residual_valuenumber float nullable required

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

purchase_pricenumber float nullable required

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

mileage_chargenumber float nullable required

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

acquisition_datestring date nullable required

The date on which the Acquisition occurred or began.

acquisition_end_datestring date nullable

The date on which the Acquisition ends or is scheduled to end.

vehicleobject nullable required

The Vehicle related to the Acquisition.

lenderobject nullable required

The Lender related to the Acquisition.

vendorobject nullable required

The Vendor related to the Acquisition.

Example response

{
  "first_payment_date": "2023-03-14",
  "acquisition_date": "2023-03-14",
  "acquisition_end_date": "2026-03-14"
}

Changes

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status