API Doc Version 1.3.42

What's New

GET /dms/get-reference-data/{dealer_code}

Get Reference Data By Dealer Code

GET /dms/get-inventory

Get Filtered Inventory

GET /dms/get-setup-data

Setup Data

GET /dms/an-order-statuses

Get AN Order Statuses

PATCH /dms/customer/documents/{customer_reference_id}

Update customer document by identifier

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

Get document package by reference_id

POST /dms/submit-order

Mock Credit Approver API & Fraud Check

POST /dms/affordability-check/

Affordability Check

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

Monthly Payment Calculation V2

GET /dms/currencies

Get All Currencies

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

Find Lender By Tenant Id

GET /dms/dealer/find/by-tenant

Get Dealer By Tenant Id

GET /dms/inventory/reference-data-by-dealer-code/{dealer_code}

Get Inventory Reference Data

GET /dms/inventory/filter

Get Inventory Data

GET /dms/state

Get All States

GET /dms/contract-term

Get All Contract Terms

GET /dms/credit-ratings

Get All Credit Rating

GET /dms/integration/lender

Get All Lender Integration

GET /dms/dealer/preference-by-dealer-code/{dealer_code}

Get Dealer Preference By Dealer Code

GET /dms/integration/by_provider_name/{provider_name}

Get Integration By Provider Name

GET /dms/vehicle-detail/{vin}

Get Vehicle Detail By Vin

GET /dms/countries

Get All Countries

GET /dms/dealer/profile/{dealer_code}

Get Dealer Profile By Dealer Code

GET /dms/vehicle/{vin}

Get Vehicle By Vin

GET /dms/contract-allowed-annum-mileage

Get All Contract Allowed Mileages

GET /dms/dealer/fee/dealer-code/{dealer_code}

Get All Dealer Fee By Code

GET /dms/asset-usage/active

Get Active Asset Usages

GET /dms/vehicle

Get All Vehicles

GET /dms/financial-insurances/filter

Get Financial Insurance Product By Filter

GET /dms/dealer/option-trim-code

Get All Dealer Options By Trim Code

POST /dms/programs/all/

Get All Evaluated Programs

POST /dms/get_event_associated_checklist/

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

GET /dms/dealer/all-dealer-distance

Get All Dealer Distance

POST /dms/customers

Gets customer names by customer reference ids

PATCH /dms/configure/appointment/{appointment_id}

Delete created appointment

GET /dms/theme-builder

Get Theme

PATCH /dms/order/quick_quotation

Update Quotation

What's Deleted

POST /dms/credit-approval

Get Credit Approval

GET /dms/workflow-status

Credit Approval status

POST /dms/credit-response

Mock Credit Approver Response

GET /dms/order/event

Get All Order Events

POST /dms/order/event

Create Order Events

DELETE /dms/order/event

Delete Order Events

PATCH /dms/order/event

Update Order Events

GET /dms/order/event/

Get Order Events

DELETE /dms/configure/appointment/{appointment_id}

Delete created appointment

What's Changed

GET /dms/address/history

Parameters:

Changed: address_type in query

POST /dms/customer/insurance-information

Request:

Changed content type : application/json

• Changed property insurance_documents (array)

  Changed items (object):

  New optional properties:

  • document

  • Added property doucment_reference_id (string)

POST /dms/customer/insurance-information/add-document

Request:

Changed content type : application/json

New optional properties:

• document

• Added property doucment_reference_id (string)

POST /dms/customer/license-verification

GET /dms/order/order-checklist

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  Changed items (object):

  • Added property changed_by (string)

  • Added property changed_at (string)

POST /dms/order/order-checklist

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  Changed items (object):

  • Added property changed_by (string)

  • Added property changed_at (string)

PATCH /dms/order/order-checklist

Request:

Changed content type : application/json

Changed items (object):

New optional properties:

• updated_by

• Added property updated_at (string)

• Added property changed_by (string)

• Added property changed_at (string)

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  Changed items (object):

  • Added property changed_by (string)

  • Added property changed_at (string)

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

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property external_order_id (string)

  • Added property status (string)

  • Added property created_by (string)

  • Added property assets (array)

    Items (object):

    • Property vin (string)

    • Property make (string)

    • Property model (string)

    • Property trim (string)

    • Property year (string)

    • Property stock_number (string)

    • Property asset_image (array)

      Items (string):

    • Property asset_type (string)

  • Changed property customer (object)

    • Added property reference_id (string)

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

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  Changed items (object):

  • Added property external_order_id (string)

  • Added property status (string)

  • Added property created_by (string)

  • Added property assets (array)

  • Changed property customer (object)

    • Added property reference_id (string)

GET /dms/configure/workqueue/search

Parameters:

Added: customer_reference_id in query

POST /dms/customer/document

Request:

Changed content type : application/json

• Added property comment (string)

PATCH /dms/customer/document

Request:

