API Doc Version 1.3.43

What's New

PATCH /dms/update-dms-customer

Update Dms Customer

GET /dms/check-dms-customer

Get customer record

GET /dms/customer/signature/by-dealer-id

Gets a customer signature record by dealer id

PATCH /dms/customer/update-insurance-information

Updates customer insurance information

POST /dms/customer/all-customers-orders-dynamic-search

Get all customer records along with its orders dynamic search

POST /dms/customer/send-order-link

send order link

GET /dms/customers/reference-id

Get reference id by email

POST /dms/send-notification-email-sqs

Send Email Notification Through SQS

POST /dms/send-notification-email

Send Email Notification

GET /dms/order/order_insurance_documents/{reference_number}

Get order insurance documents by order ID

POST /dms/configure/insurance

Add insurance

GET /dms/order/workqueue

Get all orders for workqueue.

PATCH /dms/order/asset/{reference_number}

Updates an order asset record

POST /dms/update-order-submission

Update Order Submission Status

PATCH /dms/order/approve-order-by-lender/{reference_number}/{lender_id}

Update Order Status and Lender Id

POST /dms/order/get-customer-order-submissions/{customer_reference_id}/{submission_status}

Get order lender submissions of customer by status and Lender ids

GET /dms/order/get-order-submission-by-id/{submission_id}

Get single order submission by primary key

PATCH /dms/order/re-submit/{identifier}

Update order and re-send deal to lender

PATCH /dms/configure/individualized-agreement

Creates an order individualized agreement info setup record

PATCH /dms/configure/update-financial-indicator/{reference_number}/{is_payment_updated}

Update Financial Indicator

POST /dms/order/proposal

Create new order proposal for broker

PATCH /dms/order/proposal

Update order proposal for broker

PATCH /dms/order/change-proposal-status

Update order proposal status

GET /dms/order/proposal-dashboard-analytics

Get order proposal analytics for broker dashboard

POST /dms/order/generate-document/{event_name}

Generate Document for respective event

POST /dms/order/download_document_by_event/{event_name}

Get generated document(s) key(s) against specific event

POST /dms/order/send-email/{event_name}

send Email notification

GET /dms/order/stakeholder/

Get order stakeholder

POST /dms/order/stakeholder/

Create new order stakeholder

DELETE /dms/order/stakeholder/

Update order stakeholder

PATCH /dms/order/stakeholder/

Update order stakeholder

POST /dms/configure/multiple-disclaimers

Create multiple disclaimers

POST /dms/quote/calculation/monthlyImpact

Calculate Monthly Impact

GET /dms/customer/document/download-stream

Get customer document stream by artifect_id

GET /dms/get-an-signed-url

Get AN Signed URL to Upload

POST /dms/configure/by-role/{document_package_identifier}/{document_identifier}/{signature_id}/{signer_role}

Sign document

GET /dms/configure/document-pre-signed-url/{key}

Get document package by identifier

GET /dms/configure/document-notification-bookmarks

Get bookmarks of documents and notifications

POST /dms/contract-document

Handle contract document

GET /dms/company/by-tenant-id/{tenant_id}

Find Company By Tenant Id

GET /dms/integration/company

Get All Company Integration

GET /dms/integration/by_provider_name/{dealer_code}/{integration_type}/{provider_name}

Get Integration By Provider Name

GET /dms/integration/configuration/{dealer_code}/{integration_type}/{provider_name}

Get Hubex Configuration By Provider Name

GET /dms/dealer/option-model-name

Get All Dealer Options By Model Name

GET /dms/get-payment-methods/{reference_number}

Get Payment Methods & Get Paid Amount

POST /dms/plaid-link-token/

Create Link Token

POST /dms/create-payment/

Create payment for new Order

POST /dms/update-payment/

Update Order Payment

POST /dms/add-payment-details/

Add Payment Details from dealer side

PUT /dms/remove-payment-details/{order_payment_detail_id}

Remove the order payment detail

GET /dms/dealer/get-associated-dealers

Get All Dealer Distance

GET /dms/dealer/check-actively-order

Check Dealer actively order

POST /dms/get-trade-in-year/

Get all the year from KBB

POST /dms/get-trade-in-make/

Get all the make from KBB

POST /dms/get-trade-in-model/

Get all the models from KBB

POST /dms/get-trade-in-trim/

Get all the trims from KBB

POST /dms/get-trade-in-vehicle_value/

Get vehicle estimation from KBB

POST /dms/get-trade-in-vehicle_detail/

Get vehicle details from KBB

POST /dms/get-vehicle-detail-by-vin/

Get vehicle details through VIN

PATCH /dms/set-trade-in-inspection-status/{order_id}

Set Trade-in inspection status

GET /dms/get-trade_in_history/{order_id}

Get trade in history

POST /dms/get-tradein-options/

Get trade in options linked with vehicles

POST /dms/event_analytic

Create Event

GET /dms/lead/{dealer_id}

Get dealer's lead

PATCH /dms/lead

Update exisitng Draft/Active lead otherwise create new Lead

PATCH /dms/lead/change-status/{lead_id}

Update exisitng lead status

POST /dms/insurance/add-insurance

Add Insurance

What's Deleted

GET /dms/lender/by-tenant-id/{tenant_id}

Find Lender By Tenant Id

GET /dms/integration/lender

Get All Lender Integration

GET /dms/integration/by_provider_name/{provider_name}

Get Integration By Provider Name

GET /dms/dealer/option-trim-code

Get All Dealer Options By Trim Code

What's Changed

POST /dms/customer/all-customers-dynamic-search

Parameters:

Changed: sort_by in query

Request:

Changed content type : application/json

Changed items (object):

Changed property field (string)

An enumeration.

Added enum values:
- stock_number
- dealer_id Return Type:

Changed response : 200 OK

Successful Response

Changed content type : application/json

PATCH /dms/check-customer-by-email

Return Type:

Changed response : 200 OK

Successful Response

Changed content type : application/json
- Added property preferred_contact (string)
- Added property external_id (string)

GET /dms/customer/license-info

Parameters:

Added: is_presigned_url_required in query

POST /dms/customer/license-info

Parameters:

Added: dealer_code in query

PATCH /dms/customer/license-info

Parameters:

Added: is_presigned_url_required in query

Added: dealer_code in query

POST /dms/customer/personal-finance

Parameters:

Added: dealer_code in query

PATCH /dms/customer/personal-finance

Parameters:

Added: dealer_code in query

GET /dms/customer/signature

Return Type:

Changed response : 200 OK

Successful Response

Changed content type : application/json
- Added property dealer_id (integer)

POST /dms/customer/signature

Request:

Changed content type : application/json

Added property dealer_id (integer)

Return Type:

Changed response : 201 Created

Successful Response

Changed content type : application/json
- Added property dealer_id (integer)

PATCH /dms/customer/signature

Parameters:

Added: dealer_id in query

Changed: reference_id in query

Return Type:

Changed response : 200 OK

Successful Response

Changed content type : application/json
- Added property dealer_id (integer)

GET /dms/address/history

Parameters:

Changed: address_type in query

PATCH /dms/customer/insurance-information

Request:

Changed content type : application/json

Added property insurance_documents (array)

Items (object):
- Property document (string)
- Property content_type (string)
  
  format: application/pdf, image/png
- Property name (string)
- Property file_size (string)
- Property created_by (string)
- Property doucment_reference_id (string)

POST /dms/customer/comment

Request:

Changed content type : application/json

New optional properties:

reference_id

GET /dms/customer/comments

Parameters:

Changed: reference_id in query

Changed: page_number in query

Changed: page_size in query

