Skip to main content

Create Acquisition

Creates a new Acquisition

Request Body

  • acquisition_type AcquisitionType required

    Possible values: [loan, lease]

    The acquisition type of the asset.

  • vehicle_id integer required

    Possible values: >= 1

  • vendor_id NullableId

    Possible values: >= 1

  • lender_id NullableId

    Possible values: >= 1

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

  • down_payment_amount float

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

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

  • acquisition_date date

    The date on which the Acquisition occurred or began.

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

  • first_payment_date date

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

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

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

  • loan_amount float

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

  • mileage_charge float

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

  • annual_percentage_rate float

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

  • reference_number string

    Possible values: <= 255 characters

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

  • notes string

    Optional free text field for additional notes.

Responses

OK

Response Headers

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