Changed content type : application/json

• Added property document_reference_id (string)

GET /dms/customer/document/status

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property result (array)

    Items (object):

    • Property customer_reference_id (string)

    • Property external_reference_id (string)

    • Property document_type (string)

    • Property comment (string)

    • Property category (string)

    • Property document_name (string)

    • Property document_size (string)

    • Property document_url (string)

    • Property reason_by_system (string)

    • Property reason_for_customer (string)

    • Property document_status (string)

    • Property document_upload_indicator (boolean)

    • Property expires_at (string)

      format: YYYY-MM-DD hh:mm:ss

    • Property created_at (string)

      format: YYYY-MM-DD hh:mm:ss

    • Property updated_at (string)

      format: YYYY-MM-DD hh:mm:ss

    • Property deleted_at (string)

      format: YYYY-MM-DD hh:mm:ss

    • Property updated_by (string)

    • Property created_by (string)

    • Property deleted_by (string)

    • Property uploaded_by (string)

    • Property uploaded_at (string)

    • Property is_deleted (boolean)

    • Property identifier (string)

    • Property stipulation_code (string)

    • Property document_reviews (array)

      Items (object):

      • Property reviewed_by (string)

      • Property review_date_time (string)

        format: YYYY-MM-DD hh:mm:ss

      • Property review_status (string)

      • Property review_notes (string)

      • Property reason (array)

        Items (string):

      • Property other_reason (string)

      • Property identifier (string)

  • Added property page_number (integer)

  • Added property page_size (integer)

  • Added property total_pages (integer)

  • Added property total_results (integer)

  • Deleted property customer_reference_id (string)

  • Deleted property external_reference_id (string)

  • Deleted property document_type (string)

  • Deleted property comment (string)

  • Deleted property category (string)

  • Deleted property document_name (string)

  • Deleted property document_size (string)

  • Deleted property document_url (string)

  • Deleted property reason_by_system (string)

  • Deleted property reason_for_customer (string)

  • Deleted property document_status (string)

  • Deleted property document_upload_indicator (boolean)

  • Deleted property expires_at (string)

    format: YYYY-MM-DD hh:mm:ss

  • Deleted property created_at (string)

    format: YYYY-MM-DD hh:mm:ss

  • Deleted property updated_at (string)

    format: YYYY-MM-DD hh:mm:ss

  • Deleted property deleted_at (string)

    format: YYYY-MM-DD hh:mm:ss

  • Deleted property updated_by (string)

  • Deleted property created_by (string)

  • Deleted property deleted_by (string)

  • Deleted property uploaded_by (string)

  • Deleted property uploaded_at (string)

  • Deleted property is_deleted (boolean)

  • Deleted property identifier (string)

  • Deleted property stipulation_code (string)

POST /dms/customer/document/signature-document

POST /dms/customer/additional-document

Request:

Changed content type : application/json

New optional properties:

• external_reference_id

• Added property document_reference_id (string)

GET /dms/contracts/search

Parameters:

Added: subscription_start_date_from in query

Format: YYYY-MM-DDTHH:MM:SS

Added: subscription_start_date_to in query

Format: YYYY-MM-DDTHH:MM:SS

Added: subscription_end_date_from in query

Format: YYYY-MM-DDTHH:MM:SS

Added: subscription_end_date_to in query

Format: YYYY-MM-DDTHH:MM:SS

Changed: subscription_start_date in query

Format: YYYY-MM-DDTHH:MM:SS

Changed: subscription_end_date in query

Format: YYYY-MM-DDTHH:MM:SS

GET /dms/history

Parameters:

Changed: module_type in query

module

GET /dms/history-details

Parameters:

Added: order_reference_id in query

Changed: module_type in query