POST /dms/customer/license-verification

Request:

Changed content type : application/json

Added property dealer_code (string)

POST /dms/customer/fraud-check

Request:

Changed content type : application/json

New required properties:

dealer_code

Added property dealer_code (string)

POST /dms/configure/order-fees

Request:

Changed content type : application/json

Added property vendor (string)
Added property fee_type (string)

Return Type:

Changed response : 201 Created

Successful Response

Changed content type : application/json
- Added property vendor (string)
- Added property fee_type (string)

GET /dms/configure/order-fees/{identifier}

Return Type:

Changed response : 200 OK

Successful Response

Changed content type : application/json

Changed items (object):
- Added property vendor (string)
- Added property fee_type (string)

DELETE /dms/configure/order-fees/{identifier}

Return Type:

Changed response : 200 OK

Successful Response

Changed content type : application/json
- Added property vendor (string)
- Added property fee_type (string)

PATCH /dms/configure/order-fees/{identifier}

Request:

Changed content type : application/json

Added property vendor (string)
Added property fee_type (string)

Return Type:

Changed response : 200 OK

Successful Response

Changed content type : application/json
- Added property vendor (string)
- Added property fee_type (string)

POST /dms/configure/order-fni

Request:

Changed content type : application/json

New required properties:

form_id
mileage
rate_id
term

Added property mileage (integer)
Added property term (integer)
Added property is_msp (boolean)
Added property form_id (integer)
Added property rate_id (integer)

GET /dms/configure/order-fni/{identifier}

Return Type:

Changed response : 200 OK

Successful Response

Changed content type : application/json

Changed items (object):

New required properties:
- form_id
- mileage
- rate_id
- term
- Added property mileage (integer)
- Added property term (integer)
- Added property is_msp (boolean)
- Added property form_id (integer)
- Added property rate_id (integer)

DELETE /dms/configure/order-fni/{identifier}

Return Type:

Changed response : 200 OK

Successful Response

Changed content type : application/json

New required properties:
- form_id
- mileage
- rate_id
- term
- Added property mileage (integer)
- Added property term (integer)
- Added property is_msp (boolean)
- Added property form_id (integer)
- Added property rate_id (integer)

PATCH /dms/configure/order-fni/{identifier}

Request:

Changed content type : application/json

New required properties:

form_id
mileage
rate_id
term

Added property mileage (integer)
Added property term (integer)
Added property is_msp (boolean)
Added property form_id (integer)
Added property rate_id (integer)

Return Type:

Changed response : 200 OK

Successful Response

Changed content type : application/json

New required properties:
- form_id
- mileage
- rate_id
- term
- Added property mileage (integer)
- Added property term (integer)
- Added property is_msp (boolean)
- Added property form_id (integer)
- Added property rate_id (integer)

PATCH /dms/configure/order/update-status/{reference_number}

Parameters:

Added: is_inventory_check in query

GET /dms/configure/assets-by-trim-code/{trim_code}

GET /dms/configure/quick-quotation-by-identifier/{identifier}

Return Type:

Changed response : 200 OK

Successful Response

Changed content type : application/json
- Added property name (string)
- Added property end_date (string)
- Added property updated_at (string)
- Added property estimated_monthly_payment (string)
- Added property calculations_type (string)
- Added property sum_of_advance_rentals (number)
- Added property balloon_collection (string)
- Added property product_type (string)
- Added property commission_type (string)
- Added property tax_amount (number)
- Added property tax_amount_number (integer)
- Added property deferred_type (string)
- Added property rate_type (string)
- Added property margin (number)
- Added property rental_mode (string)
- Added property sum_of_fees (number)
- Added property sum_of_periodic_interest (number)
- Added property sum_of_rentals (number)
- Added property total_payables (number)
- Added property running_id (string)
- Added property broker_id (integer)
- Added property non_vatable_amount (number)
- Added property order_stakeholders (array)
  
  Items (object):
  - Property identifier (string)
  - Property order_identifier (string)
  - Property stakeholder_reference_id (string)
  - Property name (string)
  - Property email (string)
  - Property role (string)
  - Property position (string)
  - Property contact_number (string)
  - Property address_id (string)
- Added property date_submitted (string)
- Changed property order_fees (array)
  
  Changed items (object):
  - Added property id (integer)
  - Added property fee_frequency (string)
  - Added property fee_occurance (string)
  - Added property fee_first_due_date (string)
- Changed property assets (array)
  
  Changed items (object):
  - Added property id (integer)
  - Added property identifier (string)
  - Added property rv_balloon_amount (number)
- Changed property customer (object)
  - Added property company_name (string)
  - Added property customer_type (string)

GET /dms/configure/quick-quotation-by-vendor

Parameters:

Added: statuses in query

Accepts only string values

Added: dealer_id in query

Added: broker_id in query

Added: lender_name in query

Added: dealer_name in query

Added: introducer_name in query

Added: name in query

Added: finance_type in query

Added: product_type in query

Added: finance_amount in query

Added: updated_at in query

Added: date_submitted in query

Added: start_date in query

Added: end_date in query

Added: sort_by in query

Added: sort_order in query

Added: order_stage in query

Return Type:

Changed response : 200 OK

Successful Response

Changed content type : application/json

Changed items (object):
- Added property name (string)
- Added property end_date (string)
- Added property updated_at (string)
- Added property estimated_monthly_payment (string)
- Added property calculations_type (string)
- Added property sum_of_advance_rentals (number)
- Added property balloon_collection (string)
- Added property product_type (string)
- Added property commission_type (string)
- Added property tax_amount (number)
- Added property tax_amount_number (integer)
- Added property deferred_type (string)
- Added property rate_type (string)
- Added property margin (number)
- Added property rental_mode (string)
- Added property sum_of_fees (number)
- Added property sum_of_periodic_interest (number)
- Added property sum_of_rentals (number)
- Added property total_payables (number)
- Added property running_id (string)
- Added property broker_id (integer)
- Added property non_vatable_amount (number)
- Added property order_stakeholders (array)
- Added property date_submitted (string)
- Changed property order_fees (array)
  
  Changed items (object):
  - Added property id (integer)
  - Added property fee_frequency (string)
  - Added property fee_occurance (string)
  - Added property fee_first_due_date (string)
- Changed property assets (array)
  
  Changed items (object):
  - Added property id (integer)
  - Added property identifier (string)
  - Added property rv_balloon_amount (number)
- Changed property customer (object)
  - Added property company_name (string)
  - Added property customer_type (string)

GET /dms/get-setup-data

Parameters:

Added: company_id in query

Deleted: lender_id in query

GET /dms/configure/disclaimer-agreement

Parameters:

Added: order_reference_id in query

GET /dms/configure/workqueue/search

Parameters:

Added: latest_order in query

POST /dms/quote/calculation

Request:

Changed content type : application/json

Changed property fees (array)

Fees

Changed items (object):
- Added property fee_handling (string)
- Added property is_taxable (boolean)
- Added property tax_in_capital (boolean)
- Added property vendor (string)
- Deleted property amount_handling (string)
Changed property fni_products (array)

F&I Products

Changed items (object):
- Added property is_taxable (boolean)

POST /dms/quote/calculate-order

Request:

Changed content type : application/json

Changed property fees (array)

Fees

Changed items (object):
- Added property fee_handling (string)
- Added property is_taxable (boolean)
- Added property tax_in_capital (boolean)
- Added property vendor (string)
- Deleted property amount_handling (string)
Changed property fni_products (array)

F&I Products

Changed items (object):
- Added property is_taxable (boolean)

POST /dms/quote/calculate-nfa

