API Doc Version 1.3.31

What's New

GET /dms/customer/insurance-information/document-history

Get Insurance Documents

PATCH /dms/customer/delete-insurance-information

Delete single customer insurance information

PATCH /dms/customer/insurance-information/remove-insurance-document

Delete insurance document

PATCH /dms/customer/remove-status-flag

Remove customer status flag

PATCH /dms/customer/delete-document

Delete Customer Document By Identifier

GET /dms/history

Get all customers records history

GET /dms/history-details

Get history detail

What's Deprecated

DELETE /dms/customer/insurance-information

Delete single customer insurance information

DELETE /dms/customer/insurance-information/remove-document

Delete insurance document

DELETE /dms/customer/status-flag

Remove customer status flag

DELETE /dms/customer/document

Delete customer document by identifier

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 required properties:

  • email

  • Added property created_by (string)

  • 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 required properties:

  • email

  • Added property created_by (string)

  • Changed property email (string -> string)

PATCH /dms/delete-customer

Request:

Changed content type : application/json

New required properties:

• deleted_by

POST /dms/customer/license-info

Return Type:

Changed response : 201 Created

Successful Response

• Changed content type : application/json

  • Added property reference_id (string)

  • Changed property address (object)

    New optional properties:

    • address_type

    • Deleted property address_type (string)

      An enumeration.

    • Deleted property identifier (string)

    • Deleted property created_at (string)

    • Deleted property updated_at (string)

    • Deleted property updated_by (string)

    • Deleted property deleted_at (string)

    • Deleted property deleted_by (string)

PATCH /dms/customer/license-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 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 identifier (string)

GET /dms/customer/employment-info

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property created_by (string)

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

      An enumeration.

      Enum values:

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

    • Property identifier (string)

    • Property created_at (string)

    • Property created_by (string)

    • Property updated_at (string)

    • Property updated_by (string)

    • Property deleted_at (string)

    • Property deleted_by (string)

    • Property reference_id (string)

    • Property is_active (boolean)

POST /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 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 address_type (string)

    An enumeration.

  • Property identifier (string)

• Changed property employed_since (string)

  format: YYYY-MM-DD

Return Type:

Changed response : 201 Created

Successful Response

• Changed content type : application/json

  • Added property created_by (string)

  • Added property address (object)

PATCH /dms/customer/employment-info

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property created_by (string)

  • Added property address (object)

PATCH /dms/customer/personal-finance

Request:

Changed content type : application/json

• Deleted property reference_id (string)

  Reference Id

POST /dms/customer/payment-information/

Request:

Changed content type : application/json

• Changed property type (string)

• Changed property reference_id (string)

Return Type:

Changed response : 201 Created

Successful Response

• Changed content type : application/json

  • Added property created_by (string)

GET /dms/customer/payment-information

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  Changed items (object):

  • Added property created_by (string)

PATCH /dms/customer/payment-information

Request:

Changed content type : application/json

• Changed property type (string)

• Changed property reference_id (string)

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property created_by (string)

DELETE /dms/customer/signature

Request:

Changed content type : application/json

New required properties:

• deleted_by

PATCH /dms/customer/delete-signature

Request:

Changed content type : application/json

New required properties:

• deleted_by

GET /dms/address

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  Changed items (object):

  • Added property created_by (string)

POST /dms/address

Return Type:

Changed response : 201 Created

Successful Response

• Changed content type : application/json

  • Added property created_by (string)

DELETE /dms/address

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property created_by (string)

PATCH /dms/address

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property created_by (string)

GET /dms/customer/insurance-information

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property deleted_at (string)

  • Added property deleted_by (string)

POST /dms/customer/insurance-information

Request:

Changed content type : application/json

New required properties:

• created_by

Return Type:

Changed response : 201 Created

Successful Response

• Changed content type : application/json

  • Added property deleted_at (string)

  • Added property deleted_by (string)

DELETE /dms/customer/insurance-information

PATCH /dms/customer/insurance-information

Request:

Changed content type : application/json

New required properties:

• updated_by

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property deleted_at (string)

  • Added property deleted_by (string)

GET /dms/customer/insurance-information-by-customer

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property deleted_at (string)

  • Added property deleted_by (string)

GET /dms/customer/insurance-information-by-order

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property deleted_at (string)

  • Added property deleted_by (string)

DELETE /dms/customer/insurance-information/remove-document

GET /dms/customer/status-flag

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  Changed items (object):

  • Added property is_active (boolean)

  • Added property is_deleted (boolean)

POST /dms/customer/status-flag

Request:

Changed content type : application/json

New required properties:

• created_by

Return Type:

Changed response : 201 Created

Successful Response

• Changed content type : application/json

  • Added property is_active (boolean)

  • Added property is_deleted (boolean)

DELETE /dms/customer/status-flag

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

POST /dms/configure/workqueue

Request:

Changed content type : application/json

New optional properties:

• expired_at

POST /dms/quote/calculation

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  Changed items (object):

  • Changed property rv_chart (string -> object)

    RV chart

GET /dms/customer/document

Get customer documents

POST /dms/customer/document

Request:

Changed content type : application/json

New required properties:

• created_by

DELETE /dms/customer/document

Delete customer document by identifier

PATCH /dms/customer/document

Update customer document by identifier

Request:

Changed content type : application/json

New required properties:

• updated_by

GET /dms/customer/document/status

Get customer document by identifier

GET /dms/customer/document-history

