Skip to main content

List Acquisitions

Returns a list of your Acquisitions.

Responses

OK

Response Headers

  • X-PaginationLimit string

    The per page limit. Currently set to 100 but subject to change at any time.

  • X-Pagination-Current-Page string

    The current page. Defaults to 1.

  • X-Pagination-Total-Pages string

    The total number of pages in the result set. Use this along with Pagination-Current-Page to determine if there are any remaining pages/records to be retrieved.

  • X-Pagination-Total-Count string

    The total number of records in the result set (across all pages).

Schema

array
  • 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. For loan 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 the Vehicle at the end of the lease.

  • purchase_price float

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

  • 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.

Loading...