Request:

Changed content type : application/json

Changed property fees (array)

Fees

Changed items (object):
- Added property fee_handling (string)
- Added property is_taxable (boolean)
- Added property tax_in_capital (boolean)
- Added property vendor (string)
- Deleted property amount_handling (string)
Changed property fni_products (array)

F&I Products

Changed items (object):
- Added property is_taxable (boolean)

Return Type:

Changed response : 200 OK

Successful Response

Changed content type : application/json

New required properties:
- net_financed_amount
New optional properties:
- financed_amount
- Added property net_financed_amount (number)
  
  Net Financed amount calculated
- Deleted property financed_amount (integer)
  
  Financed amount calculated

POST /dms/quote/calculation/V2

Request:

Changed content type : application/json

New required properties:

finance_type

New optional properties:

base_rate
calculation_method
financed_amount
rental_mode

Added property annual_usage (integer)

Allowed Usage
Added property lender_id (integer)

Lender Id
Added property net_financed_amount (number)

Asset Financed amount
Added property vehicle (object)

Vehicle
- Property vin (string)
  
  VIN
- Property is_new (boolean)
  
  Is New
- Property odometer_mileage (integer)
  
  Odometer
- Property msrp (number)
  
  MSRP
- Property year (integer)
  
  Year
- Property transmission_type (string)
  
  Transmission Type
Added property customer_address (object)

Customer Address
- Property street_address (string)
  
  Street Address
- Property city (string)
  
  City
- Property state (string)
  
  State
- Property zip_code (string)
  
  Zip Code
Added property dealer_address (object)

Dealer Address
Added property trade_in_amount (number)

Trade-in amount
Added property finance_type (string)

Finance Type
Added property markup_rate (number)

Markup Rate
Added property trade_ins (array)

Trade Ins

Items (object):
- Property trade_in_type (string)
  
  Trade In Type
- Property vin (string)
  
  VIN
- Property offer_amount (number)
  
  Offer Amount
- Property pay_off_amount (number)
  
  Pay Off Amount
- Property allowance_amount (number)
  
  Actual Cash Value
Added property rebate (object)

Rebate Model
- Property name (string)
  
  Description of the rebate
- Property price (number)
  
  Price of the rebate
Added property tax_on_selling_price (number)

Selling Price Tax Calculation
Deleted property financed_amount (number)

Asset Financed amount
Changed property fees (array)

Fees

Changed items (object):
- Added property fee_handling (string)
- Added property is_taxable (boolean)
- Added property tax_in_capital (boolean)
- Added property vendor (string)
- Deleted property amount_handling (string)
Changed property fni_products (array)

F&I Products

Changed items (object):
- Added property is_taxable (boolean)

Return Type:

Changed response : 200 OK

Successful Response

Changed content type : application/json
- Added property add_ons_total (number)
- Added property adjusted_capitalized_cost (number)
- Added property base_monthly_payment (number)
- Added property tax_on_capitalized_cost_reduction (number)
- Added property monthly_deprecation (number)
- Added property capitalized_cost_reduction (number)
- Added property fees_total (number)
- Added property fni_total (number)
- Added property fni_products (array)
  
  Items (object):
  - Property price (number)
  - Property name (string)
  - Property monthly_impact (number)
- Added property gross_capitalized_cost (number)
- Added property monthly_payment (number)
- Added property monthly_sales_use_tax (number)
- Added property rebate_promotions (number)
- Added property tax_amount (number)

POST /dms/quote/calculation/multi-assets

Request:

Changed content type : application/json

Changed items (object):

Changed property fees (array)

Fees

Changed items (object):
- Added property fee_handling (string)
- Added property is_taxable (boolean)
- Added property tax_in_capital (boolean)
- Added property vendor (string)
- Deleted property amount_handling (string)
Changed property fni_products (array)

F&I Products

Changed items (object):
- Added property is_taxable (boolean)

POST /dms/quote/calculation/quantity

Request:

Changed content type : application/json

Changed property fees (array)

Fees

Changed items (object):
- Added property fee_handling (string)
- Added property is_taxable (boolean)
- Added property tax_in_capital (boolean)
- Added property vendor (string)
- Deleted property amount_handling (string)
Changed property fni_products (array)

F&I Products

Changed items (object):
- Added property is_taxable (boolean)

GET /dms/customer/document/status

Return Type:

Changed response : 200 OK

Successful Response

Changed content type : application/json
- Added property customer_reference_id (string)
- Added property external_reference_id (string)
- Added property document_type (string)
- Added property comment (string)
- Added property category (string)
- Added property document_name (string)
- Added property document_size (string)
- Added property document_url (string)
- Added property reason_by_system (string)
- Added property reason_for_customer (string)
- Added property document_status (string)
- Added property document_upload_indicator (boolean)
- Added property expires_at (string)
  
  format: YYYY-MM-DD hh:mm:ss
- Added property created_at (string)
  
  format: YYYY-MM-DD hh:mm:ss
- Added property updated_at (string)
  
  format: YYYY-MM-DD hh:mm:ss
- Added property deleted_at (string)
  
  format: YYYY-MM-DD hh:mm:ss
- Added property updated_by (string)
- Added property created_by (string)
- Added property deleted_by (string)
- Added property uploaded_by (string)
- Added property uploaded_at (string)
- Added property is_deleted (boolean)
- Added property identifier (string)
- Added property stipulation_code (string)
- Deleted property result (array)
- Deleted property page_number (integer)
- Deleted property page_size (integer)
- Deleted property total_pages (integer)
- Deleted property total_results (integer)

GET /dms/configure/document-package/document

Return Type:

Changed response : 200 OK

Successful

Changed content type : application/json
- Changed property signatures (array)
  
  Changed items (object):
  - Added property x_bound (integer)
  - Added property y_bound (integer)

POST /dms/configure/{document_package_id}/{document_id}/{signature_id}

Return Type:

Changed response : 200 OK

Successful Response

Changed content type : application/json
- Changed property signatures (array)
  
  Changed items (object):
  - Added property x_bound (integer)
  - Added property y_bound (integer)

POST /dms/submit-order

Request:

New content type : application/json

GET /dms/stipulation/stipulation-by-lender

Parameters:

Added: company_id in query

Deleted: lender_id in query

POST /dms/affordability-check/

Request:

Changed content type : application/json

New required properties:

company_code
dealer_code
lender_code

New optional properties:

dealer_id

Added property dealer_code (string)
Added property company_code (string)

Company code
Added property lender_code (string)
Deleted property dealer_id (integer)

POST /dms/affordability-check/monthly-payment-calculation/V2/

Request:

Changed content type : application/json

New required properties:

company_id

New optional properties:

lender_id

Added property company_id (integer)
Deleted property lender_id (integer)

GET /dms/inventory/filter

Parameters:

Added: vin in query

Added: mileage in query

GET /dms/contract-term

Parameters:

Added: company_id in header

Deleted: lender_id in header

GET /dms/credit-ratings

Parameters:

Added: company_id in header

Deleted: lender_id in header

GET /dms/contract-allowed-annum-mileage

Parameters:

Added: company_id in header

Deleted: lender_id in header

GET /dms/asset-usage/active

Parameters:

Added: company_id in header

Deleted: lender_id in header

POST /dms/programs/all/

Request:

Changed content type : application/json

Added property dealer_code (string)

Dealer Code
Added property lender_code (string)

Lender Code
Added property company_code (string)

Company Code
Added property customer_type (string)

Customer Type for Chart
Added property product_type (string)

Product Type For Chart
Added property asset_category (string)

Asset Category For Chart
Added property asset_type (string)

