API Doc Version 1.3.40
What's New
GET /dms/address/history
Delete existing record of address
GET /dms/an-dealers
Get Dealers
PATCH /dms/configure/order-to-quotation/{identifier}/{reference_number}
Convert specific Order to Quotation
POST /dms/theme-builder
Post Theme Builder Record
GET /dms/theme-builder/{user_email}
Get theme by user email
PATCH /dms/theme-builder/{user_email}
Updates a theme builder record
POST /dms/customer/payment-information
Create customer payment information
What's Deleted
POST /dms/customer/payment-information/
Create customer payment information
GET /dms/customer/status-flag-hitsory
Get status flag history
PATCH /dms/configure/order-to-quotation/{identifier}
Convert specific Order to Quotation
What's Changed
GET /dms/customer/customer-history
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/jsonChanged items (object):
-
Added property
customer_addresses(array)Items (object):
-
Property
address_line_1(string)Address line one
-
Property
address_line_2(string)Address line two
-
Property
address_type(string)An enumeration.
Enum values:
MailingInvoiceOfficeGaragingDealerAddressDrivingLicenseBillingInsuranceAddressResidentialEmployment
-
Property
city(string)Address city
-
Property
contact_number(string)Contact number
-
Property
county(string)Address county
-
Property
created_at(string) -
Property
created_by(string) -
Property
deleted_at(string) -
Property
deleted_by(string) -
Property
identifier(string) -
Property
is_garaging(boolean)Garaging flag
-
Property
move_in_date(string)format: YYYY-MM-DD
-
Property
state_name(string)Address state name
-
Property
updated_at(string) -
Property
updated_by(string) -
Property
verified(boolean)Is Address verified
-
Property
zip_code(string)Zip code
-
-
Added property
income_info(object)-
Property
annual_employment_income(number)Annual employment income
-
Property
annual_other_income(number)Annual other income
-
Property
created_at(string) -
Property
created_by(string) -
Property
deleted_at(string) -
Property
deleted_by(string) -
Property
employed_since(string)Employed since
-
Property
employment_type(string)Employment type
-
Property
name(string)Name
-
Property
occupation(string)Occupation
-
Property
phone(string)Phone
-
Property
source_of_other_income(string)Annual other income
-
Property
updated_at(string) -
Property
updated_by(string)
-
-
Added property
license_info(object)-
Property
date_of_birth(string)format: YYYY-MM-DD
-
Property
expiry_date(string)format: YYYY-MM-DD
-
Property
first_name(string) -
Property
is_pdf_417(boolean) -
Property
is_selfie_verified(boolean) -
Property
issue_date(string)format: YYYY-MM-DD
-
Property
last_name(string) -
Property
license_number(string) -
Property
status(string)
-
-
Added property
payments_info(array)Items (object):
-
Property
Bank_name(string) -
Property
access_token(string) -
Property
account_id(string) -
Property
created_at(string) -
Property
created_by(string) -
Property
default(boolean) -
Property
deleted_at(string) -
Property
deleted_by(string) -
Property
last4(integer) -
Property
stripe_payment_method_id(string) -
Property
type(string) -
Property
updated_at(string) -
Property
updated_by(string)
-
-
PATCH /dms/check-customer-by-email
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json- Deleted property
is_parent(boolean)
- Deleted property
PATCH /dms/delete-customer
Return Type:
Changed response : 200 OK
Successful Response
- Changed content type :
application/json
PATCH /dms/customer/license-info
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json-
Added property
address(object)-
Property
address_line_1(string)Address line one
-
Property
address_line_2(string)Address line two
-
Property
city(string)Address city
-
Property
contact_number(string)Contact number
-
Property
county(string)Address county
-
Property
is_garaging(boolean)Garaging flag
-
Property
move_in_date(string)format: YYYY-MM-DD
-
Property
state_name(string)Address state name
-
Property
verified(boolean)Is Address verified
-
Property
zip_code(string)Zip code
-
-
GET /dms/customer/license-info-history
Parameters:
Added: page_number in query
Added: page_size in query
Changed: from_date in query
Format: YYYY-MM-DD
Changed: to_date in query
Format: YYYY-MM-DD
Return Type:
Changed response : 200 OK
Successful Response
- Changed content type :
application/json
POST /dms/customer/signature
DELETE /dms/customer/signature
PATCH /dms/customer/signature
PATCH /dms/customer/delete-signature
GET /dms/customer/insurance-information
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json-
Added property
is_verified(boolean) -
Added property
start_date(string)format: YYYY-MM-DD
-
POST /dms/customer/insurance-information
Request:
Changed content type : application/json
-
Added property
is_verified(boolean) -
Added property
start_date(string)format: YYYY-MM-DD
Return Type:
Changed response : 201 Created
Successful Response
-
Changed content type :
application/json-
Added property
is_verified(boolean) -
Added property
start_date(string)format: YYYY-MM-DD
-
PATCH /dms/customer/insurance-information
Request:
Changed content type : application/json
- Added property
is_verified(boolean)
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json-
Added property
is_verified(boolean) -
Added property
start_date(string)format: YYYY-MM-DD
-
GET /dms/customer/insurance-information-by-customer
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json-
Added property
is_verified(boolean) -
Added property
start_date(string)format: YYYY-MM-DD
-
GET /dms/customer/insurance-information-by-order
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json-
Added property
is_verified(boolean) -
Added property
start_date(string)format: YYYY-MM-DD
-
GET /dms/customer/insurance-information/document-history
Get customer insurance information document history
GET /dms/configure/quick-quotation-by-identifier/{identifier}
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json-
Added property
comments(string) -
Added property
reference_number(string) -
Added property
vat_treatment(string)
-
GET /dms/configure/quick-quotation-by-vendor
Parameters:
Added: reference_number in query
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/jsonChanged items (object):
-
Added property
comments(string) -
Added property
reference_number(string) -
Added property
vat_treatment(string)
-
GET /dms/customer/document
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/jsonChanged items (object):
-
Changed property
document_reviews(array)Changed items (object):
- Changed property
reason(string -> array)
- Changed property
-
DELETE /dms/customer/document
PATCH /dms/customer/document
GET /dms/customer/document/status
GET /dms/customer/document/review
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/jsonChanged items (object):
- Changed property
reason(string -> array)
- Changed property
POST /dms/customer/document/review
Request:
Changed content type : application/json
-
Added property
other_reason(string) -
Added property
reason(array)Items (string):
Return Type:
Changed response : 201 Created
Successful Response
-
Changed content type :
application/json- Changed property
reason(string -> array)
- Changed property
POST /dms/customer/
Return Type:
Changed response : 201 Created
Successful Response
-
Changed content type :
application/json- Deleted property
is_parent(boolean)
- Deleted property
DELETE /dms/customer
Return Type:
Changed response : 200 OK
Successful Response
- Changed content type :
application/json
GET /dms/customer
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json- Deleted property
is_parent(boolean)
- Deleted property
PATCH /dms/customer
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json- Deleted property
is_parent(boolean)
- Deleted property
GET /dms/customer-by-email
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json- Deleted property
is_parent(boolean)
- Deleted property
PATCH /dms/customer/employment-info
Request:
Changed content type : application/json
-
Added property
address(object)-
Property
address_line_1(string)Address line one
-
Property
address_line_2(string)Address line two
-
Property
address_type(string)An enumeration.
-
Property
city(string)Address city
-
Property
contact_number(string)Contact number
-
Property
county(string)Address county
-
Property
is_garaging(boolean)Garaging flag
-
Property
move_in_date(string)format: YYYY-MM-DD
-
Property
state_name(string)Address state name
-
Property
verified(boolean)Is Address verified
-
Property
zip_code(string)Zip code
-
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
is_verified(boolean) -
Added property
start_date(string)format: YYYY-MM-DD
-
-
GET /dms/configure/quotation
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json-
Changed property
insurance(object)-
Added property
is_verified(boolean) -
Added property
start_date(string)format: YYYY-MM-DD
-
-
GET /dms/configure/all-quotations
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/jsonChanged items (object):
-
Changed property
insurance(object)-
Added property
is_verified(boolean) -
Added property
start_date(string)format: YYYY-MM-DD
-
-
PATCH /dms/configure/quotation/{identifier}
Request:
Changed content type : application/json
-
Changed property
insurance(object)-
Added property
is_verified(boolean) -
Added property
start_date(string)format: YYYY-MM-DD
-
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json-
Changed property
insurance(object)-
Added property
is_verified(boolean) -
Added property
start_date(string)format: YYYY-MM-DD
-
-
POST /dms/configure/save-quotation
Request:
Changed content type : application/json
Changed items (object):
-
Changed property
insurance(object)-
Added property
is_verified(boolean) -
Added property
start_date(string)format: YYYY-MM-DD
-
Return Type:
Changed response : 201 Created
Successful Response
-
Changed content type :
application/jsonChanged items (object):
-
Changed property
insurance(object)-
Added property
is_verified(boolean) -
Added property
start_date(string)format: YYYY-MM-DD
-
-
PATCH /dms/order/update-credit-approver-decision/{reference_number}
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json-
Changed property
insurance(object)-
Added property
is_verified(boolean) -
Added property
start_date(string)format: YYYY-MM-DD
-
-
PATCH /dms/configure/quotation-to-order/{identifier}
Request:
Changed content type : application/json
-
Changed property
insurance(object)-
Added property
is_verified(boolean) -
Added property
start_date(string)format: YYYY-MM-DD
-
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json-
Changed property
insurance(object)-
Added property
is_verified(boolean) -
Added property
start_date(string)format: YYYY-MM-DD
-
-
POST /dms/order/quick_quotation
Request:
Changed content type : application/json
-
Changed property
quote_details(object)-
Added property
comments(string) -
Added property
reference_number(string) -
Added property
vat_treatment(string)
-
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json-
Added property
comments(string) -
Added property
reference_number(string) -
Added property
vat_treatment(string)
-
GET /dms/customer/document-history
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json-
Changed property
result(array)Changed items (object):
-
Changed property
document_reviews(array)Changed items (object):
- Changed property
reason(string -> array)
- Changed property
-
-
GET /dms/customer/all-customers
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json-
Changed property
result(array)Changed items (object):
- Deleted property
is_parent(boolean)
- Deleted property
-
POST /dms/customer/all-customers-dynamic-search
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json-
Changed property
result(array)Changed items (object):
- Deleted property
is_parent(boolean)
- Deleted property
-
GET /dms/contract
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json-
Added property
received_security_deposit(integer) -
Added property
starting_odometer(integer) -
Deleted property
recieved_security_deposit(integer) -
Changed property
returns(object)- Changed property
et_fee(string -> integer)
- Changed property
-
Changed property
customer(object)- Deleted property
is_parent(boolean)
- Deleted property
-
POST /dms/contract
Request:
Changed content type : application/json
- Added property
starting_odometer(integer)
Return Type:
Changed response : 201 Created
Successful Response
-
Changed content type :
application/json-
Added property
received_security_deposit(integer) -
Added property
starting_odometer(integer) -
Deleted property
recieved_security_deposit(integer) -
Changed property
returns(object)- Changed property
et_fee(string -> integer)
- Changed property
-
Changed property
customer(object)- Deleted property
is_parent(boolean)
- Deleted property
-
PATCH /dms/contract
Request:
Changed content type : application/json
- Added property
starting_odometer(integer)
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json-
Added property
received_security_deposit(integer) -
Added property
starting_odometer(integer) -
Deleted property
recieved_security_deposit(integer) -
Changed property
returns(object)- Changed property
et_fee(string -> integer)
- Changed property
-
Changed property
customer(object)- Deleted property
is_parent(boolean)
- Deleted property
-
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)-
Changed property
insurance(object)-
Added property
is_verified(boolean) -
Added property
start_date(string)format: YYYY-MM-DD
-
-
-
Changed property
customer_info(object)- Deleted property
is_parent(boolean)
- Deleted property
-
-
POST /dms/credit-request
Request:
Changed content type : application/json
-
Changed property
result(array)Changed items (object):
-
Changed property
order_info(object)-
Changed property
insurance(object)-
Added property
is_verified(boolean) -
Added property
start_date(string)format: YYYY-MM-DD
-
-
-
Changed property
customer_info(object)- Deleted property
is_parent(boolean)
- Deleted property
-
GET /dms/contract/all
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json-
Changed property
result(array)Changed items (object):
-
Added property
received_security_deposit(integer) -
Added property
starting_odometer(integer) -
Deleted property
recieved_security_deposit(integer) -
Changed property
returns(object)- Changed property
et_fee(string -> integer)
- Changed property
-
Changed property
customer(object)- Deleted property
is_parent(boolean)
- Deleted property
-
-