Get customer document history

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property result (array)

    Changed items (object):

    New required properties:

    • document_reviews

    • Added 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 identifier (string)

GET /dms/customer/document/review

POST /dms/customer/additional-document

Request:

Changed content type : application/json

New required properties:

• created_by

POST /dms/customer/

Request:

Changed content type : application/json

• Changed property customer_profile (object)

  New required properties:

  • created_by

  • 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 is_parent (boolean)

  • Changed property income_info (object)

    • Added property created_by (string)

  • Changed property payments_info (array)

    Changed items (object):

    • Added property created_by (string)

  • Changed property customer_addresses (array)

    Changed items (object):

    • Added property created_by (string)

DELETE /dms/customer

Request:

Changed content type : application/json

New required properties:

• deleted_by

GET /dms/customer

Parameters:

Added: email in query

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  New required properties:

  • email

  • Added property created_by (string)

  • Changed property email (string -> string)

  • Changed property income_info (object)

    • Added property created_by (string)

  • Changed property payments_info (array)

    Changed items (object):

    • Added property created_by (string)

  • Changed property customer_addresses (array)

    Changed items (object):

    • Added property created_by (string)

PATCH /dms/customer

Request:

Changed content type : application/json

• Changed property customer_profile (object)

  New required properties:

  • updated_by

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property created_by (string)

  • Added property is_parent (boolean)

  • Changed property income_info (object)

    • Added property created_by (string)

  • Changed property payments_info (array)

    Changed items (object):

    • Added property created_by (string)

  • Changed property customer_addresses (array)

    Changed items (object):

    • Added property created_by (string)

GET /dms/customer-by-email

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property created_by (string)

  • Added property is_parent (boolean)

  • Changed property income_info (object)

    • Added property created_by (string)

  • Changed property payments_info (array)

    Changed items (object):

    • Added property created_by (string)

  • Changed property customer_addresses (array)

    Changed items (object):

    • Added property created_by (string)

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 deleted_at (string)

    • Added property deleted_by (string)

GET /dms/configure/quotation

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property payment_recieved (boolean)

  • Added property base_rate (number)

  • Added property margin (number)

  • Added property applicable_rate (number)

  • Added property invoice_status (string)

    An enumeration.

    Enum values:

    • Active
    • Paused
    • Resumed

  • Deleted property vin (string)

GET /dms/configure/all-quotation

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  Changed items (object):

  • Added property payment_recieved (boolean)

  • Added property base_rate (number)

  • Added property margin (number)

  • Added property applicable_rate (number)

  • Added property invoice_status (string)

    An enumeration.

  • Deleted property vin (string)

GET /dms/configure/all-quotations

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  Changed items (object):

  • Added property payment_recieved (boolean)

  • Added property base_rate (number)

  • Added property margin (number)

  • Added property applicable_rate (number)

  • Added property invoice_status (string)

    An enumeration.

  • Deleted property vin (string)

PATCH /dms/configure/quotation/{identifier}

Request:

Changed content type : application/json

• Added property payment_recieved (boolean)

• Added property base_rate (number)

• Added property margin (number)

• Added property applicable_rate (number)

• Added property invoice_status (string)

  An enumeration.

• Deleted property vin (string)

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property payment_recieved (boolean)

  • Added property base_rate (number)

  • Added property margin (number)

  • Added property applicable_rate (number)

  • Added property invoice_status (string)

    An enumeration.

  • Deleted property vin (string)

POST /dms/configure/save-quotation

Request:

Changed content type : application/json

Changed items (object):

• Added property payment_recieved (boolean)

• Added property base_rate (number)

• Added property margin (number)

• Added property applicable_rate (number)

• Added property invoice_status (string)

  An enumeration.

• Deleted property vin (string)

Return Type:

Changed response : 201 Created

Successful Response

• Changed content type : application/json

  Changed items (object):

  • Added property payment_recieved (boolean)

  • Added property base_rate (number)

  • Added property margin (number)

  • Added property applicable_rate (number)

  • Added property invoice_status (string)

    An enumeration.

  • Deleted property vin (string)

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

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property payment_recieved (boolean)

  • Added property base_rate (number)

  • Added property margin (number)

  • Added property applicable_rate (number)

  • Added property invoice_status (string)

    An enumeration.

  • Deleted property vin (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):

    • Added property created_by (string)

    • Added property is_parent (boolean)

    • Changed property income_info (object)

      • Added property created_by (string)

    • Changed property payments_info (array)

      Changed items (object):

      • Added property created_by (string)

    • Changed property customer_addresses (array)

      Changed items (object):

      • Added property created_by (string)

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):

    • Added property created_by (string)

    • Added property is_parent (boolean)

    • Changed property income_info (object)

      • Added property created_by (string)

    • Changed property payments_info (array)

      Changed items (object):

      • Added property created_by (string)

    • Changed property customer_addresses (array)

      Changed items (object):

      • Added property created_by (string)

GET /dms/contract

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  Changed items (object):

  • Changed property customer (object)

    • Added property created_by (string)

    • Added property is_parent (boolean)

POST /dms/contract

Return Type:

Changed response : 201 Created

Successful Response

• Changed content type : application/json

  • Changed property customer (object)

    • Added property created_by (string)

    • Added property is_parent (boolean)

PATCH /dms/contract

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property customer (object)

    • Added property created_by (string)

    • Added property is_parent (boolean)

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 created_by (string)

      • Added property is_parent (boolean)