Asset Type For Chart
Added property business_trading_age (string)

Business Trading Age For Chart
Added property model_code (string)

Model Code
Added property asset_condition (string)

Asset Condition
Added property asset_classification (string)

Asset Classification (e.g. Vehicle, Equipment etc.)
Added property is_rv_guaranteed (string)

Is RV Guaranteed
Added property financed_amount (string)

Financed Amount
Added property vin (string)

Vin Number
Added property odometer (integer)

Odometer
Added property selling_price (integer)

Selling Price
Added property msrp (integer)

MSRF
Added property is_new (boolean)

Is it new
Added property total_score (integer)

Total Score
Added property is_payment_estimator (boolean)

Is Payment Estimator
Added property tier (string)

tier
Deleted property dealer_id (integer)

System Generated Dealer Id
Deleted property asset_make_id (integer)

System Generated Asset Make Id
Deleted property asset_model_id (integer)

System Generated Asset Model Id
Deleted property asset_model_detail_id (integer)

System Generated Asset Trim Id

POST /dms/get_event_associated_checklist/

This API helps to evaluate given criteria and retrieve configured checklist(s)

GET /dms/dealer/all-dealer-distance

Parameters:

Added: company_id in query

Deleted: lender_id in query

Changed: zip_code in query

Return Type:

Changed response : 200 OK

Successful Response

Changed content type : application/json
- Changed property result (array)
  
  Changed items (object):
  - Changed property dealer_zip_code (integer -> string)
    
    Dealer Zip Code

POST /dms/customer/

Request:

Changed content type : application/json

Added property customer_license (array)

Items (object):
- Property first_name (string)
  
  First name
- Property last_name (string)
  
  Last name
- Property date_of_birth (string)
  
  format: YYYY-MM-DD
- Property is_pdf_417 (boolean)
- Property license_number (string)
  
  license number
- Property issue_date (string)
  
  format: YYYY-MM-DD
- Property expiry_date (string)
  
  format: YYYY-MM-DD
- Property front_image (string)
  
  license front image
- Property back_image (string)
  
  license back image
- Property status (string)
- Property call_type (string)
  
  An enumeration.
  
  Enum values:
  - manual
  - auto
