API Doc Version 1.3.36

What's New

POST /dms/quote/create

Create Quote

GET /dms/contracts

Get order contract

GET /dms/contracts/search

Get order contract

What's Changed

GET /dms/contract

Return Type:

Changed response : 200 OK

Successful Response

Changed content type : application/json
- Added property recieved_security_deposit (integer)
- Added property buyout (object)
  
  Vehicle Buyout
  - Property buyout_option (string)
    
    Buyout Option
  - Property vehicle_purchase_price (integer)
    
    Vehicle Purchase Price
- Added property final_bill_amount (integer)
- Added property first_bill_invoice_id (string)
- Changed property returns (object)
  - Added property vin (string)
  - Added property order_reference_number (string)
  - Added property current_odometer_reading (integer)
  - Added property dealer_id (integer)
  - Added property identifier (string)
  - Added property invoice_id (string)
  - Added property penalty_reason (string)
  - Added property penalty_amount (string)
  - Added property status (string)
  - Added property allowed_usage (integer)
  - Added property external_order_id (string)
  - Added property customer_reference_id (string)
  - Added property customer_first_name (string)
  - Added property customer_last_name (string)
  - Added property order_checklist (array)
    
    Items (object):
  - Deleted property return_status (object)
  - Deleted property odometer (integer)
  - Deleted property return_location (string)
  - Deleted property exceeded_miles_panalty_amount (integer)
  - Deleted property late_return_panalty_amount (integer)
  - Deleted property meta_data (object)
  - Deleted property created_at (string)
  - Deleted property created_by (string)
  - Deleted property updated_at (string)
  - Deleted property updated_by (string)
  - Deleted property check_list (object)
  - Changed property return_type (string)
    
    Removed enum values:
    - NORMAL
    - EARLY
    - UNWIND
- Changed property customer (object)
  - Added property customer_addresses (array)
    
    Items (object):
    - Property address_line_1 (string)
      
      Address line one
    - Property address_line_2 (string)
      
      Address line two
    - Property state_name (string)
      
      Address state name
    - Property zip_code (string)
      
      Zip code
    - Property county (string)
      
      Address county
    - Property city (string)
      
      Address city
    - Property contact_number (string)
      
      Contact number
    - Property verified (boolean)
      
      Is Address verified
    - Property address_type (string)
      
      An enumeration.
      
      Enum values:
      - Mailing
      - Invoice
      - Office
      - Garaging
      - DealerAddress
      - DrivingLicense
      - Billing
      - InsuranceAddress
      - Residential
    - Property identifier (string)
    - Property created_at (string)
    - Property created_by (string)
    - Property updated_at (string)
    - Property updated_by (string)
    - Property deleted_at (string)
    - Property deleted_by (string)
  - Added property income_info (object)
    - Property employment_type (string)
      
      Employment type
    - Property name (string)
      
      Name
    - Property phone (string)
      
      Phone
    - Property employed_since (string)
      
      Employed since
    - Property occupation (string)
      
      Occupation
    - Property annual_employment_income (number)
      
      Annual employment income
    - Property annual_other_income (number)
      
      Annual other income
    - Property source_of_other_income (string)
      
      Annual other income
    - Property created_at (string)
    - Property created_by (string)
    - Property updated_at (string)
    - Property updated_by (string)
    - Property deleted_at (string)
    - Property deleted_by (string)
  - Added property payments_info (array)
    
    Items (object):
    - Property type (string)
    - Property stripe_payment_method_id (string)
    - Property access_token (string)
    - Property account_id (string)
    - Property Bank_name (string)
    - Property last4 (integer)
    - Property default (boolean)
    - Property created_at (string)
    - Property created_by (string)
    - Property updated_at (string)
    - Property updated_by (string)
    - Property deleted_at (string)
    - Property deleted_by (string)
  - Added property license_info (object)
    - Property first_name (string)
    - Property last_name (string)
    - Property status (string)
    - Property license_number (string)
    - Property is_pdf_417 (boolean)
    - Property issue_date (string)
      
      format: YYYY-MM-DD
    - Property expiry_date (string)
      
      format: YYYY-MM-DD
    - Property is_selfie_verified (boolean)

POST /dms/contract

Return Type:

Changed response : 201 Created

Successful Response

Changed content type : application/json
- Added property recieved_security_deposit (integer)
- Added property buyout (object)
  
  Vehicle Buyout