GET /dms/configure/quotation

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property id (integer)

  • Added property appointment_details (object)

    • Property id (integer)

    • Property order_id (integer)

    • Property dealer_id (integer)

    • Property customer_id (integer)

    • Property appointment_date (string)

    • Property appointment_type (string)

    • Property appointment_status (string)

    • Property comments (string)

    • Property address_id (integer)

    • Property dealer_code (string)

    • Property address_data (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 address_type (string)

        An enumeration.

        Enum values:

        • Mailing
        • Invoice
        • Office
        • Garaging
        • DealerAddress
        • DrivingLicense
        • Billing
        • InsuranceAddress
        • Residential
        • Employment

      • Property identifier (string)

      • Property id (integer)

    • Property created_by (string)

    • Property updated_by (string)

  • Changed property insurance (object)

    • Changed property insurance_documents (array)

      Changed items (object):

      New optional properties:

      • document

      • Added property doucment_reference_id (string)

GET /dms/configure/all-quotations

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  Changed items (object):

  • Added property id (integer)

  • Added property appointment_details (object)

  • Changed property insurance (object)

    • Changed property insurance_documents (array)

      Changed items (object):

      New optional properties:

      • document

      • Added property doucment_reference_id (string)

PATCH /dms/configure/quotation/{identifier}

Request:

Changed content type : application/json

• Added property id (integer)

• Added property appointment_details (object)

• Changed property insurance (object)

  • Changed property insurance_documents (array)

    Changed items (object):

    New optional properties:

    • document

    • Added property doucment_reference_id (string)

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property id (integer)

  • Added property appointment_details (object)

  • Changed property insurance (object)

    • Changed property insurance_documents (array)

      Changed items (object):

      New optional properties:

      • document

      • Added property doucment_reference_id (string)

POST /dms/configure/save-quotation

Request:

Changed content type : application/json

Changed items (object):

• Added property id (integer)

• Added property appointment_details (object)

• Changed property insurance (object)

  • Changed property insurance_documents (array)

    Changed items (object):

    New optional properties:

    • document

    • Added property doucment_reference_id (string)

Return Type:

Changed response : 201 Created

Successful Response

• Changed content type : application/json

  Changed items (object):

  • Added property id (integer)

  • Added property appointment_details (object)

  • Changed property insurance (object)

    • Changed property insurance_documents (array)

      Changed items (object):

      New optional properties:

      • document

      • Added property doucment_reference_id (string)

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

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property id (integer)

  • Added property appointment_details (object)

  • Changed property insurance (object)

    • Changed property insurance_documents (array)

      Changed items (object):

      New optional properties:

      • document

      • Added property doucment_reference_id (string)

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

Request:

Changed content type : application/json

• Added property id (integer)

• Added property appointment_details (object)

• Changed property insurance (object)

  • Changed property insurance_documents (array)

    Changed items (object):

    New optional properties:

    • document

    • Added property doucment_reference_id (string)

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property id (integer)

  • Added property appointment_details (object)

  • Changed property insurance (object)

    • Changed property insurance_documents (array)

      Changed items (object):

      New optional properties:

      • document

      • Added property doucment_reference_id (string)

POST /dms/order/quick_quotation

Request:

Changed content type : application/json

• Changed property quote_identifiers (object)

  • Added property reference_id (string)

• Changed property quote_details (object)

  • Added property customer_reference_id (string)

  • Added property external_order_id (string)

  • Added property order_status (string)

  • Added property created_by (string)

  • Added property dealer_id (string)

  • Added property assets (array)

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property external_order_id (string)

  • Added property status (string)

  • Added property created_by (string)

  • Added property assets (array)

  • Changed property customer (object)

    • Added property reference_id (string)

POST /dms/configure/appointment

Request:

Changed content type : application/json

New optional properties:

• appointment_type
• dealer_id
• order_id

• Added property appointment_status (string)

• Added property comments (string)

• Added property created_by (string)

• Added property updated_by (string)

PATCH /dms/configure/appointment

Request:

Changed content type : application/json

New required properties:

• appointment_date

New optional properties:

• dealer_id
• order_id

• Added property appointment_status (string)

• Added property comments (string)

• Added property created_by (string)

• Added property updated_by (string)

GET /dms/customer/all-customers

Parameters:

Changed: sort_by in query

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:

  • full_name
  • order_identifier
  • order_status
  • vin GET /dms/contract

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Deleted property updated_start_date (string)

  • Changed property returns (object)

    • Added property noi_date (string)

    • Added property check_list_start_date (string)

    • Added property reason (string)

    • Added property reason_detail (string)

POST /dms/contract

Return Type:

Changed response : 201 Created

Successful Response

• Changed content type : application/json

  • Deleted property updated_start_date (string)

  • Changed property returns (object)

    • Added property noi_date (string)

    • Added property check_list_start_date (string)

    • Added property reason (string)

    • Added property reason_detail (string)

PATCH /dms/contract

Request:

Changed content type : application/json

• Added property return_status (string)

• Added property start_date (string)

• Deleted property updated_start_date (string)

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Deleted property updated_start_date (string)

  • Changed property returns (object)

    • Added property noi_date (string)

    • Added property check_list_start_date (string)

    • Added property reason (string)

    • Added property reason_detail (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)

      • Added property id (integer)

      • Added property appointment_details (object)

      • Changed property insurance (object)

        • Changed property insurance_documents (array)

          Changed items (object):

          New optional properties:

          • document

          • Added property doucment_reference_id (string)

POST /dms/credit-request

Request:

Changed content type : application/json

• Changed property result (array)

  Changed items (object):

  • Changed property order_info (object)

    • Added property id (integer)

    • Added property appointment_details (object)

    • Changed property insurance (object)

      • Changed property insurance_documents (array)

        Changed items (object):

        New optional properties:

        • document

        • Added property doucment_reference_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):

    • Deleted property updated_start_date (string)

    • Changed property returns (object)

      • Added property noi_date (string)

      • Added property check_list_start_date (string)

      • Added property reason (string)

      • Added property reason_detail (string)