- Property selfie_image (string)
- Property cropped_front_image (string)
- Property cropped_back_image (string)
- Property cropped_selfie_image (string)
- Property is_selfie_verified (boolean)
- Property created_by (string)
- Property reference_id (string)
- Property identifier (string)
- Property mitek_response (string)
- Property address (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 move_in_date (string)
    
    format: YYYY-MM-DD
  - Property is_garaging (boolean)
    
    Garaging flag
  - Property identifier (string)
Added property customer_insurance (array)

Items (object):
- Property order_reference_id (string)
- Property reference_id (string)
- Property insurer_name (string)
- Property agent_phone (string)
- Property subscription_id (string)
- Property agent_name (string)
- Property policy_number (string)
- Property start_date (string)
  
  format: YYYY-MM-DD
- Property expiration_date (string)
  
  format: YYYY-MM-DD
- Property deductible_comprehensive (number)
- Property deductible_collision (number)
- Property created_by (string)
- Property identifier (string)
- Property is_verified (boolean)
- Property insurance_documents (array)
- Property insurer_address (object)
Changed property customer_profile (object)
- Added property preferred_contact (string)
- Added property external_id (string)

Return Type:

Changed response : 201 Created

Successful Response

Changed content type : application/json
- Added property preferred_contact (string)
- Added property external_id (string)

GET /dms/customer/customer-history

Return Type:

Changed response : 200 OK

Successful Response

Changed content type : application/json

Changed items (object):
- Added property preferred_contact (string)
- Added property external_id (string)

GET /dms/customer

Return Type:

Changed response : 200 OK

Successful Response

Changed content type : application/json
- Added property preferred_contact (string)
- Added property external_id (string)

PATCH /dms/customer

Parameters:

Added: dealer_code in query

Request:

Changed content type : application/json

Changed property customer_profile (object)
- Added property preferred_contact (string)

Return Type:

Changed response : 200 OK

Successful Response

Changed content type : application/json
- Added property preferred_contact (string)
- Added property external_id (string)

GET /dms/customer-by-email

Return Type:

Changed response : 200 OK

Successful Response

Changed content type : application/json
- Added property preferred_contact (string)
- Added property external_id (string)

POST /dms/customer/employment-info

Parameters:

Added: dealer_code in query

PATCH /dms/customer/employment-info

Parameters:

Added: dealer_code in query

PATCH /dms/order/quick_quotation

Request:

Changed content type : application/json

Added property name (string)
Added property identifier (string)
Added property start_date (string)
Added property end_date (string)
Added property customer_reference_id (string)
Added property external_order_id (string)
Added property created_by (string)
Added property selling_price (number)
Added property down_payment (number)
Added property estimated_monthly_payment (number)
Added property sum_of_advance_rentals (number)
Added property calculations_type (string)
Added property no_of_advance_payments (integer)
Added property no_of_regular_payments (integer)
Added property introducer_identifier (string)
Added property introducer_name (string)
Added property rental_frequency (string)
Added property deferral_amount (number)
Added property rv_balloon_value (number)
Added property balloon_collection (string)
Added property finance_type (string)
Added property product_type (string)
Added property program_type (string)
Added property finance_amount (number)
Added property gross_profit (number)
Added property commission_amount (number)
Added property due_at_signing (number)
Added property meta_data (object)
Added property comments (string)
Added property broker_id (string)
Added property vat_treatment (string)
Added property tax_amount (number)
Added property tax_amount_number (integer)
Added property deferred_type (string)
Added property reference_number (string)
Added property rental_mode (string)
Added property rate_type (string)
Added property margin (number)
Added property commission_type (string)
Added property sum_of_fees (number)
Added property sum_of_periodic_interest (number)
Added property sum_of_rentals (number)
Added property total_payables (number)
Added property running_id (string)
Added property non_vatable_amount (number)
Added property order_fees (array)

Items (object):
- Property id (integer)
- Property identifier (string)
- Property dealer_fee_name (string)
- Property applied_price (number)
- Property order_id (integer)
- Property fee_frequency (string)
- Property fee_occurance (string)
- Property fee_first_due_date (string)
Added property order_payments (array)

Items (object):
- Property identifier (string)
- Property payment_number_from (integer)
- Property payment_number_to (integer)
- Property amount (number)
- Property payment_type (string)
- Property order_id (integer)
Added property customer (object)
- Property company_name (string)
- Property first_name (string)
- Property last_name (string)
- Property mobile_number (string)
- Property customer_type (string)
- Property identifier (string)
- Property email (string)
- Property reference_id (string)
Changed property dealer_id (integer -> string)
Changed property assets (array)

Changed items (object):
- Added property id (integer)
- Added property identifier (string)
- Added property rv_balloon_amount (number)

Return Type:

Changed response : 200 OK

Successful Response

Changed content type : application/json
- Added property name (string)
- Added property end_date (string)
- Added property updated_at (string)
- Added property estimated_monthly_payment (string)
- Added property calculations_type (string)
- Added property sum_of_advance_rentals (number)
- Added property balloon_collection (string)
- Added property product_type (string)
- Added property commission_type (string)
- Added property tax_amount (number)
- Added property tax_amount_number (integer)
- Added property deferred_type (string)
- Added property rate_type (string)
- Added property margin (number)
- Added property rental_mode (string)
- Added property sum_of_fees (number)
- Added property sum_of_periodic_interest (number)
- Added property sum_of_rentals (number)
- Added property total_payables (number)
- Added property running_id (string)
- Added property broker_id (integer)
- Added property non_vatable_amount (number)
- Added property order_stakeholders (array)
- Added property date_submitted (string)
- Changed property order_fees (array)
  
  Changed items (object):
  - Added property id (integer)
  - Added property fee_frequency (string)
  - Added property fee_occurance (string)
  - Added property fee_first_due_date (string)
- Changed property assets (array)
  
  Changed items (object):
  - Added property id (integer)
  - Added property identifier (string)
  - Added property rv_balloon_amount (number)
- Changed property customer (object)
  - Added property company_name (string)
  - Added property customer_type (string)

POST /dms/order/quick_quotation

Request:

Changed content type : application/json

Changed property quote_identifiers (object)
- Added property company_name (string)
- Added property customer_type (string)
Changed property quote_details (object)
- Added property name (string)
- Added property end_date (string)
- Added property estimated_monthly_payment (number)
- Added property sum_of_advance_rentals (number)
- Added property calculations_type (string)
- Added property balloon_collection (string)
- Added property product_type (string)
- Added property program_type (string)
- Added property broker_id (string)
- Added property tax_amount (number)
- Added property tax_amount_number (integer)
- Added property deferred_type (string)
- Added property rental_mode (string)
- Added property rate_type (string)
- Added property margin (number)
- Added property commission_type (string)
- Added property sum_of_fees (number)
- Added property sum_of_periodic_interest (number)
- Added property sum_of_rentals (number)
- Added property total_payables (number)
- Added property running_id (string)
- Added property non_vatable_amount (number)
- Changed property order_fees (array)
  
  Changed items (object):
  - Added property id (integer)
  - Added property fee_frequency (string)
  - Added property fee_occurance (string)
  - Added property fee_first_due_date (string)
- Changed property assets (array)
  
  Changed items (object):
  - Added property id (integer)
  - Added property identifier (string)
  - Added property rv_balloon_amount (number)

Return Type:

Changed response : 200 OK

Successful Response

Changed content type : application/json
- Added property name (string)
- Added property end_date (string)
- Added property updated_at (string)
- Added property estimated_monthly_payment (string)
- Added property calculations_type (string)
- Added property sum_of_advance_rentals (number)
- Added property balloon_collection (string)
- Added property product_type (string)
- Added property commission_type (string)
- Added property tax_amount (number)
- Added property tax_amount_number (integer)
- Added property deferred_type (string)
- Added property rate_type (string)
- Added property margin (number)
- Added property rental_mode (string)
- Added property sum_of_fees (number)
- Added property sum_of_periodic_interest (number)
- Added property sum_of_rentals (number)
- Added property total_payables (number)
- Added property running_id (string)
- Added property broker_id (integer)
- Added property non_vatable_amount (number)
- Added property order_stakeholders (array)
- Added property date_submitted (string)
- Changed property order_fees (array)
  
  Changed items (object):
  - Added property id (integer)
  - Added property fee_frequency (string)
  - Added property fee_occurance (string)
  - Added property fee_first_due_date (string)
- Changed property assets (array)
  
  Changed items (object):
  - Added property id (integer)
  - Added property identifier (string)
  - Added property rv_balloon_amount (number)
- Changed property customer (object)
  - Added property company_name (string)
  - Added property customer_type (string)

POST /dms/configure/appointment

Request:

Changed content type : application/json

New optional properties:

customer_id

Added property time_zone (string)

PATCH /dms/configure/appointment

Request:

Changed content type : application/json

New optional properties:

customer_id

Added property time_zone (string)

GET /dms/configure/document-package

Return Type:

Changed response : 200 OK

Successful

Changed content type : application/json
- Changed property documents (array)
  
  Changed items (object):
  - Changed property signatures (array)
    
    Changed items (object):
    - Added property x_bound (integer)
    - Added property y_bound (integer)

POST /dms/configure/document-package

Parameters:

Added: is_product in query

Request:

Changed content type : application/json

Changed property documents (array)

Changed items (object):
- Changed property signatures (array)
  
  Changed items (object):
  - Added property x_bound (integer)
  - Added property y_bound (integer)

Return Type:

Changed response : 200 OK

Successful Response

Changed content type : application/json
- Changed property documents (array)
  
  Changed items (object):
  - Changed property signatures (array)
    
    Changed items (object):
    - Added property x_bound (integer)
    - Added property y_bound (integer)

GET /dms/configure/document-package-by-reference-id

Return Type:

Changed response : 200 OK

Successful Response

Changed content type : application/json
- Changed property documents (array)
  
  Changed items (object):
  - Changed property signatures (array)
    
    Changed items (object):
    - Added property x_bound (integer)
    - Added property y_bound (integer)

GET /dms/configure/all-document-packages-by-reference-id

Parameters:

Changed: document_type in query

Document Type

Return Type:

Changed response : 200 OK

Successful Response

Changed content type : application/json

Changed items (object):
- Changed property documents (array)
  
  Changed items (object):
  - Changed property signatures (array)
    
    Changed items (object):
    - Added property x_bound (integer)
    - Added property y_bound (integer)

GET /dms/customer/all-customers

Parameters:

Changed: sort_by in query

Return Type:

Changed response : 200 OK

Successful Response

Changed content type : application/json
- Changed property result (array)
  
  Changed items (object):
  - Added property preferred_contact (string)
  - Added property external_id (string)

GET /dms/configure/quotation

Return Type:

Changed response : 200 OK

Successful Response

Changed content type : application/json

New optional properties:
- allowed_usage
- annual_usage
- apr
- contract_term
- credit_rating
- customer_id
- dealer_id
- down_payment
- down_payment_lease
- due_at_signing
- estimated_monthly_payment
- lender_id
- rv_balloon_percentage
- rv_balloon_value
- selling_price
- vehicle_id
- Added property broker_id (integer)
- Added property company_id (integer)
- Added property name (string)
- Added property is_payment_updated (boolean)
- Added property tax_amount (number)
- Added property tax_amount_number (number)
- Added property deferred_type (string)
- Added property balloon_collection (string)
- Added property rate_type (string)
- Added property commission_type (string)
- Added property running_id (string)
- Added property order_currency (string)
- Added property commission_amount (number)
- Added property received_security_deposit (integer)
- Added property net_finance_amount (number)
- Added property rebate (number)
- Added property capitalized_cost_reduction (number)
- Added property monthly_deprecation (number)
- Added property tax_on_capitalized_cost_reduction (number)
- Added property monthly_sales_use_tax (number)
- Added property sum_of_fees (number)
- Added property sum_of_periodic_interest (number)
- Added property sum_of_rentals (number)
- Added property total_payables (number)
- Added property non_vatable_amount (number)
- Added property individualized_agreement (string)
- Added property base_residual_type (integer)
- Added property excess_mileage_rate (number)
- Added property asset_rv_amount (number)
- Changed property order_fnI (array)
  
  Changed items (object):
  - Added property mileage (integer)
  - Added property term (integer)
  - Added property is_msp (boolean)
- Changed property order_fees (array)
  
  Changed items (object):
  - Added property vendor (string)
  - Added property fee_type (string)
- Changed property order_asset (object)
  - Added property mileage (integer)
  - Added property asset_type (string)
  - Added property rv_balloon_amount (number)
  - Deleted property milage (boolean)
- Changed property order_tradein (object)
  - Added property trade_in_type (string)
    
    An enumeration.
    
    Enum values:
    - Manual Estimate
    - Make Model
    - Vin
    - License Plate
  - Added property question_answers (array)
    
    Items (object):
    - Property question (string)
    - Property answer (string)
    - Property trade_in_id (integer)
- Changed property appointment_details (object)
  - Added property time_zone (string)

GET /dms/configure/all-quotations

Return Type:

Changed response : 200 OK

Successful Response

Changed content type : application/json

Changed items (object):

New optional properties:
- allowed_usage
- annual_usage
- apr
- contract_term
- credit_rating
- customer_id
- dealer_id
- down_payment
- down_payment_lease
- due_at_signing
- estimated_monthly_payment
- lender_id
- rv_balloon_percentage
- rv_balloon_value
- selling_price
- vehicle_id
- Added property broker_id (integer)
- Added property company_id (integer)
- Added property name (string)
- Added property is_payment_updated (boolean)
- Added property tax_amount (number)
- Added property tax_amount_number (number)
- Added property deferred_type (string)
- Added property balloon_collection (string)
- Added property rate_type (string)
- Added property commission_type (string)
- Added property running_id (string)
- Added property order_currency (string)
- Added property commission_amount (number)
- Added property received_security_deposit (integer)
- Added property net_finance_amount (number)
- Added property rebate (number)
- Added property capitalized_cost_reduction (number)
- Added property monthly_deprecation (number)
- Added property tax_on_capitalized_cost_reduction (number)
- Added property monthly_sales_use_tax (number)
- Added property sum_of_fees (number)
- Added property sum_of_periodic_interest (number)
- Added property sum_of_rentals (number)
- Added property total_payables (number)
- Added property non_vatable_amount (number)
- Added property individualized_agreement (string)
- Added property base_residual_type (integer)
- Added property excess_mileage_rate (number)
- Added property asset_rv_amount (number)
- Changed property order_fnI (array)
  
  Changed items (object):
  - Added property mileage (integer)
  - Added property term (integer)
  - Added property is_msp (boolean)
- Changed property order_fees (array)
  
  Changed items (object):
  - Added property vendor (string)
  - Added property fee_type (string)
- Changed property order_asset (object)
  - Added property mileage (integer)
  - Added property asset_type (string)
  - Added property rv_balloon_amount (number)
  - Deleted property milage (boolean)
- Changed property order_tradein (object)
  - Added property trade_in_type (string)
    
    An enumeration.
  - Added property question_answers (array)
- Changed property appointment_details (object)
  - Added property time_zone (string)

PATCH /dms/configure/quotation/{identifier}

Request:

Changed content type : application/json

New optional properties:

allowed_usage
annual_usage
apr
contract_term
credit_rating
dealer_id
down_payment
down_payment_lease
due_at_signing
estimated_monthly_payment
lender_id
rv_balloon_percentage
rv_balloon_value
selling_price
vehicle_id

Added property broker_id (integer)
Added property company_id (integer)
Added property name (string)
Added property is_payment_updated (boolean)
Added property tax_amount (number)
Added property tax_amount_number (number)
Added property deferred_type (string)
Added property balloon_collection (string)
Added property rate_type (string)
Added property commission_type (string)
Added property running_id (string)
Added property order_currency (string)
Added property commission_amount (number)
Added property received_security_deposit (integer)
Added property net_finance_amount (number)
Added property rebate (number)
Added property capitalized_cost_reduction (number)
Added property monthly_deprecation (number)
Added property tax_on_capitalized_cost_reduction (number)
Added property monthly_sales_use_tax (number)
Added property sum_of_fees (number)
Added property sum_of_periodic_interest (number)
Added property sum_of_rentals (number)
Added property total_payables (number)
Added property non_vatable_amount (number)
Added property individualized_agreement (string)
Added property base_residual_type (integer)
Added property excess_mileage_rate (number)
Added property asset_rv_amount (number)
Changed property order_fnI (array)

Changed items (object):
- Added property mileage (integer)
- Added property term (integer)
- Added property is_msp (boolean)
Changed property order_fees (array)

Changed items (object):
- Added property vendor (string)
- Added property fee_type (string)
Changed property order_asset (object)
- Added property mileage (integer)
- Added property asset_type (string)
- Added property rv_balloon_amount (number)
- Deleted property milage (boolean)
Changed property order_tradein (object)
- Added property trade_in_type (string)
  
  An enumeration.
- Added property question_answers (array)
Changed property appointment_details (object)
- Added property time_zone (string)

Return Type:

Changed response : 200 OK

Successful Response

Changed content type : application/json

New optional properties:
- allowed_usage
- annual_usage
- apr
- contract_term
- credit_rating
- dealer_id
- down_payment
- down_payment_lease
- due_at_signing
- estimated_monthly_payment
- lender_id
- rv_balloon_percentage
- rv_balloon_value
- selling_price
- vehicle_id
- Added property broker_id (integer)
- Added property company_id (integer)
- Added property name (string)
- Added property is_payment_updated (boolean)
- Added property tax_amount (number)
- Added property tax_amount_number (number)
- Added property deferred_type (string)
- Added property balloon_collection (string)
- Added property rate_type (string)
- Added property commission_type (string)
- Added property running_id (string)
- Added property order_currency (string)
- Added property commission_amount (number)
- Added property received_security_deposit (integer)
- Added property net_finance_amount (number)
- Added property rebate (number)
- Added property capitalized_cost_reduction (number)
- Added property monthly_deprecation (number)
- Added property tax_on_capitalized_cost_reduction (number)
- Added property monthly_sales_use_tax (number)
- Added property sum_of_fees (number)
- Added property sum_of_periodic_interest (number)
- Added property sum_of_rentals (number)
- Added property total_payables (number)
- Added property non_vatable_amount (number)
- Added property individualized_agreement (string)
- Added property base_residual_type (integer)
- Added property excess_mileage_rate (number)
- Added property asset_rv_amount (number)
- Added property changeVehicleStatus (boolean)
- Changed property order_fnI (array)
  
  Changed items (object):
  - Added property mileage (integer)
  - Added property term (integer)
  - Added property is_msp (boolean)
- Changed property order_fees (array)
  
  Changed items (object):
  - Added property vendor (string)
  - Added property fee_type (string)
- Changed property order_asset (object)
  - Added property mileage (integer)
  - Added property asset_type (string)
  - Added property rv_balloon_amount (number)
  - Deleted property milage (boolean)
- Changed property order_tradein (object)
  - Added property trade_in_type (string)
    
    An enumeration.
  - Added property question_answers (array)
- Changed property appointment_details (object)
  - Added property time_zone (string)

POST /dms/configure/save-quotation

Request:

Changed content type : application/json

Changed items (object):

New optional properties:

allowed_usage
annual_usage
apr
contract_term
credit_rating
dealer_id
down_payment
down_payment_lease
due_at_signing
estimated_monthly_payment
lender_id
rv_balloon_percentage
rv_balloon_value
selling_price
vehicle_id

Added property broker_id (integer)
Added property company_id (integer)
Added property name (string)
Added property is_payment_updated (boolean)
Added property tax_amount (number)
Added property tax_amount_number (number)
Added property deferred_type (string)
Added property balloon_collection (string)
Added property rate_type (string)
Added property commission_type (string)
Added property running_id (string)
Added property order_currency (string)
Added property commission_amount (number)
Added property received_security_deposit (integer)
Added property net_finance_amount (number)
Added property rebate (number)
Added property capitalized_cost_reduction (number)
Added property monthly_deprecation (number)
Added property tax_on_capitalized_cost_reduction (number)
Added property monthly_sales_use_tax (number)
Added property sum_of_fees (number)
Added property sum_of_periodic_interest (number)
Added property sum_of_rentals (number)
Added property total_payables (number)
Added property non_vatable_amount (number)
Added property individualized_agreement (string)
Added property base_residual_type (integer)
Added property excess_mileage_rate (number)
Added property asset_rv_amount (number)
Added property is_payment_estimator (boolean)
Changed property order_fnI (array)

Changed items (object):
- Added property mileage (integer)
- Added property term (integer)
- Added property is_msp (boolean)
Changed property order_fees (array)

Changed items (object):
- Added property vendor (string)
- Added property fee_type (string)
Changed property order_asset (object)
- Added property mileage (integer)
- Added property asset_type (string)
- Added property rv_balloon_amount (number)
- Deleted property milage (boolean)
Changed property order_tradein (object)
- Added property trade_in_type (string)
  
  An enumeration.
- Added property question_answers (array)
Changed property appointment_details (object)
- Added property time_zone (string)

Return Type:

Changed response : 201 Created

Successful Response

Changed content type : application/json

Changed items (object):

New optional properties:
- allowed_usage
- annual_usage
- apr
- contract_term
- credit_rating
- customer_id
- dealer_id
- down_payment
- down_payment_lease
- due_at_signing
- estimated_monthly_payment
- lender_id
- rv_balloon_percentage
- rv_balloon_value
- selling_price
- vehicle_id
- Added property broker_id (integer)
- Added property company_id (integer)
- Added property name (string)
- Added property is_payment_updated (boolean)
- Added property tax_amount (number)
- Added property tax_amount_number (number)
- Added property deferred_type (string)
- Added property balloon_collection (string)
- Added property rate_type (string)
- Added property commission_type (string)
- Added property running_id (string)
- Added property order_currency (string)
- Added property commission_amount (number)
- Added property received_security_deposit (integer)
- Added property net_finance_amount (number)
- Added property rebate (number)
- Added property capitalized_cost_reduction (number)
- Added property monthly_deprecation (number)
- Added property tax_on_capitalized_cost_reduction (number)
- Added property monthly_sales_use_tax (number)
- Added property sum_of_fees (number)
- Added property sum_of_periodic_interest (number)
- Added property sum_of_rentals (number)
- Added property total_payables (number)
- Added property non_vatable_amount (number)
- Added property individualized_agreement (string)
- Added property base_residual_type (integer)
- Added property excess_mileage_rate (number)
- Added property asset_rv_amount (number)
- Changed property order_fnI (array)
  
  Changed items (object):
  - Added property mileage (integer)
  - Added property term (integer)
  - Added property is_msp (boolean)
- Changed property order_fees (array)
  
  Changed items (object):
  - Added property vendor (string)
  - Added property fee_type (string)
- Changed property order_asset (object)
  - Added property mileage (integer)
  - Added property asset_type (string)
  - Added property rv_balloon_amount (number)
  - Deleted property milage (boolean)
- Changed property order_tradein (object)
  - Added property trade_in_type (string)
    
    An enumeration.
  - Added property question_answers (array)
- Changed property appointment_details (object)
  - Added property time_zone (string)

PATCH /dms/order/update-credit-approver-decision/{reference_number}

Return Type:

Changed response : 200 OK

Successful Response

Changed content type : application/json

New optional properties:
- allowed_usage
- annual_usage
- apr
- contract_term
- credit_rating
- dealer_id
- down_payment
- down_payment_lease
- due_at_signing
- estimated_monthly_payment
- lender_id
- rv_balloon_percentage
- rv_balloon_value
- selling_price
- vehicle_id
- Added property broker_id (integer)
- Added property company_id (integer)
- Added property name (string)
- Added property is_payment_updated (boolean)
- Added property tax_amount (number)
- Added property tax_amount_number (number)
- Added property deferred_type (string)
- Added property balloon_collection (string)
- Added property rate_type (string)
- Added property commission_type (string)
- Added property running_id (string)
- Added property order_currency (string)
- Added property commission_amount (number)
- Added property received_security_deposit (integer)
- Added property net_finance_amount (number)
- Added property rebate (number)
- Added property capitalized_cost_reduction (number)
- Added property monthly_deprecation (number)
- Added property tax_on_capitalized_cost_reduction (number)
- Added property monthly_sales_use_tax (number)
- Added property sum_of_fees (number)
- Added property sum_of_periodic_interest (number)
- Added property sum_of_rentals (number)
- Added property total_payables (number)
- Added property non_vatable_amount (number)
- Added property individualized_agreement (string)
- Added property base_residual_type (integer)
- Added property excess_mileage_rate (number)
- Added property asset_rv_amount (number)
- Changed property order_fnI (array)
  
  Changed items (object):
  - Added property mileage (integer)
  - Added property term (integer)
  - Added property is_msp (boolean)
- Changed property order_fees (array)
  
  Changed items (object):
  - Added property vendor (string)
  - Added property fee_type (string)
- Changed property order_asset (object)
  - Added property mileage (integer)
  - Added property asset_type (string)
  - Added property rv_balloon_amount (number)
  - Deleted property milage (boolean)
- Changed property order_tradein (object)
  - Added property trade_in_type (string)
    
    An enumeration.
  - Added property question_answers (array)
- Changed property appointment_details (object)
  - Added property time_zone (string)

PATCH /dms/configure/quotation-to-order/{identifier}

Request:

Changed content type : application/json

New optional properties:

allowed_usage
annual_usage
apr
contract_term
credit_rating
dealer_id
down_payment
down_payment_lease
due_at_signing
estimated_monthly_payment
lender_id
rv_balloon_percentage
rv_balloon_value
selling_price
vehicle_id

Added property broker_id (integer)
Added property company_id (integer)
Added property name (string)
Added property is_payment_updated (boolean)
Added property tax_amount (number)
Added property tax_amount_number (number)
Added property deferred_type (string)
Added property balloon_collection (string)
Added property rate_type (string)
Added property commission_type (string)
Added property running_id (string)
Added property order_currency (string)
Added property commission_amount (number)
Added property received_security_deposit (integer)
Added property net_finance_amount (number)
Added property rebate (number)
Added property capitalized_cost_reduction (number)
Added property monthly_deprecation (number)
Added property tax_on_capitalized_cost_reduction (number)
Added property monthly_sales_use_tax (number)
Added property sum_of_fees (number)
Added property sum_of_periodic_interest (number)
Added property sum_of_rentals (number)
Added property total_payables (number)
Added property non_vatable_amount (number)
Added property individualized_agreement (string)
Added property base_residual_type (integer)
Added property excess_mileage_rate (number)
Added property asset_rv_amount (number)
Added property changeVehicleStatus (boolean)
Changed property order_fnI (array)

Changed items (object):
- Added property mileage (integer)
- Added property term (integer)
- Added property is_msp (boolean)
Changed property order_fees (array)

Changed items (object):
- Added property vendor (string)
- Added property fee_type (string)
Changed property order_asset (object)
- Added property mileage (integer)
- Added property asset_type (string)
- Added property rv_balloon_amount (number)
- Deleted property milage (boolean)
Changed property order_tradein (object)
- Added property trade_in_type (string)
  
  An enumeration.
- Added property question_answers (array)
Changed property appointment_details (object)
- Added property time_zone (string)

Return Type:

Changed response : 200 OK

Successful Response

Changed content type : application/json

New optional properties:
- allowed_usage
- annual_usage
- apr
- contract_term
- credit_rating
- dealer_id
- down_payment
- down_payment_lease
- due_at_signing
- estimated_monthly_payment
- lender_id
- rv_balloon_percentage
- rv_balloon_value
- selling_price
- vehicle_id
- Added property broker_id (integer)
- Added property company_id (integer)
- Added property name (string)
- Added property is_payment_updated (boolean)
- Added property tax_amount (number)
- Added property tax_amount_number (number)
- Added property deferred_type (string)
- Added property balloon_collection (string)
- Added property rate_type (string)
- Added property commission_type (string)
- Added property running_id (string)
- Added property order_currency (string)
- Added property commission_amount (number)
- Added property received_security_deposit (integer)
- Added property net_finance_amount (number)
- Added property rebate (number)
- Added property capitalized_cost_reduction (number)
- Added property monthly_deprecation (number)
- Added property tax_on_capitalized_cost_reduction (number)
- Added property monthly_sales_use_tax (number)
- Added property sum_of_fees (number)
- Added property sum_of_periodic_interest (number)
- Added property sum_of_rentals (number)
- Added property total_payables (number)
- Added property non_vatable_amount (number)
- Added property individualized_agreement (string)
- Added property base_residual_type (integer)
- Added property excess_mileage_rate (number)
- Added property asset_rv_amount (number)
- Added property changeVehicleStatus (boolean)
- Changed property order_fnI (array)
  
  Changed items (object):
  - Added property mileage (integer)
  - Added property term (integer)
  - Added property is_msp (boolean)
- Changed property order_fees (array)
  
  Changed items (object):
  - Added property vendor (string)
  - Added property fee_type (string)
- Changed property order_asset (object)
  - Added property mileage (integer)
  - Added property asset_type (string)
  - Added property rv_balloon_amount (number)
  - Deleted property milage (boolean)
- Changed property order_tradein (object)
  - Added property trade_in_type (string)
    
    An enumeration.
  - Added property question_answers (array)
- Changed property appointment_details (object)
  - Added property time_zone (string)

GET /dms/contract

Return Type:

Changed response : 200 OK

Successful Response

Changed content type : application/json
- Changed property customer (object)
  - Added property preferred_contact (string)
  - Added property external_id (string)

POST /dms/contract

Return Type:

Changed response : 201 Created

Successful Response

Changed content type : application/json
- Changed property customer (object)
  - Added property preferred_contact (string)
  - Added property external_id (string)

PATCH /dms/contract

Return Type:

Changed response : 200 OK

Successful Response

Changed content type : application/json
- Changed property customer (object)
  - Added property preferred_contact (string)
  - Added property external_id (string)

GET /dms/order/order_information_for_submitted_order

Return Type:

Changed response : 200 OK

Successful Response

Changed content type : application/json
- Changed property result (array)
  
  Changed items (object):
  - Changed property order_info (object)
    
    New optional properties:
    - allowed_usage
    - annual_usage
    - apr
    - contract_term
    - credit_rating
    - customer_id
    - dealer_id
    - down_payment
    - down_payment_lease
    - due_at_signing
    - estimated_monthly_payment
    - lender_id
    - rv_balloon_percentage
    - rv_balloon_value
    - selling_price
    - vehicle_id
    - Added property broker_id (integer)
    - Added property company_id (integer)
    - Added property name (string)
    - Added property is_payment_updated (boolean)
    - Added property tax_amount (number)
    - Added property tax_amount_number (number)
    - Added property deferred_type (string)
    - Added property balloon_collection (string)
    - Added property rate_type (string)
    - Added property commission_type (string)
    - Added property running_id (string)
    - Added property order_currency (string)
    - Added property commission_amount (number)
    - Added property received_security_deposit (integer)
    - Added property net_finance_amount (number)
    - Added property rebate (number)
    - Added property capitalized_cost_reduction (number)
    - Added property monthly_deprecation (number)
    - Added property tax_on_capitalized_cost_reduction (number)
    - Added property monthly_sales_use_tax (number)
    - Added property sum_of_fees (number)
    - Added property sum_of_periodic_interest (number)
    - Added property sum_of_rentals (number)
    - Added property total_payables (number)
    - Added property non_vatable_amount (number)
    - Added property individualized_agreement (string)
    - Added property base_residual_type (integer)
    - Added property excess_mileage_rate (number)
    - Added property asset_rv_amount (number)
    - Changed property order_fnI (array)
      
      Changed items (object):
      - Added property mileage (integer)
      - Added property term (integer)
      - Added property is_msp (boolean)
    - Changed property order_fees (array)
      
      Changed items (object):
      - Added property vendor (string)
      - Added property fee_type (string)
    - Changed property order_asset (object)
      - Added property mileage (integer)
      - Added property asset_type (string)
      - Added property rv_balloon_amount (number)
      - Deleted property milage (boolean)
    - Changed property order_tradein (object)
      - Added property trade_in_type (string)
        
        An enumeration.
      - Added property question_answers (array)
    - Changed property appointment_details (object)
      - Added property time_zone (string)
  - Changed property customer_info (object)
    - Added property preferred_contact (string)
    - Added property external_id (string)

POST /dms/credit-request

Request:

Changed content type : application/json

New required properties:

lender_ids

Added property lender_ids (array)

list of lender ids the order will be submitted to

Items (integer):
Changed property result (array)

Changed items (object):
- Changed property order_info (object)
  
  New optional properties:
  - allowed_usage
  - annual_usage
  - apr
  - contract_term
  - credit_rating
  - customer_id
  - dealer_id
  - down_payment
  - down_payment_lease
  - due_at_signing
  - estimated_monthly_payment
  - lender_id
  - rv_balloon_percentage
  - rv_balloon_value
  - selling_price
  - vehicle_id
  - Added property broker_id (integer)
  - Added property company_id (integer)
  - Added property name (string)
  - Added property is_payment_updated (boolean)
  - Added property tax_amount (number)
  - Added property tax_amount_number (number)
  - Added property deferred_type (string)
  - Added property balloon_collection (string)
  - Added property rate_type (string)
  - Added property commission_type (string)
  - Added property running_id (string)
  - Added property order_currency (string)
  - Added property commission_amount (number)
  - Added property received_security_deposit (integer)
  - Added property net_finance_amount (number)
  - Added property rebate (number)
  - Added property capitalized_cost_reduction (number)
  - Added property monthly_deprecation (number)
  - Added property tax_on_capitalized_cost_reduction (number)
  - Added property monthly_sales_use_tax (number)
  - Added property sum_of_fees (number)
  - Added property sum_of_periodic_interest (number)
  - Added property sum_of_rentals (number)
  - Added property total_payables (number)
  - Added property non_vatable_amount (number)
  - Added property individualized_agreement (string)
  - Added property base_residual_type (integer)
  - Added property excess_mileage_rate (number)
  - Added property asset_rv_amount (number)
  - Changed property order_fnI (array)
    
    Changed items (object):
    - Added property mileage (integer)
    - Added property term (integer)
    - Added property is_msp (boolean)
  - Changed property order_fees (array)
    
    Changed items (object):
    - Added property vendor (string)
    - Added property fee_type (string)
  - Changed property order_asset (object)
    - Added property mileage (integer)
    - Added property asset_type (string)
    - Added property rv_balloon_amount (number)
    - Deleted property milage (boolean)
  - Changed property order_tradein (object)
    - Added property trade_in_type (string)
      
      An enumeration.
    - Added property question_answers (array)
  - Changed property appointment_details (object)
    - Added property time_zone (string)
- Changed property customer_info (object)
  - Added property preferred_contact (string)
  - Added property external_id (string)

GET /dms/contract/all

Return Type:

Changed response : 200 OK

Successful Response

Changed content type : application/json
- Changed property result (array)
  
  Changed items (object):
  - Changed property customer (object)
    - Added property preferred_contact (string)
    - Added property external_id (string)

Version 1.3.44 Version 1.3.42