API Doc Version 1.3.37
What's New
POST
/dms/customer/send-email-to-customer
send email to customer
POST
/dms/customer/license-verification
License verification through MiTek
GET
/dms/configure/all-quotation/{reference_number}
Get Specific quotation
PATCH
/dms/configure/order-to-quotation/{identifier}
Convert specific Order to Quotation
GET
/dms/order/order_information_for_submitted_order
Get order by order status
GET
/dms/order/order_information/{reference_number}
Get order by order status
GET
/dms/order/credit-decision
Get credit decision
POST
/dms/order/credit-decision
Add credit decision
PATCH
/dms/order/update-credit-approver-decision/{reference_number}
Update decision status after receiving decision from credit approver
PATCH
/dms/order/update-payment-status/{reference_number}
Update Payment Status
POST
/dms/order/order-verify-document/{identifier}
Verify Order Documents
POST
/dms/order/upload-signed-document/{identifier}
Upload Signed Document
PATCH
/dms/configure/quotation-to-order/{identifier}
Convert specific Quotation to Application
GET
/dms/configure/quotation-by-customers
Get all orders of a customer
GET
/dms/all-quotation-by-reference-number/
Get all quotations based on reference number
POST
/dms/order/quick_quotation
Save Single Quotation
GET
/dms/configure/quick-quotation-by-identifier/{identifier}
Get Specific quotation
GET
/dms/configure/quick-quotation-by-vendor
Get all orders of a customer
POST
/dms/quote/calculate-order
Calculate Quotation
POST
/dms/quote/calculate-nfa
Calculate NFA [Net Financed Amount]
POST
/dms/quote/calculation/V2
Calculate Rental
POST
/dms/customer/document/signature-document
Customer Document Signature
POST
/dms/credit-approval
Get Credit Approval
GET
/dms/workflow-status
Credit Approval status
POST
/dms/credit-request
Mock Credit Approver Request
POST
/dms/credit-response
Mock Credit Approver Response
GET
/dms/stipulation/fulfillment
Get All Stipulation Fulfillments
POST
/dms/stipulation/fulfillment
Create Stipulation Fulfillment
DELETE
/dms/stipulation/fulfillment
Delete Stipulation Fulfillments
PATCH
/dms/stipulation/fulfillment
Delete Stipulation Fulfillments
GET
/dms/stipulation/fulfillment/
Get Stipulation Fulfillments
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
GET
/dms/request
Get Request
POST
/dms/request
Create Request
DELETE
/dms/request
Delete Request
PATCH
/dms/request
Update Request
GET
/dms/requests
Get All Requests
GET
/dms/stipulation/financial
Get Financial Stipulation
POST
/dms/stipulation/financial
Create Financial Stipulation
GET
/dms/stipulation/stipulation-by-lender
Get Financial Stipulation
GET
/dms/external-orders/all
Get External Orders
POST
/dms/external-orders/push-deal
Push Deal to Third Party
POST
/dms/configure/appointments
Get paginated list of Appointments
PATCH
/dms/configure/appointment
Update an created appointment
DELETE
/dms/configure/appointment/{appointment_id}
Delete created appointment
What's Deleted
GET
/dms/configure/all-quotation
Get Specific quotation
POST
/dms/configure/appointments/
Delete created appointment
PATCH
/dms/configure/appointments/
Update an created appointment
GET
/dms/referral-detail
Get all referral detail records
GET
/dms/referral-detail/{ref_id}
Get referral by ID
POST
/dms/referral
Creates referral detail
PATCH
/dms/referral/{referral_detail_id}
Update referral detail
DELETE
/dms/referral/{referral_id}
Delete referral detail
GET
/dms/configure/appointments
Get paginated list of Appointments
What's Deprecated
POST
/dms/quote/calculation
Calculate Quotation
GET
/dms/customer/insurance-information-history
Get customer insurance information history
What's Changed
GET
/dms/customer/customer-history
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json
Changed items (object):
New optional properties:
-
email
- Changed property
email
(string -> string)
-
PATCH
/dms/check-customer-by-email
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json
New optional properties:
-
email
-
Added property
is_parent
(boolean) -
Changed property
email
(string -> string)
-
POST
/dms/customer/license-info
Request:
Changed content type : application/json
-
Changed property
address
(object)-
Added property
move_in_date
(string)format: YYYY-MM-DD
-
Added property
is_garaging
(boolean)Garaging flag
-
Return Type:
Changed response : 201 Created
Successful Response
-
Changed content type :
application/json
-
Changed property
address
(object)-
Added property
move_in_date
(string)format: YYYY-MM-DD
-
Added property
is_garaging
(boolean)Garaging flag
-
-
PATCH
/dms/customer/license-info
Request:
Changed content type : application/json
-
Changed property
address
(object)-
Added property
move_in_date
(string)format: YYYY-MM-DD
-
Added property
is_garaging
(boolean)Garaging flag
-
GET
/dms/address
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json
Changed items (object):
-
Added property
move_in_date
(string)format: YYYY-MM-DD
-
Added property
is_garaging
(boolean)Garaging flag
-
Changed property
address_type
(string)An enumeration.
Added enum value:
Employment
POST
/dms/address
-
Request:
Changed content type : application/json
-
Added property
move_in_date
(string)format: YYYY-MM-DD
-
Added property
is_garaging
(boolean)Garaging flag
-
Changed property
address_type
(string)An enumeration.
Added enum value:
Employment
Return Type:
Changed response : 201 Created
Successful Response
-
Changed content type :
application/json
-
Added property
move_in_date
(string)format: YYYY-MM-DD
-
Added property
is_garaging
(boolean)Garaging flag
-
Changed property
address_type
(string)An enumeration.
Added enum value:
Employment
DELETE
/dms/address
-
Parameters:
Changed: address_type
in query
Return Type:
Changed response : 200 OK
Successful Response
- Changed content type :
application/json
PATCH
/dms/address
Request:
Changed content type : application/json
-
Added property
move_in_date
(string)format: YYYY-MM-DD
-
Added property
is_garaging
(boolean)Garaging flag
-
Changed property
address_type
(string)An enumeration.
Added enum value:
Employment
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json
-
Added property
move_in_date
(string)format: YYYY-MM-DD
-
Added property
is_garaging
(boolean)Garaging flag
-
Changed property
address_type
(string)An enumeration.
Added enum value:
Employment
GET
/dms/customer/insurance-information
-
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json
-
Changed property
insurer_address
(object)-
Added property
move_in_date
(string)format: YYYY-MM-DD
-
Added property
is_garaging
(boolean)Garaging flag
-
-
POST
/dms/customer/insurance-information
Request:
Changed content type : application/json
-
Changed property
insurer_address
(object)-
Added property
move_in_date
(string)format: YYYY-MM-DD
-
Added property
is_garaging
(boolean)Garaging flag
-
Return Type:
Changed response : 201 Created
Successful Response
-
Changed content type :
application/json
-
Changed property
insurer_address
(object)-
Added property
move_in_date
(string)format: YYYY-MM-DD
-
Added property
is_garaging
(boolean)Garaging flag
-
-
PATCH
/dms/customer/insurance-information
Request:
Changed content type : application/json
-
Added property
start_date
(string)format: YYYY-MM-DD
-
Changed property
insurer_address
(object)-
Added property
move_in_date
(string)format: YYYY-MM-DD
-
Added property
is_garaging
(boolean)Garaging flag
-
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json
-
Changed property
insurer_address
(object)-
Added property
move_in_date
(string)format: YYYY-MM-DD
-
Added property
is_garaging
(boolean)Garaging flag
-
-
GET
/dms/customer/insurance-information-by-customer
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json
-
Changed property
insurer_address
(object)-
Added property
move_in_date
(string)format: YYYY-MM-DD
-
Added property
is_garaging
(boolean)Garaging flag
-
-
GET
/dms/customer/insurance-information-by-order
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json
-
Changed property
insurer_address
(object)-
Added property
move_in_date
(string)format: YYYY-MM-DD
-
Added property
is_garaging
(boolean)Garaging flag
-
-
POST
/dms/configure/order/tradein
Request:
Changed content type : application/json
New optional properties:
condition
is_customer_titled
lender_address
lender_contact_number
lender_contract_number
lender_id
lender_name
loan_lease_balance
make
mileage
model
order_id
payment_type
payoff_amount
trade_in_amount
trim
vin
year
-
Added property
asset_image
(array)Items (string):
-
Changed property
trade_in_amount
(integer -> number) -
Changed property
payoff_amount
(integer -> number)
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json
New optional properties:
-
condition
-
identifier
-
is_customer_titled
-
lender_address
-
lender_contact_number
-
lender_contract_number
-
lender_id
-
lender_name
-
loan_lease_balance
-
make
-
mileage
-
model
-
order_id
-
payment_type
-
payoff_amount
-
trade_in_amount
-
trim
-
vin
-
year
-
Added property
asset_image
(array) -
Changed property
trade_in_amount
(integer -> number) -
Changed property
payoff_amount
(integer -> number)
-
GET
/dms/configure/order/tradein/{identifier}
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json
New optional properties:
-
condition
-
is_customer_titled
-
lender_address
-
lender_contact_number
-
lender_contract_number
-
lender_id
-
lender_name
-
loan_lease_balance
-
make
-
mileage
-
model
-
order_id
-
payment_type
-
payoff_amount
-
trade_in_amount
-
trim
-
vin
-
year
-
Added property
asset_image
(array) -
Changed property
trade_in_amount
(integer -> number) -
Changed property
payoff_amount
(integer -> number)
-
DELETE
/dms/configure/order/tradein/{identifier}
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json
New optional properties:
-
condition
-
is_customer_titled
-
lender_address
-
lender_contact_number
-
lender_contract_number
-
lender_id
-
lender_name
-
loan_lease_balance
-
make
-
mileage
-
model
-
order_id
-
payment_type
-
payoff_amount
-
trade_in_amount
-
trim
-
vin
-
year
-
Added property
asset_image
(array) -
Changed property
trade_in_amount
(integer -> number) -
Changed property
payoff_amount
(integer -> number)
-
PATCH
/dms/configure/order/tradein/{identifier}
Request:
Changed content type : application/json
New optional properties:
condition
is_customer_titled
lender_address
lender_contact_number
lender_contract_number
lender_id
lender_name
loan_lease_balance
make
mileage
model
order_id
payment_type
payoff_amount
trade_in_amount
trim
vin
year
-
Added property
asset_image
(array) -
Changed property
trade_in_amount
(integer -> number) -
Changed property
payoff_amount
(integer -> number)
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json
New optional properties:
-
condition
-
is_customer_titled
-
lender_address
-
lender_contact_number
-
lender_contract_number
-
lender_id
-
lender_name
-
loan_lease_balance
-
make
-
mileage
-
model
-
order_id
-
payment_type
-
payoff_amount
-
trade_in_amount
-
trim
-
vin
-
year
-
Added property
asset_image
(array) -
Changed property
trade_in_amount
(integer -> number) -
Changed property
payoff_amount
(integer -> number)
-
PATCH
/dms/configure/order/update-status/{order_id}
Update order status record by order reference number
Request:
Changed content type : application/json
- Added property
reason
(string)
Return Type:
Changed response : 200 OK
Successful Response
- Changed content type :
application/json
POST
/dms/configure/order/status/
Update order status history record by order reference number
GET
/dms/configure/order/status-by-dealer
Parameters:
Added: reference_number
in query
Return Type:
Changed response : 200 OK
Successful Response
- Changed content type :
application/json
GET
/dms/configure/workqueue/search
Parameters:
Added: updated_at
in query
Added: appointment_date
in query
Added: reference_number
in query
Added: multiple_order_status
in query
Added: make_model_trim
in query
Added: vehicle_condition
in query
Added: reason
in query
Added: selling_price
in query
Added: dealer_email
in query
POST
/dms/quote/calculation
Request:
Changed content type : application/json
New required properties:
dealer_id
-
Added property
asset_make_name
(string)Asset make name
-
Added property
asset_model_name
(string)Asset model name
-
Added property
asset_trim_name
(string)Asset trim name
-
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_trim_id
(integer)System Generated Asset Trim Id
-
Changed property
terms
(integer -> string)Terms
-
Changed property
dealer_id
(integer)Dealer Id
POST
/dms/configure/appointment
Request:
Changed content type : application/json
New required properties:
appointment_type
-
Added property
appointment_type
(string) -
Added property
address_id
(integer) -
Added property
dealer_code
(string) -
Added 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)
-
POST
/dms/email/
Request:
Changed content type : application/json
-
Added property
dealer_id
(integer) -
Added property
dealer_code
(string)
GET
/dms/customer/document
Parameters:
Added: stipulation_code
in query
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json
Changed items (object):
-
Added property
document_size
(string) -
Added property
uploaded_at
(string) -
Added property
stipulation_code
(string) -
Changed property
document_reviews
(array)Changed items (object):
-
Added property
reason
(string) -
Added property
other_reason
(string)
-
-
POST
/dms/customer/document
Request:
Changed content type : application/json
- Added property
stipulation_code
(string)
Return Type:
Changed response : 201 Created
Successful Response
-
Changed content type :
application/json
-
Added property
document_size
(string) -
Added property
uploaded_at
(string) -
Added property
stipulation_code
(string)
-
PATCH
/dms/customer/document
Request:
Changed content type : application/json
-
Added property
document_name
(string) -
Added property
document_size
(string) -
Added property
uploaded_at
(string)
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json
-
Added property
document_size
(string) -
Added property
uploaded_at
(string) -
Added property
stipulation_code
(string)
-
GET
/dms/customer/document/status
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json
-
Added property
document_size
(string) -
Added property
uploaded_at
(string) -
Added property
stipulation_code
(string)
-
PATCH
/dms/customer/document/status
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json
-
Added property
document_size
(string) -
Added property
uploaded_at
(string) -
Added property
stipulation_code
(string)
-
PATCH
/dms/customer/delete-document
Delete customer document by identifier
GET
/dms/customer/document/review
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json
Changed items (object):
-
Added property
reason
(string) -
Added property
other_reason
(string)
-
POST
/dms/customer/document/review
Return Type:
Changed response : 201 Created
Successful Response
-
Changed content type :
application/json
-
Added property
reason
(string) -
Added property
other_reason
(string)
-
PATCH
/dms/customer/document/uploading-status
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json
-
Added property
document_size
(string) -
Added property
uploaded_at
(string) -
Added property
stipulation_code
(string)
-
POST
/dms/customer/additional-document
Request:
Changed content type : application/json
- Added property
uploaded_at
(string)
Return Type:
Changed response : 201 Created
Successful Response
-
Changed content type :
application/json
-
Added property
document_size
(string) -
Added property
uploaded_at
(string) -
Added property
stipulation_code
(string)
-
PATCH
/dms/configure/metadata
Add Meta Data
GET
/dms/contracts
Get contracts by external order ids
GET
/dms/contracts/search
Get contracts by external order ids
POST
/dms/customer/
Request:
Changed content type : application/json
-
Changed property
customer_addresses
(array)Changed items (object):
-
Added property
move_in_date
(string)format: YYYY-MM-DD
-
Added property
is_garaging
(boolean)Garaging flag
-
Changed property
address_type
(string)An enumeration.
Added enum value:
Employment
Return Type:
-
Changed response : 201 Created
Successful Response
-
Changed content type :
application/json
-
Changed property
license_info
(object)- Added property
date_of_birth
(string)format: YYYY-MM-DD
- Added property
-
Changed property
customer_addresses
(array)Changed items (object):
-
Added property
move_in_date
(string)format: YYYY-MM-DD
-
Added property
is_garaging
(boolean)Garaging flag
-
Changed property
address_type
(string)An enumeration.
Added enum value:
Employment
GET
/dms/customer
-
-
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json
New optional properties:
-
email
-
Added property
is_parent
(boolean) -
Changed property
email
(string -> string) -
Changed property
license_info
(object)- Added property
date_of_birth
(string)format: YYYY-MM-DD
- Added property
-
Changed property
customer_addresses
(array)Changed items (object):
-
Added property
move_in_date
(string)format: YYYY-MM-DD
-
Added property
is_garaging
(boolean)Garaging flag
-
Changed property
address_type
(string)An enumeration.
Added enum value:
Employment
PATCH
/dms/customer
-
-
Request:
Changed content type : application/json
-
Changed property
customer_addresses
(array)Changed items (object):
-
Added property
move_in_date
(string)format: YYYY-MM-DD
-
Added property
is_garaging
(boolean)Garaging flag
-
Changed property
address_type
(string)An enumeration.
Added enum value:
Employment
Return Type:
-
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json
-
Changed property
license_info
(object)- Added property
date_of_birth
(string)format: YYYY-MM-DD
- Added property
-
Changed property
customer_addresses
(array)Changed items (object):
-
Added property
move_in_date
(string)format: YYYY-MM-DD
-
Added property
is_garaging
(boolean)Garaging flag
-
Changed property
address_type
(string)An enumeration.
Added enum value:
Employment
GET
/dms/customer-by-email
-
-
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json
-
Changed property
license_info
(object)- Added property
date_of_birth
(string)format: YYYY-MM-DD
- Added property
-
Changed property
customer_addresses
(array)Changed items (object):
-
Added property
move_in_date
(string)format: YYYY-MM-DD
-
Added property
is_garaging
(boolean)Garaging flag
-
Changed property
address_type
(string)An enumeration.
Added enum value:
Employment
GET
/dms/customer/employment-info
-
-
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json
-
Changed property
address
(object)-
Added property
move_in_date
(string)format: YYYY-MM-DD
-
Added property
is_garaging
(boolean)Garaging flag
-
Changed property
address_type
(string)An enumeration.
Added enum value:
Employment
POST
/dms/customer/employment-info
-
-
Request:
Changed content type : application/json
-
Changed property
address
(object)-
Added property
move_in_date
(string)format: YYYY-MM-DD
-
Added property
is_garaging
(boolean)Garaging flag
-
Changed property
address_type
(string)An enumeration.
Added enum value:
Employment
Return Type:
-
Changed response : 201 Created
Successful Response
-
Changed content type :
application/json
-
Changed property
address
(object)-
Added property
move_in_date
(string)format: YYYY-MM-DD
-
Added property
is_garaging
(boolean)Garaging flag
-
Changed property
address_type
(string)An enumeration.
Added enum value:
Employment
PATCH
/dms/customer/employment-info
-
-
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json
-
Changed property
address
(object)-
Added property
move_in_date
(string)format: YYYY-MM-DD
-
Added property
is_garaging
(boolean)Garaging flag
-
Changed property
address_type
(string)An enumeration.
Added enum value:
Employment
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):
-
Changed property
insurer_address
(object)-
Added property
move_in_date
(string)format: YYYY-MM-DD
-
Added property
is_garaging
(boolean)Garaging flag
-
-
-
GET
/dms/configure/quotation
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json
New required properties:
-
down_payment_lease
-
Added property
down_payment_lease
(number) -
Added property
schedule_option
(string) -
Added property
asset_usage
(string) -
Added property
calcuation_method
(string) -
Added property
order_stage
(string) -
Added property
insurance
(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
expiration_date
(string)format: YYYY-MM-DD
-
Property
deductible_comprehensive
(number) -
Property
deductible_collision
(number) -
Property
created_by
(string) -
Property
identifier
(string) -
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
insurer_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
rental_mode
(string) -
Added property
rental_frequency
(string) -
Changed property
order_options
(array)Changed items (object -> object):
-
Changed property
order_fnI
(array)Changed items (object -> object):
-
Changed property
order_asset
(object)- Added property
vin
(string)
- Added property
-
Changed property
order_tradein
(object)New optional properties:
-
condition
-
is_customer_titled
-
lender_address
-
lender_contact_number
-
lender_contract_number
-
lender_name
-
loan_lease_balance
-
make
-
mileage
-
model
-
payment_type
-
payoff_amount
-
trade_in_amount
-
trim
-
vin
-
year
-
Added property
lender_id
(integer)DealerTradeIn lender id
-
Added property
asset_image
(array) -
Changed property
trade_in_amount
(integer -> number) -
Changed property
payoff_amount
(integer -> number)
-
-
GET
/dms/configure/all-quotations
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json
Changed items (object):
New required properties:
-
down_payment_lease
-
Added property
down_payment_lease
(number) -
Added property
schedule_option
(string) -
Added property
asset_usage
(string) -
Added property
calcuation_method
(string) -
Added property
order_stage
(string) -
Added property
insurance
(object) -
Added property
rental_mode
(string) -
Added property
rental_frequency
(string) -
Changed property
order_options
(array)Changed items (object -> object):
-
Changed property
order_fnI
(array)Changed items (object -> object):
-
Changed property
order_asset
(object)- Added property
vin
(string)
- Added property
-
Changed property
order_tradein
(object)New optional properties:
-
condition
-
is_customer_titled
-
lender_address
-
lender_contact_number
-
lender_contract_number
-
lender_name
-
loan_lease_balance
-
make
-
mileage
-
model
-
payment_type
-
payoff_amount
-
trade_in_amount
-
trim
-
vin
-
year
-
Added property
lender_id
(integer)DealerTradeIn lender id
-
Added property
asset_image
(array) -
Changed property
trade_in_amount
(integer -> number) -
Changed property
payoff_amount
(integer -> number)
-
-
PATCH
/dms/configure/quotation/{identifier}
Request:
Changed content type : application/json
New required properties:
down_payment_lease
-
Added property
down_payment_lease
(number) -
Added property
schedule_option
(string) -
Added property
asset_usage
(string) -
Added property
calcuation_method
(string) -
Added property
order_stage
(string) -
Added property
insurance
(object) -
Added property
rental_mode
(string) -
Added property
rental_frequency
(string) -
Changed property
order_options
(array)Changed items (object -> object):
-
Changed property
order_fnI
(array)Changed items (object -> object):
-
Changed property
order_asset
(object)- Added property
vin
(string)
- Added property
-
Changed property
order_tradein
(object)New optional properties:
-
condition
-
is_customer_titled
-
lender_address
-
lender_contact_number
-
lender_contract_number
-
lender_name
-
loan_lease_balance
-
make
-
mileage
-
model
-
payment_type
-
payoff_amount
-
trade_in_amount
-
trim
-
vin
-
year
-
Added property
lender_id
(integer)DealerTradeIn lender id
-
Added property
asset_image
(array) -
Changed property
trade_in_amount
(integer -> number) -
Changed property
payoff_amount
(integer -> number)
-
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json
New required properties:
-
down_payment_lease
-
identifier
-
Added property
down_payment_lease
(number) -
Added property
schedule_option
(string) -
Added property
asset_usage
(string) -
Added property
calcuation_method
(string) -
Added property
order_stage
(string) -
Added property
insurance
(object) -
Added property
rental_mode
(string) -
Added property
rental_frequency
(string) -
Added property
identifier
(string) -
Changed property
order_options
(array)Changed items (object -> object):
-
Changed property
order_fnI
(array)Changed items (object -> object):
-
Changed property
order_asset
(object)- Added property
vin
(string)
- Added property
-
Changed property
order_tradein
(object)New optional properties:
-
condition
-
is_customer_titled
-
lender_address
-
lender_contact_number
-
lender_contract_number
-
lender_name
-
loan_lease_balance
-
make
-
mileage
-
model
-
payment_type
-
payoff_amount
-
trade_in_amount
-
trim
-
vin
-
year
-
Added property
lender_id
(integer)DealerTradeIn lender id
-
Added property
asset_image
(array) -
Changed property
trade_in_amount
(integer -> number) -
Changed property
payoff_amount
(integer -> number)
-
-
POST
/dms/configure/save-quotation
Request:
Changed content type : application/json
Changed items (object):
New required properties:
down_payment_lease
-
Added property
down_payment_lease
(number) -
Added property
schedule_option
(string) -
Added property
asset_usage
(string) -
Added property
calcuation_method
(string) -
Added property
order_stage
(string) -
Added property
insurance
(object) -
Added property
rental_mode
(string) -
Added property
rental_frequency
(string) -
Changed property
order_options
(array)Changed items (object -> object):
-
Changed property
order_fnI
(array)Changed items (object -> object):
-
Changed property
order_asset
(object)- Added property
vin
(string)
- Added property
-
Changed property
order_tradein
(object)New optional properties:
-
condition
-
is_customer_titled
-
lender_address
-
lender_contact_number
-
lender_contract_number
-
lender_name
-
loan_lease_balance
-
make
-
mileage
-
model
-
payment_type
-
payoff_amount
-
trade_in_amount
-
trim
-
vin
-
year
-
Added property
lender_id
(integer)DealerTradeIn lender id
-
Added property
asset_image
(array) -
Changed property
trade_in_amount
(integer -> number) -
Changed property
payoff_amount
(integer -> number)
-
Return Type:
Changed response : 201 Created
Successful Response
-
Changed content type :
application/json
Changed items (object):
New required properties:
-
down_payment_lease
-
Added property
down_payment_lease
(number) -
Added property
schedule_option
(string) -
Added property
asset_usage
(string) -
Added property
calcuation_method
(string) -
Added property
order_stage
(string) -
Added property
insurance
(object) -
Added property
rental_mode
(string) -
Added property
rental_frequency
(string) -
Changed property
order_options
(array)Changed items (object -> object):
-
Changed property
order_fnI
(array)Changed items (object -> object):
-
Changed property
order_asset
(object)- Added property
vin
(string)
- Added property
-
Changed property
order_tradein
(object)New optional properties:
-
condition
-
is_customer_titled
-
lender_address
-
lender_contact_number
-
lender_contract_number
-
lender_name
-
loan_lease_balance
-
make
-
mileage
-
model
-
payment_type
-
payoff_amount
-
trade_in_amount
-
trim
-
vin
-
year
-
Added property
lender_id
(integer)DealerTradeIn lender id
-
Added property
asset_image
(array) -
Changed property
trade_in_amount
(integer -> number) -
Changed property
payoff_amount
(integer -> number)
-
-
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):
-
Added property
document_size
(string) -
Added property
uploaded_at
(string) -
Added property
stipulation_code
(string) -
Changed property
document_reviews
(array)Changed items (object):
-
Added property
reason
(string) -
Added property
other_reason
(string)
-
-
-
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):
-
Changed property
license_info
(object)- Added property
date_of_birth
(string)format: YYYY-MM-DD
- Added property
-
Changed property
customer_addresses
(array)Changed items (object):
-
Added property
move_in_date
(string)format: YYYY-MM-DD
-
Added property
is_garaging
(boolean)Garaging flag
-
Changed property
address_type
(string)An enumeration.
Added enum value:
Employment
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):
-
Changed property
license_info
(object)- Added property
date_of_birth
(string)format: YYYY-MM-DD
- Added property
-
Changed property
customer_addresses
(array)Changed items (object):
-
Added property
move_in_date
(string)format: YYYY-MM-DD
-
Added property
is_garaging
(boolean)Garaging flag
-
Changed property
address_type
(string)An enumeration.
Added enum value:
Employment
GET
/dms/contract
-
-
-
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json
-
Changed property
returns
(object)- Added property
et_fee
(string)
- Added property
-
Changed property
customer
(object)-
Changed property
license_info
(object)- Added property
date_of_birth
(string)format: YYYY-MM-DD
- Added property
-
Changed property
customer_addresses
(array)Changed items (object):
-
Added property
move_in_date
(string)format: YYYY-MM-DD
-
Added property
is_garaging
(boolean)Garaging flag
-
Changed property
address_type
(string)An enumeration.
Added enum value:
Employment
POST
/dms/contract
-
-
-
Return Type:
Changed response : 201 Created
Successful Response
-
Changed content type :
application/json
-
Changed property
returns
(object)- Added property
et_fee
(string)
- Added property
-
Changed property
customer
(object)-
Changed property
license_info
(object)- Added property
date_of_birth
(string)format: YYYY-MM-DD
- Added property
-
Changed property
customer_addresses
(array)Changed items (object):
-
Added property
move_in_date
(string)format: YYYY-MM-DD
-
Added property
is_garaging
(boolean)Garaging flag
-
Changed property
address_type
(string)An enumeration.
Added enum value:
Employment
PATCH
/dms/contract
-
-
-
Return Type:
Changed response : 200 OK
Successful Response
-
Changed content type :
application/json
-
Changed property
returns
(object)- Added property
et_fee
(string)
- Added property
-
Changed property
customer
(object)-
Changed property
license_info
(object)- Added property
date_of_birth
(string)format: YYYY-MM-DD
- Added property
-
Changed property
customer_addresses
(array)Changed items (object):
-
Added property
move_in_date
(string)format: YYYY-MM-DD
-
Added property
is_garaging
(boolean)Garaging flag
-
Changed property
address_type
(string)An enumeration.
Added enum value:
Employment
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
returns
(object)- Added property
et_fee
(string)
- Added property
-
Changed property
customer
(object)-
Changed property
license_info
(object)- Added property
date_of_birth
(string)format: YYYY-MM-DD
- Added property
-
Changed property
customer_addresses
(array)Changed items (object):
-
Added property
move_in_date
(string)format: YYYY-MM-DD
-
Added property
is_garaging
(boolean)Garaging flag
-
Changed property
address_type
(string)An enumeration.
Added enum value:
Employment
-
-
-
-