API Doc Version 1.3.12
What's New
POST
/dms/customer/all-customers-dynamic-search
Get all customer records dynamic search
GET
/dms/customers
Gets customer names by customer reference ids
GET
/dms/configure/assets-by-trim-code/{trim_code}
Get assets by trim code
GET
/dms/configure/order/status-by-dealer
Get order status by dealer
GET
/dms/customer/document-history
Get customer document upload history
What's Deleted
GET
/dms/quote-comparison/{trim_code}
Quote Comparison
GET
/dms/customer/document/
Get customer document upload history
What's Changed
PATCH
/dms/check-customer-by-email
Parameters:
Deleted: email
in query
Request:
New content type : application/json
POST
/dms/customer/employment-info
Request:
Changed content type : application/json
New required properties:
employment_type
reference_id
GET
/dms/customer/personal-finance
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json
New required properties:
-
reference_id
- Changed property
reference_id
(string)Reference Id
-
POST
/dms/customer/personal-finance
Request:
Changed content type : application/json
New required properties:
reference_id
- Changed property
reference_id
(string)Reference Id
Return Type:
Changed response : 201 Created
Successful Response
-
Changed content type :
application/json
New required properties:
-
reference_id
- Changed property
reference_id
(string)Reference Id
-
PATCH
/dms/customer/personal-finance
Request:
Changed content type : application/json
New required properties:
reference_id
- Added property
reference_id
(string)Reference Id
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json
New required properties:
-
reference_id
- Changed property
reference_id
(string)Reference Id
-
POST
/dms/customer/payment-information/
Request:
Changed content type : application/json
New required properties:
reference_id
type
-
Changed property
type
(string)Payment type
-
Changed property
last4
(string -> integer) -
Changed property
reference_id
(string)Reference Id
Return Type:
Changed response : 201 Created
Successful Response
-
Changed content type :
application/json
New required properties:
-
reference_id
- Changed property
reference_id
(string)Reference Id
-
GET
/dms/customer/payment-information
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json
Changed items (object):
New required properties:
-
reference_id
- Changed property
reference_id
(string)Reference Id
-
PATCH
/dms/customer/payment-information
Parameters:
Deleted: reference_id
in query
Request:
Changed content type : application/json
New required properties:
reference_id
type
-
Added property
reference_id
(string)Reference Id
-
Changed property
type
(string)Payment type
-
Changed property
last4
(string -> integer)
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json
New required properties:
-
reference_id
- Changed property
reference_id
(string)Reference Id
-
GET
/dms/customer/insurance-information
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json
-
Added property
created_by
(string) -
Added property
updated_by
(string) -
Changed property
insurance_documents
(array)Changed items (object):
New required properties:
content_type
meta_data
New optional properties:
-
document_ext
-
document_name
-
Added property
content_type
(string) -
Added property
meta_data
(object)-
Property
name
(string) -
Property
size
(string)
-
-
Deleted property
document_ext
(string) -
Deleted property
document_name
(string)
-
POST
/dms/customer/insurance-information
Request:
Changed content type : application/json
-
Added property
created_by
(string) -
Changed property
insurance_documents
(array)Changed items (object):
New required properties:
content_type
meta_data
New optional properties:
-
document_ext
-
document_name
-
Added property
content_type
(string) -
Added property
meta_data
(object) -
Deleted property
document_ext
(string) -
Deleted property
document_name
(string)
Return Type:
Changed response : 201 Created
Successful Response
-
Changed content type :
application/json
-
Added property
created_by
(string) -
Added property
updated_by
(string) -
Changed property
insurance_documents
(array)Changed items (object):
New required properties:
content_type
meta_data
New optional properties:
-
document_ext
-
document_name
-
Added property
content_type
(string) -
Added property
meta_data
(object) -
Deleted property
document_ext
(string) -
Deleted property
document_name
(string)
-
PATCH
/dms/customer/insurance-information
Request:
Changed content type : application/json
- Added property
updated_by
(string)
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json
-
Added property
created_by
(string) -
Added property
updated_by
(string) -
Changed property
insurance_documents
(array)Changed items (object):
New required properties:
content_type
meta_data
New optional properties:
-
document_ext
-
document_name
-
Added property
content_type
(string) -
Added property
meta_data
(object) -
Deleted property
document_ext
(string) -
Deleted property
document_name
(string)
-
GET
/dms/customer/insurance-information-by-customer
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json
-
Added property
created_by
(string) -
Added property
updated_by
(string) -
Changed property
insurance_documents
(array)Changed items (object):
New required properties:
content_type
meta_data
New optional properties:
-
document_ext
-
document_name
-
Added property
content_type
(string) -
Added property
meta_data
(object) -
Deleted property
document_ext
(string) -
Deleted property
document_name
(string)
-
GET
/dms/customer/insurance-information-by-order
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json
-
Added property
created_by
(string) -
Added property
updated_by
(string) -
Changed property
insurance_documents
(array)Changed items (object):
New required properties:
content_type
meta_data
New optional properties:
-
document_ext
-
document_name
-
Added property
content_type
(string) -
Added property
meta_data
(object) -
Deleted property
document_ext
(string) -
Deleted property
document_name
(string)
-
POST
/dms/customer/insurance-information/add-document
Request:
Changed content type : application/json
New required properties:
content_type
meta_data
New optional properties:
document_ext
document_name
-
Added property
content_type
(string) -
Added property
meta_data
(object) -
Deleted property
document_ext
(string) -
Deleted property
document_name
(string)
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json
Changed items (object):
New required properties:
content_type
meta_data
New optional properties:
-
document_ext
-
document_name
-
Added property
content_type
(string) -
Added property
meta_data
(object) -
Deleted property
document_ext
(string) -
Deleted property
document_name
(string)
GET
/dms/customer/status-flag
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json
Changed items (object):
-
Added property
created_by
(string) -
Added property
updated_by
(string)
-
POST
/dms/customer/status-flag
Request:
Changed content type : application/json
- Added property
created_by
(string)
Return Type:
Changed response : 201 Created
Successful Response
-
Changed content type :
application/json
-
Added property
created_by
(string) -
Added property
updated_by
(string)
-
GET
/dms/customer/status-flag-hitsory
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json
-
Changed property
result
(array)Changed items (object):
-
Added property
created_by
(string) -
Added property
updated_by
(string) -
Added property
is_deleted
(boolean)
-
-
POST
/dms/configure/order-fees
Request:
Changed content type : application/json
-
Added property
identifier
(string) -
Deleted property
id
(integer)
Return Type:
Changed response : 201 Created
Successful Response
-
Changed content type :
application/json
-
Added property
identifier
(string) -
Deleted property
id
(integer)
-
DELETE
/dms/configure/order-fees/{order_fee_id}
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json
-
Added property
identifier
(string) -
Deleted property
id
(integer)
-
PATCH
/dms/configure/order-fees/{order_fee_id}
Request:
Changed content type : application/json
-
Added property
identifier
(string) -
Deleted property
id
(integer)
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json
-
Added property
identifier
(string) -
Deleted property
id
(integer)
-
GET
/dms/configure/order-fees/{order_id}
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json
Changed items (object):
-
Added property
identifier
(string) -
Deleted property
id
(integer)
-
POST
/dms/configure/order-options
Request:
Changed content type : application/json
-
Added property
identifier
(string) -
Deleted property
id
(integer)
Return Type:
Changed response : 201 Created
Successful Response
-
Changed content type :
application/json
-
Added property
identifier
(string) -
Deleted property
id
(integer)
-
DELETE
/dms/configure/order-options/{order_option_id}
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json
-
Added property
identifier
(string) -
Deleted property
id
(integer)
-
PATCH
/dms/configure/order-options/{order_option_id}
Request:
Changed content type : application/json
-
Added property
identifier
(string) -
Deleted property
id
(integer)
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json
-
Added property
identifier
(string) -
Deleted property
id
(integer)
-
GET
/dms/configure/order-options/{order_id}
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json
Changed items (object):
-
Added property
identifier
(string) -
Deleted property
id
(integer)
-
POST
/dms/configure/order-fni
Request:
Changed content type : application/json
- Deleted property
id
(integer)
Return Type:
Changed response : 201 Created
Successful Response
-
Changed content type :
application/json
-
Added property
identifier
(string) -
Deleted property
id
(integer)
-
DELETE
/dms/configure/order-fni/{order_fni_id}
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json
- Deleted property
id
(integer)
- Deleted property
PATCH
/dms/configure/order-fni/{order_fni_id}
Request:
Changed content type : application/json
- Deleted property
id
(integer)
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json
- Deleted property
id
(integer)
- Deleted property
GET
/dms/configure/order-fni/{order_id}
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json
Changed items (object):
- Deleted property
id
(integer)
- Deleted property
POST
/dms/configure/order/tradein
Request:
Changed content type : application/json
- Deleted property
id
(integer)
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json
New required properties:
-
identifier
-
Added property
identifier
(string) -
Deleted property
id
(integer)
-
GET
/dms/configure/order/tradein/{order_id}
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json
- Deleted property
id
(integer)
- Deleted property
PATCH
/dms/configure/order/tradein/{order_id}
Request:
Changed content type : application/json
- Deleted property
id
(integer)
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json
- Deleted property
id
(integer)
- Deleted property
DELETE
/dms/configure/order/tradein/{tradein_id}
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json
- Deleted property
id
(integer)
- Deleted property
POST
/dms/configure/appointment
Request:
Changed content type : application/json
- Deleted property
id
(integer)
GET
/dms/customer/document
Parameters:
Added: category
in query
PATCH
/dms/customer/document
Request:
Changed content type : application/json
New required properties:
content_type
-
Added property
content_type
(string) -
Added property
updated_by
(string) -
Deleted property
document_extension
(string)
POST
/dms/customer/additional-document
Request:
Changed content type : application/json
New required properties:
content_type
-
Added property
content_type
(string) -
Deleted property
document_extension
(string)
POST
/dms/configure/{document_package_id}
/{document_id}
/{signature_id}
Return Type:
Changed response : 404 Not Found
Not Found
- New content type :
application/json
Changed response : 422 Unprocessable Entity
Validation Error
- New content type :
application/json
Changed response : 200 OK
Successful Response
GET
/dms/customer/insurance-information-history
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json
-
Changed property
result
(array)Changed items (object):
-
Added property
created_by
(string) -
Added property
updated_by
(string) -
Changed property
insurance_documents
(array)Changed items (object):
New required properties:
content_type
meta_data
New optional properties:
-
document_ext
-
document_name
-
Added property
content_type
(string) -
Added property
meta_data
(object) -
Deleted property
document_ext
(string) -
Deleted property
document_name
(string)
-
-
GET
/dms/configure/quotation
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json
New required properties:
identifier
New optional properties:
-
id
-
Added property
identifier
(string) -
Deleted property
id
(integer) -
Changed property
order_fees
(array)Changed items (object):
- Added property
identifier
(string)
- Added property
-
Changed property
order_options
(array)Changed items (object):
- Added property
identifier
(string)
- Added property
-
Changed property
order_fnI
(array)Changed items (object):
- Added property
identifier
(string)
- Added property
-
Changed property
order_asset
(object)- Added property
identifier
(string)
- Added property
-
Changed property
order_tradein
(object)- Added property
identifier
(string)
- Added property
GET
/dms/configure/all-quotation
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json
Changed items (object):
New required properties:
identifier
New optional properties:
-
id
-
Added property
identifier
(string) -
Deleted property
id
(integer) -
Changed property
order_fees
(array)Changed items (object):
- Added property
identifier
(string)
- Added property
-
Changed property
order_options
(array)Changed items (object):
- Added property
identifier
(string)
- Added property
-
Changed property
order_fnI
(array)Changed items (object):
- Added property
identifier
(string)
- Added property
-
Changed property
order_asset
(object)- Added property
identifier
(string)
- Added property
-
Changed property
order_tradein
(object)- Added property
identifier
(string)
- Added property
GET
/dms/configure/all-quotations
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json
Changed items (object):
New required properties:
identifier
New optional properties:
-
id
-
Added property
identifier
(string) -
Deleted property
id
(integer) -
Changed property
order_fees
(array)Changed items (object):
- Added property
identifier
(string)
- Added property
-
Changed property
order_options
(array)Changed items (object):
- Added property
identifier
(string)
- Added property
-
Changed property
order_fnI
(array)Changed items (object):
- Added property
identifier
(string)
- Added property
-
Changed property
order_asset
(object)- Added property
identifier
(string)
- Added property
-
Changed property
order_tradein
(object)- Added property
identifier
(string)
- Added property
PATCH
/dms/configure/quotation/{order_id}
Request:
Changed content type : application/json
-
Changed property
order_fees
(array)Changed items (object):
- Added property
identifier
(string)
- Added property
-
Changed property
order_options
(array)Changed items (object):
- Added property
identifier
(string)
- Added property
-
Changed property
order_fnI
(array)Changed items (object):
- Added property
identifier
(string)
- Added property
-
Changed property
order_asset
(object)- Added property
identifier
(string)
- Added property
-
Changed property
order_tradein
(object)- Added property
identifier
(string)
- Added property
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json
-
Changed property
order_fees
(array)Changed items (object):
- Added property
identifier
(string)
- Added property
-
Changed property
order_options
(array)Changed items (object):
- Added property
identifier
(string)
- Added property
-
Changed property
order_fnI
(array)Changed items (object):
- Added property
identifier
(string)
- Added property
-
Changed property
order_asset
(object)- Added property
identifier
(string)
- Added property
-
Changed property
order_tradein
(object)- Added property
identifier
(string)
- Added property
-
POST
/dms/configure/save-quotation
Request:
Changed content type : application/json
Changed items (object):
-
Changed property
order_fees
(array)Changed items (object):
- Added property
identifier
(string)
- Added property
-
Changed property
order_options
(array)Changed items (object):
- Added property
identifier
(string)
- Added property
-
Changed property
order_fnI
(array)Changed items (object):
- Added property
identifier
(string)
- Added property
-
Changed property
order_asset
(object)- Added property
identifier
(string)
- Added property
-
Changed property
order_tradein
(object)- Added property
identifier
(string)
- Added property
Return Type:
Changed response : 201 Created
Successful Response
-
Changed content type :
application/json
Changed items (object):
New required properties:
identifier
New optional properties:
-
id
-
Added property
identifier
(string) -
Deleted property
id
(integer) -
Changed property
order_fees
(array)Changed items (object):
- Added property
identifier
(string)
- Added property
-
Changed property
order_options
(array)Changed items (object):
- Added property
identifier
(string)
- Added property
-
Changed property
order_fnI
(array)Changed items (object):
- Added property
identifier
(string)
- Added property
-
Changed property
order_asset
(object)- Added property
identifier
(string)
- Added property
-
Changed property
order_tradein
(object)- Added property
identifier
(string)
- Added property
PATCH
/dms/configure/order/update-status/{order_id}
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json
-
Changed property
order_fees
(array)Changed items (object):
- Added property
identifier
(string)
- Added property
-
Changed property
order_options
(array)Changed items (object):
- Added property
identifier
(string)
- Added property
-
Changed property
order_fnI
(array)Changed items (object):
- Added property
identifier
(string)
- Added property
-
Changed property
order_asset
(object)- Added property
identifier
(string)
- Added property
-
Changed property
order_tradein
(object)- Added property
identifier
(string)
- Added property
-
POST
/dms/configure/document-package
Return Type:
New response : 412 Precondition Failed
Precondition Failed
Changed response : 404 Not Found
Not Found
- New content type :
application/json
Changed response : 422 Unprocessable Entity
Validation Error
- New content type :
application/json
Changed response : 200 OK
Successful Response
GET
/dms/configure/document-package-by-reference-id
Return Type:
Changed response : 404 Not Found
Not Found
- New content type :
application/json
Changed response : 200 OK
Successful Response