- Added property final_bill_amount (integer)
- Added property first_bill_invoice_id (string)
- Changed property returns (object)
  - Added property vin (string)
  - Added property order_reference_number (string)
  - Added property current_odometer_reading (integer)
  - Added property dealer_id (integer)
  - Added property identifier (string)
  - Added property invoice_id (string)
  - Added property penalty_reason (string)
  - Added property penalty_amount (string)
  - Added property status (string)
  - Added property allowed_usage (integer)
  - Added property external_order_id (string)
  - Added property customer_reference_id (string)
  - Added property customer_first_name (string)
  - Added property customer_last_name (string)
  - Added property order_checklist (array)
  - Deleted property return_status (object)
  - Deleted property odometer (integer)
  - Deleted property return_location (string)
  - Deleted property exceeded_miles_panalty_amount (integer)
  - Deleted property late_return_panalty_amount (integer)
  - Deleted property meta_data (object)
  - Deleted property created_at (string)
  - Deleted property created_by (string)
  - Deleted property updated_at (string)
  - Deleted property updated_by (string)
  - Deleted property check_list (object)
  - Changed property return_type (string)
    
    Removed enum values:
    - NORMAL
    - EARLY
    - UNWIND
- Changed property customer (object)
  - Added property customer_addresses (array)
  - Added property income_info (object)
  - Added property payments_info (array)
  - Added property license_info (object)

PATCH /dms/contract

Request:

Changed content type : application/json

Added property final_bill_invoice_id (string)
Added property final_bill_amount (integer)
Added property buyout (object)

Vehicle Buyout
Added property assets (array)

Items (object):
- Property vin (string)
Changed property subscription_status (string)

An enumeration.

Added enum value:
- PURCHASED Return Type:

Changed response : 200 OK

Successful Response

Changed content type : application/json
- Added property recieved_security_deposit (integer)
- Added property buyout (object)
  
  Vehicle Buyout
- Added property final_bill_amount (integer)
- Added property first_bill_invoice_id (string)
- Changed property returns (object)
  - Added property vin (string)
  - Added property order_reference_number (string)
  - Added property current_odometer_reading (integer)
  - Added property dealer_id (integer)
  - Added property identifier (string)
  - Added property invoice_id (string)
  - Added property penalty_reason (string)
  - Added property penalty_amount (string)
  - Added property status (string)
  - Added property allowed_usage (integer)
  - Added property external_order_id (string)
  - Added property customer_reference_id (string)
  - Added property customer_first_name (string)
  - Added property customer_last_name (string)
  - Added property order_checklist (array)
  - Deleted property return_status (object)
  - Deleted property odometer (integer)
  - Deleted property return_location (string)
  - Deleted property exceeded_miles_panalty_amount (integer)
  - Deleted property late_return_panalty_amount (integer)
  - Deleted property meta_data (object)
  - Deleted property created_at (string)
  - Deleted property created_by (string)
  - Deleted property updated_at (string)
  - Deleted property updated_by (string)
  - Deleted property check_list (object)
  - Changed property return_type (string)
    
    Removed enum values:
    - NORMAL
    - EARLY
    - UNWIND
- Changed property customer (object)
  - Added property customer_addresses (array)
  - Added property income_info (object)
  - Added property payments_info (array)
  - Added property license_info (object)

GET /dms/contract/all

Parameters:

Changed: statuses in query

Accepts only string values

Return Type:

Changed response : 200 OK

Successful Response

Changed content type : application/json
- Changed property result (array)
  
  Changed items (object):
  - Added property recieved_security_deposit (integer)
  - Added property buyout (object)
    
    Vehicle Buyout
  - Added property final_bill_amount (integer)
  - Added property first_bill_invoice_id (string)
  - Changed property returns (object)
    - Added property vin (string)
    - Added property order_reference_number (string)
    - Added property current_odometer_reading (integer)
    - Added property dealer_id (integer)
    - Added property identifier (string)
    - Added property invoice_id (string)
    - Added property penalty_reason (string)
    - Added property penalty_amount (string)
    - Added property status (string)
    - Added property allowed_usage (integer)
    - Added property external_order_id (string)
    - Added property customer_reference_id (string)
    - Added property customer_first_name (string)
    - Added property customer_last_name (string)
    - Added property order_checklist (array)
    - Deleted property return_status (object)
    - Deleted property odometer (integer)
    - Deleted property return_location (string)
    - Deleted property exceeded_miles_panalty_amount (integer)
    - Deleted property late_return_panalty_amount (integer)
    - Deleted property meta_data (object)
    - Deleted property created_at (string)
    - Deleted property created_by (string)
    - Deleted property updated_at (string)
    - Deleted property updated_by (string)
    - Deleted property check_list (object)
    - Changed property return_type (string)
      
      Removed enum values:
      - NORMAL
      - EARLY
      - UNWIND
  - Changed property customer (object)
    - Added property customer_addresses (array)
    - Added property income_info (object)
    - Added property payments_info (array)
    - Added property license_info (object)

Version 1.3.37 Version 1.3.33