openapi: 3.0.2 info: version: 1.3.43 title: Lane API contact: email: support@netsolapp.io, support@appexnow.com x-logo: url: ../lane/docs/64x64.png altText: Lane backgroundColor: '#FFFFFF' description: >- Lane offers a feature-rich, end-to-end order management system for asset leasing, loans and credit companies. Our platform covers all aspects, from conducting end-to-end sales to performing dealer and partner-related tasks and marketing-related activities. externalDocs: url: https://developer.appexnow.com/docs/lane/overview description: Product Documentation servers: - url: https://dms-api.netsolapp.io tags: - name: Customer Management description: >- Customer Management is a collection of APIs to manage Customer information. It includes but is not limited to personal information, License information, employment information, financial information, signatures, address(es) and insurance information. This collection facilitates to manage Customer information for any business and provides all relevant information for its operations. - name: Order Management description: Manage operations related to Orders. - name: Disclaimer Management description: Manage disclaimers for order and customers. - name: Workqueue Management description: Manage operations related to workqueue. - name: Order Calculations description: Manage operations related to order calculations. - name: Appointment Management description: Manage operations related to appointment management. - name: Customer Consent description: Manage operations related to customer consent. - name: Customer Document description: Manage customer documents for order and customers. - name: Document Package Management description: Manage operations related to Document package - name: Credit Approval description: Manage operations related to Credit Approval. - name: Customer Contract description: Manage operations related to Customer Contract - name: Stipulation Fulfillment description: Manage operations related to Stipulation Fulfillment - name: Order Events description: Manage operations related to Order Events - name: History description: Manage operations related to History - name: Request description: Manage operations related to Request - name: Stipulation description: Manage operations related to Stipulation - name: External Order Management description: Manage operations related to External Order Management - name: root description: API health and Version - name: AN Dealers - name: Theme Builder - name: External Keys - name: Change Log description: "# API Docs Version 1.3.43\r\n --- \r\n\r\n## What's New\r\n\r\n\r\n### `PATCH` /dms/update-dms-customer\r\n\r\n> Update Dms Customer\r\n\r\n\r\n### `GET` /dms/check-dms-customer\r\n\r\n> Get customer record\r\n\r\n\r\n### `GET` /dms/customer/signature/by-dealer-id\r\n\r\n> Gets a customer signature record by dealer id\r\n\r\n\r\n### `PATCH` /dms/customer/update-insurance-information\r\n\r\n> Updates customer insurance information\r\n\r\n\r\n### `POST` /dms/customer/all-customers-orders-dynamic-search\r\n\r\n> Get all customer records along with its orders dynamic search\r\n\r\n\r\n### `POST` /dms/customer/send-order-link\r\n\r\n> send order link\r\n\r\n\r\n### `GET` /dms/customers/reference-id\r\n\r\n> Get reference id by email\r\n\r\n\r\n### `POST` /dms/send-notification-email-sqs\r\n\r\n> Send Email Notification Through SQS\r\n\r\n\r\n### `POST` /dms/send-notification-email\r\n\r\n> Send Email Notification\r\n\r\n\r\n### `GET` /dms/order/order_insurance_documents/{reference_number}\r\n\r\n> Get order insurance documents by order ID\r\n\r\n\r\n### `POST` /dms/configure/insurance\r\n\r\n> Add insurance\r\n\r\n\r\n### `GET` /dms/order/workqueue\r\n\r\n> Get all orders for workqueue.\r\n\r\n\r\n### `PATCH` /dms/order/asset/{reference_number}\r\n\r\n> Updates an order asset record\r\n\r\n\r\n### `POST` /dms/update-order-submission\r\n\r\n> Update Order Submission Status\r\n\r\n\r\n### `PATCH` /dms/order/approve-order-by-lender/{reference_number}/{lender_id}\r\n\r\n> Update Order Status and Lender Id\r\n\r\n\r\n### `POST` /dms/order/get-customer-order-submissions/{customer_reference_id}/{submission_status}\r\n\r\n> Get order lender submissions of customer by status and Lender ids\r\n\r\n\r\n### `GET` /dms/order/get-order-submission-by-id/{submission_id}\r\n\r\n> Get single order submission by primary key\r\n\r\n\r\n### `PATCH` /dms/order/re-submit/{identifier}\r\n\r\n> Update order and re-send deal to lender\r\n\r\n\r\n### `PATCH` /dms/configure/individualized-agreement\r\n\r\n> Creates an order individualized agreement info setup record\r\n\r\n\r\n### `PATCH` /dms/configure/update-financial-indicator/{reference_number}/{is_payment_updated}\r\n\r\n> Update Financial Indicator\r\n\r\n\r\n### `POST` /dms/order/proposal\r\n\r\n> Create new order proposal for broker\r\n\r\n\r\n### `PATCH` /dms/order/proposal\r\n\r\n> Update order proposal for broker\r\n\r\n\r\n### `PATCH` /dms/order/change-proposal-status\r\n\r\n> Update order proposal status\r\n\r\n\r\n### `GET` /dms/order/proposal-dashboard-analytics\r\n\r\n> Get order proposal analytics for broker dashboard\r\n\r\n\r\n### `POST` /dms/order/generate-document/{event_name}\r\n\r\n> Generate Document for respective event\r\n\r\n\r\n### `POST` /dms/order/download_document_by_event/{event_name}\r\n\r\n> Get generated document(s) key(s) against specific event\r\n\r\n\r\n### `POST` /dms/order/send-email/{event_name}\r\n\r\n> send Email notification\r\n\r\n\r\n### `GET` /dms/order/stakeholder/\r\n\r\n> Get order stakeholder\r\n\r\n\r\n### `POST` /dms/order/stakeholder/\r\n\r\n> Create new order stakeholder\r\n\r\n\r\n### `DELETE` /dms/order/stakeholder/\r\n\r\n> Update order stakeholder\r\n\r\n\r\n### `PATCH` /dms/order/stakeholder/\r\n\r\n> Update order stakeholder\r\n\r\n\r\n### `POST` /dms/configure/multiple-disclaimers\r\n\r\n> Create multiple disclaimers\r\n\r\n\r\n### `POST` /dms/quote/calculation/monthlyImpact\r\n\r\n> Calculate Monthly Impact\r\n\r\n\r\n### `GET` /dms/customer/document/download-stream\r\n\r\n> Get customer document stream by artifect_id\r\n\r\n\r\n### `GET` /dms/get-an-signed-url\r\n\r\n> Get AN Signed URL to Upload\r\n\r\n\r\n### `POST` /dms/configure/by-role/{document_package_identifier}/{document_identifier}/{signature_id}/{signer_role}\r\n\r\n> Sign document\r\n\r\n\r\n### `GET` /dms/configure/document-pre-signed-url/{key}\r\n\r\n> Get document package by identifier\r\n\r\n\r\n### `GET` /dms/configure/document-notification-bookmarks\r\n\r\n> Get bookmarks of documents and notifications\r\n\r\n\r\n### `POST` /dms/contract-document\r\n\r\n> Handle contract document\r\n\r\n\r\n### `GET` /dms/company/by-tenant-id/{tenant_id}\r\n\r\n> Find Company By Tenant Id\r\n\r\n\r\n### `GET` /dms/integration/company\r\n\r\n> Get All Company Integration\r\n\r\n\r\n### `GET` /dms/integration/by_provider_name/{dealer_code}/{integration_type}/{provider_name}\r\n\r\n> Get Integration By Provider Name\r\n\r\n\r\n### `GET` /dms/integration/configuration/{dealer_code}/{integration_type}/{provider_name}\r\n\r\n> Get Hubex Configuration By Provider Name\r\n\r\n\r\n### `GET` /dms/dealer/option-model-name\r\n\r\n> Get All Dealer Options By Model Name\r\n\r\n\r\n### `GET` /dms/get-payment-methods/{reference_number}\r\n\r\n> Get Payment Methods & Get Paid Amount\r\n\r\n\r\n### `POST` /dms/plaid-link-token/\r\n\r\n> Create Link Token\r\n\r\n\r\n### `POST` /dms/create-payment/\r\n\r\n> Create payment for new Order\r\n\r\n\r\n### `POST` /dms/update-payment/\r\n\r\n> Update Order Payment\r\n\r\n\r\n### `POST` /dms/add-payment-details/\r\n\r\n> Add Payment Details from dealer side\r\n\r\n\r\n### `PUT` /dms/remove-payment-details/{order_payment_detail_id}\r\n\r\n> Remove the order payment detail\r\n\r\n\r\n### `GET` /dms/dealer/get-associated-dealers\r\n\r\n> Get All Dealer Distance\r\n\r\n\r\n### `GET` /dms/dealer/check-actively-order\r\n\r\n> Check Dealer actively order\r\n\r\n\r\n### `POST` /dms/get-trade-in-year/\r\n\r\n> Get all the year from KBB\r\n\r\n\r\n### `POST` /dms/get-trade-in-make/\r\n\r\n> Get all the make from KBB\r\n\r\n\r\n### `POST` /dms/get-trade-in-model/\r\n\r\n> Get all the models from KBB\r\n\r\n\r\n### `POST` /dms/get-trade-in-trim/\r\n\r\n> Get all the trims from KBB\r\n\r\n\r\n### `POST` /dms/get-trade-in-vehicle_value/\r\n\r\n> Get vehicle estimation from KBB\r\n\r\n\r\n### `POST` /dms/get-trade-in-vehicle_detail/\r\n\r\n> Get vehicle details from KBB\r\n\r\n\r\n### `POST` /dms/get-vehicle-detail-by-vin/\r\n\r\n> Get vehicle details through VIN\r\n\r\n\r\n### `PATCH` /dms/set-trade-in-inspection-status/{order_id}\r\n\r\n> Set Trade-in inspection status\r\n\r\n\r\n### `GET` /dms/get-trade_in_history/{order_id}\r\n\r\n> Get trade in history\r\n\r\n\r\n### `POST` /dms/get-tradein-options/\r\n\r\n> Get trade in options linked with vehicles\r\n\r\n\r\n### `POST` /dms/event_analytic\r\n\r\n> Create Event\r\n\r\n\r\n### `GET` /dms/lead/{dealer_id}\r\n\r\n> Get dealer's lead\r\n\r\n\r\n### `PATCH` /dms/lead\r\n\r\n> Update exisitng Draft/Active lead otherwise create new Lead\r\n\r\n\r\n### `PATCH` /dms/lead/change-status/{lead_id}\r\n\r\n> Update exisitng lead status\r\n\r\n\r\n### `POST` /dms/insurance/add-insurance\r\n\r\n> Add Insurance\r\n\r\n\r\n## What's Deleted\r\n\r\n\r\n### `GET` /dms/lender/by-tenant-id/{tenant_id}\r\n\r\n> Find Lender By Tenant Id\r\n\r\n\r\n### `GET` /dms/integration/lender\r\n\r\n> Get All Lender Integration\r\n\r\n\r\n### `GET` /dms/integration/by_provider_name/{provider_name}\r\n\r\n> Get Integration By Provider Name\r\n\r\n\r\n### `GET` /dms/dealer/option-trim-code\r\n\r\n> Get All Dealer Options By Trim Code\r\n\r\n\r\n## What's Changed\r\n\r\n\r\n### `POST` /dms/customer/all-customers-dynamic-search\r\n\r\n\r\n#### Parameters:\r\n\r\nChanged: `sort_by` in `query`\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\nChanged items (object):\r\n\r\n* Changed property `field` (string)\r\n > An enumeration.\r\n\r\n\r\n Added enum values:\r\n\r\n * `stock_number`\r\n * `dealer_id`\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n### `PATCH` /dms/check-customer-by-email\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `preferred_contact` (string)\r\n\r\n * Added property `external_id` (string)\r\n\r\n### `GET` /dms/customer/license-info\r\n\r\n\r\n#### Parameters:\r\n\r\nAdded: `is_presigned_url_required` in `query`\r\n\r\n### `POST` /dms/customer/license-info\r\n\r\n\r\n#### Parameters:\r\n\r\nAdded: `dealer_code` in `query`\r\n\r\n### `PATCH` /dms/customer/license-info\r\n\r\n\r\n#### Parameters:\r\n\r\nAdded: `is_presigned_url_required` in `query`\r\n\r\nAdded: `dealer_code` in `query`\r\n\r\n### `POST` /dms/customer/personal-finance\r\n\r\n\r\n#### Parameters:\r\n\r\nAdded: `dealer_code` in `query`\r\n\r\n### `PATCH` /dms/customer/personal-finance\r\n\r\n\r\n#### Parameters:\r\n\r\nAdded: `dealer_code` in `query`\r\n\r\n### `GET` /dms/customer/signature\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `dealer_id` (integer)\r\n\r\n### `POST` /dms/customer/signature\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Added property `dealer_id` (integer)\r\n\r\n#### Return Type:\r\n\r\nChanged response : **201 Created**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `dealer_id` (integer)\r\n\r\n### `PATCH` /dms/customer/signature\r\n\r\n\r\n#### Parameters:\r\n\r\nAdded: `dealer_id` in `query`\r\n\r\nChanged: `reference_id` in `query`\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `dealer_id` (integer)\r\n\r\n### `GET` /dms/address/history\r\n\r\n\r\n#### Parameters:\r\n\r\nChanged: `address_type` in `query`\r\n\r\n### `PATCH` /dms/customer/insurance-information\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Added property `insurance_documents` (array)\r\n\r\n Items (object):\r\n\r\n * Property `document` (string)\r\n\r\n * Property `content_type` (string)\r\n > format: application/pdf, image/png\r\n\r\n\r\n * Property `name` (string)\r\n\r\n * Property `file_size` (string)\r\n\r\n * Property `created_by` (string)\r\n\r\n * Property `doucment_reference_id` (string)\r\n\r\n### `POST` /dms/customer/comment\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\nNew optional properties:\r\n- `reference_id`\r\n\r\n### `GET` /dms/customer/comments\r\n\r\n\r\n#### Parameters:\r\n\r\nChanged: `reference_id` in `query`\r\n\r\nChanged: `page_number` in `query`\r\n\r\nChanged: `page_size` in `query`\r\n\r\n### `POST` /dms/customer/license-verification\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Added property `dealer_code` (string)\r\n\r\n### `POST` /dms/customer/fraud-check\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\nNew required properties:\r\n- `dealer_code`\r\n\r\n* Added property `dealer_code` (string)\r\n\r\n### `POST` /dms/configure/order-fees\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Added property `vendor` (string)\r\n\r\n* Added property `fee_type` (string)\r\n\r\n#### Return Type:\r\n\r\nChanged response : **201 Created**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `vendor` (string)\r\n\r\n * Added property `fee_type` (string)\r\n\r\n### `GET` /dms/configure/order-fees/{identifier}\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n Changed items (object):\r\n\r\n * Added property `vendor` (string)\r\n\r\n * Added property `fee_type` (string)\r\n\r\n### `DELETE` /dms/configure/order-fees/{identifier}\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `vendor` (string)\r\n\r\n * Added property `fee_type` (string)\r\n\r\n### `PATCH` /dms/configure/order-fees/{identifier}\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Added property `vendor` (string)\r\n\r\n* Added property `fee_type` (string)\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `vendor` (string)\r\n\r\n * Added property `fee_type` (string)\r\n\r\n### `POST` /dms/configure/order-fni\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\nNew required properties:\r\n- `form_id`\r\n- `mileage`\r\n- `rate_id`\r\n- `term`\r\n\r\n* Added property `mileage` (integer)\r\n\r\n* Added property `term` (integer)\r\n\r\n* Added property `is_msp` (boolean)\r\n\r\n* Added property `form_id` (integer)\r\n\r\n* Added property `rate_id` (integer)\r\n\r\n### `GET` /dms/configure/order-fni/{identifier}\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n Changed items (object):\r\n\r\n New required properties:\r\n - `form_id`\r\n - `mileage`\r\n - `rate_id`\r\n - `term`\r\n\r\n * Added property `mileage` (integer)\r\n\r\n * Added property `term` (integer)\r\n\r\n * Added property `is_msp` (boolean)\r\n\r\n * Added property `form_id` (integer)\r\n\r\n * Added property `rate_id` (integer)\r\n\r\n### `DELETE` /dms/configure/order-fni/{identifier}\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n New required properties:\r\n - `form_id`\r\n - `mileage`\r\n - `rate_id`\r\n - `term`\r\n\r\n * Added property `mileage` (integer)\r\n\r\n * Added property `term` (integer)\r\n\r\n * Added property `is_msp` (boolean)\r\n\r\n * Added property `form_id` (integer)\r\n\r\n * Added property `rate_id` (integer)\r\n\r\n### `PATCH` /dms/configure/order-fni/{identifier}\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\nNew required properties:\r\n- `form_id`\r\n- `mileage`\r\n- `rate_id`\r\n- `term`\r\n\r\n* Added property `mileage` (integer)\r\n\r\n* Added property `term` (integer)\r\n\r\n* Added property `is_msp` (boolean)\r\n\r\n* Added property `form_id` (integer)\r\n\r\n* Added property `rate_id` (integer)\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n New required properties:\r\n - `form_id`\r\n - `mileage`\r\n - `rate_id`\r\n - `term`\r\n\r\n * Added property `mileage` (integer)\r\n\r\n * Added property `term` (integer)\r\n\r\n * Added property `is_msp` (boolean)\r\n\r\n * Added property `form_id` (integer)\r\n\r\n * Added property `rate_id` (integer)\r\n\r\n### `PATCH` /dms/configure/order/update-status/{reference_number}\r\n\r\n\r\n#### Parameters:\r\n\r\nAdded: `is_inventory_check` in `query`\r\n\r\n### `GET` /dms/configure/assets-by-trim-code/{trim_code}\r\n\r\n\r\n### `GET` /dms/configure/quick-quotation-by-identifier/{identifier}\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `name` (string)\r\n\r\n * Added property `end_date` (string)\r\n\r\n * Added property `updated_at` (string)\r\n\r\n * Added property `estimated_monthly_payment` (string)\r\n\r\n * Added property `calculations_type` (string)\r\n\r\n * Added property `sum_of_advance_rentals` (number)\r\n\r\n * Added property `balloon_collection` (string)\r\n\r\n * Added property `product_type` (string)\r\n\r\n * Added property `commission_type` (string)\r\n\r\n * Added property `tax_amount` (number)\r\n\r\n * Added property `tax_amount_number` (integer)\r\n\r\n * Added property `deferred_type` (string)\r\n\r\n * Added property `rate_type` (string)\r\n\r\n * Added property `margin` (number)\r\n\r\n * Added property `rental_mode` (string)\r\n\r\n * Added property `sum_of_fees` (number)\r\n\r\n * Added property `sum_of_periodic_interest` (number)\r\n\r\n * Added property `sum_of_rentals` (number)\r\n\r\n * Added property `total_payables` (number)\r\n\r\n * Added property `running_id` (string)\r\n\r\n * Added property `broker_id` (integer)\r\n\r\n * Added property `non_vatable_amount` (number)\r\n\r\n * Added property `order_stakeholders` (array)\r\n\r\n Items (object):\r\n\r\n * Property `identifier` (string)\r\n\r\n * Property `order_identifier` (string)\r\n\r\n * Property `stakeholder_reference_id` (string)\r\n\r\n * Property `name` (string)\r\n\r\n * Property `email` (string)\r\n\r\n * Property `role` (string)\r\n\r\n * Property `position` (string)\r\n\r\n * Property `contact_number` (string)\r\n\r\n * Property `address_id` (string)\r\n\r\n * Added property `date_submitted` (string)\r\n\r\n * Changed property `order_fees` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `id` (integer)\r\n\r\n * Added property `fee_frequency` (string)\r\n\r\n * Added property `fee_occurance` (string)\r\n\r\n * Added property `fee_first_due_date` (string)\r\n\r\n * Changed property `assets` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `id` (integer)\r\n\r\n * Added property `identifier` (string)\r\n\r\n * Added property `rv_balloon_amount` (number)\r\n\r\n * Changed property `customer` (object)\r\n\r\n * Added property `company_name` (string)\r\n\r\n * Added property `customer_type` (string)\r\n\r\n### `GET` /dms/configure/quick-quotation-by-vendor\r\n\r\n\r\n#### Parameters:\r\n\r\nAdded: `statuses` in `query`\r\n> Accepts only string values\r\n\r\n\r\nAdded: `dealer_id` in `query`\r\n\r\nAdded: `broker_id` in `query`\r\n\r\nAdded: `lender_name` in `query`\r\n\r\nAdded: `dealer_name` in `query`\r\n\r\nAdded: `introducer_name` in `query`\r\n\r\nAdded: `name` in `query`\r\n\r\nAdded: `finance_type` in `query`\r\n\r\nAdded: `product_type` in `query`\r\n\r\nAdded: `finance_amount` in `query`\r\n\r\nAdded: `updated_at` in `query`\r\n\r\nAdded: `date_submitted` in `query`\r\n\r\nAdded: `start_date` in `query`\r\n\r\nAdded: `end_date` in `query`\r\n\r\nAdded: `sort_by` in `query`\r\n\r\nAdded: `sort_order` in `query`\r\n\r\nAdded: `order_stage` in `query`\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n Changed items (object):\r\n\r\n * Added property `name` (string)\r\n\r\n * Added property `end_date` (string)\r\n\r\n * Added property `updated_at` (string)\r\n\r\n * Added property `estimated_monthly_payment` (string)\r\n\r\n * Added property `calculations_type` (string)\r\n\r\n * Added property `sum_of_advance_rentals` (number)\r\n\r\n * Added property `balloon_collection` (string)\r\n\r\n * Added property `product_type` (string)\r\n\r\n * Added property `commission_type` (string)\r\n\r\n * Added property `tax_amount` (number)\r\n\r\n * Added property `tax_amount_number` (integer)\r\n\r\n * Added property `deferred_type` (string)\r\n\r\n * Added property `rate_type` (string)\r\n\r\n * Added property `margin` (number)\r\n\r\n * Added property `rental_mode` (string)\r\n\r\n * Added property `sum_of_fees` (number)\r\n\r\n * Added property `sum_of_periodic_interest` (number)\r\n\r\n * Added property `sum_of_rentals` (number)\r\n\r\n * Added property `total_payables` (number)\r\n\r\n * Added property `running_id` (string)\r\n\r\n * Added property `broker_id` (integer)\r\n\r\n * Added property `non_vatable_amount` (number)\r\n\r\n * Added property `order_stakeholders` (array)\r\n\r\n * Added property `date_submitted` (string)\r\n\r\n * Changed property `order_fees` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `id` (integer)\r\n\r\n * Added property `fee_frequency` (string)\r\n\r\n * Added property `fee_occurance` (string)\r\n\r\n * Added property `fee_first_due_date` (string)\r\n\r\n * Changed property `assets` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `id` (integer)\r\n\r\n * Added property `identifier` (string)\r\n\r\n * Added property `rv_balloon_amount` (number)\r\n\r\n * Changed property `customer` (object)\r\n\r\n * Added property `company_name` (string)\r\n\r\n * Added property `customer_type` (string)\r\n\r\n### `GET` /dms/get-setup-data\r\n\r\n\r\n#### Parameters:\r\n\r\nAdded: `company_id` in `query`\r\n\r\nDeleted: `lender_id` in `query`\r\n\r\n### `GET` /dms/configure/disclaimer-agreement\r\n\r\n\r\n#### Parameters:\r\n\r\nAdded: `order_reference_id` in `query`\r\n\r\n### `GET` /dms/configure/workqueue/search\r\n\r\n\r\n#### Parameters:\r\n\r\nAdded: `latest_order` in `query`\r\n\r\n### `POST` /dms/quote/calculation\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Changed property `fees` (array)\r\n > Fees\r\n\r\n\r\n Changed items (object):\r\n\r\n * Added property `fee_handling` (string)\r\n\r\n * Added property `is_taxable` (boolean)\r\n\r\n * Added property `tax_in_capital` (boolean)\r\n\r\n * Added property `vendor` (string)\r\n\r\n * Deleted property `amount_handling` (string)\r\n\r\n* Changed property `fni_products` (array)\r\n > F&I Products\r\n\r\n\r\n Changed items (object):\r\n\r\n * Added property `is_taxable` (boolean)\r\n\r\n### `POST` /dms/quote/calculate-order\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Changed property `fees` (array)\r\n > Fees\r\n\r\n\r\n Changed items (object):\r\n\r\n * Added property `fee_handling` (string)\r\n\r\n * Added property `is_taxable` (boolean)\r\n\r\n * Added property `tax_in_capital` (boolean)\r\n\r\n * Added property `vendor` (string)\r\n\r\n * Deleted property `amount_handling` (string)\r\n\r\n* Changed property `fni_products` (array)\r\n > F&I Products\r\n\r\n\r\n Changed items (object):\r\n\r\n * Added property `is_taxable` (boolean)\r\n\r\n### `POST` /dms/quote/calculate-nfa\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Changed property `fees` (array)\r\n > Fees\r\n\r\n\r\n Changed items (object):\r\n\r\n * Added property `fee_handling` (string)\r\n\r\n * Added property `is_taxable` (boolean)\r\n\r\n * Added property `tax_in_capital` (boolean)\r\n\r\n * Added property `vendor` (string)\r\n\r\n * Deleted property `amount_handling` (string)\r\n\r\n* Changed property `fni_products` (array)\r\n > F&I Products\r\n\r\n\r\n Changed items (object):\r\n\r\n * Added property `is_taxable` (boolean)\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n New required properties:\r\n - `net_financed_amount`\r\n\r\n New optional properties:\r\n - `financed_amount`\r\n\r\n * Added property `net_financed_amount` (number)\r\n > Net Financed amount calculated\r\n\r\n\r\n * Deleted property `financed_amount` (integer)\r\n > Financed amount calculated\r\n\r\n\r\n### `POST` /dms/quote/calculation/V2\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\nNew required properties:\r\n- `finance_type`\r\n\r\nNew optional properties:\r\n- `base_rate`\r\n- `calculation_method`\r\n- `financed_amount`\r\n- `rental_mode`\r\n\r\n* Added property `annual_usage` (integer)\r\n > Allowed Usage\r\n\r\n\r\n* Added property `lender_id` (integer)\r\n > Lender Id\r\n\r\n\r\n* Added property `net_financed_amount` (number)\r\n > Asset Financed amount\r\n\r\n\r\n* Added property `vehicle` (object)\r\n > Vehicle\r\n\r\n\r\n * Property `vin` (string)\r\n > VIN\r\n\r\n\r\n * Property `is_new` (boolean)\r\n > Is New\r\n\r\n\r\n * Property `odometer_mileage` (integer)\r\n > Odometer\r\n\r\n\r\n * Property `msrp` (number)\r\n > MSRP\r\n\r\n\r\n * Property `year` (integer)\r\n > Year\r\n\r\n\r\n * Property `transmission_type` (string)\r\n > Transmission Type\r\n\r\n\r\n* Added property `customer_address` (object)\r\n > Customer Address\r\n\r\n\r\n * Property `street_address` (string)\r\n > Street Address\r\n\r\n\r\n * Property `city` (string)\r\n > City\r\n\r\n\r\n * Property `state` (string)\r\n > State\r\n\r\n\r\n * Property `zip_code` (string)\r\n > Zip Code\r\n\r\n\r\n* Added property `dealer_address` (object)\r\n > Dealer Address\r\n\r\n\r\n* Added property `trade_in_amount` (number)\r\n > Trade-in amount\r\n\r\n\r\n* Added property `finance_type` (string)\r\n > Finance Type\r\n\r\n\r\n* Added property `markup_rate` (number)\r\n > Markup Rate\r\n\r\n\r\n* Added property `trade_ins` (array)\r\n > Trade Ins\r\n\r\n\r\n Items (object):\r\n\r\n * Property `trade_in_type` (string)\r\n > Trade In Type\r\n\r\n\r\n * Property `vin` (string)\r\n > VIN\r\n\r\n\r\n * Property `offer_amount` (number)\r\n > Offer Amount\r\n\r\n\r\n * Property `pay_off_amount` (number)\r\n > Pay Off Amount\r\n\r\n\r\n * Property `allowance_amount` (number)\r\n > Actual Cash Value\r\n\r\n\r\n* Added property `rebate` (object)\r\n > Rebate Model\r\n\r\n\r\n * Property `name` (string)\r\n > Description of the rebate\r\n\r\n\r\n * Property `price` (number)\r\n > Price of the rebate\r\n\r\n\r\n* Added property `tax_on_selling_price` (number)\r\n > Selling Price Tax Calculation\r\n\r\n\r\n* Deleted property `financed_amount` (number)\r\n > Asset Financed amount\r\n\r\n\r\n* Changed property `fees` (array)\r\n > Fees\r\n\r\n\r\n Changed items (object):\r\n\r\n * Added property `fee_handling` (string)\r\n\r\n * Added property `is_taxable` (boolean)\r\n\r\n * Added property `tax_in_capital` (boolean)\r\n\r\n * Added property `vendor` (string)\r\n\r\n * Deleted property `amount_handling` (string)\r\n\r\n* Changed property `fni_products` (array)\r\n > F&I Products\r\n\r\n\r\n Changed items (object):\r\n\r\n * Added property `is_taxable` (boolean)\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `add_ons_total` (number)\r\n\r\n * Added property `adjusted_capitalized_cost` (number)\r\n\r\n * Added property `base_monthly_payment` (number)\r\n\r\n * Added property `tax_on_capitalized_cost_reduction` (number)\r\n\r\n * Added property `monthly_deprecation` (number)\r\n\r\n * Added property `capitalized_cost_reduction` (number)\r\n\r\n * Added property `fees_total` (number)\r\n\r\n * Added property `fni_total` (number)\r\n\r\n * Added property `fni_products` (array)\r\n\r\n Items (object):\r\n\r\n * Property `price` (number)\r\n\r\n * Property `name` (string)\r\n\r\n * Property `monthly_impact` (number)\r\n\r\n * Added property `gross_capitalized_cost` (number)\r\n\r\n * Added property `monthly_payment` (number)\r\n\r\n * Added property `monthly_sales_use_tax` (number)\r\n\r\n * Added property `rebate_promotions` (number)\r\n\r\n * Added property `tax_amount` (number)\r\n\r\n### `POST` /dms/quote/calculation/multi-assets\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\nChanged items (object):\r\n\r\n* Changed property `fees` (array)\r\n > Fees\r\n\r\n\r\n Changed items (object):\r\n\r\n * Added property `fee_handling` (string)\r\n\r\n * Added property `is_taxable` (boolean)\r\n\r\n * Added property `tax_in_capital` (boolean)\r\n\r\n * Added property `vendor` (string)\r\n\r\n * Deleted property `amount_handling` (string)\r\n\r\n* Changed property `fni_products` (array)\r\n > F&I Products\r\n\r\n\r\n Changed items (object):\r\n\r\n * Added property `is_taxable` (boolean)\r\n\r\n### `POST` /dms/quote/calculation/quantity\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Changed property `fees` (array)\r\n > Fees\r\n\r\n\r\n Changed items (object):\r\n\r\n * Added property `fee_handling` (string)\r\n\r\n * Added property `is_taxable` (boolean)\r\n\r\n * Added property `tax_in_capital` (boolean)\r\n\r\n * Added property `vendor` (string)\r\n\r\n * Deleted property `amount_handling` (string)\r\n\r\n* Changed property `fni_products` (array)\r\n > F&I Products\r\n\r\n\r\n Changed items (object):\r\n\r\n * Added property `is_taxable` (boolean)\r\n\r\n### `GET` /dms/customer/document/status\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `customer_reference_id` (string)\r\n\r\n * Added property `external_reference_id` (string)\r\n\r\n * Added property `document_type` (string)\r\n\r\n * Added property `comment` (string)\r\n\r\n * Added property `category` (string)\r\n\r\n * Added property `document_name` (string)\r\n\r\n * Added property `document_size` (string)\r\n\r\n * Added property `document_url` (string)\r\n\r\n * Added property `reason_by_system` (string)\r\n\r\n * Added property `reason_for_customer` (string)\r\n\r\n * Added property `document_status` (string)\r\n\r\n * Added property `document_upload_indicator` (boolean)\r\n\r\n * Added property `expires_at` (string)\r\n > format: YYYY-MM-DD hh:mm:ss\r\n\r\n\r\n * Added property `created_at` (string)\r\n > format: YYYY-MM-DD hh:mm:ss\r\n\r\n\r\n * Added property `updated_at` (string)\r\n > format: YYYY-MM-DD hh:mm:ss\r\n\r\n\r\n * Added property `deleted_at` (string)\r\n > format: YYYY-MM-DD hh:mm:ss\r\n\r\n\r\n * Added property `updated_by` (string)\r\n\r\n * Added property `created_by` (string)\r\n\r\n * Added property `deleted_by` (string)\r\n\r\n * Added property `uploaded_by` (string)\r\n\r\n * Added property `uploaded_at` (string)\r\n\r\n * Added property `is_deleted` (boolean)\r\n\r\n * Added property `identifier` (string)\r\n\r\n * Added property `stipulation_code` (string)\r\n\r\n * Deleted property `result` (array)\r\n\r\n * Deleted property `page_number` (integer)\r\n\r\n * Deleted property `page_size` (integer)\r\n\r\n * Deleted property `total_pages` (integer)\r\n\r\n * Deleted property `total_results` (integer)\r\n\r\n### `GET` /dms/configure/document-package/document\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `signatures` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `x_bound` (integer)\r\n\r\n * Added property `y_bound` (integer)\r\n\r\n### `POST` /dms/configure/{document_package_id}/{document_id}/{signature_id}\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `signatures` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `x_bound` (integer)\r\n\r\n * Added property `y_bound` (integer)\r\n\r\n### `POST` /dms/submit-order\r\n\r\n\r\n#### Request:\r\n\r\nNew content type : `application/json`\r\n\r\n### `GET` /dms/stipulation/stipulation-by-lender\r\n\r\n\r\n#### Parameters:\r\n\r\nAdded: `company_id` in `query`\r\n\r\nDeleted: `lender_id` in `query`\r\n\r\n### `POST` /dms/affordability-check/\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\nNew required properties:\r\n- `company_code`\r\n- `dealer_code`\r\n- `lender_code`\r\n\r\nNew optional properties:\r\n- `dealer_id`\r\n\r\n* Added property `dealer_code` (string)\r\n\r\n* Added property `company_code` (string)\r\n > Company code\r\n\r\n\r\n* Added property `lender_code` (string)\r\n\r\n* Deleted property `dealer_id` (integer)\r\n\r\n### `POST` /dms/affordability-check/monthly-payment-calculation/V2/\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\nNew required properties:\r\n- `company_id`\r\n\r\nNew optional properties:\r\n- `lender_id`\r\n\r\n* Added property `company_id` (integer)\r\n\r\n* Deleted property `lender_id` (integer)\r\n\r\n### `GET` /dms/inventory/filter\r\n\r\n\r\n#### Parameters:\r\n\r\nAdded: `vin` in `query`\r\n\r\nAdded: `mileage` in `query`\r\n\r\n### `GET` /dms/contract-term\r\n\r\n\r\n#### Parameters:\r\n\r\nAdded: `company_id` in `header`\r\n\r\nDeleted: `lender_id` in `header`\r\n\r\n### `GET` /dms/credit-ratings\r\n\r\n\r\n#### Parameters:\r\n\r\nAdded: `company_id` in `header`\r\n\r\nDeleted: `lender_id` in `header`\r\n\r\n### `GET` /dms/contract-allowed-annum-mileage\r\n\r\n\r\n#### Parameters:\r\n\r\nAdded: `company_id` in `header`\r\n\r\nDeleted: `lender_id` in `header`\r\n\r\n### `GET` /dms/asset-usage/active\r\n\r\n\r\n#### Parameters:\r\n\r\nAdded: `company_id` in `header`\r\n\r\nDeleted: `lender_id` in `header`\r\n\r\n### `POST` /dms/programs/all/\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Added property `dealer_code` (string)\r\n > Dealer Code\r\n\r\n\r\n* Added property `lender_code` (string)\r\n > Lender Code\r\n\r\n\r\n* Added property `company_code` (string)\r\n > Company Code\r\n\r\n\r\n* Added property `customer_type` (string)\r\n > Customer Type for Chart\r\n\r\n\r\n* Added property `product_type` (string)\r\n > Product Type For Chart\r\n\r\n\r\n* Added property `asset_category` (string)\r\n > Asset Category For Chart\r\n\r\n\r\n* Added property `asset_type` (string)\r\n > Asset Type For Chart\r\n\r\n\r\n* Added property `business_trading_age` (string)\r\n > Business Trading Age For Chart\r\n\r\n\r\n* Added property `model_code` (string)\r\n > Model Code\r\n\r\n\r\n* Added property `asset_condition` (string)\r\n > Asset Condition\r\n\r\n\r\n* Added property `asset_classification` (string)\r\n > Asset Classification (e.g. Vehicle, Equipment etc.)\r\n\r\n\r\n* Added property `is_rv_guaranteed` (string)\r\n > Is RV Guaranteed\r\n\r\n\r\n* Added property `financed_amount` (string)\r\n > Financed Amount\r\n\r\n\r\n* Added property `vin` (string)\r\n > Vin Number\r\n\r\n\r\n* Added property `odometer` (integer)\r\n > Odometer\r\n\r\n\r\n* Added property `selling_price` (integer)\r\n > Selling Price\r\n\r\n\r\n* Added property `msrp` (integer)\r\n > MSRF\r\n\r\n\r\n* Added property `is_new` (boolean)\r\n > Is it new\r\n\r\n\r\n* Added property `total_score` (integer)\r\n > Total Score\r\n\r\n\r\n* Added property `is_payment_estimator` (boolean)\r\n > Is Payment Estimator\r\n\r\n\r\n* Added property `tier` (string)\r\n > tier\r\n\r\n\r\n* Deleted property `dealer_id` (integer)\r\n > System Generated Dealer Id\r\n\r\n\r\n* Deleted property `asset_make_id` (integer)\r\n > System Generated Asset Make Id\r\n\r\n\r\n* Deleted property `asset_model_id` (integer)\r\n > System Generated Asset Model Id\r\n\r\n\r\n* Deleted property `asset_model_detail_id` (integer)\r\n > System Generated Asset Trim Id\r\n\r\n\r\n### `POST` /dms/get_event_associated_checklist/\r\n\r\n> This API helps to evaluate given criteria and retrieve configured checklist(s)\r\n\r\n\r\n### `GET` /dms/dealer/all-dealer-distance\r\n\r\n\r\n#### Parameters:\r\n\r\nAdded: `company_id` in `query`\r\n\r\nDeleted: `lender_id` in `query`\r\n\r\nChanged: `zip_code` in `query`\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `result` (array)\r\n\r\n Changed items (object):\r\n\r\n * Changed property `dealer_zip_code` (integer -> string)\r\n > Dealer Zip Code\r\n\r\n\r\n### `POST` /dms/customer/\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Added property `customer_license` (array)\r\n\r\n Items (object):\r\n\r\n * Property `first_name` (string)\r\n > First name\r\n\r\n\r\n * Property `last_name` (string)\r\n > Last name\r\n\r\n\r\n * Property `date_of_birth` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n * Property `is_pdf_417` (boolean)\r\n\r\n * Property `license_number` (string)\r\n > license number\r\n\r\n\r\n * Property `issue_date` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n * Property `expiry_date` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n * Property `front_image` (string)\r\n > license front image\r\n\r\n\r\n * Property `back_image` (string)\r\n > license back image\r\n\r\n\r\n * Property `status` (string)\r\n\r\n * Property `call_type` (string)\r\n > An enumeration.\r\n\r\n\r\n Enum values:\r\n\r\n * `manual`\r\n * `auto`\r\n * Property `selfie_image` (string)\r\n\r\n * Property `cropped_front_image` (string)\r\n\r\n * Property `cropped_back_image` (string)\r\n\r\n * Property `cropped_selfie_image` (string)\r\n\r\n * Property `is_selfie_verified` (boolean)\r\n\r\n * Property `created_by` (string)\r\n\r\n * Property `reference_id` (string)\r\n\r\n * Property `identifier` (string)\r\n\r\n * Property `mitek_response` (string)\r\n\r\n * Property `address` (object)\r\n\r\n * Property `address_line_1` (string)\r\n > Address line one\r\n\r\n\r\n * Property `address_line_2` (string)\r\n > Address line two\r\n\r\n\r\n * Property `state_name` (string)\r\n > Address state name\r\n\r\n\r\n * Property `zip_code` (string)\r\n > Zip code\r\n\r\n\r\n * Property `county` (string)\r\n > Address county\r\n\r\n\r\n * Property `city` (string)\r\n > Address city\r\n\r\n\r\n * Property `contact_number` (string)\r\n > Contact number\r\n\r\n\r\n * Property `verified` (boolean)\r\n > Is Address verified\r\n\r\n\r\n * Property `move_in_date` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n * Property `is_garaging` (boolean)\r\n > Garaging flag\r\n\r\n\r\n * Property `identifier` (string)\r\n\r\n* Added property `customer_insurance` (array)\r\n\r\n Items (object):\r\n\r\n * Property `order_reference_id` (string)\r\n\r\n * Property `reference_id` (string)\r\n\r\n * Property `insurer_name` (string)\r\n\r\n * Property `agent_phone` (string)\r\n\r\n * Property `subscription_id` (string)\r\n\r\n * Property `agent_name` (string)\r\n\r\n * Property `policy_number` (string)\r\n\r\n * Property `start_date` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n * Property `expiration_date` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n * Property `deductible_comprehensive` (number)\r\n\r\n * Property `deductible_collision` (number)\r\n\r\n * Property `created_by` (string)\r\n\r\n * Property `identifier` (string)\r\n\r\n * Property `is_verified` (boolean)\r\n\r\n * Property `insurance_documents` (array)\r\n\r\n * Property `insurer_address` (object)\r\n\r\n* Changed property `customer_profile` (object)\r\n\r\n * Added property `preferred_contact` (string)\r\n\r\n * Added property `external_id` (string)\r\n\r\n#### Return Type:\r\n\r\nChanged response : **201 Created**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `preferred_contact` (string)\r\n\r\n * Added property `external_id` (string)\r\n\r\n### `GET` /dms/customer/customer-history\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n Changed items (object):\r\n\r\n * Added property `preferred_contact` (string)\r\n\r\n * Added property `external_id` (string)\r\n\r\n### `GET` /dms/customer\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `preferred_contact` (string)\r\n\r\n * Added property `external_id` (string)\r\n\r\n### `PATCH` /dms/customer\r\n\r\n\r\n#### Parameters:\r\n\r\nAdded: `dealer_code` in `query`\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Changed property `customer_profile` (object)\r\n\r\n * Added property `preferred_contact` (string)\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `preferred_contact` (string)\r\n\r\n * Added property `external_id` (string)\r\n\r\n### `GET` /dms/customer-by-email\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `preferred_contact` (string)\r\n\r\n * Added property `external_id` (string)\r\n\r\n### `POST` /dms/customer/employment-info\r\n\r\n\r\n#### Parameters:\r\n\r\nAdded: `dealer_code` in `query`\r\n\r\n### `PATCH` /dms/customer/employment-info\r\n\r\n\r\n#### Parameters:\r\n\r\nAdded: `dealer_code` in `query`\r\n\r\n### `PATCH` /dms/order/quick_quotation\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Added property `name` (string)\r\n\r\n* Added property `identifier` (string)\r\n\r\n* Added property `start_date` (string)\r\n\r\n* Added property `end_date` (string)\r\n\r\n* Added property `customer_reference_id` (string)\r\n\r\n* Added property `external_order_id` (string)\r\n\r\n* Added property `created_by` (string)\r\n\r\n* Added property `selling_price` (number)\r\n\r\n* Added property `down_payment` (number)\r\n\r\n* Added property `estimated_monthly_payment` (number)\r\n\r\n* Added property `sum_of_advance_rentals` (number)\r\n\r\n* Added property `calculations_type` (string)\r\n\r\n* Added property `no_of_advance_payments` (integer)\r\n\r\n* Added property `no_of_regular_payments` (integer)\r\n\r\n* Added property `introducer_identifier` (string)\r\n\r\n* Added property `introducer_name` (string)\r\n\r\n* Added property `rental_frequency` (string)\r\n\r\n* Added property `deferral_amount` (number)\r\n\r\n* Added property `rv_balloon_value` (number)\r\n\r\n* Added property `balloon_collection` (string)\r\n\r\n* Added property `finance_type` (string)\r\n\r\n* Added property `product_type` (string)\r\n\r\n* Added property `program_type` (string)\r\n\r\n* Added property `finance_amount` (number)\r\n\r\n* Added property `gross_profit` (number)\r\n\r\n* Added property `commission_amount` (number)\r\n\r\n* Added property `due_at_signing` (number)\r\n\r\n* Added property `meta_data` (object)\r\n\r\n* Added property `comments` (string)\r\n\r\n* Added property `broker_id` (string)\r\n\r\n* Added property `vat_treatment` (string)\r\n\r\n* Added property `tax_amount` (number)\r\n\r\n* Added property `tax_amount_number` (integer)\r\n\r\n* Added property `deferred_type` (string)\r\n\r\n* Added property `reference_number` (string)\r\n\r\n* Added property `rental_mode` (string)\r\n\r\n* Added property `rate_type` (string)\r\n\r\n* Added property `margin` (number)\r\n\r\n* Added property `commission_type` (string)\r\n\r\n* Added property `sum_of_fees` (number)\r\n\r\n* Added property `sum_of_periodic_interest` (number)\r\n\r\n* Added property `sum_of_rentals` (number)\r\n\r\n* Added property `total_payables` (number)\r\n\r\n* Added property `running_id` (string)\r\n\r\n* Added property `non_vatable_amount` (number)\r\n\r\n* Added property `order_fees` (array)\r\n\r\n Items (object):\r\n\r\n * Property `id` (integer)\r\n\r\n * Property `identifier` (string)\r\n\r\n * Property `dealer_fee_name` (string)\r\n\r\n * Property `applied_price` (number)\r\n\r\n * Property `order_id` (integer)\r\n\r\n * Property `fee_frequency` (string)\r\n\r\n * Property `fee_occurance` (string)\r\n\r\n * Property `fee_first_due_date` (string)\r\n\r\n* Added property `order_payments` (array)\r\n\r\n Items (object):\r\n\r\n * Property `identifier` (string)\r\n\r\n * Property `payment_number_from` (integer)\r\n\r\n * Property `payment_number_to` (integer)\r\n\r\n * Property `amount` (number)\r\n\r\n * Property `payment_type` (string)\r\n\r\n * Property `order_id` (integer)\r\n\r\n* Added property `customer` (object)\r\n\r\n * Property `company_name` (string)\r\n\r\n * Property `first_name` (string)\r\n\r\n * Property `last_name` (string)\r\n\r\n * Property `mobile_number` (string)\r\n\r\n * Property `customer_type` (string)\r\n\r\n * Property `identifier` (string)\r\n\r\n * Property `email` (string)\r\n\r\n * Property `reference_id` (string)\r\n\r\n* Changed property `dealer_id` (integer -> string)\r\n\r\n* Changed property `assets` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `id` (integer)\r\n\r\n * Added property `identifier` (string)\r\n\r\n * Added property `rv_balloon_amount` (number)\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `name` (string)\r\n\r\n * Added property `end_date` (string)\r\n\r\n * Added property `updated_at` (string)\r\n\r\n * Added property `estimated_monthly_payment` (string)\r\n\r\n * Added property `calculations_type` (string)\r\n\r\n * Added property `sum_of_advance_rentals` (number)\r\n\r\n * Added property `balloon_collection` (string)\r\n\r\n * Added property `product_type` (string)\r\n\r\n * Added property `commission_type` (string)\r\n\r\n * Added property `tax_amount` (number)\r\n\r\n * Added property `tax_amount_number` (integer)\r\n\r\n * Added property `deferred_type` (string)\r\n\r\n * Added property `rate_type` (string)\r\n\r\n * Added property `margin` (number)\r\n\r\n * Added property `rental_mode` (string)\r\n\r\n * Added property `sum_of_fees` (number)\r\n\r\n * Added property `sum_of_periodic_interest` (number)\r\n\r\n * Added property `sum_of_rentals` (number)\r\n\r\n * Added property `total_payables` (number)\r\n\r\n * Added property `running_id` (string)\r\n\r\n * Added property `broker_id` (integer)\r\n\r\n * Added property `non_vatable_amount` (number)\r\n\r\n * Added property `order_stakeholders` (array)\r\n\r\n * Added property `date_submitted` (string)\r\n\r\n * Changed property `order_fees` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `id` (integer)\r\n\r\n * Added property `fee_frequency` (string)\r\n\r\n * Added property `fee_occurance` (string)\r\n\r\n * Added property `fee_first_due_date` (string)\r\n\r\n * Changed property `assets` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `id` (integer)\r\n\r\n * Added property `identifier` (string)\r\n\r\n * Added property `rv_balloon_amount` (number)\r\n\r\n * Changed property `customer` (object)\r\n\r\n * Added property `company_name` (string)\r\n\r\n * Added property `customer_type` (string)\r\n\r\n### `POST` /dms/order/quick_quotation\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Changed property `quote_identifiers` (object)\r\n\r\n * Added property `company_name` (string)\r\n\r\n * Added property `customer_type` (string)\r\n\r\n* Changed property `quote_details` (object)\r\n\r\n * Added property `name` (string)\r\n\r\n * Added property `end_date` (string)\r\n\r\n * Added property `estimated_monthly_payment` (number)\r\n\r\n * Added property `sum_of_advance_rentals` (number)\r\n\r\n * Added property `calculations_type` (string)\r\n\r\n * Added property `balloon_collection` (string)\r\n\r\n * Added property `product_type` (string)\r\n\r\n * Added property `program_type` (string)\r\n\r\n * Added property `broker_id` (string)\r\n\r\n * Added property `tax_amount` (number)\r\n\r\n * Added property `tax_amount_number` (integer)\r\n\r\n * Added property `deferred_type` (string)\r\n\r\n * Added property `rental_mode` (string)\r\n\r\n * Added property `rate_type` (string)\r\n\r\n * Added property `margin` (number)\r\n\r\n * Added property `commission_type` (string)\r\n\r\n * Added property `sum_of_fees` (number)\r\n\r\n * Added property `sum_of_periodic_interest` (number)\r\n\r\n * Added property `sum_of_rentals` (number)\r\n\r\n * Added property `total_payables` (number)\r\n\r\n * Added property `running_id` (string)\r\n\r\n * Added property `non_vatable_amount` (number)\r\n\r\n * Changed property `order_fees` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `id` (integer)\r\n\r\n * Added property `fee_frequency` (string)\r\n\r\n * Added property `fee_occurance` (string)\r\n\r\n * Added property `fee_first_due_date` (string)\r\n\r\n * Changed property `assets` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `id` (integer)\r\n\r\n * Added property `identifier` (string)\r\n\r\n * Added property `rv_balloon_amount` (number)\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `name` (string)\r\n\r\n * Added property `end_date` (string)\r\n\r\n * Added property `updated_at` (string)\r\n\r\n * Added property `estimated_monthly_payment` (string)\r\n\r\n * Added property `calculations_type` (string)\r\n\r\n * Added property `sum_of_advance_rentals` (number)\r\n\r\n * Added property `balloon_collection` (string)\r\n\r\n * Added property `product_type` (string)\r\n\r\n * Added property `commission_type` (string)\r\n\r\n * Added property `tax_amount` (number)\r\n\r\n * Added property `tax_amount_number` (integer)\r\n\r\n * Added property `deferred_type` (string)\r\n\r\n * Added property `rate_type` (string)\r\n\r\n * Added property `margin` (number)\r\n\r\n * Added property `rental_mode` (string)\r\n\r\n * Added property `sum_of_fees` (number)\r\n\r\n * Added property `sum_of_periodic_interest` (number)\r\n\r\n * Added property `sum_of_rentals` (number)\r\n\r\n * Added property `total_payables` (number)\r\n\r\n * Added property `running_id` (string)\r\n\r\n * Added property `broker_id` (integer)\r\n\r\n * Added property `non_vatable_amount` (number)\r\n\r\n * Added property `order_stakeholders` (array)\r\n\r\n * Added property `date_submitted` (string)\r\n\r\n * Changed property `order_fees` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `id` (integer)\r\n\r\n * Added property `fee_frequency` (string)\r\n\r\n * Added property `fee_occurance` (string)\r\n\r\n * Added property `fee_first_due_date` (string)\r\n\r\n * Changed property `assets` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `id` (integer)\r\n\r\n * Added property `identifier` (string)\r\n\r\n * Added property `rv_balloon_amount` (number)\r\n\r\n * Changed property `customer` (object)\r\n\r\n * Added property `company_name` (string)\r\n\r\n * Added property `customer_type` (string)\r\n\r\n### `POST` /dms/configure/appointment\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\nNew optional properties:\r\n- `customer_id`\r\n\r\n* Added property `time_zone` (string)\r\n\r\n### `PATCH` /dms/configure/appointment\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\nNew optional properties:\r\n- `customer_id`\r\n\r\n* Added property `time_zone` (string)\r\n\r\n### `GET` /dms/configure/document-package\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `documents` (array)\r\n\r\n Changed items (object):\r\n\r\n * Changed property `signatures` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `x_bound` (integer)\r\n\r\n * Added property `y_bound` (integer)\r\n\r\n### `POST` /dms/configure/document-package\r\n\r\n\r\n#### Parameters:\r\n\r\nAdded: `is_product` in `query`\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Changed property `documents` (array)\r\n\r\n Changed items (object):\r\n\r\n * Changed property `signatures` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `x_bound` (integer)\r\n\r\n * Added property `y_bound` (integer)\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `documents` (array)\r\n\r\n Changed items (object):\r\n\r\n * Changed property `signatures` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `x_bound` (integer)\r\n\r\n * Added property `y_bound` (integer)\r\n\r\n### `GET` /dms/configure/document-package-by-reference-id\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `documents` (array)\r\n\r\n Changed items (object):\r\n\r\n * Changed property `signatures` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `x_bound` (integer)\r\n\r\n * Added property `y_bound` (integer)\r\n\r\n### `GET` /dms/configure/all-document-packages-by-reference-id\r\n\r\n\r\n#### Parameters:\r\n\r\nChanged: `document_type` in `query`\r\n> Document Type\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n Changed items (object):\r\n\r\n * Changed property `documents` (array)\r\n\r\n Changed items (object):\r\n\r\n * Changed property `signatures` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `x_bound` (integer)\r\n\r\n * Added property `y_bound` (integer)\r\n\r\n### `GET` /dms/customer/all-customers\r\n\r\n\r\n#### Parameters:\r\n\r\nChanged: `sort_by` in `query`\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `result` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `preferred_contact` (string)\r\n\r\n * Added property `external_id` (string)\r\n\r\n### `GET` /dms/configure/quotation\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n New optional properties:\r\n - `allowed_usage`\r\n - `annual_usage`\r\n - `apr`\r\n - `contract_term`\r\n - `credit_rating`\r\n - `customer_id`\r\n - `dealer_id`\r\n - `down_payment`\r\n - `down_payment_lease`\r\n - `due_at_signing`\r\n - `estimated_monthly_payment`\r\n - `lender_id`\r\n - `rv_balloon_percentage`\r\n - `rv_balloon_value`\r\n - `selling_price`\r\n - `vehicle_id`\r\n\r\n * Added property `broker_id` (integer)\r\n\r\n * Added property `company_id` (integer)\r\n\r\n * Added property `name` (string)\r\n\r\n * Added property `is_payment_updated` (boolean)\r\n\r\n * Added property `tax_amount` (number)\r\n\r\n * Added property `tax_amount_number` (number)\r\n\r\n * Added property `deferred_type` (string)\r\n\r\n * Added property `balloon_collection` (string)\r\n\r\n * Added property `rate_type` (string)\r\n\r\n * Added property `commission_type` (string)\r\n\r\n * Added property `running_id` (string)\r\n\r\n * Added property `order_currency` (string)\r\n\r\n * Added property `commission_amount` (number)\r\n\r\n * Added property `received_security_deposit` (integer)\r\n\r\n * Added property `net_finance_amount` (number)\r\n\r\n * Added property `rebate` (number)\r\n\r\n * Added property `capitalized_cost_reduction` (number)\r\n\r\n * Added property `monthly_deprecation` (number)\r\n\r\n * Added property `tax_on_capitalized_cost_reduction` (number)\r\n\r\n * Added property `monthly_sales_use_tax` (number)\r\n\r\n * Added property `sum_of_fees` (number)\r\n\r\n * Added property `sum_of_periodic_interest` (number)\r\n\r\n * Added property `sum_of_rentals` (number)\r\n\r\n * Added property `total_payables` (number)\r\n\r\n * Added property `non_vatable_amount` (number)\r\n\r\n * Added property `individualized_agreement` (string)\r\n\r\n * Added property `base_residual_type` (integer)\r\n\r\n * Added property `excess_mileage_rate` (number)\r\n\r\n * Added property `asset_rv_amount` (number)\r\n\r\n * Changed property `order_fnI` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `mileage` (integer)\r\n\r\n * Added property `term` (integer)\r\n\r\n * Added property `is_msp` (boolean)\r\n\r\n * Changed property `order_fees` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `vendor` (string)\r\n\r\n * Added property `fee_type` (string)\r\n\r\n * Changed property `order_asset` (object)\r\n\r\n * Added property `mileage` (integer)\r\n\r\n * Added property `asset_type` (string)\r\n\r\n * Added property `rv_balloon_amount` (number)\r\n\r\n * Deleted property `milage` (boolean)\r\n\r\n * Changed property `order_tradein` (object)\r\n\r\n * Added property `trade_in_type` (string)\r\n > An enumeration.\r\n\r\n\r\n Enum values:\r\n\r\n * `Manual Estimate`\r\n * `Make Model`\r\n * `Vin`\r\n * `License Plate`\r\n * Added property `question_answers` (array)\r\n\r\n Items (object):\r\n\r\n * Property `question` (string)\r\n\r\n * Property `answer` (string)\r\n\r\n * Property `trade_in_id` (integer)\r\n\r\n * Changed property `appointment_details` (object)\r\n\r\n * Added property `time_zone` (string)\r\n\r\n### `GET` /dms/configure/all-quotations\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n Changed items (object):\r\n\r\n New optional properties:\r\n - `allowed_usage`\r\n - `annual_usage`\r\n - `apr`\r\n - `contract_term`\r\n - `credit_rating`\r\n - `customer_id`\r\n - `dealer_id`\r\n - `down_payment`\r\n - `down_payment_lease`\r\n - `due_at_signing`\r\n - `estimated_monthly_payment`\r\n - `lender_id`\r\n - `rv_balloon_percentage`\r\n - `rv_balloon_value`\r\n - `selling_price`\r\n - `vehicle_id`\r\n\r\n * Added property `broker_id` (integer)\r\n\r\n * Added property `company_id` (integer)\r\n\r\n * Added property `name` (string)\r\n\r\n * Added property `is_payment_updated` (boolean)\r\n\r\n * Added property `tax_amount` (number)\r\n\r\n * Added property `tax_amount_number` (number)\r\n\r\n * Added property `deferred_type` (string)\r\n\r\n * Added property `balloon_collection` (string)\r\n\r\n * Added property `rate_type` (string)\r\n\r\n * Added property `commission_type` (string)\r\n\r\n * Added property `running_id` (string)\r\n\r\n * Added property `order_currency` (string)\r\n\r\n * Added property `commission_amount` (number)\r\n\r\n * Added property `received_security_deposit` (integer)\r\n\r\n * Added property `net_finance_amount` (number)\r\n\r\n * Added property `rebate` (number)\r\n\r\n * Added property `capitalized_cost_reduction` (number)\r\n\r\n * Added property `monthly_deprecation` (number)\r\n\r\n * Added property `tax_on_capitalized_cost_reduction` (number)\r\n\r\n * Added property `monthly_sales_use_tax` (number)\r\n\r\n * Added property `sum_of_fees` (number)\r\n\r\n * Added property `sum_of_periodic_interest` (number)\r\n\r\n * Added property `sum_of_rentals` (number)\r\n\r\n * Added property `total_payables` (number)\r\n\r\n * Added property `non_vatable_amount` (number)\r\n\r\n * Added property `individualized_agreement` (string)\r\n\r\n * Added property `base_residual_type` (integer)\r\n\r\n * Added property `excess_mileage_rate` (number)\r\n\r\n * Added property `asset_rv_amount` (number)\r\n\r\n * Changed property `order_fnI` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `mileage` (integer)\r\n\r\n * Added property `term` (integer)\r\n\r\n * Added property `is_msp` (boolean)\r\n\r\n * Changed property `order_fees` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `vendor` (string)\r\n\r\n * Added property `fee_type` (string)\r\n\r\n * Changed property `order_asset` (object)\r\n\r\n * Added property `mileage` (integer)\r\n\r\n * Added property `asset_type` (string)\r\n\r\n * Added property `rv_balloon_amount` (number)\r\n\r\n * Deleted property `milage` (boolean)\r\n\r\n * Changed property `order_tradein` (object)\r\n\r\n * Added property `trade_in_type` (string)\r\n > An enumeration.\r\n\r\n\r\n * Added property `question_answers` (array)\r\n\r\n * Changed property `appointment_details` (object)\r\n\r\n * Added property `time_zone` (string)\r\n\r\n### `PATCH` /dms/configure/quotation/{identifier}\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\nNew optional properties:\r\n- `allowed_usage`\r\n- `annual_usage`\r\n- `apr`\r\n- `contract_term`\r\n- `credit_rating`\r\n- `dealer_id`\r\n- `down_payment`\r\n- `down_payment_lease`\r\n- `due_at_signing`\r\n- `estimated_monthly_payment`\r\n- `lender_id`\r\n- `rv_balloon_percentage`\r\n- `rv_balloon_value`\r\n- `selling_price`\r\n- `vehicle_id`\r\n\r\n* Added property `broker_id` (integer)\r\n\r\n* Added property `company_id` (integer)\r\n\r\n* Added property `name` (string)\r\n\r\n* Added property `is_payment_updated` (boolean)\r\n\r\n* Added property `tax_amount` (number)\r\n\r\n* Added property `tax_amount_number` (number)\r\n\r\n* Added property `deferred_type` (string)\r\n\r\n* Added property `balloon_collection` (string)\r\n\r\n* Added property `rate_type` (string)\r\n\r\n* Added property `commission_type` (string)\r\n\r\n* Added property `running_id` (string)\r\n\r\n* Added property `order_currency` (string)\r\n\r\n* Added property `commission_amount` (number)\r\n\r\n* Added property `received_security_deposit` (integer)\r\n\r\n* Added property `net_finance_amount` (number)\r\n\r\n* Added property `rebate` (number)\r\n\r\n* Added property `capitalized_cost_reduction` (number)\r\n\r\n* Added property `monthly_deprecation` (number)\r\n\r\n* Added property `tax_on_capitalized_cost_reduction` (number)\r\n\r\n* Added property `monthly_sales_use_tax` (number)\r\n\r\n* Added property `sum_of_fees` (number)\r\n\r\n* Added property `sum_of_periodic_interest` (number)\r\n\r\n* Added property `sum_of_rentals` (number)\r\n\r\n* Added property `total_payables` (number)\r\n\r\n* Added property `non_vatable_amount` (number)\r\n\r\n* Added property `individualized_agreement` (string)\r\n\r\n* Added property `base_residual_type` (integer)\r\n\r\n* Added property `excess_mileage_rate` (number)\r\n\r\n* Added property `asset_rv_amount` (number)\r\n\r\n* Changed property `order_fnI` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `mileage` (integer)\r\n\r\n * Added property `term` (integer)\r\n\r\n * Added property `is_msp` (boolean)\r\n\r\n* Changed property `order_fees` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `vendor` (string)\r\n\r\n * Added property `fee_type` (string)\r\n\r\n* Changed property `order_asset` (object)\r\n\r\n * Added property `mileage` (integer)\r\n\r\n * Added property `asset_type` (string)\r\n\r\n * Added property `rv_balloon_amount` (number)\r\n\r\n * Deleted property `milage` (boolean)\r\n\r\n* Changed property `order_tradein` (object)\r\n\r\n * Added property `trade_in_type` (string)\r\n > An enumeration.\r\n\r\n\r\n * Added property `question_answers` (array)\r\n\r\n* Changed property `appointment_details` (object)\r\n\r\n * Added property `time_zone` (string)\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n New optional properties:\r\n - `allowed_usage`\r\n - `annual_usage`\r\n - `apr`\r\n - `contract_term`\r\n - `credit_rating`\r\n - `dealer_id`\r\n - `down_payment`\r\n - `down_payment_lease`\r\n - `due_at_signing`\r\n - `estimated_monthly_payment`\r\n - `lender_id`\r\n - `rv_balloon_percentage`\r\n - `rv_balloon_value`\r\n - `selling_price`\r\n - `vehicle_id`\r\n\r\n * Added property `broker_id` (integer)\r\n\r\n * Added property `company_id` (integer)\r\n\r\n * Added property `name` (string)\r\n\r\n * Added property `is_payment_updated` (boolean)\r\n\r\n * Added property `tax_amount` (number)\r\n\r\n * Added property `tax_amount_number` (number)\r\n\r\n * Added property `deferred_type` (string)\r\n\r\n * Added property `balloon_collection` (string)\r\n\r\n * Added property `rate_type` (string)\r\n\r\n * Added property `commission_type` (string)\r\n\r\n * Added property `running_id` (string)\r\n\r\n * Added property `order_currency` (string)\r\n\r\n * Added property `commission_amount` (number)\r\n\r\n * Added property `received_security_deposit` (integer)\r\n\r\n * Added property `net_finance_amount` (number)\r\n\r\n * Added property `rebate` (number)\r\n\r\n * Added property `capitalized_cost_reduction` (number)\r\n\r\n * Added property `monthly_deprecation` (number)\r\n\r\n * Added property `tax_on_capitalized_cost_reduction` (number)\r\n\r\n * Added property `monthly_sales_use_tax` (number)\r\n\r\n * Added property `sum_of_fees` (number)\r\n\r\n * Added property `sum_of_periodic_interest` (number)\r\n\r\n * Added property `sum_of_rentals` (number)\r\n\r\n * Added property `total_payables` (number)\r\n\r\n * Added property `non_vatable_amount` (number)\r\n\r\n * Added property `individualized_agreement` (string)\r\n\r\n * Added property `base_residual_type` (integer)\r\n\r\n * Added property `excess_mileage_rate` (number)\r\n\r\n * Added property `asset_rv_amount` (number)\r\n\r\n * Added property `changeVehicleStatus` (boolean)\r\n\r\n * Changed property `order_fnI` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `mileage` (integer)\r\n\r\n * Added property `term` (integer)\r\n\r\n * Added property `is_msp` (boolean)\r\n\r\n * Changed property `order_fees` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `vendor` (string)\r\n\r\n * Added property `fee_type` (string)\r\n\r\n * Changed property `order_asset` (object)\r\n\r\n * Added property `mileage` (integer)\r\n\r\n * Added property `asset_type` (string)\r\n\r\n * Added property `rv_balloon_amount` (number)\r\n\r\n * Deleted property `milage` (boolean)\r\n\r\n * Changed property `order_tradein` (object)\r\n\r\n * Added property `trade_in_type` (string)\r\n > An enumeration.\r\n\r\n\r\n * Added property `question_answers` (array)\r\n\r\n * Changed property `appointment_details` (object)\r\n\r\n * Added property `time_zone` (string)\r\n\r\n### `POST` /dms/configure/save-quotation\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\nChanged items (object):\r\n\r\nNew optional properties:\r\n- `allowed_usage`\r\n- `annual_usage`\r\n- `apr`\r\n- `contract_term`\r\n- `credit_rating`\r\n- `dealer_id`\r\n- `down_payment`\r\n- `down_payment_lease`\r\n- `due_at_signing`\r\n- `estimated_monthly_payment`\r\n- `lender_id`\r\n- `rv_balloon_percentage`\r\n- `rv_balloon_value`\r\n- `selling_price`\r\n- `vehicle_id`\r\n\r\n* Added property `broker_id` (integer)\r\n\r\n* Added property `company_id` (integer)\r\n\r\n* Added property `name` (string)\r\n\r\n* Added property `is_payment_updated` (boolean)\r\n\r\n* Added property `tax_amount` (number)\r\n\r\n* Added property `tax_amount_number` (number)\r\n\r\n* Added property `deferred_type` (string)\r\n\r\n* Added property `balloon_collection` (string)\r\n\r\n* Added property `rate_type` (string)\r\n\r\n* Added property `commission_type` (string)\r\n\r\n* Added property `running_id` (string)\r\n\r\n* Added property `order_currency` (string)\r\n\r\n* Added property `commission_amount` (number)\r\n\r\n* Added property `received_security_deposit` (integer)\r\n\r\n* Added property `net_finance_amount` (number)\r\n\r\n* Added property `rebate` (number)\r\n\r\n* Added property `capitalized_cost_reduction` (number)\r\n\r\n* Added property `monthly_deprecation` (number)\r\n\r\n* Added property `tax_on_capitalized_cost_reduction` (number)\r\n\r\n* Added property `monthly_sales_use_tax` (number)\r\n\r\n* Added property `sum_of_fees` (number)\r\n\r\n* Added property `sum_of_periodic_interest` (number)\r\n\r\n* Added property `sum_of_rentals` (number)\r\n\r\n* Added property `total_payables` (number)\r\n\r\n* Added property `non_vatable_amount` (number)\r\n\r\n* Added property `individualized_agreement` (string)\r\n\r\n* Added property `base_residual_type` (integer)\r\n\r\n* Added property `excess_mileage_rate` (number)\r\n\r\n* Added property `asset_rv_amount` (number)\r\n\r\n* Added property `is_payment_estimator` (boolean)\r\n\r\n* Changed property `order_fnI` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `mileage` (integer)\r\n\r\n * Added property `term` (integer)\r\n\r\n * Added property `is_msp` (boolean)\r\n\r\n* Changed property `order_fees` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `vendor` (string)\r\n\r\n * Added property `fee_type` (string)\r\n\r\n* Changed property `order_asset` (object)\r\n\r\n * Added property `mileage` (integer)\r\n\r\n * Added property `asset_type` (string)\r\n\r\n * Added property `rv_balloon_amount` (number)\r\n\r\n * Deleted property `milage` (boolean)\r\n\r\n* Changed property `order_tradein` (object)\r\n\r\n * Added property `trade_in_type` (string)\r\n > An enumeration.\r\n\r\n\r\n * Added property `question_answers` (array)\r\n\r\n* Changed property `appointment_details` (object)\r\n\r\n * Added property `time_zone` (string)\r\n\r\n#### Return Type:\r\n\r\nChanged response : **201 Created**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n Changed items (object):\r\n\r\n New optional properties:\r\n - `allowed_usage`\r\n - `annual_usage`\r\n - `apr`\r\n - `contract_term`\r\n - `credit_rating`\r\n - `customer_id`\r\n - `dealer_id`\r\n - `down_payment`\r\n - `down_payment_lease`\r\n - `due_at_signing`\r\n - `estimated_monthly_payment`\r\n - `lender_id`\r\n - `rv_balloon_percentage`\r\n - `rv_balloon_value`\r\n - `selling_price`\r\n - `vehicle_id`\r\n\r\n * Added property `broker_id` (integer)\r\n\r\n * Added property `company_id` (integer)\r\n\r\n * Added property `name` (string)\r\n\r\n * Added property `is_payment_updated` (boolean)\r\n\r\n * Added property `tax_amount` (number)\r\n\r\n * Added property `tax_amount_number` (number)\r\n\r\n * Added property `deferred_type` (string)\r\n\r\n * Added property `balloon_collection` (string)\r\n\r\n * Added property `rate_type` (string)\r\n\r\n * Added property `commission_type` (string)\r\n\r\n * Added property `running_id` (string)\r\n\r\n * Added property `order_currency` (string)\r\n\r\n * Added property `commission_amount` (number)\r\n\r\n * Added property `received_security_deposit` (integer)\r\n\r\n * Added property `net_finance_amount` (number)\r\n\r\n * Added property `rebate` (number)\r\n\r\n * Added property `capitalized_cost_reduction` (number)\r\n\r\n * Added property `monthly_deprecation` (number)\r\n\r\n * Added property `tax_on_capitalized_cost_reduction` (number)\r\n\r\n * Added property `monthly_sales_use_tax` (number)\r\n\r\n * Added property `sum_of_fees` (number)\r\n\r\n * Added property `sum_of_periodic_interest` (number)\r\n\r\n * Added property `sum_of_rentals` (number)\r\n\r\n * Added property `total_payables` (number)\r\n\r\n * Added property `non_vatable_amount` (number)\r\n\r\n * Added property `individualized_agreement` (string)\r\n\r\n * Added property `base_residual_type` (integer)\r\n\r\n * Added property `excess_mileage_rate` (number)\r\n\r\n * Added property `asset_rv_amount` (number)\r\n\r\n * Changed property `order_fnI` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `mileage` (integer)\r\n\r\n * Added property `term` (integer)\r\n\r\n * Added property `is_msp` (boolean)\r\n\r\n * Changed property `order_fees` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `vendor` (string)\r\n\r\n * Added property `fee_type` (string)\r\n\r\n * Changed property `order_asset` (object)\r\n\r\n * Added property `mileage` (integer)\r\n\r\n * Added property `asset_type` (string)\r\n\r\n * Added property `rv_balloon_amount` (number)\r\n\r\n * Deleted property `milage` (boolean)\r\n\r\n * Changed property `order_tradein` (object)\r\n\r\n * Added property `trade_in_type` (string)\r\n > An enumeration.\r\n\r\n\r\n * Added property `question_answers` (array)\r\n\r\n * Changed property `appointment_details` (object)\r\n\r\n * Added property `time_zone` (string)\r\n\r\n### `PATCH` /dms/order/update-credit-approver-decision/{reference_number}\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n New optional properties:\r\n - `allowed_usage`\r\n - `annual_usage`\r\n - `apr`\r\n - `contract_term`\r\n - `credit_rating`\r\n - `dealer_id`\r\n - `down_payment`\r\n - `down_payment_lease`\r\n - `due_at_signing`\r\n - `estimated_monthly_payment`\r\n - `lender_id`\r\n - `rv_balloon_percentage`\r\n - `rv_balloon_value`\r\n - `selling_price`\r\n - `vehicle_id`\r\n\r\n * Added property `broker_id` (integer)\r\n\r\n * Added property `company_id` (integer)\r\n\r\n * Added property `name` (string)\r\n\r\n * Added property `is_payment_updated` (boolean)\r\n\r\n * Added property `tax_amount` (number)\r\n\r\n * Added property `tax_amount_number` (number)\r\n\r\n * Added property `deferred_type` (string)\r\n\r\n * Added property `balloon_collection` (string)\r\n\r\n * Added property `rate_type` (string)\r\n\r\n * Added property `commission_type` (string)\r\n\r\n * Added property `running_id` (string)\r\n\r\n * Added property `order_currency` (string)\r\n\r\n * Added property `commission_amount` (number)\r\n\r\n * Added property `received_security_deposit` (integer)\r\n\r\n * Added property `net_finance_amount` (number)\r\n\r\n * Added property `rebate` (number)\r\n\r\n * Added property `capitalized_cost_reduction` (number)\r\n\r\n * Added property `monthly_deprecation` (number)\r\n\r\n * Added property `tax_on_capitalized_cost_reduction` (number)\r\n\r\n * Added property `monthly_sales_use_tax` (number)\r\n\r\n * Added property `sum_of_fees` (number)\r\n\r\n * Added property `sum_of_periodic_interest` (number)\r\n\r\n * Added property `sum_of_rentals` (number)\r\n\r\n * Added property `total_payables` (number)\r\n\r\n * Added property `non_vatable_amount` (number)\r\n\r\n * Added property `individualized_agreement` (string)\r\n\r\n * Added property `base_residual_type` (integer)\r\n\r\n * Added property `excess_mileage_rate` (number)\r\n\r\n * Added property `asset_rv_amount` (number)\r\n\r\n * Changed property `order_fnI` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `mileage` (integer)\r\n\r\n * Added property `term` (integer)\r\n\r\n * Added property `is_msp` (boolean)\r\n\r\n * Changed property `order_fees` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `vendor` (string)\r\n\r\n * Added property `fee_type` (string)\r\n\r\n * Changed property `order_asset` (object)\r\n\r\n * Added property `mileage` (integer)\r\n\r\n * Added property `asset_type` (string)\r\n\r\n * Added property `rv_balloon_amount` (number)\r\n\r\n * Deleted property `milage` (boolean)\r\n\r\n * Changed property `order_tradein` (object)\r\n\r\n * Added property `trade_in_type` (string)\r\n > An enumeration.\r\n\r\n\r\n * Added property `question_answers` (array)\r\n\r\n * Changed property `appointment_details` (object)\r\n\r\n * Added property `time_zone` (string)\r\n\r\n### `PATCH` /dms/configure/quotation-to-order/{identifier}\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\nNew optional properties:\r\n- `allowed_usage`\r\n- `annual_usage`\r\n- `apr`\r\n- `contract_term`\r\n- `credit_rating`\r\n- `dealer_id`\r\n- `down_payment`\r\n- `down_payment_lease`\r\n- `due_at_signing`\r\n- `estimated_monthly_payment`\r\n- `lender_id`\r\n- `rv_balloon_percentage`\r\n- `rv_balloon_value`\r\n- `selling_price`\r\n- `vehicle_id`\r\n\r\n* Added property `broker_id` (integer)\r\n\r\n* Added property `company_id` (integer)\r\n\r\n* Added property `name` (string)\r\n\r\n* Added property `is_payment_updated` (boolean)\r\n\r\n* Added property `tax_amount` (number)\r\n\r\n* Added property `tax_amount_number` (number)\r\n\r\n* Added property `deferred_type` (string)\r\n\r\n* Added property `balloon_collection` (string)\r\n\r\n* Added property `rate_type` (string)\r\n\r\n* Added property `commission_type` (string)\r\n\r\n* Added property `running_id` (string)\r\n\r\n* Added property `order_currency` (string)\r\n\r\n* Added property `commission_amount` (number)\r\n\r\n* Added property `received_security_deposit` (integer)\r\n\r\n* Added property `net_finance_amount` (number)\r\n\r\n* Added property `rebate` (number)\r\n\r\n* Added property `capitalized_cost_reduction` (number)\r\n\r\n* Added property `monthly_deprecation` (number)\r\n\r\n* Added property `tax_on_capitalized_cost_reduction` (number)\r\n\r\n* Added property `monthly_sales_use_tax` (number)\r\n\r\n* Added property `sum_of_fees` (number)\r\n\r\n* Added property `sum_of_periodic_interest` (number)\r\n\r\n* Added property `sum_of_rentals` (number)\r\n\r\n* Added property `total_payables` (number)\r\n\r\n* Added property `non_vatable_amount` (number)\r\n\r\n* Added property `individualized_agreement` (string)\r\n\r\n* Added property `base_residual_type` (integer)\r\n\r\n* Added property `excess_mileage_rate` (number)\r\n\r\n* Added property `asset_rv_amount` (number)\r\n\r\n* Added property `changeVehicleStatus` (boolean)\r\n\r\n* Changed property `order_fnI` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `mileage` (integer)\r\n\r\n * Added property `term` (integer)\r\n\r\n * Added property `is_msp` (boolean)\r\n\r\n* Changed property `order_fees` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `vendor` (string)\r\n\r\n * Added property `fee_type` (string)\r\n\r\n* Changed property `order_asset` (object)\r\n\r\n * Added property `mileage` (integer)\r\n\r\n * Added property `asset_type` (string)\r\n\r\n * Added property `rv_balloon_amount` (number)\r\n\r\n * Deleted property `milage` (boolean)\r\n\r\n* Changed property `order_tradein` (object)\r\n\r\n * Added property `trade_in_type` (string)\r\n > An enumeration.\r\n\r\n\r\n * Added property `question_answers` (array)\r\n\r\n* Changed property `appointment_details` (object)\r\n\r\n * Added property `time_zone` (string)\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n New optional properties:\r\n - `allowed_usage`\r\n - `annual_usage`\r\n - `apr`\r\n - `contract_term`\r\n - `credit_rating`\r\n - `dealer_id`\r\n - `down_payment`\r\n - `down_payment_lease`\r\n - `due_at_signing`\r\n - `estimated_monthly_payment`\r\n - `lender_id`\r\n - `rv_balloon_percentage`\r\n - `rv_balloon_value`\r\n - `selling_price`\r\n - `vehicle_id`\r\n\r\n * Added property `broker_id` (integer)\r\n\r\n * Added property `company_id` (integer)\r\n\r\n * Added property `name` (string)\r\n\r\n * Added property `is_payment_updated` (boolean)\r\n\r\n * Added property `tax_amount` (number)\r\n\r\n * Added property `tax_amount_number` (number)\r\n\r\n * Added property `deferred_type` (string)\r\n\r\n * Added property `balloon_collection` (string)\r\n\r\n * Added property `rate_type` (string)\r\n\r\n * Added property `commission_type` (string)\r\n\r\n * Added property `running_id` (string)\r\n\r\n * Added property `order_currency` (string)\r\n\r\n * Added property `commission_amount` (number)\r\n\r\n * Added property `received_security_deposit` (integer)\r\n\r\n * Added property `net_finance_amount` (number)\r\n\r\n * Added property `rebate` (number)\r\n\r\n * Added property `capitalized_cost_reduction` (number)\r\n\r\n * Added property `monthly_deprecation` (number)\r\n\r\n * Added property `tax_on_capitalized_cost_reduction` (number)\r\n\r\n * Added property `monthly_sales_use_tax` (number)\r\n\r\n * Added property `sum_of_fees` (number)\r\n\r\n * Added property `sum_of_periodic_interest` (number)\r\n\r\n * Added property `sum_of_rentals` (number)\r\n\r\n * Added property `total_payables` (number)\r\n\r\n * Added property `non_vatable_amount` (number)\r\n\r\n * Added property `individualized_agreement` (string)\r\n\r\n * Added property `base_residual_type` (integer)\r\n\r\n * Added property `excess_mileage_rate` (number)\r\n\r\n * Added property `asset_rv_amount` (number)\r\n\r\n * Added property `changeVehicleStatus` (boolean)\r\n\r\n * Changed property `order_fnI` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `mileage` (integer)\r\n\r\n * Added property `term` (integer)\r\n\r\n * Added property `is_msp` (boolean)\r\n\r\n * Changed property `order_fees` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `vendor` (string)\r\n\r\n * Added property `fee_type` (string)\r\n\r\n * Changed property `order_asset` (object)\r\n\r\n * Added property `mileage` (integer)\r\n\r\n * Added property `asset_type` (string)\r\n\r\n * Added property `rv_balloon_amount` (number)\r\n\r\n * Deleted property `milage` (boolean)\r\n\r\n * Changed property `order_tradein` (object)\r\n\r\n * Added property `trade_in_type` (string)\r\n > An enumeration.\r\n\r\n\r\n * Added property `question_answers` (array)\r\n\r\n * Changed property `appointment_details` (object)\r\n\r\n * Added property `time_zone` (string)\r\n\r\n### `GET` /dms/contract\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `customer` (object)\r\n\r\n * Added property `preferred_contact` (string)\r\n\r\n * Added property `external_id` (string)\r\n\r\n### `POST` /dms/contract\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **201 Created**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `customer` (object)\r\n\r\n * Added property `preferred_contact` (string)\r\n\r\n * Added property `external_id` (string)\r\n\r\n### `PATCH` /dms/contract\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `customer` (object)\r\n\r\n * Added property `preferred_contact` (string)\r\n\r\n * Added property `external_id` (string)\r\n\r\n### `GET` /dms/order/order_information_for_submitted_order\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `result` (array)\r\n\r\n Changed items (object):\r\n\r\n * Changed property `order_info` (object)\r\n\r\n New optional properties:\r\n - `allowed_usage`\r\n - `annual_usage`\r\n - `apr`\r\n - `contract_term`\r\n - `credit_rating`\r\n - `customer_id`\r\n - `dealer_id`\r\n - `down_payment`\r\n - `down_payment_lease`\r\n - `due_at_signing`\r\n - `estimated_monthly_payment`\r\n - `lender_id`\r\n - `rv_balloon_percentage`\r\n - `rv_balloon_value`\r\n - `selling_price`\r\n - `vehicle_id`\r\n\r\n * Added property `broker_id` (integer)\r\n\r\n * Added property `company_id` (integer)\r\n\r\n * Added property `name` (string)\r\n\r\n * Added property `is_payment_updated` (boolean)\r\n\r\n * Added property `tax_amount` (number)\r\n\r\n * Added property `tax_amount_number` (number)\r\n\r\n * Added property `deferred_type` (string)\r\n\r\n * Added property `balloon_collection` (string)\r\n\r\n * Added property `rate_type` (string)\r\n\r\n * Added property `commission_type` (string)\r\n\r\n * Added property `running_id` (string)\r\n\r\n * Added property `order_currency` (string)\r\n\r\n * Added property `commission_amount` (number)\r\n\r\n * Added property `received_security_deposit` (integer)\r\n\r\n * Added property `net_finance_amount` (number)\r\n\r\n * Added property `rebate` (number)\r\n\r\n * Added property `capitalized_cost_reduction` (number)\r\n\r\n * Added property `monthly_deprecation` (number)\r\n\r\n * Added property `tax_on_capitalized_cost_reduction` (number)\r\n\r\n * Added property `monthly_sales_use_tax` (number)\r\n\r\n * Added property `sum_of_fees` (number)\r\n\r\n * Added property `sum_of_periodic_interest` (number)\r\n\r\n * Added property `sum_of_rentals` (number)\r\n\r\n * Added property `total_payables` (number)\r\n\r\n * Added property `non_vatable_amount` (number)\r\n\r\n * Added property `individualized_agreement` (string)\r\n\r\n * Added property `base_residual_type` (integer)\r\n\r\n * Added property `excess_mileage_rate` (number)\r\n\r\n * Added property `asset_rv_amount` (number)\r\n\r\n * Changed property `order_fnI` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `mileage` (integer)\r\n\r\n * Added property `term` (integer)\r\n\r\n * Added property `is_msp` (boolean)\r\n\r\n * Changed property `order_fees` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `vendor` (string)\r\n\r\n * Added property `fee_type` (string)\r\n\r\n * Changed property `order_asset` (object)\r\n\r\n * Added property `mileage` (integer)\r\n\r\n * Added property `asset_type` (string)\r\n\r\n * Added property `rv_balloon_amount` (number)\r\n\r\n * Deleted property `milage` (boolean)\r\n\r\n * Changed property `order_tradein` (object)\r\n\r\n * Added property `trade_in_type` (string)\r\n > An enumeration.\r\n\r\n\r\n * Added property `question_answers` (array)\r\n\r\n * Changed property `appointment_details` (object)\r\n\r\n * Added property `time_zone` (string)\r\n\r\n * Changed property `customer_info` (object)\r\n\r\n * Added property `preferred_contact` (string)\r\n\r\n * Added property `external_id` (string)\r\n\r\n### `POST` /dms/credit-request\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\nNew required properties:\r\n- `lender_ids`\r\n\r\n* Added property `lender_ids` (array)\r\n > list of lender ids the order will be submitted to\r\n\r\n\r\n Items (integer):\r\n\r\n* Changed property `result` (array)\r\n\r\n Changed items (object):\r\n\r\n * Changed property `order_info` (object)\r\n\r\n New optional properties:\r\n - `allowed_usage`\r\n - `annual_usage`\r\n - `apr`\r\n - `contract_term`\r\n - `credit_rating`\r\n - `customer_id`\r\n - `dealer_id`\r\n - `down_payment`\r\n - `down_payment_lease`\r\n - `due_at_signing`\r\n - `estimated_monthly_payment`\r\n - `lender_id`\r\n - `rv_balloon_percentage`\r\n - `rv_balloon_value`\r\n - `selling_price`\r\n - `vehicle_id`\r\n\r\n * Added property `broker_id` (integer)\r\n\r\n * Added property `company_id` (integer)\r\n\r\n * Added property `name` (string)\r\n\r\n * Added property `is_payment_updated` (boolean)\r\n\r\n * Added property `tax_amount` (number)\r\n\r\n * Added property `tax_amount_number` (number)\r\n\r\n * Added property `deferred_type` (string)\r\n\r\n * Added property `balloon_collection` (string)\r\n\r\n * Added property `rate_type` (string)\r\n\r\n * Added property `commission_type` (string)\r\n\r\n * Added property `running_id` (string)\r\n\r\n * Added property `order_currency` (string)\r\n\r\n * Added property `commission_amount` (number)\r\n\r\n * Added property `received_security_deposit` (integer)\r\n\r\n * Added property `net_finance_amount` (number)\r\n\r\n * Added property `rebate` (number)\r\n\r\n * Added property `capitalized_cost_reduction` (number)\r\n\r\n * Added property `monthly_deprecation` (number)\r\n\r\n * Added property `tax_on_capitalized_cost_reduction` (number)\r\n\r\n * Added property `monthly_sales_use_tax` (number)\r\n\r\n * Added property `sum_of_fees` (number)\r\n\r\n * Added property `sum_of_periodic_interest` (number)\r\n\r\n * Added property `sum_of_rentals` (number)\r\n\r\n * Added property `total_payables` (number)\r\n\r\n * Added property `non_vatable_amount` (number)\r\n\r\n * Added property `individualized_agreement` (string)\r\n\r\n * Added property `base_residual_type` (integer)\r\n\r\n * Added property `excess_mileage_rate` (number)\r\n\r\n * Added property `asset_rv_amount` (number)\r\n\r\n * Changed property `order_fnI` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `mileage` (integer)\r\n\r\n * Added property `term` (integer)\r\n\r\n * Added property `is_msp` (boolean)\r\n\r\n * Changed property `order_fees` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `vendor` (string)\r\n\r\n * Added property `fee_type` (string)\r\n\r\n * Changed property `order_asset` (object)\r\n\r\n * Added property `mileage` (integer)\r\n\r\n * Added property `asset_type` (string)\r\n\r\n * Added property `rv_balloon_amount` (number)\r\n\r\n * Deleted property `milage` (boolean)\r\n\r\n * Changed property `order_tradein` (object)\r\n\r\n * Added property `trade_in_type` (string)\r\n > An enumeration.\r\n\r\n\r\n * Added property `question_answers` (array)\r\n\r\n * Changed property `appointment_details` (object)\r\n\r\n * Added property `time_zone` (string)\r\n\r\n * Changed property `customer_info` (object)\r\n\r\n * Added property `preferred_contact` (string)\r\n\r\n * Added property `external_id` (string)\r\n\r\n### `GET` /dms/contract/all\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `result` (array)\r\n\r\n Changed items (object):\r\n\r\n * Changed property `customer` (object)\r\n\r\n * Added property `preferred_contact` (string)\r\n\r\n * Added property `external_id` (string)\r\n\r\n# API Docs Version 1.3.42\r\n --- \r\n\r\n## What's New\r\n\r\n\r\n### `GET` /dms/get-reference-data/{dealer_code}\r\n\r\n> Get Reference Data By Dealer Code\r\n\r\n\r\n### `GET` /dms/get-inventory\r\n\r\n> Get Filtered Inventory\r\n\r\n\r\n### `GET` /dms/get-setup-data\r\n\r\n> Setup Data\r\n\r\n\r\n### `GET` /dms/an-order-statuses\r\n\r\n> Get AN Order Statuses\r\n\r\n\r\n### `PATCH` /dms/customer/documents/{customer_reference_id}\r\n\r\n> Update customer document by identifier\r\n\r\n\r\n### `GET` /dms/configure/all-document-packages-by-reference-id\r\n\r\n> Get document package by reference_id\r\n\r\n\r\n### `POST` /dms/submit-order\r\n\r\n> Mock Credit Approver API & Fraud Check\r\n\r\n\r\n### `POST` /dms/affordability-check/\r\n\r\n> Affordability Check\r\n\r\n\r\n### `POST` /dms/affordability-check/monthly-payment-calculation/V2/\r\n\r\n> Monthly Payment Calculation V2\r\n\r\n\r\n### `GET` /dms/currencies\r\n\r\n> Get All Currencies\r\n\r\n\r\n### `GET` /dms/lender/by-tenant-id/{tenant_id}\r\n\r\n> Find Lender By Tenant Id\r\n\r\n\r\n### `GET` /dms/dealer/find/by-tenant\r\n\r\n> Get Dealer By Tenant Id\r\n\r\n\r\n### `GET` /dms/inventory/reference-data-by-dealer-code/{dealer_code}\r\n\r\n> Get Inventory Reference Data\r\n\r\n\r\n### `GET` /dms/inventory/filter\r\n\r\n> Get Inventory Data\r\n\r\n\r\n### `GET` /dms/state\r\n\r\n> Get All States\r\n\r\n\r\n### `GET` /dms/contract-term\r\n\r\n> Get All Contract Terms\r\n\r\n\r\n### `GET` /dms/credit-ratings\r\n\r\n> Get All Credit Rating\r\n\r\n\r\n### `GET` /dms/integration/lender\r\n\r\n> Get All Lender Integration\r\n\r\n\r\n### `GET` /dms/dealer/preference-by-dealer-code/{dealer_code}\r\n\r\n> Get Dealer Preference By Dealer Code\r\n\r\n\r\n### `GET` /dms/integration/by_provider_name/{provider_name}\r\n\r\n> Get Integration By Provider Name\r\n\r\n\r\n### `GET` /dms/vehicle-detail/{vin}\r\n\r\n> Get Vehicle Detail By Vin\r\n\r\n\r\n### `GET` /dms/countries\r\n\r\n> Get All Countries\r\n\r\n\r\n### `GET` /dms/dealer/profile/{dealer_code}\r\n\r\n> Get Dealer Profile By Dealer Code\r\n\r\n\r\n### `GET` /dms/vehicle/{vin}\r\n\r\n> Get Vehicle By Vin\r\n\r\n\r\n### `GET` /dms/contract-allowed-annum-mileage\r\n\r\n> Get All Contract Allowed Mileages\r\n\r\n\r\n### `GET` /dms/dealer/fee/dealer-code/{dealer_code}\r\n\r\n> Get All Dealer Fee By Code\r\n\r\n\r\n### `GET` /dms/asset-usage/active\r\n\r\n> Get Active Asset Usages\r\n\r\n\r\n### `GET` /dms/vehicle\r\n\r\n> Get All Vehicles\r\n\r\n\r\n### `GET` /dms/financial-insurances/filter\r\n\r\n> Get Financial Insurance Product By Filter\r\n\r\n\r\n### `GET` /dms/dealer/option-trim-code\r\n\r\n> Get All Dealer Options By Trim Code\r\n\r\n\r\n### `POST` /dms/programs/all/\r\n\r\n> Get All Evaluated Programs\r\n\r\n\r\n### `POST` /dms/get_event_associated_checklist/\r\n\r\n> This API helps to evaluate given criteria and retrive configured checklist(s)\r\n\r\n\r\n### `GET` /dms/dealer/all-dealer-distance\r\n\r\n> Get All Dealer Distance\r\n\r\n\r\n### `POST` /dms/customers\r\n\r\n> Gets customer names by customer reference ids\r\n\r\n\r\n### `PATCH` /dms/configure/appointment/{appointment_id}\r\n\r\n> Delete created appointment\r\n\r\n\r\n### `GET` /dms/theme-builder\r\n\r\n> Get Theme\r\n\r\n\r\n### `PATCH` /dms/order/quick_quotation\r\n\r\n> Update Quotation\r\n\r\n\r\n## What's Deleted\r\n\r\n\r\n### `POST` /dms/credit-approval\r\n\r\n> Get Credit Approval\r\n\r\n\r\n### `GET` /dms/workflow-status\r\n\r\n> Credit Approval status\r\n\r\n\r\n### `POST` /dms/credit-response\r\n\r\n> Mock Credit Approver Response\r\n\r\n\r\n### `GET` /dms/order/event\r\n\r\n> Get All Order Events\r\n\r\n\r\n### `POST` /dms/order/event\r\n\r\n> Create Order Events\r\n\r\n\r\n### `DELETE` /dms/order/event\r\n\r\n> Delete Order Events\r\n\r\n\r\n### `PATCH` /dms/order/event\r\n\r\n> Update Order Events\r\n\r\n\r\n### `GET` /dms/order/event/\r\n\r\n> Get Order Events\r\n\r\n\r\n### `DELETE` /dms/configure/appointment/{appointment_id}\r\n\r\n> Delete created appointment\r\n\r\n\r\n## What's Changed\r\n\r\n\r\n### `GET` /dms/address/history\r\n\r\n\r\n#### Parameters:\r\n\r\nChanged: `address_type` in `query`\r\n\r\n### `POST` /dms/customer/insurance-information\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Changed property `insurance_documents` (array)\r\n\r\n Changed items (object):\r\n\r\n New optional properties:\r\n - `document`\r\n\r\n * Added property `doucment_reference_id` (string)\r\n\r\n### `POST` /dms/customer/insurance-information/add-document\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\nNew optional properties:\r\n- `document`\r\n\r\n* Added property `doucment_reference_id` (string)\r\n\r\n### `POST` /dms/customer/license-verification\r\n\r\n\r\n### `GET` /dms/order/order-checklist\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n Changed items (object):\r\n\r\n * Added property `changed_by` (string)\r\n\r\n * Added property `changed_at` (string)\r\n\r\n### `POST` /dms/order/order-checklist\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n Changed items (object):\r\n\r\n * Added property `changed_by` (string)\r\n\r\n * Added property `changed_at` (string)\r\n\r\n### `PATCH` /dms/order/order-checklist\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\nChanged items (object):\r\n\r\nNew optional properties:\r\n- `updated_by`\r\n\r\n* Added property `updated_at` (string)\r\n\r\n* Added property `changed_by` (string)\r\n\r\n* Added property `changed_at` (string)\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n Changed items (object):\r\n\r\n * Added property `changed_by` (string)\r\n\r\n * Added property `changed_at` (string)\r\n\r\n### `GET` /dms/configure/quick-quotation-by-identifier/{identifier}\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `external_order_id` (string)\r\n\r\n * Added property `status` (string)\r\n\r\n * Added property `created_by` (string)\r\n\r\n * Added property `assets` (array)\r\n\r\n Items (object):\r\n\r\n * Property `vin` (string)\r\n\r\n * Property `make` (string)\r\n\r\n * Property `model` (string)\r\n\r\n * Property `trim` (string)\r\n\r\n * Property `year` (string)\r\n\r\n * Property `stock_number` (string)\r\n\r\n * Property `asset_image` (array)\r\n\r\n Items (string):\r\n\r\n * Property `asset_type` (string)\r\n\r\n * Changed property `customer` (object)\r\n\r\n * Added property `reference_id` (string)\r\n\r\n### `GET` /dms/configure/quick-quotation-by-vendor\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n Changed items (object):\r\n\r\n * Added property `external_order_id` (string)\r\n\r\n * Added property `status` (string)\r\n\r\n * Added property `created_by` (string)\r\n\r\n * Added property `assets` (array)\r\n\r\n * Changed property `customer` (object)\r\n\r\n * Added property `reference_id` (string)\r\n\r\n### `GET` /dms/configure/workqueue/search\r\n\r\n\r\n#### Parameters:\r\n\r\nAdded: `customer_reference_id` in `query`\r\n\r\n### `POST` /dms/customer/document\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Added property `comment` (string)\r\n\r\n### `PATCH` /dms/customer/document\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Added property `document_reference_id` (string)\r\n\r\n### `GET` /dms/customer/document/status\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `result` (array)\r\n\r\n Items (object):\r\n\r\n * Property `customer_reference_id` (string)\r\n\r\n * Property `external_reference_id` (string)\r\n\r\n * Property `document_type` (string)\r\n\r\n * Property `comment` (string)\r\n\r\n * Property `category` (string)\r\n\r\n * Property `document_name` (string)\r\n\r\n * Property `document_size` (string)\r\n\r\n * Property `document_url` (string)\r\n\r\n * Property `reason_by_system` (string)\r\n\r\n * Property `reason_for_customer` (string)\r\n\r\n * Property `document_status` (string)\r\n\r\n * Property `document_upload_indicator` (boolean)\r\n\r\n * Property `expires_at` (string)\r\n > format: YYYY-MM-DD hh:mm:ss\r\n\r\n\r\n * Property `created_at` (string)\r\n > format: YYYY-MM-DD hh:mm:ss\r\n\r\n\r\n * Property `updated_at` (string)\r\n > format: YYYY-MM-DD hh:mm:ss\r\n\r\n\r\n * Property `deleted_at` (string)\r\n > format: YYYY-MM-DD hh:mm:ss\r\n\r\n\r\n * Property `updated_by` (string)\r\n\r\n * Property `created_by` (string)\r\n\r\n * Property `deleted_by` (string)\r\n\r\n * Property `uploaded_by` (string)\r\n\r\n * Property `uploaded_at` (string)\r\n\r\n * Property `is_deleted` (boolean)\r\n\r\n * Property `identifier` (string)\r\n\r\n * Property `stipulation_code` (string)\r\n\r\n * Property `document_reviews` (array)\r\n\r\n Items (object):\r\n\r\n * Property `reviewed_by` (string)\r\n\r\n * Property `review_date_time` (string)\r\n > format: YYYY-MM-DD hh:mm:ss\r\n\r\n\r\n * Property `review_status` (string)\r\n\r\n * Property `review_notes` (string)\r\n\r\n * Property `reason` (array)\r\n\r\n Items (string):\r\n\r\n * Property `other_reason` (string)\r\n\r\n * Property `identifier` (string)\r\n\r\n * Added property `page_number` (integer)\r\n\r\n * Added property `page_size` (integer)\r\n\r\n * Added property `total_pages` (integer)\r\n\r\n * Added property `total_results` (integer)\r\n\r\n * Deleted property `customer_reference_id` (string)\r\n\r\n * Deleted property `external_reference_id` (string)\r\n\r\n * Deleted property `document_type` (string)\r\n\r\n * Deleted property `comment` (string)\r\n\r\n * Deleted property `category` (string)\r\n\r\n * Deleted property `document_name` (string)\r\n\r\n * Deleted property `document_size` (string)\r\n\r\n * Deleted property `document_url` (string)\r\n\r\n * Deleted property `reason_by_system` (string)\r\n\r\n * Deleted property `reason_for_customer` (string)\r\n\r\n * Deleted property `document_status` (string)\r\n\r\n * Deleted property `document_upload_indicator` (boolean)\r\n\r\n * Deleted property `expires_at` (string)\r\n > format: YYYY-MM-DD hh:mm:ss\r\n\r\n\r\n * Deleted property `created_at` (string)\r\n > format: YYYY-MM-DD hh:mm:ss\r\n\r\n\r\n * Deleted property `updated_at` (string)\r\n > format: YYYY-MM-DD hh:mm:ss\r\n\r\n\r\n * Deleted property `deleted_at` (string)\r\n > format: YYYY-MM-DD hh:mm:ss\r\n\r\n\r\n * Deleted property `updated_by` (string)\r\n\r\n * Deleted property `created_by` (string)\r\n\r\n * Deleted property `deleted_by` (string)\r\n\r\n * Deleted property `uploaded_by` (string)\r\n\r\n * Deleted property `uploaded_at` (string)\r\n\r\n * Deleted property `is_deleted` (boolean)\r\n\r\n * Deleted property `identifier` (string)\r\n\r\n * Deleted property `stipulation_code` (string)\r\n\r\n### `POST` /dms/customer/document/signature-document\r\n\r\n\r\n### `POST` /dms/customer/additional-document\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\nNew optional properties:\r\n- `external_reference_id`\r\n\r\n* Added property `document_reference_id` (string)\r\n\r\n### `GET` /dms/contracts/search\r\n\r\n\r\n#### Parameters:\r\n\r\nAdded: `subscription_start_date_from` in `query`\r\n> Format: YYYY-MM-DDTHH:MM:SS\r\n\r\n\r\nAdded: `subscription_start_date_to` in `query`\r\n> Format: YYYY-MM-DDTHH:MM:SS\r\n\r\n\r\nAdded: `subscription_end_date_from` in `query`\r\n> Format: YYYY-MM-DDTHH:MM:SS\r\n\r\n\r\nAdded: `subscription_end_date_to` in `query`\r\n> Format: YYYY-MM-DDTHH:MM:SS\r\n\r\n\r\nChanged: `subscription_start_date` in `query`\r\n> Format: YYYY-MM-DDTHH:MM:SS\r\n\r\n\r\nChanged: `subscription_end_date` in `query`\r\n> Format: YYYY-MM-DDTHH:MM:SS\r\n\r\n\r\n### `GET` /dms/history\r\n\r\n\r\n#### Parameters:\r\n\r\nChanged: `module_type` in `query`\r\n> module\r\n\r\n\r\n### `GET` /dms/history-details\r\n\r\n\r\n#### Parameters:\r\n\r\nAdded: `order_reference_id` in `query`\r\n\r\nChanged: `module_type` in `query`\r\n\r\n### `GET` /dms/configure/quotation\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `id` (integer)\r\n\r\n * Added property `appointment_details` (object)\r\n\r\n * Property `id` (integer)\r\n\r\n * Property `order_id` (integer)\r\n\r\n * Property `dealer_id` (integer)\r\n\r\n * Property `customer_id` (integer)\r\n\r\n * Property `appointment_date` (string)\r\n\r\n * Property `appointment_type` (string)\r\n\r\n * Property `appointment_status` (string)\r\n\r\n * Property `comments` (string)\r\n\r\n * Property `address_id` (integer)\r\n\r\n * Property `dealer_code` (string)\r\n\r\n * Property `address_data` (object)\r\n\r\n * Property `address_line_1` (string)\r\n > Address line one\r\n\r\n\r\n * Property `address_line_2` (string)\r\n > Address line two\r\n\r\n\r\n * Property `state_name` (string)\r\n > Address state name\r\n\r\n\r\n * Property `zip_code` (string)\r\n > Zip code\r\n\r\n\r\n * Property `county` (string)\r\n > Address county\r\n\r\n\r\n * Property `city` (string)\r\n > Address city\r\n\r\n\r\n * Property `contact_number` (string)\r\n > Contact number\r\n\r\n\r\n * Property `verified` (boolean)\r\n > Is Address verified\r\n\r\n\r\n * Property `move_in_date` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n * Property `is_garaging` (boolean)\r\n > Garaging flag\r\n\r\n\r\n * Property `address_type` (string)\r\n > An enumeration.\r\n\r\n\r\n Enum values:\r\n\r\n * `Mailing`\r\n * `Invoice`\r\n * `Office`\r\n * `Garaging`\r\n * `DealerAddress`\r\n * `DrivingLicense`\r\n * `Billing`\r\n * `InsuranceAddress`\r\n * `Residential`\r\n * `Employment`\r\n * Property `identifier` (string)\r\n\r\n * Property `id` (integer)\r\n\r\n * Property `created_by` (string)\r\n\r\n * Property `updated_by` (string)\r\n\r\n * Changed property `insurance` (object)\r\n\r\n * Changed property `insurance_documents` (array)\r\n\r\n Changed items (object):\r\n\r\n New optional properties:\r\n - `document`\r\n\r\n * Added property `doucment_reference_id` (string)\r\n\r\n### `GET` /dms/configure/all-quotations\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n Changed items (object):\r\n\r\n * Added property `id` (integer)\r\n\r\n * Added property `appointment_details` (object)\r\n\r\n * Changed property `insurance` (object)\r\n\r\n * Changed property `insurance_documents` (array)\r\n\r\n Changed items (object):\r\n\r\n New optional properties:\r\n - `document`\r\n\r\n * Added property `doucment_reference_id` (string)\r\n\r\n### `PATCH` /dms/configure/quotation/{identifier}\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Added property `id` (integer)\r\n\r\n* Added property `appointment_details` (object)\r\n\r\n* Changed property `insurance` (object)\r\n\r\n * Changed property `insurance_documents` (array)\r\n\r\n Changed items (object):\r\n\r\n New optional properties:\r\n - `document`\r\n\r\n * Added property `doucment_reference_id` (string)\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `id` (integer)\r\n\r\n * Added property `appointment_details` (object)\r\n\r\n * Changed property `insurance` (object)\r\n\r\n * Changed property `insurance_documents` (array)\r\n\r\n Changed items (object):\r\n\r\n New optional properties:\r\n - `document`\r\n\r\n * Added property `doucment_reference_id` (string)\r\n\r\n### `POST` /dms/configure/save-quotation\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\nChanged items (object):\r\n\r\n* Added property `id` (integer)\r\n\r\n* Added property `appointment_details` (object)\r\n\r\n* Changed property `insurance` (object)\r\n\r\n * Changed property `insurance_documents` (array)\r\n\r\n Changed items (object):\r\n\r\n New optional properties:\r\n - `document`\r\n\r\n * Added property `doucment_reference_id` (string)\r\n\r\n#### Return Type:\r\n\r\nChanged response : **201 Created**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n Changed items (object):\r\n\r\n * Added property `id` (integer)\r\n\r\n * Added property `appointment_details` (object)\r\n\r\n * Changed property `insurance` (object)\r\n\r\n * Changed property `insurance_documents` (array)\r\n\r\n Changed items (object):\r\n\r\n New optional properties:\r\n - `document`\r\n\r\n * Added property `doucment_reference_id` (string)\r\n\r\n### `PATCH` /dms/order/update-credit-approver-decision/{reference_number}\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `id` (integer)\r\n\r\n * Added property `appointment_details` (object)\r\n\r\n * Changed property `insurance` (object)\r\n\r\n * Changed property `insurance_documents` (array)\r\n\r\n Changed items (object):\r\n\r\n New optional properties:\r\n - `document`\r\n\r\n * Added property `doucment_reference_id` (string)\r\n\r\n### `PATCH` /dms/configure/quotation-to-order/{identifier}\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Added property `id` (integer)\r\n\r\n* Added property `appointment_details` (object)\r\n\r\n* Changed property `insurance` (object)\r\n\r\n * Changed property `insurance_documents` (array)\r\n\r\n Changed items (object):\r\n\r\n New optional properties:\r\n - `document`\r\n\r\n * Added property `doucment_reference_id` (string)\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `id` (integer)\r\n\r\n * Added property `appointment_details` (object)\r\n\r\n * Changed property `insurance` (object)\r\n\r\n * Changed property `insurance_documents` (array)\r\n\r\n Changed items (object):\r\n\r\n New optional properties:\r\n - `document`\r\n\r\n * Added property `doucment_reference_id` (string)\r\n\r\n### `POST` /dms/order/quick_quotation\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Changed property `quote_identifiers` (object)\r\n\r\n * Added property `reference_id` (string)\r\n\r\n* Changed property `quote_details` (object)\r\n\r\n * Added property `customer_reference_id` (string)\r\n\r\n * Added property `external_order_id` (string)\r\n\r\n * Added property `order_status` (string)\r\n\r\n * Added property `created_by` (string)\r\n\r\n * Added property `dealer_id` (string)\r\n\r\n * Added property `assets` (array)\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `external_order_id` (string)\r\n\r\n * Added property `status` (string)\r\n\r\n * Added property `created_by` (string)\r\n\r\n * Added property `assets` (array)\r\n\r\n * Changed property `customer` (object)\r\n\r\n * Added property `reference_id` (string)\r\n\r\n### `POST` /dms/configure/appointment\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\nNew optional properties:\r\n- `appointment_type`\r\n- `dealer_id`\r\n- `order_id`\r\n\r\n* Added property `appointment_status` (string)\r\n\r\n* Added property `comments` (string)\r\n\r\n* Added property `created_by` (string)\r\n\r\n* Added property `updated_by` (string)\r\n\r\n### `PATCH` /dms/configure/appointment\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\nNew required properties:\r\n- `appointment_date`\r\n\r\nNew optional properties:\r\n- `dealer_id`\r\n- `order_id`\r\n\r\n* Added property `appointment_status` (string)\r\n\r\n* Added property `comments` (string)\r\n\r\n* Added property `created_by` (string)\r\n\r\n* Added property `updated_by` (string)\r\n\r\n### `GET` /dms/customer/all-customers\r\n\r\n\r\n#### Parameters:\r\n\r\nChanged: `sort_by` in `query`\r\n\r\n### `POST` /dms/customer/all-customers-dynamic-search\r\n\r\n\r\n#### Parameters:\r\n\r\nChanged: `sort_by` in `query`\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\nChanged items (object):\r\n\r\n* Changed property `field` (string)\r\n > An enumeration.\r\n\r\n\r\n Added enum values:\r\n\r\n * `full_name`\r\n * `order_identifier`\r\n * `order_status`\r\n * `vin`\r\n### `GET` /dms/contract\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Deleted property `updated_start_date` (string)\r\n\r\n * Changed property `returns` (object)\r\n\r\n * Added property `noi_date` (string)\r\n\r\n * Added property `check_list_start_date` (string)\r\n\r\n * Added property `reason` (string)\r\n\r\n * Added property `reason_detail` (string)\r\n\r\n### `POST` /dms/contract\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **201 Created**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Deleted property `updated_start_date` (string)\r\n\r\n * Changed property `returns` (object)\r\n\r\n * Added property `noi_date` (string)\r\n\r\n * Added property `check_list_start_date` (string)\r\n\r\n * Added property `reason` (string)\r\n\r\n * Added property `reason_detail` (string)\r\n\r\n### `PATCH` /dms/contract\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Added property `return_status` (string)\r\n\r\n* Added property `start_date` (string)\r\n\r\n* Deleted property `updated_start_date` (string)\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Deleted property `updated_start_date` (string)\r\n\r\n * Changed property `returns` (object)\r\n\r\n * Added property `noi_date` (string)\r\n\r\n * Added property `check_list_start_date` (string)\r\n\r\n * Added property `reason` (string)\r\n\r\n * Added property `reason_detail` (string)\r\n\r\n### `GET` /dms/order/order_information_for_submitted_order\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `result` (array)\r\n\r\n Changed items (object):\r\n\r\n * Changed property `order_info` (object)\r\n\r\n * Added property `id` (integer)\r\n\r\n * Added property `appointment_details` (object)\r\n\r\n * Changed property `insurance` (object)\r\n\r\n * Changed property `insurance_documents` (array)\r\n\r\n Changed items (object):\r\n\r\n New optional properties:\r\n - `document`\r\n\r\n * Added property `doucment_reference_id` (string)\r\n\r\n### `POST` /dms/credit-request\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Changed property `result` (array)\r\n\r\n Changed items (object):\r\n\r\n * Changed property `order_info` (object)\r\n\r\n * Added property `id` (integer)\r\n\r\n * Added property `appointment_details` (object)\r\n\r\n * Changed property `insurance` (object)\r\n\r\n * Changed property `insurance_documents` (array)\r\n\r\n Changed items (object):\r\n\r\n New optional properties:\r\n - `document`\r\n\r\n * Added property `doucment_reference_id` (string)\r\n\r\n### `GET` /dms/contract/all\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `result` (array)\r\n\r\n Changed items (object):\r\n\r\n * Deleted property `updated_start_date` (string)\r\n\r\n * Changed property `returns` (object)\r\n\r\n * Added property `noi_date` (string)\r\n\r\n * Added property `check_list_start_date` (string)\r\n\r\n * Added property `reason` (string)\r\n\r\n * Added property `reason_detail` (string)\r\n\r\n# API Docs Version 1.3.42\r\n --- \r\n\r\n## What's New\r\n\r\n\r\n### `GET` /dms/get-reference-data/{dealer_code}\r\n\r\n> Get Reference Data By Dealer Code\r\n\r\n\r\n### `GET` /dms/get-inventory\r\n\r\n> Get Filtered Inventory\r\n\r\n\r\n### `GET` /dms/get-setup-data\r\n\r\n> Setup Data\r\n\r\n\r\n### `GET` /dms/an-order-statuses\r\n\r\n> Get AN Order Statuses\r\n\r\n\r\n### `PATCH` /dms/customer/documents/{customer_reference_id}\r\n\r\n> Update customer document by identifier\r\n\r\n\r\n### `GET` /dms/configure/all-document-packages-by-reference-id\r\n\r\n> Get document package by reference_id\r\n\r\n\r\n### `POST` /dms/submit-order\r\n\r\n> Mock Credit Approver API & Fraud Check\r\n\r\n\r\n### `POST` /dms/affordability-check/\r\n\r\n> Affordability Check\r\n\r\n\r\n### `POST` /dms/affordability-check/monthly-payment-calculation/V2/\r\n\r\n> Monthly Payment Calculation V2\r\n\r\n\r\n### `GET` /dms/currencies\r\n\r\n> Get All Currencies\r\n\r\n\r\n### `GET` /dms/lender/by-tenant-id/{tenant_id}\r\n\r\n> Find Lender By Tenant Id\r\n\r\n\r\n### `GET` /dms/dealer/find/by-tenant\r\n\r\n> Get Dealer By Tenant Id\r\n\r\n\r\n### `GET` /dms/inventory/reference-data-by-dealer-code/{dealer_code}\r\n\r\n> Get Inventory Reference Data\r\n\r\n\r\n### `GET` /dms/inventory/filter\r\n\r\n> Get Inventory Data\r\n\r\n\r\n### `GET` /dms/state\r\n\r\n> Get All States\r\n\r\n\r\n### `GET` /dms/contract-term\r\n\r\n> Get All Contract Terms\r\n\r\n\r\n### `GET` /dms/credit-ratings\r\n\r\n> Get All Credit Rating\r\n\r\n\r\n### `GET` /dms/integration/lender\r\n\r\n> Get All Lender Integration\r\n\r\n\r\n### `GET` /dms/dealer/preference-by-dealer-code/{dealer_code}\r\n\r\n> Get Dealer Preference By Dealer Code\r\n\r\n\r\n### `GET` /dms/integration/by_provider_name/{provider_name}\r\n\r\n> Get Integration By Provider Name\r\n\r\n\r\n### `GET` /dms/vehicle-detail/{vin}\r\n\r\n> Get Vehicle Detail By Vin\r\n\r\n\r\n### `GET` /dms/countries\r\n\r\n> Get All Countries\r\n\r\n\r\n### `GET` /dms/dealer/profile/{dealer_code}\r\n\r\n> Get Dealer Profile By Dealer Code\r\n\r\n\r\n### `GET` /dms/vehicle/{vin}\r\n\r\n> Get Vehicle By Vin\r\n\r\n\r\n### `GET` /dms/contract-allowed-annum-mileage\r\n\r\n> Get All Contract Allowed Mileages\r\n\r\n\r\n### `GET` /dms/dealer/fee/dealer-code/{dealer_code}\r\n\r\n> Get All Dealer Fee By Code\r\n\r\n\r\n### `GET` /dms/asset-usage/active\r\n\r\n> Get Active Asset Usages\r\n\r\n\r\n### `GET` /dms/vehicle\r\n\r\n> Get All Vehicles\r\n\r\n\r\n### `GET` /dms/financial-insurances/filter\r\n\r\n> Get Financial Insurance Product By Filter\r\n\r\n\r\n### `GET` /dms/dealer/option-trim-code\r\n\r\n> Get All Dealer Options By Trim Code\r\n\r\n\r\n### `POST` /dms/programs/all/\r\n\r\n> Get All Evaluated Programs\r\n\r\n\r\n### `POST` /dms/get_event_associated_checklist/\r\n\r\n> This API helps to evaluate given criteria and retrive configured checklist(s)\r\n\r\n\r\n### `GET` /dms/dealer/all-dealer-distance\r\n\r\n> Get All Dealer Distance\r\n\r\n\r\n### `POST` /dms/customers\r\n\r\n> Gets customer names by customer reference ids\r\n\r\n\r\n### `PATCH` /dms/configure/appointment/{appointment_id}\r\n\r\n> Delete created appointment\r\n\r\n\r\n### `GET` /dms/theme-builder\r\n\r\n> Get Theme\r\n\r\n\r\n### `PATCH` /dms/order/quick_quotation\r\n\r\n> Update Quotation\r\n\r\n\r\n## What's Deleted\r\n\r\n\r\n### `POST` /dms/credit-approval\r\n\r\n> Get Credit Approval\r\n\r\n\r\n### `GET` /dms/workflow-status\r\n\r\n> Credit Approval status\r\n\r\n\r\n### `POST` /dms/credit-response\r\n\r\n> Mock Credit Approver Response\r\n\r\n\r\n### `GET` /dms/order/event\r\n\r\n> Get All Order Events\r\n\r\n\r\n### `POST` /dms/order/event\r\n\r\n> Create Order Events\r\n\r\n\r\n### `DELETE` /dms/order/event\r\n\r\n> Delete Order Events\r\n\r\n\r\n### `PATCH` /dms/order/event\r\n\r\n> Update Order Events\r\n\r\n\r\n### `GET` /dms/order/event/\r\n\r\n> Get Order Events\r\n\r\n\r\n### `DELETE` /dms/configure/appointment/{appointment_id}\r\n\r\n> Delete created appointment\r\n\r\n\r\n## What's Changed\r\n\r\n\r\n### `GET` /dms/address/history\r\n\r\n\r\n#### Parameters:\r\n\r\nChanged: `address_type` in `query`\r\n\r\n### `POST` /dms/customer/insurance-information\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Changed property `insurance_documents` (array)\r\n\r\n Changed items (object):\r\n\r\n New optional properties:\r\n - `document`\r\n\r\n * Added property `doucment_reference_id` (string)\r\n\r\n### `POST` /dms/customer/insurance-information/add-document\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\nNew optional properties:\r\n- `document`\r\n\r\n* Added property `doucment_reference_id` (string)\r\n\r\n### `POST` /dms/customer/license-verification\r\n\r\n\r\n### `GET` /dms/order/order-checklist\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n Changed items (object):\r\n\r\n * Added property `changed_by` (string)\r\n\r\n * Added property `changed_at` (string)\r\n\r\n### `POST` /dms/order/order-checklist\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n Changed items (object):\r\n\r\n * Added property `changed_by` (string)\r\n\r\n * Added property `changed_at` (string)\r\n\r\n### `PATCH` /dms/order/order-checklist\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\nChanged items (object):\r\n\r\nNew optional properties:\r\n- `updated_by`\r\n\r\n* Added property `updated_at` (string)\r\n\r\n* Added property `changed_by` (string)\r\n\r\n* Added property `changed_at` (string)\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n Changed items (object):\r\n\r\n * Added property `changed_by` (string)\r\n\r\n * Added property `changed_at` (string)\r\n\r\n### `GET` /dms/configure/quick-quotation-by-identifier/{identifier}\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `external_order_id` (string)\r\n\r\n * Added property `status` (string)\r\n\r\n * Added property `created_by` (string)\r\n\r\n * Added property `assets` (array)\r\n\r\n Items (object):\r\n\r\n * Property `vin` (string)\r\n\r\n * Property `make` (string)\r\n\r\n * Property `model` (string)\r\n\r\n * Property `trim` (string)\r\n\r\n * Property `year` (string)\r\n\r\n * Property `stock_number` (string)\r\n\r\n * Property `asset_image` (array)\r\n\r\n Items (string):\r\n\r\n * Property `asset_type` (string)\r\n\r\n * Changed property `customer` (object)\r\n\r\n * Added property `reference_id` (string)\r\n\r\n### `GET` /dms/configure/quick-quotation-by-vendor\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n Changed items (object):\r\n\r\n * Added property `external_order_id` (string)\r\n\r\n * Added property `status` (string)\r\n\r\n * Added property `created_by` (string)\r\n\r\n * Added property `assets` (array)\r\n\r\n * Changed property `customer` (object)\r\n\r\n * Added property `reference_id` (string)\r\n\r\n### `GET` /dms/configure/workqueue/search\r\n\r\n\r\n#### Parameters:\r\n\r\nAdded: `customer_reference_id` in `query`\r\n\r\n### `POST` /dms/customer/document\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Added property `comment` (string)\r\n\r\n### `PATCH` /dms/customer/document\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Added property `document_reference_id` (string)\r\n\r\n### `GET` /dms/customer/document/status\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `result` (array)\r\n\r\n Items (object):\r\n\r\n * Property `customer_reference_id` (string)\r\n\r\n * Property `external_reference_id` (string)\r\n\r\n * Property `document_type` (string)\r\n\r\n * Property `comment` (string)\r\n\r\n * Property `category` (string)\r\n\r\n * Property `document_name` (string)\r\n\r\n * Property `document_size` (string)\r\n\r\n * Property `document_url` (string)\r\n\r\n * Property `reason_by_system` (string)\r\n\r\n * Property `reason_for_customer` (string)\r\n\r\n * Property `document_status` (string)\r\n\r\n * Property `document_upload_indicator` (boolean)\r\n\r\n * Property `expires_at` (string)\r\n > format: YYYY-MM-DD hh:mm:ss\r\n\r\n\r\n * Property `created_at` (string)\r\n > format: YYYY-MM-DD hh:mm:ss\r\n\r\n\r\n * Property `updated_at` (string)\r\n > format: YYYY-MM-DD hh:mm:ss\r\n\r\n\r\n * Property `deleted_at` (string)\r\n > format: YYYY-MM-DD hh:mm:ss\r\n\r\n\r\n * Property `updated_by` (string)\r\n\r\n * Property `created_by` (string)\r\n\r\n * Property `deleted_by` (string)\r\n\r\n * Property `uploaded_by` (string)\r\n\r\n * Property `uploaded_at` (string)\r\n\r\n * Property `is_deleted` (boolean)\r\n\r\n * Property `identifier` (string)\r\n\r\n * Property `stipulation_code` (string)\r\n\r\n * Property `document_reviews` (array)\r\n\r\n Items (object):\r\n\r\n * Property `reviewed_by` (string)\r\n\r\n * Property `review_date_time` (string)\r\n > format: YYYY-MM-DD hh:mm:ss\r\n\r\n\r\n * Property `review_status` (string)\r\n\r\n * Property `review_notes` (string)\r\n\r\n * Property `reason` (array)\r\n\r\n Items (string):\r\n\r\n * Property `other_reason` (string)\r\n\r\n * Property `identifier` (string)\r\n\r\n * Added property `page_number` (integer)\r\n\r\n * Added property `page_size` (integer)\r\n\r\n * Added property `total_pages` (integer)\r\n\r\n * Added property `total_results` (integer)\r\n\r\n * Deleted property `customer_reference_id` (string)\r\n\r\n * Deleted property `external_reference_id` (string)\r\n\r\n * Deleted property `document_type` (string)\r\n\r\n * Deleted property `comment` (string)\r\n\r\n * Deleted property `category` (string)\r\n\r\n * Deleted property `document_name` (string)\r\n\r\n * Deleted property `document_size` (string)\r\n\r\n * Deleted property `document_url` (string)\r\n\r\n * Deleted property `reason_by_system` (string)\r\n\r\n * Deleted property `reason_for_customer` (string)\r\n\r\n * Deleted property `document_status` (string)\r\n\r\n * Deleted property `document_upload_indicator` (boolean)\r\n\r\n * Deleted property `expires_at` (string)\r\n > format: YYYY-MM-DD hh:mm:ss\r\n\r\n\r\n * Deleted property `created_at` (string)\r\n > format: YYYY-MM-DD hh:mm:ss\r\n\r\n\r\n * Deleted property `updated_at` (string)\r\n > format: YYYY-MM-DD hh:mm:ss\r\n\r\n\r\n * Deleted property `deleted_at` (string)\r\n > format: YYYY-MM-DD hh:mm:ss\r\n\r\n\r\n * Deleted property `updated_by` (string)\r\n\r\n * Deleted property `created_by` (string)\r\n\r\n * Deleted property `deleted_by` (string)\r\n\r\n * Deleted property `uploaded_by` (string)\r\n\r\n * Deleted property `uploaded_at` (string)\r\n\r\n * Deleted property `is_deleted` (boolean)\r\n\r\n * Deleted property `identifier` (string)\r\n\r\n * Deleted property `stipulation_code` (string)\r\n\r\n### `POST` /dms/customer/document/signature-document\r\n\r\n\r\n### `POST` /dms/customer/additional-document\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\nNew optional properties:\r\n- `external_reference_id`\r\n\r\n* Added property `document_reference_id` (string)\r\n\r\n### `GET` /dms/contracts/search\r\n\r\n\r\n#### Parameters:\r\n\r\nAdded: `subscription_start_date_from` in `query`\r\n> Format: YYYY-MM-DDTHH:MM:SS\r\n\r\n\r\nAdded: `subscription_start_date_to` in `query`\r\n> Format: YYYY-MM-DDTHH:MM:SS\r\n\r\n\r\nAdded: `subscription_end_date_from` in `query`\r\n> Format: YYYY-MM-DDTHH:MM:SS\r\n\r\n\r\nAdded: `subscription_end_date_to` in `query`\r\n> Format: YYYY-MM-DDTHH:MM:SS\r\n\r\n\r\nChanged: `subscription_start_date` in `query`\r\n> Format: YYYY-MM-DDTHH:MM:SS\r\n\r\n\r\nChanged: `subscription_end_date` in `query`\r\n> Format: YYYY-MM-DDTHH:MM:SS\r\n\r\n\r\n### `GET` /dms/history\r\n\r\n\r\n#### Parameters:\r\n\r\nChanged: `module_type` in `query`\r\n> module\r\n\r\n\r\n### `GET` /dms/history-details\r\n\r\n\r\n#### Parameters:\r\n\r\nAdded: `order_reference_id` in `query`\r\n\r\nChanged: `module_type` in `query`\r\n\r\n### `GET` /dms/configure/quotation\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `id` (integer)\r\n\r\n * Added property `appointment_details` (object)\r\n\r\n * Property `id` (integer)\r\n\r\n * Property `order_id` (integer)\r\n\r\n * Property `dealer_id` (integer)\r\n\r\n * Property `customer_id` (integer)\r\n\r\n * Property `appointment_date` (string)\r\n\r\n * Property `appointment_type` (string)\r\n\r\n * Property `appointment_status` (string)\r\n\r\n * Property `comments` (string)\r\n\r\n * Property `address_id` (integer)\r\n\r\n * Property `dealer_code` (string)\r\n\r\n * Property `address_data` (object)\r\n\r\n * Property `address_line_1` (string)\r\n > Address line one\r\n\r\n\r\n * Property `address_line_2` (string)\r\n > Address line two\r\n\r\n\r\n * Property `state_name` (string)\r\n > Address state name\r\n\r\n\r\n * Property `zip_code` (string)\r\n > Zip code\r\n\r\n\r\n * Property `county` (string)\r\n > Address county\r\n\r\n\r\n * Property `city` (string)\r\n > Address city\r\n\r\n\r\n * Property `contact_number` (string)\r\n > Contact number\r\n\r\n\r\n * Property `verified` (boolean)\r\n > Is Address verified\r\n\r\n\r\n * Property `move_in_date` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n * Property `is_garaging` (boolean)\r\n > Garaging flag\r\n\r\n\r\n * Property `address_type` (string)\r\n > An enumeration.\r\n\r\n\r\n Enum values:\r\n\r\n * `Mailing`\r\n * `Invoice`\r\n * `Office`\r\n * `Garaging`\r\n * `DealerAddress`\r\n * `DrivingLicense`\r\n * `Billing`\r\n * `InsuranceAddress`\r\n * `Residential`\r\n * `Employment`\r\n * Property `identifier` (string)\r\n\r\n * Property `id` (integer)\r\n\r\n * Property `created_by` (string)\r\n\r\n * Property `updated_by` (string)\r\n\r\n * Changed property `insurance` (object)\r\n\r\n * Changed property `insurance_documents` (array)\r\n\r\n Changed items (object):\r\n\r\n New optional properties:\r\n - `document`\r\n\r\n * Added property `doucment_reference_id` (string)\r\n\r\n### `GET` /dms/configure/all-quotations\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n Changed items (object):\r\n\r\n * Added property `id` (integer)\r\n\r\n * Added property `appointment_details` (object)\r\n\r\n * Changed property `insurance` (object)\r\n\r\n * Changed property `insurance_documents` (array)\r\n\r\n Changed items (object):\r\n\r\n New optional properties:\r\n - `document`\r\n\r\n * Added property `doucment_reference_id` (string)\r\n\r\n### `PATCH` /dms/configure/quotation/{identifier}\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Added property `id` (integer)\r\n\r\n* Added property `appointment_details` (object)\r\n\r\n* Changed property `insurance` (object)\r\n\r\n * Changed property `insurance_documents` (array)\r\n\r\n Changed items (object):\r\n\r\n New optional properties:\r\n - `document`\r\n\r\n * Added property `doucment_reference_id` (string)\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `id` (integer)\r\n\r\n * Added property `appointment_details` (object)\r\n\r\n * Changed property `insurance` (object)\r\n\r\n * Changed property `insurance_documents` (array)\r\n\r\n Changed items (object):\r\n\r\n New optional properties:\r\n - `document`\r\n\r\n * Added property `doucment_reference_id` (string)\r\n\r\n### `POST` /dms/configure/save-quotation\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\nChanged items (object):\r\n\r\n* Added property `id` (integer)\r\n\r\n* Added property `appointment_details` (object)\r\n\r\n* Changed property `insurance` (object)\r\n\r\n * Changed property `insurance_documents` (array)\r\n\r\n Changed items (object):\r\n\r\n New optional properties:\r\n - `document`\r\n\r\n * Added property `doucment_reference_id` (string)\r\n\r\n#### Return Type:\r\n\r\nChanged response : **201 Created**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n Changed items (object):\r\n\r\n * Added property `id` (integer)\r\n\r\n * Added property `appointment_details` (object)\r\n\r\n * Changed property `insurance` (object)\r\n\r\n * Changed property `insurance_documents` (array)\r\n\r\n Changed items (object):\r\n\r\n New optional properties:\r\n - `document`\r\n\r\n * Added property `doucment_reference_id` (string)\r\n\r\n### `PATCH` /dms/order/update-credit-approver-decision/{reference_number}\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `id` (integer)\r\n\r\n * Added property `appointment_details` (object)\r\n\r\n * Changed property `insurance` (object)\r\n\r\n * Changed property `insurance_documents` (array)\r\n\r\n Changed items (object):\r\n\r\n New optional properties:\r\n - `document`\r\n\r\n * Added property `doucment_reference_id` (string)\r\n\r\n### `PATCH` /dms/configure/quotation-to-order/{identifier}\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Added property `id` (integer)\r\n\r\n* Added property `appointment_details` (object)\r\n\r\n* Changed property `insurance` (object)\r\n\r\n * Changed property `insurance_documents` (array)\r\n\r\n Changed items (object):\r\n\r\n New optional properties:\r\n - `document`\r\n\r\n * Added property `doucment_reference_id` (string)\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `id` (integer)\r\n\r\n * Added property `appointment_details` (object)\r\n\r\n * Changed property `insurance` (object)\r\n\r\n * Changed property `insurance_documents` (array)\r\n\r\n Changed items (object):\r\n\r\n New optional properties:\r\n - `document`\r\n\r\n * Added property `doucment_reference_id` (string)\r\n\r\n### `POST` /dms/order/quick_quotation\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Changed property `quote_identifiers` (object)\r\n\r\n * Added property `reference_id` (string)\r\n\r\n* Changed property `quote_details` (object)\r\n\r\n * Added property `customer_reference_id` (string)\r\n\r\n * Added property `external_order_id` (string)\r\n\r\n * Added property `order_status` (string)\r\n\r\n * Added property `created_by` (string)\r\n\r\n * Added property `dealer_id` (string)\r\n\r\n * Added property `assets` (array)\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `external_order_id` (string)\r\n\r\n * Added property `status` (string)\r\n\r\n * Added property `created_by` (string)\r\n\r\n * Added property `assets` (array)\r\n\r\n * Changed property `customer` (object)\r\n\r\n * Added property `reference_id` (string)\r\n\r\n### `POST` /dms/configure/appointment\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\nNew optional properties:\r\n- `appointment_type`\r\n- `dealer_id`\r\n- `order_id`\r\n\r\n* Added property `appointment_status` (string)\r\n\r\n* Added property `comments` (string)\r\n\r\n* Added property `created_by` (string)\r\n\r\n* Added property `updated_by` (string)\r\n\r\n### `PATCH` /dms/configure/appointment\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\nNew required properties:\r\n- `appointment_date`\r\n\r\nNew optional properties:\r\n- `dealer_id`\r\n- `order_id`\r\n\r\n* Added property `appointment_status` (string)\r\n\r\n* Added property `comments` (string)\r\n\r\n* Added property `created_by` (string)\r\n\r\n* Added property `updated_by` (string)\r\n\r\n### `GET` /dms/customer/all-customers\r\n\r\n\r\n#### Parameters:\r\n\r\nChanged: `sort_by` in `query`\r\n\r\n### `POST` /dms/customer/all-customers-dynamic-search\r\n\r\n\r\n#### Parameters:\r\n\r\nChanged: `sort_by` in `query`\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\nChanged items (object):\r\n\r\n* Changed property `field` (string)\r\n > An enumeration.\r\n\r\n\r\n Added enum values:\r\n\r\n * `full_name`\r\n * `order_identifier`\r\n * `order_status`\r\n * `vin`\r\n### `GET` /dms/contract\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Deleted property `updated_start_date` (string)\r\n\r\n * Changed property `returns` (object)\r\n\r\n * Added property `noi_date` (string)\r\n\r\n * Added property `check_list_start_date` (string)\r\n\r\n * Added property `reason` (string)\r\n\r\n * Added property `reason_detail` (string)\r\n\r\n### `POST` /dms/contract\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **201 Created**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Deleted property `updated_start_date` (string)\r\n\r\n * Changed property `returns` (object)\r\n\r\n * Added property `noi_date` (string)\r\n\r\n * Added property `check_list_start_date` (string)\r\n\r\n * Added property `reason` (string)\r\n\r\n * Added property `reason_detail` (string)\r\n\r\n### `PATCH` /dms/contract\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Added property `return_status` (string)\r\n\r\n* Added property `start_date` (string)\r\n\r\n* Deleted property `updated_start_date` (string)\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Deleted property `updated_start_date` (string)\r\n\r\n * Changed property `returns` (object)\r\n\r\n * Added property `noi_date` (string)\r\n\r\n * Added property `check_list_start_date` (string)\r\n\r\n * Added property `reason` (string)\r\n\r\n * Added property `reason_detail` (string)\r\n\r\n### `GET` /dms/order/order_information_for_submitted_order\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `result` (array)\r\n\r\n Changed items (object):\r\n\r\n * Changed property `order_info` (object)\r\n\r\n * Added property `id` (integer)\r\n\r\n * Added property `appointment_details` (object)\r\n\r\n * Changed property `insurance` (object)\r\n\r\n * Changed property `insurance_documents` (array)\r\n\r\n Changed items (object):\r\n\r\n New optional properties:\r\n - `document`\r\n\r\n * Added property `doucment_reference_id` (string)\r\n\r\n### `POST` /dms/credit-request\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Changed property `result` (array)\r\n\r\n Changed items (object):\r\n\r\n * Changed property `order_info` (object)\r\n\r\n * Added property `id` (integer)\r\n\r\n * Added property `appointment_details` (object)\r\n\r\n * Changed property `insurance` (object)\r\n\r\n * Changed property `insurance_documents` (array)\r\n\r\n Changed items (object):\r\n\r\n New optional properties:\r\n - `document`\r\n\r\n * Added property `doucment_reference_id` (string)\r\n\r\n### `GET` /dms/contract/all\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `result` (array)\r\n\r\n Changed items (object):\r\n\r\n * Deleted property `updated_start_date` (string)\r\n\r\n * Changed property `returns` (object)\r\n\r\n * Added property `noi_date` (string)\r\n\r\n * Added property `check_list_start_date` (string)\r\n\r\n * Added property `reason` (string)\r\n\r\n * Added property `reason_detail` (string)\r\n\r\n# API Docs Version 1.3.41\r\n --- \r\n\r\n## What's New\r\n\r\n\r\n### `GET` /dms/order/order-checklist-update-history\r\n\r\n> Get Order Checklist Update History\r\n\r\n\r\n### `PATCH` /dms/contract/past-due-webhook\r\n\r\n> Past due webhook\r\n\r\n\r\n### `GET` /dms/external-keys/all\r\n\r\n> Get Keys\r\n\r\n\r\n## What's Changed\r\n\r\n\r\n### `GET` /dms/order/order-checklist\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n Changed items (object):\r\n\r\n * Added property `created_by` (string)\r\n\r\n * Added property `updated_by` (string)\r\n\r\n * Added property `deleted_by` (string)\r\n\r\n * Added property `created_at` (string)\r\n\r\n * Added property `updated_at` (string)\r\n\r\n### `POST` /dms/order/order-checklist\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\nChanged items (object):\r\n\r\nNew required properties:\r\n- `created_by`\r\n\r\n* Added property `created_by` (string)\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n Changed items (object):\r\n\r\n * Added property `created_by` (string)\r\n\r\n * Added property `updated_by` (string)\r\n\r\n * Added property `deleted_by` (string)\r\n\r\n * Added property `created_at` (string)\r\n\r\n * Added property `updated_at` (string)\r\n\r\n### `PATCH` /dms/order/order-checklist\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\nChanged items (object):\r\n\r\nNew required properties:\r\n- `updated_by`\r\n\r\n* Added property `updated_by` (string)\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n Changed items (object):\r\n\r\n * Added property `created_by` (string)\r\n\r\n * Added property `updated_by` (string)\r\n\r\n * Added property `deleted_by` (string)\r\n\r\n * Added property `created_at` (string)\r\n\r\n * Added property `updated_at` (string)\r\n\r\n### `GET` /dms/contract\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `updated_start_date` (string)\r\n\r\n * Changed property `returns` (object)\r\n\r\n * Added property `dealer_comments` (string)\r\n\r\n### `POST` /dms/contract\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **201 Created**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `updated_start_date` (string)\r\n\r\n * Changed property `returns` (object)\r\n\r\n * Added property `dealer_comments` (string)\r\n\r\n### `PATCH` /dms/contract\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Added property `updated_start_date` (string)\r\n\r\n* Deleted property `start_date` (string)\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `updated_start_date` (string)\r\n\r\n * Changed property `returns` (object)\r\n\r\n * Added property `dealer_comments` (string)\r\n\r\n### `GET` /dms/contract/all\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `result` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `updated_start_date` (string)\r\n\r\n * Changed property `returns` (object)\r\n\r\n * Added property `dealer_comments` (string)\r\n\r\n# API Docs Version 1.3.40\r\n --- \r\n\r\n## What's New\r\n\r\n\r\n### `GET` /dms/address/history\r\n\r\n> Delete existing record of address\r\n\r\n\r\n### `GET` /dms/an-dealers\r\n\r\n> Get Dealers\r\n\r\n\r\n### `PATCH` /dms/configure/order-to-quotation/{identifier}/{reference_number}\r\n\r\n> Convert specific Order to Quotation\r\n\r\n\r\n### `POST` /dms/theme-builder\r\n\r\n> Post Theme Builder Record\r\n\r\n\r\n### `GET` /dms/theme-builder/{user_email}\r\n\r\n> Get theme by user email\r\n\r\n\r\n### `PATCH` /dms/theme-builder/{user_email}\r\n\r\n> Updates a theme builder record\r\n\r\n\r\n### `POST` /dms/customer/payment-information\r\n\r\n> Create customer payment information\r\n\r\n\r\n## What's Deleted\r\n\r\n\r\n### `POST` /dms/customer/payment-information/\r\n\r\n> Create customer payment information\r\n\r\n\r\n### `GET` /dms/customer/status-flag-hitsory\r\n\r\n> Get status flag history\r\n\r\n\r\n### `PATCH` /dms/configure/order-to-quotation/{identifier}\r\n\r\n> Convert specific Order to Quotation\r\n\r\n\r\n## What's Changed\r\n\r\n\r\n### `GET` /dms/customer/customer-history\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n Changed items (object):\r\n\r\n * Added property `customer_addresses` (array)\r\n\r\n Items (object):\r\n\r\n * Property `address_line_1` (string)\r\n > Address line one\r\n\r\n\r\n * Property `address_line_2` (string)\r\n > Address line two\r\n\r\n\r\n * Property `address_type` (string)\r\n > An enumeration.\r\n\r\n\r\n Enum values:\r\n\r\n * `Mailing`\r\n * `Invoice`\r\n * `Office`\r\n * `Garaging`\r\n * `DealerAddress`\r\n * `DrivingLicense`\r\n * `Billing`\r\n * `InsuranceAddress`\r\n * `Residential`\r\n * `Employment`\r\n * Property `city` (string)\r\n > Address city\r\n\r\n\r\n * Property `contact_number` (string)\r\n > Contact number\r\n\r\n\r\n * Property `county` (string)\r\n > Address county\r\n\r\n\r\n * Property `created_at` (string)\r\n\r\n * Property `created_by` (string)\r\n\r\n * Property `deleted_at` (string)\r\n\r\n * Property `deleted_by` (string)\r\n\r\n * Property `identifier` (string)\r\n\r\n * Property `is_garaging` (boolean)\r\n > Garaging flag\r\n\r\n\r\n * Property `move_in_date` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n * Property `state_name` (string)\r\n > Address state name\r\n\r\n\r\n * Property `updated_at` (string)\r\n\r\n * Property `updated_by` (string)\r\n\r\n * Property `verified` (boolean)\r\n > Is Address verified\r\n\r\n\r\n * Property `zip_code` (string)\r\n > Zip code\r\n\r\n\r\n * Added property `income_info` (object)\r\n\r\n * Property `annual_employment_income` (number)\r\n > Annual employment income\r\n\r\n\r\n * Property `annual_other_income` (number)\r\n > Annual other income\r\n\r\n\r\n * Property `created_at` (string)\r\n\r\n * Property `created_by` (string)\r\n\r\n * Property `deleted_at` (string)\r\n\r\n * Property `deleted_by` (string)\r\n\r\n * Property `employed_since` (string)\r\n > Employed since\r\n\r\n\r\n * Property `employment_type` (string)\r\n > Employment type\r\n\r\n\r\n * Property `name` (string)\r\n > Name\r\n\r\n\r\n * Property `occupation` (string)\r\n > Occupation\r\n\r\n\r\n * Property `phone` (string)\r\n > Phone\r\n\r\n\r\n * Property `source_of_other_income` (string)\r\n > Annual other income\r\n\r\n\r\n * Property `updated_at` (string)\r\n\r\n * Property `updated_by` (string)\r\n\r\n * Added property `license_info` (object)\r\n\r\n * Property `date_of_birth` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n * Property `expiry_date` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n * Property `first_name` (string)\r\n\r\n * Property `is_pdf_417` (boolean)\r\n\r\n * Property `is_selfie_verified` (boolean)\r\n\r\n * Property `issue_date` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n * Property `last_name` (string)\r\n\r\n * Property `license_number` (string)\r\n\r\n * Property `status` (string)\r\n\r\n * Added property `payments_info` (array)\r\n\r\n Items (object):\r\n\r\n * Property `Bank_name` (string)\r\n\r\n * Property `access_token` (string)\r\n\r\n * Property `account_id` (string)\r\n\r\n * Property `created_at` (string)\r\n\r\n * Property `created_by` (string)\r\n\r\n * Property `default` (boolean)\r\n\r\n * Property `deleted_at` (string)\r\n\r\n * Property `deleted_by` (string)\r\n\r\n * Property `last4` (integer)\r\n\r\n * Property `stripe_payment_method_id` (string)\r\n\r\n * Property `type` (string)\r\n\r\n * Property `updated_at` (string)\r\n\r\n * Property `updated_by` (string)\r\n\r\n### `PATCH` /dms/check-customer-by-email\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Deleted property `is_parent` (boolean)\r\n\r\n### `PATCH` /dms/delete-customer\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n### `PATCH` /dms/customer/license-info\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `address` (object)\r\n\r\n * Property `address_line_1` (string)\r\n > Address line one\r\n\r\n\r\n * Property `address_line_2` (string)\r\n > Address line two\r\n\r\n\r\n * Property `city` (string)\r\n > Address city\r\n\r\n\r\n * Property `contact_number` (string)\r\n > Contact number\r\n\r\n\r\n * Property `county` (string)\r\n > Address county\r\n\r\n\r\n * Property `is_garaging` (boolean)\r\n > Garaging flag\r\n\r\n\r\n * Property `move_in_date` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n * Property `state_name` (string)\r\n > Address state name\r\n\r\n\r\n * Property `verified` (boolean)\r\n > Is Address verified\r\n\r\n\r\n * Property `zip_code` (string)\r\n > Zip code\r\n\r\n\r\n### `GET` /dms/customer/license-info-history\r\n\r\n\r\n#### Parameters:\r\n\r\nAdded: `page_number` in `query`\r\n\r\nAdded: `page_size` in `query`\r\n\r\nChanged: `from_date` in `query`\r\n> Format: YYYY-MM-DD\r\n\r\n\r\nChanged: `to_date` in `query`\r\n> Format: YYYY-MM-DD\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n### `POST` /dms/customer/signature\r\n\r\n\r\n### `DELETE` /dms/customer/signature\r\n\r\n\r\n### `PATCH` /dms/customer/signature\r\n\r\n\r\n### `PATCH` /dms/customer/delete-signature\r\n\r\n\r\n### `GET` /dms/customer/insurance-information\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `is_verified` (boolean)\r\n\r\n * Added property `start_date` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n### `POST` /dms/customer/insurance-information\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Added property `is_verified` (boolean)\r\n\r\n* Added property `start_date` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **201 Created**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `is_verified` (boolean)\r\n\r\n * Added property `start_date` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n### `PATCH` /dms/customer/insurance-information\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Added property `is_verified` (boolean)\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `is_verified` (boolean)\r\n\r\n * Added property `start_date` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n### `GET` /dms/customer/insurance-information-by-customer\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `is_verified` (boolean)\r\n\r\n * Added property `start_date` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n### `GET` /dms/customer/insurance-information-by-order\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `is_verified` (boolean)\r\n\r\n * Added property `start_date` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n### `GET` /dms/customer/insurance-information/document-history\r\n\r\n> Get customer insurance information document history\r\n\r\n\r\n### `GET` /dms/configure/quick-quotation-by-identifier/{identifier}\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `comments` (string)\r\n\r\n * Added property `reference_number` (string)\r\n\r\n * Added property `vat_treatment` (string)\r\n\r\n### `GET` /dms/configure/quick-quotation-by-vendor\r\n\r\n\r\n#### Parameters:\r\n\r\nAdded: `reference_number` in `query`\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n Changed items (object):\r\n\r\n * Added property `comments` (string)\r\n\r\n * Added property `reference_number` (string)\r\n\r\n * Added property `vat_treatment` (string)\r\n\r\n### `GET` /dms/customer/document\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n Changed items (object):\r\n\r\n * Changed property `document_reviews` (array)\r\n\r\n Changed items (object):\r\n\r\n * Changed property `reason` (string -> array)\r\n\r\n### `DELETE` /dms/customer/document\r\n\r\n\r\n### `PATCH` /dms/customer/document\r\n\r\n\r\n### `GET` /dms/customer/document/status\r\n\r\n\r\n### `GET` /dms/customer/document/review\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n Changed items (object):\r\n\r\n * Changed property `reason` (string -> array)\r\n\r\n### `POST` /dms/customer/document/review\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Added property `other_reason` (string)\r\n\r\n* Added property `reason` (array)\r\n\r\n Items (string):\r\n\r\n#### Return Type:\r\n\r\nChanged response : **201 Created**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `reason` (string -> array)\r\n\r\n### `POST` /dms/customer/\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **201 Created**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Deleted property `is_parent` (boolean)\r\n\r\n### `DELETE` /dms/customer\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n### `GET` /dms/customer\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Deleted property `is_parent` (boolean)\r\n\r\n### `PATCH` /dms/customer\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Deleted property `is_parent` (boolean)\r\n\r\n### `GET` /dms/customer-by-email\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Deleted property `is_parent` (boolean)\r\n\r\n### `PATCH` /dms/customer/employment-info\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Added property `address` (object)\r\n\r\n * Property `address_line_1` (string)\r\n > Address line one\r\n\r\n\r\n * Property `address_line_2` (string)\r\n > Address line two\r\n\r\n\r\n * Property `address_type` (string)\r\n > An enumeration.\r\n\r\n\r\n * Property `city` (string)\r\n > Address city\r\n\r\n\r\n * Property `contact_number` (string)\r\n > Contact number\r\n\r\n\r\n * Property `county` (string)\r\n > Address county\r\n\r\n\r\n * Property `is_garaging` (boolean)\r\n > Garaging flag\r\n\r\n\r\n * Property `move_in_date` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n * Property `state_name` (string)\r\n > Address state name\r\n\r\n\r\n * Property `verified` (boolean)\r\n > Is Address verified\r\n\r\n\r\n * Property `zip_code` (string)\r\n > Zip code\r\n\r\n\r\n### `GET` /dms/customer/insurance-information-history\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `result` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `is_verified` (boolean)\r\n\r\n * Added property `start_date` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n### `GET` /dms/configure/quotation\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `insurance` (object)\r\n\r\n * Added property `is_verified` (boolean)\r\n\r\n * Added property `start_date` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n### `GET` /dms/configure/all-quotations\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n Changed items (object):\r\n\r\n * Changed property `insurance` (object)\r\n\r\n * Added property `is_verified` (boolean)\r\n\r\n * Added property `start_date` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n### `PATCH` /dms/configure/quotation/{identifier}\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Changed property `insurance` (object)\r\n\r\n * Added property `is_verified` (boolean)\r\n\r\n * Added property `start_date` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `insurance` (object)\r\n\r\n * Added property `is_verified` (boolean)\r\n\r\n * Added property `start_date` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n### `POST` /dms/configure/save-quotation\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\nChanged items (object):\r\n\r\n* Changed property `insurance` (object)\r\n\r\n * Added property `is_verified` (boolean)\r\n\r\n * Added property `start_date` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **201 Created**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n Changed items (object):\r\n\r\n * Changed property `insurance` (object)\r\n\r\n * Added property `is_verified` (boolean)\r\n\r\n * Added property `start_date` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n### `PATCH` /dms/order/update-credit-approver-decision/{reference_number}\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `insurance` (object)\r\n\r\n * Added property `is_verified` (boolean)\r\n\r\n * Added property `start_date` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n### `PATCH` /dms/configure/quotation-to-order/{identifier}\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Changed property `insurance` (object)\r\n\r\n * Added property `is_verified` (boolean)\r\n\r\n * Added property `start_date` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `insurance` (object)\r\n\r\n * Added property `is_verified` (boolean)\r\n\r\n * Added property `start_date` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n### `POST` /dms/order/quick_quotation\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Changed property `quote_details` (object)\r\n\r\n * Added property `comments` (string)\r\n\r\n * Added property `reference_number` (string)\r\n\r\n * Added property `vat_treatment` (string)\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `comments` (string)\r\n\r\n * Added property `reference_number` (string)\r\n\r\n * Added property `vat_treatment` (string)\r\n\r\n### `GET` /dms/customer/document-history\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `result` (array)\r\n\r\n Changed items (object):\r\n\r\n * Changed property `document_reviews` (array)\r\n\r\n Changed items (object):\r\n\r\n * Changed property `reason` (string -> array)\r\n\r\n### `GET` /dms/customer/all-customers\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `result` (array)\r\n\r\n Changed items (object):\r\n\r\n * Deleted property `is_parent` (boolean)\r\n\r\n### `POST` /dms/customer/all-customers-dynamic-search\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `result` (array)\r\n\r\n Changed items (object):\r\n\r\n * Deleted property `is_parent` (boolean)\r\n\r\n### `GET` /dms/contract\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `received_security_deposit` (integer)\r\n\r\n * Added property `starting_odometer` (integer)\r\n\r\n * Deleted property `recieved_security_deposit` (integer)\r\n\r\n * Changed property `returns` (object)\r\n\r\n * Changed property `et_fee` (string -> integer)\r\n\r\n * Changed property `customer` (object)\r\n\r\n * Deleted property `is_parent` (boolean)\r\n\r\n### `POST` /dms/contract\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Added property `starting_odometer` (integer)\r\n\r\n#### Return Type:\r\n\r\nChanged response : **201 Created**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `received_security_deposit` (integer)\r\n\r\n * Added property `starting_odometer` (integer)\r\n\r\n * Deleted property `recieved_security_deposit` (integer)\r\n\r\n * Changed property `returns` (object)\r\n\r\n * Changed property `et_fee` (string -> integer)\r\n\r\n * Changed property `customer` (object)\r\n\r\n * Deleted property `is_parent` (boolean)\r\n\r\n### `PATCH` /dms/contract\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Added property `starting_odometer` (integer)\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `received_security_deposit` (integer)\r\n\r\n * Added property `starting_odometer` (integer)\r\n\r\n * Deleted property `recieved_security_deposit` (integer)\r\n\r\n * Changed property `returns` (object)\r\n\r\n * Changed property `et_fee` (string -> integer)\r\n\r\n * Changed property `customer` (object)\r\n\r\n * Deleted property `is_parent` (boolean)\r\n\r\n### `GET` /dms/order/order_information_for_submitted_order\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `result` (array)\r\n\r\n Changed items (object):\r\n\r\n * Changed property `order_info` (object)\r\n\r\n * Changed property `insurance` (object)\r\n\r\n * Added property `is_verified` (boolean)\r\n\r\n * Added property `start_date` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n * Changed property `customer_info` (object)\r\n\r\n * Deleted property `is_parent` (boolean)\r\n\r\n### `POST` /dms/credit-request\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Changed property `result` (array)\r\n\r\n Changed items (object):\r\n\r\n * Changed property `order_info` (object)\r\n\r\n * Changed property `insurance` (object)\r\n\r\n * Added property `is_verified` (boolean)\r\n\r\n * Added property `start_date` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n * Changed property `customer_info` (object)\r\n\r\n * Deleted property `is_parent` (boolean)\r\n\r\n### `GET` /dms/contract/all\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `result` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `received_security_deposit` (integer)\r\n\r\n * Added property `starting_odometer` (integer)\r\n\r\n * Deleted property `recieved_security_deposit` (integer)\r\n\r\n * Changed property `returns` (object)\r\n\r\n * Changed property `et_fee` (string -> integer)\r\n\r\n * Changed property `customer` (object)\r\n\r\n * Deleted property `is_parent` (boolean)\r\n\r\n# API Docs Version 1.3.38\r\n---\r\n## What's New\r\n\r\n\r\n### `POST` /dms/customer/fraud-check\r\n\r\n> Creates personal finance information\r\n\r\n\r\n\r\n\r\n# API Docs Version 1.3.37\r\n---\r\n## What's New\r\n\r\n\r\n### `POST` /dms/customer/send-email-to-customer\r\n\r\n> send email to customer\r\n\r\n\r\n### `POST` /dms/customer/license-verification\r\n\r\n> License verification through MiTek\r\n\r\n\r\n### `GET` /dms/configure/all-quotation/{reference_number}\r\n\r\n> Get Specific quotation\r\n\r\n\r\n### `PATCH` /dms/configure/order-to-quotation/{identifier}\r\n\r\n> Convert specific Order to Quotation\r\n\r\n\r\n### `GET` /dms/order/order_information_for_submitted_order\r\n\r\n> Get order by order status\r\n\r\n\r\n### `GET` /dms/order/order_information/{reference_number}\r\n\r\n> Get order by order status\r\n\r\n\r\n### `GET` /dms/order/credit-decision\r\n\r\n> Get credit decision\r\n\r\n\r\n### `POST` /dms/order/credit-decision\r\n\r\n> Add credit decision\r\n\r\n\r\n### `PATCH` /dms/order/update-credit-approver-decision/{reference_number}\r\n\r\n> Update decision status after receiving decision from credit approver\r\n\r\n\r\n### `PATCH` /dms/order/update-payment-status/{reference_number}\r\n\r\n> Update Payment Status\r\n\r\n\r\n### `POST` /dms/order/order-verify-document/{identifier}\r\n\r\n> Verify Order Documents\r\n\r\n\r\n### `POST` /dms/order/upload-signed-document/{identifier}\r\n\r\n> Upload Signed Document\r\n\r\n\r\n### `PATCH` /dms/configure/quotation-to-order/{identifier}\r\n\r\n> Convert specific Quotation to Application\r\n\r\n\r\n### `GET` /dms/configure/quotation-by-customers\r\n\r\n> Get all orders of a customer\r\n\r\n\r\n### `GET` /dms/all-quotation-by-reference-number/\r\n\r\n> Get all quotations based on reference number\r\n\r\n\r\n### `POST` /dms/order/quick_quotation\r\n\r\n> Save Single Quotation\r\n\r\n\r\n### `GET` /dms/configure/quick-quotation-by-identifier/{identifier}\r\n\r\n> Get Specific quotation\r\n\r\n\r\n### `GET` /dms/configure/quick-quotation-by-vendor\r\n\r\n> Get all orders of a customer\r\n\r\n\r\n### `POST` /dms/quote/calculate-order\r\n\r\n> Calculate Quotation\r\n\r\n\r\n### `POST` /dms/quote/calculate-nfa\r\n\r\n> Calculate NFA [Net Financed Amount]\r\n\r\n\r\n### `POST` /dms/quote/calculation/V2\r\n\r\n> Calculate Rental\r\n\r\n\r\n### `POST` /dms/customer/document/signature-document\r\n\r\n> Customer Document Signature\r\n\r\n\r\n### `POST` /dms/credit-approval\r\n\r\n> Get Credit Approval\r\n\r\n\r\n### `GET` /dms/workflow-status\r\n\r\n> Credit Approval status\r\n\r\n\r\n### `POST` /dms/credit-request\r\n\r\n> Mock Credit Approver Request\r\n\r\n\r\n### `POST` /dms/credit-response\r\n\r\n> Mock Credit Approver Response\r\n\r\n\r\n### `GET` /dms/stipulation/fulfillment\r\n\r\n> Get All Stipulation Fulfillments\r\n\r\n\r\n### `POST` /dms/stipulation/fulfillment\r\n\r\n> Create Stipulation Fulfillment\r\n\r\n\r\n### `DELETE` /dms/stipulation/fulfillment\r\n\r\n> Delete Stipulation Fulfillments\r\n\r\n\r\n### `PATCH` /dms/stipulation/fulfillment\r\n\r\n> Delete Stipulation Fulfillments\r\n\r\n\r\n### `GET` /dms/stipulation/fulfillment/\r\n\r\n> Get Stipulation Fulfillments\r\n\r\n\r\n### `GET` /dms/order/event\r\n\r\n> Get All Order Events\r\n\r\n\r\n### `POST` /dms/order/event\r\n\r\n> Create Order Events\r\n\r\n\r\n### `DELETE` /dms/order/event\r\n\r\n> Delete Order Events\r\n\r\n\r\n### `PATCH` /dms/order/event\r\n\r\n> Update Order Events\r\n\r\n\r\n### `GET` /dms/order/event/\r\n\r\n> Get Order Events\r\n\r\n\r\n### `GET` /dms/request\r\n\r\n> Get Request\r\n\r\n\r\n### `POST` /dms/request\r\n\r\n> Create Request\r\n\r\n\r\n### `DELETE` /dms/request\r\n\r\n> Delete Request\r\n\r\n\r\n### `PATCH` /dms/request\r\n\r\n> Update Request\r\n\r\n\r\n### `GET` /dms/requests\r\n\r\n> Get All Requests\r\n\r\n\r\n### `GET` /dms/stipulation/financial\r\n\r\n> Get Financial Stipulation\r\n\r\n\r\n### `POST` /dms/stipulation/financial\r\n\r\n> Create Financial Stipulation\r\n\r\n\r\n### `GET` /dms/stipulation/stipulation-by-lender\r\n\r\n> Get Financial Stipulation\r\n\r\n\r\n### `GET` /dms/external-orders/all\r\n\r\n> Get External Orders\r\n\r\n\r\n### `POST` /dms/external-orders/push-deal\r\n\r\n> Push Deal to Third Party\r\n\r\n\r\n### `POST` /dms/configure/appointments\r\n\r\n> Get paginated list of Appointments\r\n\r\n\r\n### `PATCH` /dms/configure/appointment\r\n\r\n> Update an created appointment\r\n\r\n\r\n### `DELETE` /dms/configure/appointment/{appointment_id}\r\n\r\n> Delete created appointment\r\n\r\n\r\n## What's Deleted\r\n\r\n\r\n### `GET` /dms/configure/all-quotation\r\n\r\n> Get Specific quotation\r\n\r\n\r\n### `POST` /dms/configure/appointments/\r\n\r\n> Delete created appointment\r\n\r\n\r\n### `PATCH` /dms/configure/appointments/\r\n\r\n> Update an created appointment\r\n\r\n\r\n### `GET` /dms/referral-detail\r\n\r\n> Get all referral detail records\r\n\r\n\r\n### `GET` /dms/referral-detail/{ref_id}\r\n\r\n> Get referral by ID\r\n\r\n\r\n### `POST` /dms/referral\r\n\r\n> Creates referral detail\r\n\r\n\r\n### `PATCH` /dms/referral/{referral_detail_id}\r\n\r\n> Update referral detail\r\n\r\n\r\n### `DELETE` /dms/referral/{referral_id}\r\n\r\n> Delete referral detail\r\n\r\n\r\n### `GET` /dms/configure/appointments\r\n\r\n> Get paginated list of Appointments\r\n\r\n\r\n## What's Deprecated\r\n\r\n\r\n### `POST` /dms/quote/calculation\r\n\r\n> Calculate Quotation\r\n\r\n\r\n### `GET` /dms/customer/insurance-information-history\r\n\r\n> Get customer insurance information history\r\n\r\n\r\n## What's Changed\r\n\r\n\r\n### `GET` /dms/customer/customer-history\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n Changed items (object):\r\n\r\n New optional properties:\r\n - `email`\r\n\r\n * Changed property `email` (string -> string)\r\n\r\n### `PATCH` /dms/check-customer-by-email\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n New optional properties:\r\n - `email`\r\n\r\n * Added property `is_parent` (boolean)\r\n\r\n * Changed property `email` (string -> string)\r\n\r\n### `POST` /dms/customer/license-info\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Changed property `address` (object)\r\n\r\n * Added property `move_in_date` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n * Added property `is_garaging` (boolean)\r\n > Garaging flag\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **201 Created**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `address` (object)\r\n\r\n * Added property `move_in_date` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n * Added property `is_garaging` (boolean)\r\n > Garaging flag\r\n\r\n\r\n### `PATCH` /dms/customer/license-info\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Changed property `address` (object)\r\n\r\n * Added property `move_in_date` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n * Added property `is_garaging` (boolean)\r\n > Garaging flag\r\n\r\n\r\n### `GET` /dms/address\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n Changed items (object):\r\n\r\n * Added property `move_in_date` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n * Added property `is_garaging` (boolean)\r\n > Garaging flag\r\n\r\n\r\n * Changed property `address_type` (string)\r\n > An enumeration.\r\n\r\n\r\n Added enum value:\r\n\r\n * `Employment`\r\n### `POST` /dms/address\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Added property `move_in_date` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n* Added property `is_garaging` (boolean)\r\n > Garaging flag\r\n\r\n\r\n* Changed property `address_type` (string)\r\n > An enumeration.\r\n\r\n\r\n Added enum value:\r\n\r\n * `Employment`\r\n#### Return Type:\r\n\r\nChanged response : **201 Created**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `move_in_date` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n * Added property `is_garaging` (boolean)\r\n > Garaging flag\r\n\r\n\r\n * Changed property `address_type` (string)\r\n > An enumeration.\r\n\r\n\r\n Added enum value:\r\n\r\n * `Employment`\r\n### `DELETE` /dms/address\r\n\r\n\r\n#### Parameters:\r\n\r\nChanged: `address_type` in `query`\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n### `PATCH` /dms/address\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Added property `move_in_date` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n* Added property `is_garaging` (boolean)\r\n > Garaging flag\r\n\r\n\r\n* Changed property `address_type` (string)\r\n > An enumeration.\r\n\r\n\r\n Added enum value:\r\n\r\n * `Employment`\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `move_in_date` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n * Added property `is_garaging` (boolean)\r\n > Garaging flag\r\n\r\n\r\n * Changed property `address_type` (string)\r\n > An enumeration.\r\n\r\n\r\n Added enum value:\r\n\r\n * `Employment`\r\n### `GET` /dms/customer/insurance-information\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `insurer_address` (object)\r\n\r\n * Added property `move_in_date` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n * Added property `is_garaging` (boolean)\r\n > Garaging flag\r\n\r\n\r\n### `POST` /dms/customer/insurance-information\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Changed property `insurer_address` (object)\r\n\r\n * Added property `move_in_date` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n * Added property `is_garaging` (boolean)\r\n > Garaging flag\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **201 Created**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `insurer_address` (object)\r\n\r\n * Added property `move_in_date` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n * Added property `is_garaging` (boolean)\r\n > Garaging flag\r\n\r\n\r\n### `PATCH` /dms/customer/insurance-information\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Added property `start_date` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n* Changed property `insurer_address` (object)\r\n\r\n * Added property `move_in_date` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n * Added property `is_garaging` (boolean)\r\n > Garaging flag\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `insurer_address` (object)\r\n\r\n * Added property `move_in_date` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n * Added property `is_garaging` (boolean)\r\n > Garaging flag\r\n\r\n\r\n### `GET` /dms/customer/insurance-information-by-customer\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `insurer_address` (object)\r\n\r\n * Added property `move_in_date` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n * Added property `is_garaging` (boolean)\r\n > Garaging flag\r\n\r\n\r\n### `GET` /dms/customer/insurance-information-by-order\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `insurer_address` (object)\r\n\r\n * Added property `move_in_date` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n * Added property `is_garaging` (boolean)\r\n > Garaging flag\r\n\r\n\r\n### `POST` /dms/configure/order/tradein\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\nNew optional properties:\r\n- `condition`\r\n- `is_customer_titled`\r\n- `lender_address`\r\n- `lender_contact_number`\r\n- `lender_contract_number`\r\n- `lender_id`\r\n- `lender_name`\r\n- `loan_lease_balance`\r\n- `make`\r\n- `mileage`\r\n- `model`\r\n- `order_id`\r\n- `payment_type`\r\n- `payoff_amount`\r\n- `trade_in_amount`\r\n- `trim`\r\n- `vin`\r\n- `year`\r\n\r\n* Added property `asset_image` (array)\r\n\r\n Items (string):\r\n\r\n* Changed property `trade_in_amount` (integer -> number)\r\n\r\n* Changed property `payoff_amount` (integer -> number)\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n New optional properties:\r\n - `condition`\r\n - `identifier`\r\n - `is_customer_titled`\r\n - `lender_address`\r\n - `lender_contact_number`\r\n - `lender_contract_number`\r\n - `lender_id`\r\n - `lender_name`\r\n - `loan_lease_balance`\r\n - `make`\r\n - `mileage`\r\n - `model`\r\n - `order_id`\r\n - `payment_type`\r\n - `payoff_amount`\r\n - `trade_in_amount`\r\n - `trim`\r\n - `vin`\r\n - `year`\r\n\r\n * Added property `asset_image` (array)\r\n\r\n * Changed property `trade_in_amount` (integer -> number)\r\n\r\n * Changed property `payoff_amount` (integer -> number)\r\n\r\n### `GET` /dms/configure/order/tradein/{identifier}\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n New optional properties:\r\n - `condition`\r\n - `is_customer_titled`\r\n - `lender_address`\r\n - `lender_contact_number`\r\n - `lender_contract_number`\r\n - `lender_id`\r\n - `lender_name`\r\n - `loan_lease_balance`\r\n - `make`\r\n - `mileage`\r\n - `model`\r\n - `order_id`\r\n - `payment_type`\r\n - `payoff_amount`\r\n - `trade_in_amount`\r\n - `trim`\r\n - `vin`\r\n - `year`\r\n\r\n * Added property `asset_image` (array)\r\n\r\n * Changed property `trade_in_amount` (integer -> number)\r\n\r\n * Changed property `payoff_amount` (integer -> number)\r\n\r\n### `DELETE` /dms/configure/order/tradein/{identifier}\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n New optional properties:\r\n - `condition`\r\n - `is_customer_titled`\r\n - `lender_address`\r\n - `lender_contact_number`\r\n - `lender_contract_number`\r\n - `lender_id`\r\n - `lender_name`\r\n - `loan_lease_balance`\r\n - `make`\r\n - `mileage`\r\n - `model`\r\n - `order_id`\r\n - `payment_type`\r\n - `payoff_amount`\r\n - `trade_in_amount`\r\n - `trim`\r\n - `vin`\r\n - `year`\r\n\r\n * Added property `asset_image` (array)\r\n\r\n * Changed property `trade_in_amount` (integer -> number)\r\n\r\n * Changed property `payoff_amount` (integer -> number)\r\n\r\n### `PATCH` /dms/configure/order/tradein/{identifier}\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\nNew optional properties:\r\n- `condition`\r\n- `is_customer_titled`\r\n- `lender_address`\r\n- `lender_contact_number`\r\n- `lender_contract_number`\r\n- `lender_id`\r\n- `lender_name`\r\n- `loan_lease_balance`\r\n- `make`\r\n- `mileage`\r\n- `model`\r\n- `order_id`\r\n- `payment_type`\r\n- `payoff_amount`\r\n- `trade_in_amount`\r\n- `trim`\r\n- `vin`\r\n- `year`\r\n\r\n* Added property `asset_image` (array)\r\n\r\n* Changed property `trade_in_amount` (integer -> number)\r\n\r\n* Changed property `payoff_amount` (integer -> number)\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n New optional properties:\r\n - `condition`\r\n - `is_customer_titled`\r\n - `lender_address`\r\n - `lender_contact_number`\r\n - `lender_contract_number`\r\n - `lender_id`\r\n - `lender_name`\r\n - `loan_lease_balance`\r\n - `make`\r\n - `mileage`\r\n - `model`\r\n - `order_id`\r\n - `payment_type`\r\n - `payoff_amount`\r\n - `trade_in_amount`\r\n - `trim`\r\n - `vin`\r\n - `year`\r\n\r\n * Added property `asset_image` (array)\r\n\r\n * Changed property `trade_in_amount` (integer -> number)\r\n\r\n * Changed property `payoff_amount` (integer -> number)\r\n\r\n### `PATCH` /dms/configure/order/update-status/{order_id}\r\n\r\n> Update order status record by order reference number\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Added property `reason` (string)\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n### `POST` /dms/configure/order/status/\r\n\r\n> Update order status history record by order reference number\r\n\r\n\r\n### `GET` /dms/configure/order/status-by-dealer\r\n\r\n\r\n#### Parameters:\r\n\r\nAdded: `reference_number` in `query`\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n### `GET` /dms/configure/workqueue/search\r\n\r\n\r\n#### Parameters:\r\n\r\nAdded: `updated_at` in `query`\r\n\r\nAdded: `appointment_date` in `query`\r\n\r\nAdded: `reference_number` in `query`\r\n\r\nAdded: `multiple_order_status` in `query`\r\n\r\nAdded: `make_model_trim` in `query`\r\n\r\nAdded: `vehicle_condition` in `query`\r\n\r\nAdded: `reason` in `query`\r\n\r\nAdded: `selling_price` in `query`\r\n\r\nAdded: `dealer_email` in `query`\r\n\r\n### `POST` /dms/quote/calculation\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\nNew required properties:\r\n- `dealer_id`\r\n\r\n* Added property `asset_make_name` (string)\r\n > Asset make name\r\n\r\n\r\n* Added property `asset_model_name` (string)\r\n > Asset model name\r\n\r\n\r\n* Added property `asset_trim_name` (string)\r\n > Asset trim name\r\n\r\n\r\n* Deleted property `asset_make_id` (integer)\r\n > System Generated Asset Make Id\r\n\r\n\r\n* Deleted property `asset_model_id` (integer)\r\n > System Generated Asset Model Id\r\n\r\n\r\n* Deleted property `asset_trim_id` (integer)\r\n > System Generated Asset Trim Id\r\n\r\n\r\n* Changed property `terms` (integer -> string)\r\n > Terms\r\n\r\n\r\n* Changed property `dealer_id` (integer)\r\n > Dealer Id\r\n\r\n\r\n### `POST` /dms/configure/appointment\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\nNew required properties:\r\n- `appointment_type`\r\n\r\n* Added property `appointment_type` (string)\r\n\r\n* Added property `address_id` (integer)\r\n\r\n* Added property `dealer_code` (string)\r\n\r\n* Added property `address_data` (object)\r\n\r\n * Property `address_line_1` (string)\r\n > Address line one\r\n\r\n\r\n * Property `address_line_2` (string)\r\n > Address line two\r\n\r\n\r\n * Property `state_name` (string)\r\n > Address state name\r\n\r\n\r\n * Property `zip_code` (string)\r\n > Zip code\r\n\r\n\r\n * Property `county` (string)\r\n > Address county\r\n\r\n\r\n * Property `city` (string)\r\n > Address city\r\n\r\n\r\n * Property `contact_number` (string)\r\n > Contact number\r\n\r\n\r\n * Property `verified` (boolean)\r\n > Is Address verified\r\n\r\n\r\n * Property `move_in_date` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n * Property `is_garaging` (boolean)\r\n > Garaging flag\r\n\r\n\r\n * Property `address_type` (string)\r\n > An enumeration.\r\n\r\n\r\n Enum values:\r\n\r\n * `Mailing`\r\n * `Invoice`\r\n * `Office`\r\n * `Garaging`\r\n * `DealerAddress`\r\n * `DrivingLicense`\r\n * `Billing`\r\n * `InsuranceAddress`\r\n * `Residential`\r\n * `Employment`\r\n * Property `identifier` (string)\r\n\r\n * Property `id` (integer)\r\n\r\n### `POST` /dms/email/\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Added property `dealer_id` (integer)\r\n\r\n* Added property `dealer_code` (string)\r\n\r\n### `GET` /dms/customer/document\r\n\r\n\r\n#### Parameters:\r\n\r\nAdded: `stipulation_code` in `query`\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n Changed items (object):\r\n\r\n * Added property `document_size` (string)\r\n\r\n * Added property `uploaded_at` (string)\r\n\r\n * Added property `stipulation_code` (string)\r\n\r\n * Changed property `document_reviews` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `reason` (string)\r\n\r\n * Added property `other_reason` (string)\r\n\r\n### `POST` /dms/customer/document\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Added property `stipulation_code` (string)\r\n\r\n#### Return Type:\r\n\r\nChanged response : **201 Created**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `document_size` (string)\r\n\r\n * Added property `uploaded_at` (string)\r\n\r\n * Added property `stipulation_code` (string)\r\n\r\n### `PATCH` /dms/customer/document\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Added property `document_name` (string)\r\n\r\n* Added property `document_size` (string)\r\n\r\n* Added property `uploaded_at` (string)\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `document_size` (string)\r\n\r\n * Added property `uploaded_at` (string)\r\n\r\n * Added property `stipulation_code` (string)\r\n\r\n### `GET` /dms/customer/document/status\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `document_size` (string)\r\n\r\n * Added property `uploaded_at` (string)\r\n\r\n * Added property `stipulation_code` (string)\r\n\r\n### `PATCH` /dms/customer/document/status\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `document_size` (string)\r\n\r\n * Added property `uploaded_at` (string)\r\n\r\n * Added property `stipulation_code` (string)\r\n\r\n### `PATCH` /dms/customer/delete-document\r\n\r\n> Delete customer document by identifier\r\n\r\n\r\n### `GET` /dms/customer/document/review\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n Changed items (object):\r\n\r\n * Added property `reason` (string)\r\n\r\n * Added property `other_reason` (string)\r\n\r\n### `POST` /dms/customer/document/review\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **201 Created**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `reason` (string)\r\n\r\n * Added property `other_reason` (string)\r\n\r\n### `PATCH` /dms/customer/document/uploading-status\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `document_size` (string)\r\n\r\n * Added property `uploaded_at` (string)\r\n\r\n * Added property `stipulation_code` (string)\r\n\r\n### `POST` /dms/customer/additional-document\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Added property `uploaded_at` (string)\r\n\r\n#### Return Type:\r\n\r\nChanged response : **201 Created**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `document_size` (string)\r\n\r\n * Added property `uploaded_at` (string)\r\n\r\n * Added property `stipulation_code` (string)\r\n\r\n### `PATCH` /dms/configure/metadata\r\n\r\n> Add Meta Data\r\n\r\n\r\n### `GET` /dms/contracts\r\n\r\n> Get contracts by external order ids\r\n\r\n\r\n### `GET` /dms/contracts/search\r\n\r\n> Get contracts by external order ids\r\n\r\n\r\n### `POST` /dms/customer/\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Changed property `customer_addresses` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `move_in_date` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n * Added property `is_garaging` (boolean)\r\n > Garaging flag\r\n\r\n\r\n * Changed property `address_type` (string)\r\n > An enumeration.\r\n\r\n\r\n Added enum value:\r\n\r\n * `Employment`\r\n#### Return Type:\r\n\r\nChanged response : **201 Created**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `license_info` (object)\r\n\r\n * Added property `date_of_birth` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n * Changed property `customer_addresses` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `move_in_date` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n * Added property `is_garaging` (boolean)\r\n > Garaging flag\r\n\r\n\r\n * Changed property `address_type` (string)\r\n > An enumeration.\r\n\r\n\r\n Added enum value:\r\n\r\n * `Employment`\r\n### `GET` /dms/customer\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n New optional properties:\r\n - `email`\r\n\r\n * Added property `is_parent` (boolean)\r\n\r\n * Changed property `email` (string -> string)\r\n\r\n * Changed property `license_info` (object)\r\n\r\n * Added property `date_of_birth` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n * Changed property `customer_addresses` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `move_in_date` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n * Added property `is_garaging` (boolean)\r\n > Garaging flag\r\n\r\n\r\n * Changed property `address_type` (string)\r\n > An enumeration.\r\n\r\n\r\n Added enum value:\r\n\r\n * `Employment`\r\n### `PATCH` /dms/customer\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Changed property `customer_addresses` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `move_in_date` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n * Added property `is_garaging` (boolean)\r\n > Garaging flag\r\n\r\n\r\n * Changed property `address_type` (string)\r\n > An enumeration.\r\n\r\n\r\n Added enum value:\r\n\r\n * `Employment`\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `license_info` (object)\r\n\r\n * Added property `date_of_birth` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n * Changed property `customer_addresses` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `move_in_date` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n * Added property `is_garaging` (boolean)\r\n > Garaging flag\r\n\r\n\r\n * Changed property `address_type` (string)\r\n > An enumeration.\r\n\r\n\r\n Added enum value:\r\n\r\n * `Employment`\r\n### `GET` /dms/customer-by-email\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `license_info` (object)\r\n\r\n * Added property `date_of_birth` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n * Changed property `customer_addresses` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `move_in_date` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n * Added property `is_garaging` (boolean)\r\n > Garaging flag\r\n\r\n\r\n * Changed property `address_type` (string)\r\n > An enumeration.\r\n\r\n\r\n Added enum value:\r\n\r\n * `Employment`\r\n### `GET` /dms/customer/employment-info\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `address` (object)\r\n\r\n * Added property `move_in_date` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n * Added property `is_garaging` (boolean)\r\n > Garaging flag\r\n\r\n\r\n * Changed property `address_type` (string)\r\n > An enumeration.\r\n\r\n\r\n Added enum value:\r\n\r\n * `Employment`\r\n### `POST` /dms/customer/employment-info\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Changed property `address` (object)\r\n\r\n * Added property `move_in_date` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n * Added property `is_garaging` (boolean)\r\n > Garaging flag\r\n\r\n\r\n * Changed property `address_type` (string)\r\n > An enumeration.\r\n\r\n\r\n Added enum value:\r\n\r\n * `Employment`\r\n#### Return Type:\r\n\r\nChanged response : **201 Created**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `address` (object)\r\n\r\n * Added property `move_in_date` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n * Added property `is_garaging` (boolean)\r\n > Garaging flag\r\n\r\n\r\n * Changed property `address_type` (string)\r\n > An enumeration.\r\n\r\n\r\n Added enum value:\r\n\r\n * `Employment`\r\n### `PATCH` /dms/customer/employment-info\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `address` (object)\r\n\r\n * Added property `move_in_date` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n * Added property `is_garaging` (boolean)\r\n > Garaging flag\r\n\r\n\r\n * Changed property `address_type` (string)\r\n > An enumeration.\r\n\r\n\r\n Added enum value:\r\n\r\n * `Employment`\r\n### `GET` /dms/customer/insurance-information-history\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `result` (array)\r\n\r\n Changed items (object):\r\n\r\n * Changed property `insurer_address` (object)\r\n\r\n * Added property `move_in_date` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n * Added property `is_garaging` (boolean)\r\n > Garaging flag\r\n\r\n\r\n### `GET` /dms/configure/quotation\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n New required properties:\r\n - `down_payment_lease`\r\n\r\n * Added property `down_payment_lease` (number)\r\n\r\n * Added property `schedule_option` (string)\r\n\r\n * Added property `asset_usage` (string)\r\n\r\n * Added property `calcuation_method` (string)\r\n\r\n * Added property `order_stage` (string)\r\n\r\n * Added property `insurance` (object)\r\n\r\n * Property `order_reference_id` (string)\r\n\r\n * Property `reference_id` (string)\r\n\r\n * Property `insurer_name` (string)\r\n\r\n * Property `agent_phone` (string)\r\n\r\n * Property `subscription_id` (string)\r\n\r\n * Property `agent_name` (string)\r\n\r\n * Property `policy_number` (string)\r\n\r\n * Property `expiration_date` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n * Property `deductible_comprehensive` (number)\r\n\r\n * Property `deductible_collision` (number)\r\n\r\n * Property `created_by` (string)\r\n\r\n * Property `identifier` (string)\r\n\r\n * Property `insurance_documents` (array)\r\n\r\n Items (object):\r\n\r\n * Property `document` (string)\r\n\r\n * Property `content_type` (string)\r\n > format: application/pdf, image/png\r\n\r\n\r\n * Property `name` (string)\r\n\r\n * Property `file_size` (string)\r\n\r\n * Property `created_by` (string)\r\n\r\n * Property `insurer_address` (object)\r\n\r\n * Property `address_line_1` (string)\r\n > Address line one\r\n\r\n\r\n * Property `address_line_2` (string)\r\n > Address line two\r\n\r\n\r\n * Property `state_name` (string)\r\n > Address state name\r\n\r\n\r\n * Property `zip_code` (string)\r\n > Zip code\r\n\r\n\r\n * Property `county` (string)\r\n > Address county\r\n\r\n\r\n * Property `city` (string)\r\n > Address city\r\n\r\n\r\n * Property `contact_number` (string)\r\n > Contact number\r\n\r\n\r\n * Property `verified` (boolean)\r\n > Is Address verified\r\n\r\n\r\n * Property `move_in_date` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n * Property `is_garaging` (boolean)\r\n > Garaging flag\r\n\r\n\r\n * Property `identifier` (string)\r\n\r\n * Added property `rental_mode` (string)\r\n\r\n * Added property `rental_frequency` (string)\r\n\r\n * Changed property `order_options` (array)\r\n\r\n Changed items (object -> object):\r\n\r\n * Changed property `order_fnI` (array)\r\n\r\n Changed items (object -> object):\r\n\r\n * Changed property `order_asset` (object)\r\n\r\n * Added property `vin` (string)\r\n\r\n * Changed property `order_tradein` (object)\r\n\r\n New optional properties:\r\n - `condition`\r\n - `is_customer_titled`\r\n - `lender_address`\r\n - `lender_contact_number`\r\n - `lender_contract_number`\r\n - `lender_name`\r\n - `loan_lease_balance`\r\n - `make`\r\n - `mileage`\r\n - `model`\r\n - `payment_type`\r\n - `payoff_amount`\r\n - `trade_in_amount`\r\n - `trim`\r\n - `vin`\r\n - `year`\r\n\r\n * Added property `lender_id` (integer)\r\n > DealerTradeIn lender id\r\n\r\n\r\n * Added property `asset_image` (array)\r\n\r\n * Changed property `trade_in_amount` (integer -> number)\r\n\r\n * Changed property `payoff_amount` (integer -> number)\r\n\r\n### `GET` /dms/configure/all-quotations\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n Changed items (object):\r\n\r\n New required properties:\r\n - `down_payment_lease`\r\n\r\n * Added property `down_payment_lease` (number)\r\n\r\n * Added property `schedule_option` (string)\r\n\r\n * Added property `asset_usage` (string)\r\n\r\n * Added property `calcuation_method` (string)\r\n\r\n * Added property `order_stage` (string)\r\n\r\n * Added property `insurance` (object)\r\n\r\n * Added property `rental_mode` (string)\r\n\r\n * Added property `rental_frequency` (string)\r\n\r\n * Changed property `order_options` (array)\r\n\r\n Changed items (object -> object):\r\n\r\n * Changed property `order_fnI` (array)\r\n\r\n Changed items (object -> object):\r\n\r\n * Changed property `order_asset` (object)\r\n\r\n * Added property `vin` (string)\r\n\r\n * Changed property `order_tradein` (object)\r\n\r\n New optional properties:\r\n - `condition`\r\n - `is_customer_titled`\r\n - `lender_address`\r\n - `lender_contact_number`\r\n - `lender_contract_number`\r\n - `lender_name`\r\n - `loan_lease_balance`\r\n - `make`\r\n - `mileage`\r\n - `model`\r\n - `payment_type`\r\n - `payoff_amount`\r\n - `trade_in_amount`\r\n - `trim`\r\n - `vin`\r\n - `year`\r\n\r\n * Added property `lender_id` (integer)\r\n > DealerTradeIn lender id\r\n\r\n\r\n * Added property `asset_image` (array)\r\n\r\n * Changed property `trade_in_amount` (integer -> number)\r\n\r\n * Changed property `payoff_amount` (integer -> number)\r\n\r\n### `PATCH` /dms/configure/quotation/{identifier}\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\nNew required properties:\r\n- `down_payment_lease`\r\n\r\n* Added property `down_payment_lease` (number)\r\n\r\n* Added property `schedule_option` (string)\r\n\r\n* Added property `asset_usage` (string)\r\n\r\n* Added property `calcuation_method` (string)\r\n\r\n* Added property `order_stage` (string)\r\n\r\n* Added property `insurance` (object)\r\n\r\n* Added property `rental_mode` (string)\r\n\r\n* Added property `rental_frequency` (string)\r\n\r\n* Changed property `order_options` (array)\r\n\r\n Changed items (object -> object):\r\n\r\n* Changed property `order_fnI` (array)\r\n\r\n Changed items (object -> object):\r\n\r\n* Changed property `order_asset` (object)\r\n\r\n * Added property `vin` (string)\r\n\r\n* Changed property `order_tradein` (object)\r\n\r\n New optional properties:\r\n - `condition`\r\n - `is_customer_titled`\r\n - `lender_address`\r\n - `lender_contact_number`\r\n - `lender_contract_number`\r\n - `lender_name`\r\n - `loan_lease_balance`\r\n - `make`\r\n - `mileage`\r\n - `model`\r\n - `payment_type`\r\n - `payoff_amount`\r\n - `trade_in_amount`\r\n - `trim`\r\n - `vin`\r\n - `year`\r\n\r\n * Added property `lender_id` (integer)\r\n > DealerTradeIn lender id\r\n\r\n\r\n * Added property `asset_image` (array)\r\n\r\n * Changed property `trade_in_amount` (integer -> number)\r\n\r\n * Changed property `payoff_amount` (integer -> number)\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n New required properties:\r\n - `down_payment_lease`\r\n - `identifier`\r\n\r\n * Added property `down_payment_lease` (number)\r\n\r\n * Added property `schedule_option` (string)\r\n\r\n * Added property `asset_usage` (string)\r\n\r\n * Added property `calcuation_method` (string)\r\n\r\n * Added property `order_stage` (string)\r\n\r\n * Added property `insurance` (object)\r\n\r\n * Added property `rental_mode` (string)\r\n\r\n * Added property `rental_frequency` (string)\r\n\r\n * Added property `identifier` (string)\r\n\r\n * Changed property `order_options` (array)\r\n\r\n Changed items (object -> object):\r\n\r\n * Changed property `order_fnI` (array)\r\n\r\n Changed items (object -> object):\r\n\r\n * Changed property `order_asset` (object)\r\n\r\n * Added property `vin` (string)\r\n\r\n * Changed property `order_tradein` (object)\r\n\r\n New optional properties:\r\n - `condition`\r\n - `is_customer_titled`\r\n - `lender_address`\r\n - `lender_contact_number`\r\n - `lender_contract_number`\r\n - `lender_name`\r\n - `loan_lease_balance`\r\n - `make`\r\n - `mileage`\r\n - `model`\r\n - `payment_type`\r\n - `payoff_amount`\r\n - `trade_in_amount`\r\n - `trim`\r\n - `vin`\r\n - `year`\r\n\r\n * Added property `lender_id` (integer)\r\n > DealerTradeIn lender id\r\n\r\n\r\n * Added property `asset_image` (array)\r\n\r\n * Changed property `trade_in_amount` (integer -> number)\r\n\r\n * Changed property `payoff_amount` (integer -> number)\r\n\r\n### `POST` /dms/configure/save-quotation\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\nChanged items (object):\r\n\r\nNew required properties:\r\n- `down_payment_lease`\r\n\r\n* Added property `down_payment_lease` (number)\r\n\r\n* Added property `schedule_option` (string)\r\n\r\n* Added property `asset_usage` (string)\r\n\r\n* Added property `calcuation_method` (string)\r\n\r\n* Added property `order_stage` (string)\r\n\r\n* Added property `insurance` (object)\r\n\r\n* Added property `rental_mode` (string)\r\n\r\n* Added property `rental_frequency` (string)\r\n\r\n* Changed property `order_options` (array)\r\n\r\n Changed items (object -> object):\r\n\r\n* Changed property `order_fnI` (array)\r\n\r\n Changed items (object -> object):\r\n\r\n* Changed property `order_asset` (object)\r\n\r\n * Added property `vin` (string)\r\n\r\n* Changed property `order_tradein` (object)\r\n\r\n New optional properties:\r\n - `condition`\r\n - `is_customer_titled`\r\n - `lender_address`\r\n - `lender_contact_number`\r\n - `lender_contract_number`\r\n - `lender_name`\r\n - `loan_lease_balance`\r\n - `make`\r\n - `mileage`\r\n - `model`\r\n - `payment_type`\r\n - `payoff_amount`\r\n - `trade_in_amount`\r\n - `trim`\r\n - `vin`\r\n - `year`\r\n\r\n * Added property `lender_id` (integer)\r\n > DealerTradeIn lender id\r\n\r\n\r\n * Added property `asset_image` (array)\r\n\r\n * Changed property `trade_in_amount` (integer -> number)\r\n\r\n * Changed property `payoff_amount` (integer -> number)\r\n\r\n#### Return Type:\r\n\r\nChanged response : **201 Created**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n Changed items (object):\r\n\r\n New required properties:\r\n - `down_payment_lease`\r\n\r\n * Added property `down_payment_lease` (number)\r\n\r\n * Added property `schedule_option` (string)\r\n\r\n * Added property `asset_usage` (string)\r\n\r\n * Added property `calcuation_method` (string)\r\n\r\n * Added property `order_stage` (string)\r\n\r\n * Added property `insurance` (object)\r\n\r\n * Added property `rental_mode` (string)\r\n\r\n * Added property `rental_frequency` (string)\r\n\r\n * Changed property `order_options` (array)\r\n\r\n Changed items (object -> object):\r\n\r\n * Changed property `order_fnI` (array)\r\n\r\n Changed items (object -> object):\r\n\r\n * Changed property `order_asset` (object)\r\n\r\n * Added property `vin` (string)\r\n\r\n * Changed property `order_tradein` (object)\r\n\r\n New optional properties:\r\n - `condition`\r\n - `is_customer_titled`\r\n - `lender_address`\r\n - `lender_contact_number`\r\n - `lender_contract_number`\r\n - `lender_name`\r\n - `loan_lease_balance`\r\n - `make`\r\n - `mileage`\r\n - `model`\r\n - `payment_type`\r\n - `payoff_amount`\r\n - `trade_in_amount`\r\n - `trim`\r\n - `vin`\r\n - `year`\r\n\r\n * Added property `lender_id` (integer)\r\n > DealerTradeIn lender id\r\n\r\n\r\n * Added property `asset_image` (array)\r\n\r\n * Changed property `trade_in_amount` (integer -> number)\r\n\r\n * Changed property `payoff_amount` (integer -> number)\r\n\r\n### `GET` /dms/customer/document-history\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `result` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `document_size` (string)\r\n\r\n * Added property `uploaded_at` (string)\r\n\r\n * Added property `stipulation_code` (string)\r\n\r\n * Changed property `document_reviews` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `reason` (string)\r\n\r\n * Added property `other_reason` (string)\r\n\r\n### `GET` /dms/customer/all-customers\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `result` (array)\r\n\r\n Changed items (object):\r\n\r\n * Changed property `license_info` (object)\r\n\r\n * Added property `date_of_birth` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n * Changed property `customer_addresses` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `move_in_date` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n * Added property `is_garaging` (boolean)\r\n > Garaging flag\r\n\r\n\r\n * Changed property `address_type` (string)\r\n > An enumeration.\r\n\r\n\r\n Added enum value:\r\n\r\n * `Employment`\r\n### `POST` /dms/customer/all-customers-dynamic-search\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `result` (array)\r\n\r\n Changed items (object):\r\n\r\n * Changed property `license_info` (object)\r\n\r\n * Added property `date_of_birth` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n * Changed property `customer_addresses` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `move_in_date` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n * Added property `is_garaging` (boolean)\r\n > Garaging flag\r\n\r\n\r\n * Changed property `address_type` (string)\r\n > An enumeration.\r\n\r\n\r\n Added enum value:\r\n\r\n * `Employment`\r\n### `GET` /dms/contract\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `returns` (object)\r\n\r\n * Added property `et_fee` (string)\r\n\r\n * Changed property `customer` (object)\r\n\r\n * Changed property `license_info` (object)\r\n\r\n * Added property `date_of_birth` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n * Changed property `customer_addresses` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `move_in_date` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n * Added property `is_garaging` (boolean)\r\n > Garaging flag\r\n\r\n\r\n * Changed property `address_type` (string)\r\n > An enumeration.\r\n\r\n\r\n Added enum value:\r\n\r\n * `Employment`\r\n### `POST` /dms/contract\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **201 Created**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `returns` (object)\r\n\r\n * Added property `et_fee` (string)\r\n\r\n * Changed property `customer` (object)\r\n\r\n * Changed property `license_info` (object)\r\n\r\n * Added property `date_of_birth` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n * Changed property `customer_addresses` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `move_in_date` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n * Added property `is_garaging` (boolean)\r\n > Garaging flag\r\n\r\n\r\n * Changed property `address_type` (string)\r\n > An enumeration.\r\n\r\n\r\n Added enum value:\r\n\r\n * `Employment`\r\n### `PATCH` /dms/contract\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `returns` (object)\r\n\r\n * Added property `et_fee` (string)\r\n\r\n * Changed property `customer` (object)\r\n\r\n * Changed property `license_info` (object)\r\n\r\n * Added property `date_of_birth` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n * Changed property `customer_addresses` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `move_in_date` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n * Added property `is_garaging` (boolean)\r\n > Garaging flag\r\n\r\n\r\n * Changed property `address_type` (string)\r\n > An enumeration.\r\n\r\n\r\n Added enum value:\r\n\r\n * `Employment`\r\n### `GET` /dms/contract/all\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `result` (array)\r\n\r\n Changed items (object):\r\n\r\n * Changed property `returns` (object)\r\n\r\n * Added property `et_fee` (string)\r\n\r\n * Changed property `customer` (object)\r\n\r\n * Changed property `license_info` (object)\r\n\r\n * Added property `date_of_birth` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n * Changed property `customer_addresses` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `move_in_date` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n * Added property `is_garaging` (boolean)\r\n > Garaging flag\r\n\r\n\r\n * Changed property `address_type` (string)\r\n > An enumeration.\r\n\r\n\r\n Added enum value:\r\n\r\n * `Employment`\r\n\r\n\r\n# API Docs Version 1.3.36\r\n---\r\n## What's New\r\n\r\n\r\n### `POST` /dms/quote/create\r\n\r\n> Create Quote\r\n\r\n\r\n### `GET` /dms/contracts\r\n\r\n> Get order contract\r\n\r\n\r\n### `GET` /dms/contracts/search\r\n\r\n> Get order contract\r\n\r\n\r\n## What's Changed\r\n\r\n\r\n### `GET` /dms/contract\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `recieved_security_deposit` (integer)\r\n\r\n * Added property `buyout` (object)\r\n > Vehicle Buyout\r\n\r\n\r\n * Property `buyout_option` (string)\r\n > Buyout Option\r\n\r\n\r\n * Property `vehicle_purchase_price` (integer)\r\n > Vehicle Purchase Price\r\n\r\n\r\n * Added property `final_bill_amount` (integer)\r\n\r\n * Added property `first_bill_invoice_id` (string)\r\n\r\n * Changed property `returns` (object)\r\n\r\n * Added property `vin` (string)\r\n\r\n * Added property `order_reference_number` (string)\r\n\r\n * Added property `current_odometer_reading` (integer)\r\n\r\n * Added property `dealer_id` (integer)\r\n\r\n * Added property `identifier` (string)\r\n\r\n * Added property `invoice_id` (string)\r\n\r\n * Added property `penalty_reason` (string)\r\n\r\n * Added property `penalty_amount` (string)\r\n\r\n * Added property `status` (string)\r\n\r\n * Added property `allowed_usage` (integer)\r\n\r\n * Added property `external_order_id` (string)\r\n\r\n * Added property `customer_reference_id` (string)\r\n\r\n * Added property `customer_first_name` (string)\r\n\r\n * Added property `customer_last_name` (string)\r\n\r\n * Added property `order_checklist` (array)\r\n\r\n Items (object):\r\n\r\n * Deleted property `return_status` (object)\r\n\r\n * Deleted property `odometer` (integer)\r\n\r\n * Deleted property `return_location` (string)\r\n\r\n * Deleted property `exceeded_miles_panalty_amount` (integer)\r\n\r\n * Deleted property `late_return_panalty_amount` (integer)\r\n\r\n * Deleted property `meta_data` (object)\r\n\r\n * Deleted property `created_at` (string)\r\n\r\n * Deleted property `created_by` (string)\r\n\r\n * Deleted property `updated_at` (string)\r\n\r\n * Deleted property `updated_by` (string)\r\n\r\n * Deleted property `check_list` (object)\r\n\r\n * Changed property `return_type` (string)\r\n\r\n Removed enum values:\r\n\r\n * `NORMAL`\r\n * `EARLY`\r\n * `UNWIND `\r\n * Changed property `customer` (object)\r\n\r\n * Added property `customer_addresses` (array)\r\n\r\n Items (object):\r\n\r\n * Property `address_line_1` (string)\r\n > Address line one\r\n\r\n\r\n * Property `address_line_2` (string)\r\n > Address line two\r\n\r\n\r\n * Property `state_name` (string)\r\n > Address state name\r\n\r\n\r\n * Property `zip_code` (string)\r\n > Zip code\r\n\r\n\r\n * Property `county` (string)\r\n > Address county\r\n\r\n\r\n * Property `city` (string)\r\n > Address city\r\n\r\n\r\n * Property `contact_number` (string)\r\n > Contact number\r\n\r\n\r\n * Property `verified` (boolean)\r\n > Is Address verified\r\n\r\n\r\n * Property `address_type` (string)\r\n > An enumeration.\r\n\r\n\r\n Enum values:\r\n\r\n * `Mailing`\r\n * `Invoice`\r\n * `Office`\r\n * `Garaging`\r\n * `DealerAddress`\r\n * `DrivingLicense`\r\n * `Billing`\r\n * `InsuranceAddress`\r\n * `Residential`\r\n * Property `identifier` (string)\r\n\r\n * Property `created_at` (string)\r\n\r\n * Property `created_by` (string)\r\n\r\n * Property `updated_at` (string)\r\n\r\n * Property `updated_by` (string)\r\n\r\n * Property `deleted_at` (string)\r\n\r\n * Property `deleted_by` (string)\r\n\r\n * Added property `income_info` (object)\r\n\r\n * Property `employment_type` (string)\r\n > Employment type\r\n\r\n\r\n * Property `name` (string)\r\n > Name\r\n\r\n\r\n * Property `phone` (string)\r\n > Phone\r\n\r\n\r\n * Property `employed_since` (string)\r\n > Employed since\r\n\r\n\r\n * Property `occupation` (string)\r\n > Occupation\r\n\r\n\r\n * Property `annual_employment_income` (number)\r\n > Annual employment income\r\n\r\n\r\n * Property `annual_other_income` (number)\r\n > Annual other income\r\n\r\n\r\n * Property `source_of_other_income` (string)\r\n > Annual other income\r\n\r\n\r\n * Property `created_at` (string)\r\n\r\n * Property `created_by` (string)\r\n\r\n * Property `updated_at` (string)\r\n\r\n * Property `updated_by` (string)\r\n\r\n * Property `deleted_at` (string)\r\n\r\n * Property `deleted_by` (string)\r\n\r\n * Added property `payments_info` (array)\r\n\r\n Items (object):\r\n\r\n * Property `type` (string)\r\n\r\n * Property `stripe_payment_method_id` (string)\r\n\r\n * Property `access_token` (string)\r\n\r\n * Property `account_id` (string)\r\n\r\n * Property `Bank_name` (string)\r\n\r\n * Property `last4` (integer)\r\n\r\n * Property `default` (boolean)\r\n\r\n * Property `created_at` (string)\r\n\r\n * Property `created_by` (string)\r\n\r\n * Property `updated_at` (string)\r\n\r\n * Property `updated_by` (string)\r\n\r\n * Property `deleted_at` (string)\r\n\r\n * Property `deleted_by` (string)\r\n\r\n * Added property `license_info` (object)\r\n\r\n * Property `first_name` (string)\r\n\r\n * Property `last_name` (string)\r\n\r\n * Property `status` (string)\r\n\r\n * Property `license_number` (string)\r\n\r\n * Property `is_pdf_417` (boolean)\r\n\r\n * Property `issue_date` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n * Property `expiry_date` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n * Property `is_selfie_verified` (boolean)\r\n\r\n### `POST` /dms/contract\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **201 Created**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `recieved_security_deposit` (integer)\r\n\r\n * Added property `buyout` (object)\r\n > Vehicle Buyout\r\n\r\n\r\n * Added property `final_bill_amount` (integer)\r\n\r\n * Added property `first_bill_invoice_id` (string)\r\n\r\n * Changed property `returns` (object)\r\n\r\n * Added property `vin` (string)\r\n\r\n * Added property `order_reference_number` (string)\r\n\r\n * Added property `current_odometer_reading` (integer)\r\n\r\n * Added property `dealer_id` (integer)\r\n\r\n * Added property `identifier` (string)\r\n\r\n * Added property `invoice_id` (string)\r\n\r\n * Added property `penalty_reason` (string)\r\n\r\n * Added property `penalty_amount` (string)\r\n\r\n * Added property `status` (string)\r\n\r\n * Added property `allowed_usage` (integer)\r\n\r\n * Added property `external_order_id` (string)\r\n\r\n * Added property `customer_reference_id` (string)\r\n\r\n * Added property `customer_first_name` (string)\r\n\r\n * Added property `customer_last_name` (string)\r\n\r\n * Added property `order_checklist` (array)\r\n\r\n * Deleted property `return_status` (object)\r\n\r\n * Deleted property `odometer` (integer)\r\n\r\n * Deleted property `return_location` (string)\r\n\r\n * Deleted property `exceeded_miles_panalty_amount` (integer)\r\n\r\n * Deleted property `late_return_panalty_amount` (integer)\r\n\r\n * Deleted property `meta_data` (object)\r\n\r\n * Deleted property `created_at` (string)\r\n\r\n * Deleted property `created_by` (string)\r\n\r\n * Deleted property `updated_at` (string)\r\n\r\n * Deleted property `updated_by` (string)\r\n\r\n * Deleted property `check_list` (object)\r\n\r\n * Changed property `return_type` (string)\r\n\r\n Removed enum values:\r\n\r\n * `NORMAL`\r\n * `EARLY`\r\n * `UNWIND `\r\n * Changed property `customer` (object)\r\n\r\n * Added property `customer_addresses` (array)\r\n\r\n * Added property `income_info` (object)\r\n\r\n * Added property `payments_info` (array)\r\n\r\n * Added property `license_info` (object)\r\n\r\n### `PATCH` /dms/contract\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Added property `final_bill_invoice_id` (string)\r\n\r\n* Added property `final_bill_amount` (integer)\r\n\r\n* Added property `buyout` (object)\r\n > Vehicle Buyout\r\n\r\n\r\n* Added property `assets` (array)\r\n\r\n Items (object):\r\n\r\n * Property `vin` (string)\r\n\r\n* Changed property `subscription_status` (string)\r\n > An enumeration.\r\n\r\n\r\n Added enum value:\r\n\r\n * `PURCHASED`\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `recieved_security_deposit` (integer)\r\n\r\n * Added property `buyout` (object)\r\n > Vehicle Buyout\r\n\r\n\r\n * Added property `final_bill_amount` (integer)\r\n\r\n * Added property `first_bill_invoice_id` (string)\r\n\r\n * Changed property `returns` (object)\r\n\r\n * Added property `vin` (string)\r\n\r\n * Added property `order_reference_number` (string)\r\n\r\n * Added property `current_odometer_reading` (integer)\r\n\r\n * Added property `dealer_id` (integer)\r\n\r\n * Added property `identifier` (string)\r\n\r\n * Added property `invoice_id` (string)\r\n\r\n * Added property `penalty_reason` (string)\r\n\r\n * Added property `penalty_amount` (string)\r\n\r\n * Added property `status` (string)\r\n\r\n * Added property `allowed_usage` (integer)\r\n\r\n * Added property `external_order_id` (string)\r\n\r\n * Added property `customer_reference_id` (string)\r\n\r\n * Added property `customer_first_name` (string)\r\n\r\n * Added property `customer_last_name` (string)\r\n\r\n * Added property `order_checklist` (array)\r\n\r\n * Deleted property `return_status` (object)\r\n\r\n * Deleted property `odometer` (integer)\r\n\r\n * Deleted property `return_location` (string)\r\n\r\n * Deleted property `exceeded_miles_panalty_amount` (integer)\r\n\r\n * Deleted property `late_return_panalty_amount` (integer)\r\n\r\n * Deleted property `meta_data` (object)\r\n\r\n * Deleted property `created_at` (string)\r\n\r\n * Deleted property `created_by` (string)\r\n\r\n * Deleted property `updated_at` (string)\r\n\r\n * Deleted property `updated_by` (string)\r\n\r\n * Deleted property `check_list` (object)\r\n\r\n * Changed property `return_type` (string)\r\n\r\n Removed enum values:\r\n\r\n * `NORMAL`\r\n * `EARLY`\r\n * `UNWIND `\r\n * Changed property `customer` (object)\r\n\r\n * Added property `customer_addresses` (array)\r\n\r\n * Added property `income_info` (object)\r\n\r\n * Added property `payments_info` (array)\r\n\r\n * Added property `license_info` (object)\r\n\r\n### `GET` /dms/contract/all\r\n\r\n\r\n#### Parameters:\r\n\r\nChanged: `statuses` in `query`\r\n> Accepts only string values\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `result` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `recieved_security_deposit` (integer)\r\n\r\n * Added property `buyout` (object)\r\n > Vehicle Buyout\r\n\r\n\r\n * Added property `final_bill_amount` (integer)\r\n\r\n * Added property `first_bill_invoice_id` (string)\r\n\r\n * Changed property `returns` (object)\r\n\r\n * Added property `vin` (string)\r\n\r\n * Added property `order_reference_number` (string)\r\n\r\n * Added property `current_odometer_reading` (integer)\r\n\r\n * Added property `dealer_id` (integer)\r\n\r\n * Added property `identifier` (string)\r\n\r\n * Added property `invoice_id` (string)\r\n\r\n * Added property `penalty_reason` (string)\r\n\r\n * Added property `penalty_amount` (string)\r\n\r\n * Added property `status` (string)\r\n\r\n * Added property `allowed_usage` (integer)\r\n\r\n * Added property `external_order_id` (string)\r\n\r\n * Added property `customer_reference_id` (string)\r\n\r\n * Added property `customer_first_name` (string)\r\n\r\n * Added property `customer_last_name` (string)\r\n\r\n * Added property `order_checklist` (array)\r\n\r\n * Deleted property `return_status` (object)\r\n\r\n * Deleted property `odometer` (integer)\r\n\r\n * Deleted property `return_location` (string)\r\n\r\n * Deleted property `exceeded_miles_panalty_amount` (integer)\r\n\r\n * Deleted property `late_return_panalty_amount` (integer)\r\n\r\n * Deleted property `meta_data` (object)\r\n\r\n * Deleted property `created_at` (string)\r\n\r\n * Deleted property `created_by` (string)\r\n\r\n * Deleted property `updated_at` (string)\r\n\r\n * Deleted property `updated_by` (string)\r\n\r\n * Deleted property `check_list` (object)\r\n\r\n * Changed property `return_type` (string)\r\n\r\n Removed enum values:\r\n\r\n * `NORMAL`\r\n * `EARLY`\r\n * `UNWIND `\r\n * Changed property `customer` (object)\r\n\r\n * Added property `customer_addresses` (array)\r\n\r\n * Added property `income_info` (object)\r\n\r\n * Added property `payments_info` (array)\r\n\r\n * Added property `license_info` (object)\r\n\r\n\r\n\r\n# API Docs Version 1.3.33\r\n---\r\n## What's Deprecated\r\n\r\n\r\n### `GET` /dms/customer/status-flag-hitsory\r\n\r\n> Get status flag history\r\n\r\n\r\n## What's Changed\r\n\r\n\r\n### `GET` /dms/customer/license-info\r\n\r\n\r\n#### Parameters:\r\n\r\nDeleted: `include_images` in `query`\r\n\r\n### `GET` /dms/customer/status-flag-hitsory\r\n\r\n\r\n### `GET` /dms/customer/all-customers\r\n\r\n\r\n#### Parameters:\r\n\r\nChanged: `sort_by` in `query`\r\n\r\n### `POST` /dms/customer/all-customers-dynamic-search\r\n\r\n\r\n#### Parameters:\r\n\r\nAdded: `from_date` in `query`\r\n> Format: YYYY-MM-DD\r\n\r\n\r\nAdded: `to_date` in `query`\r\n> Format: YYYY-MM-DD\r\n\r\n\r\nChanged: `sort_by` in `query`\r\n\r\n### `GET` /dms/contract\r\n\r\n> Get active contract\r\n\r\n\r\n#### Parameters:\r\n\r\nDeleted: `statuses` in `query`\r\n> Accepts only string values\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n### `POST` /dms/contract\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **201 Created**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `invocation_type` (string)\r\n\r\n### `PATCH` /dms/contract\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Changed property `subscription_status` (string)\r\n > An enumeration.\r\n\r\n\r\n Added enum values:\r\n\r\n * `RETURN_SUBMITTED`\r\n * `PAUSED`\r\n * `RESUME`\r\n Removed enum value:\r\n\r\n * `PAST_DUE`\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `invocation_type` (string)\r\n\r\n### `GET` /dms/contract/all\r\n\r\n\r\n#### Parameters:\r\n\r\nChanged: `statuses` in `query`\r\n> Accepts only string values\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `result` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `invocation_type` (string)\r\n\r\n\r\n\r\n# API Docs Version 1.3.31\r\n---\r\n## What's New\r\n\r\n\r\n### `GET` /dms/customer/insurance-information/document-history\r\n\r\n> Get Insurance Documents\r\n\r\n\r\n### `PATCH` /dms/customer/delete-insurance-information\r\n\r\n> Delete single customer insurance information\r\n\r\n\r\n### `PATCH` /dms/customer/insurance-information/remove-insurance-document\r\n\r\n> Delete insurance document\r\n\r\n\r\n### `PATCH` /dms/customer/remove-status-flag\r\n\r\n> Remove customer status flag\r\n\r\n\r\n### `PATCH` /dms/customer/delete-document\r\n\r\n> Delete Customer Document By Identifier\r\n\r\n\r\n### `GET` /dms/history\r\n\r\n> Get all customers records history\r\n\r\n\r\n### `GET` /dms/history-details\r\n\r\n> Get history detail\r\n\r\n\r\n## What's Deprecated\r\n\r\n\r\n### `DELETE` /dms/customer/insurance-information\r\n\r\n> Delete single customer insurance information\r\n\r\n\r\n### `DELETE` /dms/customer/insurance-information/remove-document\r\n\r\n> Delete insurance document\r\n\r\n\r\n### `DELETE` /dms/customer/status-flag\r\n\r\n> Remove customer status flag\r\n\r\n\r\n### `DELETE` /dms/customer/document\r\n\r\n> Delete customer document by identifier\r\n\r\n\r\n## What's Changed\r\n\r\n\r\n### `GET` /dms/customer/customer-history\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n Changed items (object):\r\n\r\n New required properties:\r\n - `email`\r\n\r\n * Added property `created_by` (string)\r\n\r\n * Changed property `email` (string -> string)\r\n\r\n### `PATCH` /dms/check-customer-by-email\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n New required properties:\r\n - `email`\r\n\r\n * Added property `created_by` (string)\r\n\r\n * Changed property `email` (string -> string)\r\n\r\n### `PATCH` /dms/delete-customer\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\nNew required properties:\r\n- `deleted_by`\r\n\r\n### `POST` /dms/customer/license-info\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **201 Created**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `reference_id` (string)\r\n\r\n * Changed property `address` (object)\r\n\r\n New optional properties:\r\n - `address_type`\r\n\r\n * Deleted property `address_type` (string)\r\n > An enumeration.\r\n\r\n\r\n * Deleted property `identifier` (string)\r\n\r\n * Deleted property `created_at` (string)\r\n\r\n * Deleted property `updated_at` (string)\r\n\r\n * Deleted property `updated_by` (string)\r\n\r\n * Deleted property `deleted_at` (string)\r\n\r\n * Deleted property `deleted_by` (string)\r\n\r\n### `PATCH` /dms/customer/license-info\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Added property `address` (object)\r\n\r\n * Property `address_line_1` (string)\r\n > Address line one\r\n\r\n\r\n * Property `address_line_2` (string)\r\n > Address line two\r\n\r\n\r\n * Property `state_name` (string)\r\n > Address state name\r\n\r\n\r\n * Property `zip_code` (string)\r\n > Zip code\r\n\r\n\r\n * Property `county` (string)\r\n > Address county\r\n\r\n\r\n * Property `city` (string)\r\n > Address city\r\n\r\n\r\n * Property `contact_number` (string)\r\n > Contact number\r\n\r\n\r\n * Property `verified` (boolean)\r\n > Is Address verified\r\n\r\n\r\n * Property `identifier` (string)\r\n\r\n### `GET` /dms/customer/employment-info\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `created_by` (string)\r\n\r\n * Added property `address` (object)\r\n\r\n * Property `address_line_1` (string)\r\n > Address line one\r\n\r\n\r\n * Property `address_line_2` (string)\r\n > Address line two\r\n\r\n\r\n * Property `state_name` (string)\r\n > Address state name\r\n\r\n\r\n * Property `zip_code` (string)\r\n > Zip code\r\n\r\n\r\n * Property `county` (string)\r\n > Address county\r\n\r\n\r\n * Property `city` (string)\r\n > Address city\r\n\r\n\r\n * Property `contact_number` (string)\r\n > Contact number\r\n\r\n\r\n * Property `verified` (boolean)\r\n > Is Address verified\r\n\r\n\r\n * Property `address_type` (string)\r\n > An enumeration.\r\n\r\n\r\n Enum values:\r\n\r\n * `Mailing`\r\n * `Invoice`\r\n * `Office`\r\n * `Garaging`\r\n * `DealerAddress`\r\n * `DrivingLicense`\r\n * `Billing`\r\n * `InsuranceAddress`\r\n * `Residential`\r\n * Property `identifier` (string)\r\n\r\n * Property `created_at` (string)\r\n\r\n * Property `created_by` (string)\r\n\r\n * Property `updated_at` (string)\r\n\r\n * Property `updated_by` (string)\r\n\r\n * Property `deleted_at` (string)\r\n\r\n * Property `deleted_by` (string)\r\n\r\n * Property `reference_id` (string)\r\n\r\n * Property `is_active` (boolean)\r\n\r\n### `POST` /dms/customer/employment-info\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Added property `address` (object)\r\n\r\n * Property `address_line_1` (string)\r\n > Address line one\r\n\r\n\r\n * Property `address_line_2` (string)\r\n > Address line two\r\n\r\n\r\n * Property `state_name` (string)\r\n > Address state name\r\n\r\n\r\n * Property `zip_code` (string)\r\n > Zip code\r\n\r\n\r\n * Property `county` (string)\r\n > Address county\r\n\r\n\r\n * Property `city` (string)\r\n > Address city\r\n\r\n\r\n * Property `contact_number` (string)\r\n > Contact number\r\n\r\n\r\n * Property `verified` (boolean)\r\n > Is Address verified\r\n\r\n\r\n * Property `address_type` (string)\r\n > An enumeration.\r\n\r\n\r\n * Property `identifier` (string)\r\n\r\n* Changed property `employed_since` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **201 Created**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `created_by` (string)\r\n\r\n * Added property `address` (object)\r\n\r\n### `PATCH` /dms/customer/employment-info\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `created_by` (string)\r\n\r\n * Added property `address` (object)\r\n\r\n### `PATCH` /dms/customer/personal-finance\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Deleted property `reference_id` (string)\r\n > Reference Id\r\n\r\n\r\n### `POST` /dms/customer/payment-information/\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Changed property `type` (string)\r\n\r\n* Changed property `reference_id` (string)\r\n\r\n#### Return Type:\r\n\r\nChanged response : **201 Created**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `created_by` (string)\r\n\r\n### `GET` /dms/customer/payment-information\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n Changed items (object):\r\n\r\n * Added property `created_by` (string)\r\n\r\n### `PATCH` /dms/customer/payment-information\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Changed property `type` (string)\r\n\r\n* Changed property `reference_id` (string)\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `created_by` (string)\r\n\r\n### `DELETE` /dms/customer/signature\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\nNew required properties:\r\n- `deleted_by`\r\n\r\n### `PATCH` /dms/customer/delete-signature\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\nNew required properties:\r\n- `deleted_by`\r\n\r\n### `GET` /dms/address\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n Changed items (object):\r\n\r\n * Added property `created_by` (string)\r\n\r\n### `POST` /dms/address\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **201 Created**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `created_by` (string)\r\n\r\n### `DELETE` /dms/address\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `created_by` (string)\r\n\r\n### `PATCH` /dms/address\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `created_by` (string)\r\n\r\n### `GET` /dms/customer/insurance-information\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `deleted_at` (string)\r\n\r\n * Added property `deleted_by` (string)\r\n\r\n### `POST` /dms/customer/insurance-information\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\nNew required properties:\r\n- `created_by`\r\n\r\n#### Return Type:\r\n\r\nChanged response : **201 Created**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `deleted_at` (string)\r\n\r\n * Added property `deleted_by` (string)\r\n\r\n### `DELETE` /dms/customer/insurance-information\r\n\r\n\r\n### `PATCH` /dms/customer/insurance-information\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\nNew required properties:\r\n- `updated_by`\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `deleted_at` (string)\r\n\r\n * Added property `deleted_by` (string)\r\n\r\n### `GET` /dms/customer/insurance-information-by-customer\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `deleted_at` (string)\r\n\r\n * Added property `deleted_by` (string)\r\n\r\n### `GET` /dms/customer/insurance-information-by-order\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `deleted_at` (string)\r\n\r\n * Added property `deleted_by` (string)\r\n\r\n### `DELETE` /dms/customer/insurance-information/remove-document\r\n\r\n\r\n### `GET` /dms/customer/status-flag\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n Changed items (object):\r\n\r\n * Added property `is_active` (boolean)\r\n\r\n * Added property `is_deleted` (boolean)\r\n\r\n### `POST` /dms/customer/status-flag\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\nNew required properties:\r\n- `created_by`\r\n\r\n#### Return Type:\r\n\r\nChanged response : **201 Created**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `is_active` (boolean)\r\n\r\n * Added property `is_deleted` (boolean)\r\n\r\n### `DELETE` /dms/customer/status-flag\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n### `POST` /dms/configure/workqueue\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\nNew optional properties:\r\n- `expired_at`\r\n\r\n### `POST` /dms/quote/calculation\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n Changed items (object):\r\n\r\n * Changed property `rv_chart` (string -> object)\r\n > RV chart\r\n\r\n\r\n### `GET` /dms/customer/document\r\n\r\n> Get customer documents\r\n\r\n\r\n### `POST` /dms/customer/document\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\nNew required properties:\r\n- `created_by`\r\n\r\n### `DELETE` /dms/customer/document\r\n\r\n> Delete customer document by identifier\r\n\r\n\r\n### `PATCH` /dms/customer/document\r\n\r\n> Update customer document by identifier\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\nNew required properties:\r\n- `updated_by`\r\n\r\n### `GET` /dms/customer/document/status\r\n\r\n> Get customer document by identifier\r\n\r\n\r\n### `GET` /dms/customer/document-history\r\n\r\n> Get customer document history\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `result` (array)\r\n\r\n Changed items (object):\r\n\r\n New required properties:\r\n - `document_reviews`\r\n\r\n * Added property `document_reviews` (array)\r\n\r\n Items (object):\r\n\r\n * Property `reviewed_by` (string)\r\n\r\n * Property `review_date_time` (string)\r\n > format: YYYY-MM-DD hh:mm:ss\r\n\r\n\r\n * Property `review_status` (string)\r\n\r\n * Property `review_notes` (string)\r\n\r\n * Property `identifier` (string)\r\n\r\n### `GET` /dms/customer/document/review\r\n\r\n\r\n### `POST` /dms/customer/additional-document\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\nNew required properties:\r\n- `created_by`\r\n\r\n### `POST` /dms/customer/\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Changed property `customer_profile` (object)\r\n\r\n New required properties:\r\n - `created_by`\r\n\r\n * Added property `created_by` (string)\r\n\r\n#### Return Type:\r\n\r\nChanged response : **201 Created**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `created_by` (string)\r\n\r\n * Added property `is_parent` (boolean)\r\n\r\n * Changed property `income_info` (object)\r\n\r\n * Added property `created_by` (string)\r\n\r\n * Changed property `payments_info` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `created_by` (string)\r\n\r\n * Changed property `customer_addresses` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `created_by` (string)\r\n\r\n### `DELETE` /dms/customer\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\nNew required properties:\r\n- `deleted_by`\r\n\r\n### `GET` /dms/customer\r\n\r\n\r\n#### Parameters:\r\n\r\nAdded: `email` in `query`\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n New required properties:\r\n - `email`\r\n\r\n * Added property `created_by` (string)\r\n\r\n * Changed property `email` (string -> string)\r\n\r\n * Changed property `income_info` (object)\r\n\r\n * Added property `created_by` (string)\r\n\r\n * Changed property `payments_info` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `created_by` (string)\r\n\r\n * Changed property `customer_addresses` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `created_by` (string)\r\n\r\n### `PATCH` /dms/customer\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Changed property `customer_profile` (object)\r\n\r\n New required properties:\r\n - `updated_by`\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `created_by` (string)\r\n\r\n * Added property `is_parent` (boolean)\r\n\r\n * Changed property `income_info` (object)\r\n\r\n * Added property `created_by` (string)\r\n\r\n * Changed property `payments_info` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `created_by` (string)\r\n\r\n * Changed property `customer_addresses` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `created_by` (string)\r\n\r\n### `GET` /dms/customer-by-email\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `created_by` (string)\r\n\r\n * Added property `is_parent` (boolean)\r\n\r\n * Changed property `income_info` (object)\r\n\r\n * Added property `created_by` (string)\r\n\r\n * Changed property `payments_info` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `created_by` (string)\r\n\r\n * Changed property `customer_addresses` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `created_by` (string)\r\n\r\n### `GET` /dms/customer/insurance-information-history\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `result` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `deleted_at` (string)\r\n\r\n * Added property `deleted_by` (string)\r\n\r\n### `GET` /dms/configure/quotation\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `payment_recieved` (boolean)\r\n\r\n * Added property `base_rate` (number)\r\n\r\n * Added property `margin` (number)\r\n\r\n * Added property `applicable_rate` (number)\r\n\r\n * Added property `invoice_status` (string)\r\n > An enumeration.\r\n\r\n\r\n Enum values:\r\n\r\n * `Active`\r\n * `Paused`\r\n * `Resumed`\r\n * Deleted property `vin` (string)\r\n\r\n### `GET` /dms/configure/all-quotation\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n Changed items (object):\r\n\r\n * Added property `payment_recieved` (boolean)\r\n\r\n * Added property `base_rate` (number)\r\n\r\n * Added property `margin` (number)\r\n\r\n * Added property `applicable_rate` (number)\r\n\r\n * Added property `invoice_status` (string)\r\n > An enumeration.\r\n\r\n\r\n * Deleted property `vin` (string)\r\n\r\n### `GET` /dms/configure/all-quotations\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n Changed items (object):\r\n\r\n * Added property `payment_recieved` (boolean)\r\n\r\n * Added property `base_rate` (number)\r\n\r\n * Added property `margin` (number)\r\n\r\n * Added property `applicable_rate` (number)\r\n\r\n * Added property `invoice_status` (string)\r\n > An enumeration.\r\n\r\n\r\n * Deleted property `vin` (string)\r\n\r\n### `PATCH` /dms/configure/quotation/{identifier}\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Added property `payment_recieved` (boolean)\r\n\r\n* Added property `base_rate` (number)\r\n\r\n* Added property `margin` (number)\r\n\r\n* Added property `applicable_rate` (number)\r\n\r\n* Added property `invoice_status` (string)\r\n > An enumeration.\r\n\r\n\r\n* Deleted property `vin` (string)\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `payment_recieved` (boolean)\r\n\r\n * Added property `base_rate` (number)\r\n\r\n * Added property `margin` (number)\r\n\r\n * Added property `applicable_rate` (number)\r\n\r\n * Added property `invoice_status` (string)\r\n > An enumeration.\r\n\r\n\r\n * Deleted property `vin` (string)\r\n\r\n### `POST` /dms/configure/save-quotation\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\nChanged items (object):\r\n\r\n* Added property `payment_recieved` (boolean)\r\n\r\n* Added property `base_rate` (number)\r\n\r\n* Added property `margin` (number)\r\n\r\n* Added property `applicable_rate` (number)\r\n\r\n* Added property `invoice_status` (string)\r\n > An enumeration.\r\n\r\n\r\n* Deleted property `vin` (string)\r\n\r\n#### Return Type:\r\n\r\nChanged response : **201 Created**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n Changed items (object):\r\n\r\n * Added property `payment_recieved` (boolean)\r\n\r\n * Added property `base_rate` (number)\r\n\r\n * Added property `margin` (number)\r\n\r\n * Added property `applicable_rate` (number)\r\n\r\n * Added property `invoice_status` (string)\r\n > An enumeration.\r\n\r\n\r\n * Deleted property `vin` (string)\r\n\r\n### `PATCH` /dms/configure/order/update-status/{order_id}\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `payment_recieved` (boolean)\r\n\r\n * Added property `base_rate` (number)\r\n\r\n * Added property `margin` (number)\r\n\r\n * Added property `applicable_rate` (number)\r\n\r\n * Added property `invoice_status` (string)\r\n > An enumeration.\r\n\r\n\r\n * Deleted property `vin` (string)\r\n\r\n### `GET` /dms/customer/all-customers\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `result` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `created_by` (string)\r\n\r\n * Added property `is_parent` (boolean)\r\n\r\n * Changed property `income_info` (object)\r\n\r\n * Added property `created_by` (string)\r\n\r\n * Changed property `payments_info` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `created_by` (string)\r\n\r\n * Changed property `customer_addresses` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `created_by` (string)\r\n\r\n### `POST` /dms/customer/all-customers-dynamic-search\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `result` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `created_by` (string)\r\n\r\n * Added property `is_parent` (boolean)\r\n\r\n * Changed property `income_info` (object)\r\n\r\n * Added property `created_by` (string)\r\n\r\n * Changed property `payments_info` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `created_by` (string)\r\n\r\n * Changed property `customer_addresses` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `created_by` (string)\r\n\r\n### `GET` /dms/contract\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n Changed items (object):\r\n\r\n * Changed property `customer` (object)\r\n\r\n * Added property `created_by` (string)\r\n\r\n * Added property `is_parent` (boolean)\r\n\r\n### `POST` /dms/contract\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **201 Created**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `customer` (object)\r\n\r\n * Added property `created_by` (string)\r\n\r\n * Added property `is_parent` (boolean)\r\n\r\n### `PATCH` /dms/contract\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `customer` (object)\r\n\r\n * Added property `created_by` (string)\r\n\r\n * Added property `is_parent` (boolean)\r\n\r\n### `GET` /dms/contract/all\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `result` (array)\r\n\r\n Changed items (object):\r\n\r\n * Changed property `customer` (object)\r\n\r\n * Added property `created_by` (string)\r\n\r\n * Added property `is_parent` (boolean)\r\n\r\n\r\n# API Docs Version 1.3.30\r\n---\r\n## What's New\r\n\r\n\r\n### `GET` /dms/contract\r\n\r\n> Get contract\r\n\r\n\r\n### `POST` /dms/contract\r\n\r\n> Create contract\r\n\r\n\r\n### `PATCH` /dms/contract\r\n\r\n> Update contract\r\n\r\n\r\n### `GET` /dms/contract/all\r\n\r\n> Get all contract records\r\n\r\n\r\n\r\n# API Docs Version 1.3.29\r\n---\r\n## What's Changed\r\n\r\n\r\n### `GET` /dms/customer/customer-history\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n Changed items (object):\r\n\r\n New optional properties:\r\n - `email`\r\n\r\n * Changed property `email` (string -> string)\r\n\r\n### `PATCH` /dms/check-customer-by-email\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n New optional properties:\r\n - `email`\r\n\r\n * Changed property `email` (string -> string)\r\n\r\n### `POST` /dms/customer/\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **201 Created**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n New optional properties:\r\n - `email`\r\n\r\n * Changed property `email` (string -> string)\r\n\r\n### `GET` /dms/customer\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n New optional properties:\r\n - `email`\r\n\r\n * Changed property `email` (string -> string)\r\n\r\n### `PATCH` /dms/customer\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n New optional properties:\r\n - `email`\r\n\r\n * Changed property `email` (string -> string)\r\n\r\n### `GET` /dms/customer-by-email\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n New optional properties:\r\n - `email`\r\n\r\n * Changed property `email` (string -> string)\r\n\r\n### `GET` /dms/customer/all-customers\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `result` (array)\r\n\r\n Changed items (object):\r\n\r\n New optional properties:\r\n - `email`\r\n\r\n * Changed property `email` (string -> string)\r\n\r\n### `POST` /dms/customer/all-customers-dynamic-search\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `result` (array)\r\n\r\n Changed items (object):\r\n\r\n New optional properties:\r\n - `email`\r\n\r\n * Changed property `email` (string -> string)\r\n\r\n\r\n# API Docs Version 1.3.27\r\n---\r\n## What's New\r\n\r\n\r\n### `GET` /dms/order/order-checklist\r\n\r\n> Get Order checklist\r\n\r\n\r\n### `POST` /dms/order/order-checklist\r\n\r\n> Add Order checklist\r\n\r\n\r\n### `DELETE` /dms/order/order-checklist\r\n\r\n> Delete Order checklist\r\n\r\n\r\n### `PATCH` /dms/order/order-checklist\r\n\r\n> Update Order checklist\r\n\r\n\r\n## What's Changed\r\n\r\n\r\n### `GET` /dms/customer\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `disclaimer_info` (array)\r\n\r\n Items (object):\r\n\r\n * Property `order_reference_id` (string)\r\n\r\n * Property `customer_reference_id` (string)\r\n\r\n * Property `identifier` (string)\r\n\r\n * Property `disclaimer_name` (string)\r\n\r\n * Property `disclaimer_version` (string)\r\n\r\n * Property `disclaimer_details` (string)\r\n\r\n * Property `disclaimer_acceptance_date` (string)\r\n\r\n\r\n# API Docs Version 1.3.26\r\n---\r\n## What's New\r\n\r\n\r\n### `GET` /dms/configure/customer-mandatory-disclaimers\r\n\r\n> Get customer mandatory Disclaimers\r\n\r\n\r\n### `PATCH` /dms/configure/disclaimer-accord\r\n\r\n> Update Disclaimer accord\r\n\r\n\r\n### `DELETE` /dms/customer/insurance-information/remove-document\r\n\r\n> Delete insurance document\r\n\r\n\r\n## What's Deleted\r\n\r\n\r\n### `POST` /dms/customer/insurance-information/remove-document\r\n\r\n> Delete insurance document\r\n\r\n\r\n## What's Changed\r\n\r\n\r\n### `GET` /dms/customer/third-party-response-history\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n### `GET` /dms/configure/disclaimer\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `disclaimer_accord` (boolean)\r\n\r\n### `POST` /dms/configure/disclaimer\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Added property `disclaimer_accord` (boolean)\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `disclaimer_accord` (boolean)\r\n\r\n### `GET` /dms/configure/disclaimer-by-name/{name}\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n Changed items (object):\r\n\r\n * Added property `disclaimer_accord` (boolean)\r\n\r\n### `GET` /dms/configure/all-disclaimer\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n Changed items (object):\r\n\r\n * Added property `disclaimer_accord` (boolean)\r\n\r\n### `PATCH` /dms/configure/disclaimer/{name}\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `disclaimer_accord` (boolean)\r\n\r\n### `POST` /dms/customer/all-customers-dynamic-search\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\nChanged items (object):\r\n\r\nNew optional properties:\r\n- `value`\r\n\r\n* Changed property `value` (string -> object)\r\n\r\n\r\n\r\n# API Docs Version 1.3.21\r\n---\r\n## What's Deleted\r\n\r\n\r\n### `POST` /dms/configure/document-package-2\r\n\r\n> Create document package\r\n\r\n\r\n### `POST` /dms/configure/document-package-3\r\n\r\n> Create document package\r\n\r\n\r\n## What's Changed\r\n\r\n\r\n### `GET` /dms/customer/third-party-response-history\r\n\r\n\r\n#### Parameters:\r\n\r\nAdded: `identifier` in `query`\r\n\r\nAdded: `include_images` in `query`\r\n\r\nAdded: `include_response` in `query`\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n### `POST` /dms/customer/signature\r\n\r\n\r\n### `DELETE` /dms/customer/signature\r\n\r\n\r\n### `PATCH` /dms/customer/signature\r\n\r\n\r\n### `PATCH` /dms/customer/delete-signature\r\n\r\n\r\n### `GET` /dms/customer/insurance-information\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `insurance_documents` (array)\r\n\r\n Changed items (object):\r\n\r\n New optional properties:\r\n - `content_type`\r\n - `created_at`\r\n - `document`\r\n - `meta_data`\r\n\r\n * Added property `document_uri` (string)\r\n\r\n * Added property `name` (string)\r\n\r\n * Added property `file_size` (string)\r\n\r\n * Added property `identifier` (string)\r\n\r\n * Added property `is_active` (boolean)\r\n\r\n * Added property `created_by` (string)\r\n\r\n * Added property `deleted_at` (string)\r\n\r\n * Added property `deleted_by` (string)\r\n\r\n * Deleted property `document` (string)\r\n\r\n * Deleted property `meta_data` (object)\r\n\r\n * Changed property `created_at` (string -> string)\r\n\r\n### `POST` /dms/customer/insurance-information\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Changed property `insurance_documents` (array)\r\n\r\n Changed items (object):\r\n\r\n New required properties:\r\n - `file_size`\r\n - `name`\r\n\r\n New optional properties:\r\n - `created_at`\r\n - `meta_data`\r\n\r\n * Added property `name` (string)\r\n\r\n * Added property `file_size` (string)\r\n\r\n * Added property `created_by` (string)\r\n\r\n * Deleted property `meta_data` (object)\r\n\r\n * Deleted property `created_at` (string)\r\n\r\n * Changed property `content_type` (string)\r\n > format: application/pdf, image/png\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **201 Created**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `insurance_documents` (array)\r\n\r\n Changed items (object):\r\n\r\n New optional properties:\r\n - `content_type`\r\n - `created_at`\r\n - `document`\r\n - `meta_data`\r\n\r\n * Added property `document_uri` (string)\r\n\r\n * Added property `name` (string)\r\n\r\n * Added property `file_size` (string)\r\n\r\n * Added property `identifier` (string)\r\n\r\n * Added property `is_active` (boolean)\r\n\r\n * Added property `created_by` (string)\r\n\r\n * Added property `deleted_at` (string)\r\n\r\n * Added property `deleted_by` (string)\r\n\r\n * Deleted property `document` (string)\r\n\r\n * Deleted property `meta_data` (object)\r\n\r\n * Changed property `created_at` (string -> string)\r\n\r\n### `PATCH` /dms/customer/insurance-information\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Changed property `insurer_address` (object)\r\n\r\n * Deleted property `identifier` (string)\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `insurance_documents` (array)\r\n\r\n Changed items (object):\r\n\r\n New optional properties:\r\n - `content_type`\r\n - `created_at`\r\n - `document`\r\n - `meta_data`\r\n\r\n * Added property `document_uri` (string)\r\n\r\n * Added property `name` (string)\r\n\r\n * Added property `file_size` (string)\r\n\r\n * Added property `identifier` (string)\r\n\r\n * Added property `is_active` (boolean)\r\n\r\n * Added property `created_by` (string)\r\n\r\n * Added property `deleted_at` (string)\r\n\r\n * Added property `deleted_by` (string)\r\n\r\n * Deleted property `document` (string)\r\n\r\n * Deleted property `meta_data` (object)\r\n\r\n * Changed property `created_at` (string -> string)\r\n\r\n### `GET` /dms/customer/insurance-information-by-customer\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `insurance_documents` (array)\r\n\r\n Changed items (object):\r\n\r\n New optional properties:\r\n - `content_type`\r\n - `created_at`\r\n - `document`\r\n - `meta_data`\r\n\r\n * Added property `document_uri` (string)\r\n\r\n * Added property `name` (string)\r\n\r\n * Added property `file_size` (string)\r\n\r\n * Added property `identifier` (string)\r\n\r\n * Added property `is_active` (boolean)\r\n\r\n * Added property `created_by` (string)\r\n\r\n * Added property `deleted_at` (string)\r\n\r\n * Added property `deleted_by` (string)\r\n\r\n * Deleted property `document` (string)\r\n\r\n * Deleted property `meta_data` (object)\r\n\r\n * Changed property `created_at` (string -> string)\r\n\r\n### `GET` /dms/customer/insurance-information-by-order\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `insurance_documents` (array)\r\n\r\n Changed items (object):\r\n\r\n New optional properties:\r\n - `content_type`\r\n - `created_at`\r\n - `document`\r\n - `meta_data`\r\n\r\n * Added property `document_uri` (string)\r\n\r\n * Added property `name` (string)\r\n\r\n * Added property `file_size` (string)\r\n\r\n * Added property `identifier` (string)\r\n\r\n * Added property `is_active` (boolean)\r\n\r\n * Added property `created_by` (string)\r\n\r\n * Added property `deleted_at` (string)\r\n\r\n * Added property `deleted_by` (string)\r\n\r\n * Deleted property `document` (string)\r\n\r\n * Deleted property `meta_data` (object)\r\n\r\n * Changed property `created_at` (string -> string)\r\n\r\n### `POST` /dms/customer/insurance-information/add-document\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\nNew required properties:\r\n- `file_size`\r\n- `name`\r\n\r\nNew optional properties:\r\n- `created_at`\r\n- `meta_data`\r\n\r\n* Added property `name` (string)\r\n\r\n* Added property `file_size` (string)\r\n\r\n* Added property `created_by` (string)\r\n\r\n* Deleted property `meta_data` (object)\r\n\r\n* Deleted property `created_at` (string)\r\n\r\n* Changed property `content_type` (string)\r\n > format: application/pdf, image/png\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n Changed items (object):\r\n\r\n New optional properties:\r\n - `content_type`\r\n - `created_at`\r\n - `document`\r\n - `meta_data`\r\n\r\n * Added property `document_uri` (string)\r\n\r\n * Added property `name` (string)\r\n\r\n * Added property `file_size` (string)\r\n\r\n * Added property `identifier` (string)\r\n\r\n * Added property `is_active` (boolean)\r\n\r\n * Added property `created_by` (string)\r\n\r\n * Added property `deleted_at` (string)\r\n\r\n * Added property `deleted_by` (string)\r\n\r\n * Deleted property `document` (string)\r\n\r\n * Deleted property `meta_data` (object)\r\n\r\n * Changed property `created_at` (string -> string)\r\n\r\n### `POST` /dms/customer/insurance-information/remove-document\r\n\r\n\r\n#### Parameters:\r\n\r\nAdded: `identifier` in `query`\r\n\r\nDeleted: `document_id` in `query`\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n### `POST` /dms/customer/comment\r\n\r\n> Create customer comment diary\r\n\r\n\r\n### `PATCH` /dms/customer/comment\r\n\r\n> Update customer comment diary\r\n\r\n\r\n### `GET` /dms/customer/comments\r\n\r\n> Get customer comment diary\r\n\r\n\r\n### `GET` /dms/customer/insurance-information-history\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `result` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `insurer_address` (object)\r\n\r\n * Property `address_line_1` (string)\r\n > Address line one\r\n\r\n\r\n * Property `address_line_2` (string)\r\n > Address line two\r\n\r\n\r\n * Property `state_name` (string)\r\n > Address state name\r\n\r\n\r\n * Property `zip_code` (string)\r\n > Zip code\r\n\r\n\r\n * Property `county` (string)\r\n > Address county\r\n\r\n\r\n * Property `city` (string)\r\n > Address city\r\n\r\n\r\n * Property `contact_number` (string)\r\n > Contact number\r\n\r\n\r\n * Property `verified` (boolean)\r\n > Is Address verified\r\n\r\n\r\n * Property `identifier` (string)\r\n\r\n * Changed property `insurance_documents` (array)\r\n\r\n Changed items (object):\r\n\r\n New optional properties:\r\n - `content_type`\r\n - `created_at`\r\n - `document`\r\n - `meta_data`\r\n\r\n * Added property `document_uri` (string)\r\n\r\n * Added property `name` (string)\r\n\r\n * Added property `file_size` (string)\r\n\r\n * Added property `identifier` (string)\r\n\r\n * Added property `is_active` (boolean)\r\n\r\n * Added property `created_by` (string)\r\n\r\n * Added property `deleted_at` (string)\r\n\r\n * Added property `deleted_by` (string)\r\n\r\n * Deleted property `document` (string)\r\n\r\n * Deleted property `meta_data` (object)\r\n\r\n * Changed property `created_at` (string -> string)\r\n\r\n\r\n\r\n# API Docs Version 1.3.15\r\n---\r\n## What's New\r\n\r\n\r\n### `POST` /dms/configure/document-package-2\r\n\r\n> Create document package\r\n\r\n\r\n### `POST` /dms/configure/document-package-3\r\n\r\n> Create document package\r\n\r\n\r\n### `PATCH` /dms/configure/metadata\r\n\r\n> Add meta data\r\n\r\n\r\n### `GET` /dms/configure/order-fees/{identifier}\r\n\r\n> Get all order fees for order\r\n\r\n\r\n### `GET` /dms/configure/order-options/{identifier}\r\n\r\n> Get order option details\r\n\r\n\r\n### `GET` /dms/configure/order-fni/{identifier}\r\n\r\n> Get orders finance insurance product filtered on identifier\r\n\r\n\r\n### `DELETE` /dms/configure/order/tradein/{identifier}\r\n\r\n> Delete order tradein info setup record\r\n\r\n\r\n## What's Deleted\r\n\r\n\r\n### `GET` /dms/configure/order-fees/{order_id}\r\n\r\n> Get all order fees for order\r\n\r\n\r\n### `GET` /dms/configure/order-options/{order_id}\r\n\r\n> Get order option details\r\n\r\n\r\n### `GET` /dms/configure/order-fni/{order_id}\r\n\r\n> Get orders finance insurance product filtered on order id\r\n\r\n\r\n### `DELETE` /dms/configure/order/tradein/{tradein_id}\r\n\r\n> Delete order tradein info setup record\r\n\r\n\r\n## What's Changed\r\n\r\n\r\n### `PATCH` /dms/customer/personal-finance\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\nNew optional properties:\r\n- `reference_id`\r\n\r\n### `POST` /dms/customer/payment-information/\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **201 Created**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `last4` (string -> integer)\r\n\r\n### `GET` /dms/customer/payment-information\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n Changed items (object):\r\n\r\n * Changed property `last4` (string -> integer)\r\n\r\n### `PATCH` /dms/customer/payment-information\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `last4` (string -> integer)\r\n\r\n### `GET` /dms/address\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n Changed items (object):\r\n\r\n * Added property `is_active` (boolean)\r\n\r\n### `POST` /dms/address\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Added property `identifier` (string)\r\n\r\n#### Return Type:\r\n\r\nChanged response : **201 Created**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `is_active` (boolean)\r\n\r\n### `PATCH` /dms/address\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `is_active` (boolean)\r\n\r\n### `POST` /dms/customer/status-flag\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Added property `identifier` (string)\r\n\r\n### `POST` /dms/customer/comment\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Added property `identifier` (string)\r\n\r\n### `DELETE` /dms/configure/order-fees/{order_fee_id}\r\n\r\n> Delete all orders fees filtered on identifier\r\n\r\n\r\n### `PATCH` /dms/configure/order-fees/{order_fee_id}\r\n\r\n\r\n### `DELETE` /dms/configure/order-options/{order_option_id}\r\n\r\n\r\n### `PATCH` /dms/configure/order-options/{order_option_id}\r\n\r\n\r\n### `DELETE` /dms/configure/order-fni/{order_fni_id}\r\n\r\n> Delete all orders finance insurance product filtered on identifier\r\n\r\n\r\n### `PATCH` /dms/configure/order-fni/{order_fni_id}\r\n\r\n\r\n### `GET` /dms/configure/order/tradein/{order_id}\r\n\r\n\r\n### `PATCH` /dms/configure/order/tradein/{order_id}\r\n\r\n\r\n### `POST` /dms/configure/order/status/\r\n\r\n\r\n### `POST` /dms/quote/calculation/multi-assets\r\n\r\n\r\n### `POST` /dms/customer/document\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Added property `identifier` (string)\r\n\r\n### `POST` /dms/customer/document/review\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Added property `identifier` (string)\r\n\r\n### `GET` /dms/configure/document-package/document\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `meta_data` (object)\r\n\r\n### `POST` /dms/configure/{document_package_id}/{document_id}/{signature_id}\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `meta_data` (object)\r\n\r\n### `POST` /dms/customer/\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Changed property `customer_profile` (object)\r\n\r\n * Added property `identifier` (string)\r\n\r\n* Changed property `customer_addresses` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `identifier` (string)\r\n\r\n#### Return Type:\r\n\r\nChanged response : **201 Created**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `payments_info` (array)\r\n\r\n Changed items (object):\r\n\r\n * Changed property `last4` (string -> integer)\r\n\r\n### `GET` /dms/customer\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `payments_info` (array)\r\n\r\n Changed items (object):\r\n\r\n * Changed property `last4` (string -> integer)\r\n\r\n### `PATCH` /dms/customer\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Changed property `customer_addresses` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `identifier` (string)\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `payments_info` (array)\r\n\r\n Changed items (object):\r\n\r\n * Changed property `last4` (string -> integer)\r\n\r\n### `GET` /dms/customer-by-email\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `payments_info` (array)\r\n\r\n Changed items (object):\r\n\r\n * Changed property `last4` (string -> integer)\r\n\r\n### `POST` /dms/customer/license-info\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Added property `identifier` (string)\r\n\r\n* Changed property `address` (object)\r\n\r\n * Added property `identifier` (string)\r\n\r\n### `GET` /dms/customer/third-party-response-history\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n Changed items (object):\r\n\r\n * Changed property `license_detail` (object)\r\n\r\n * Changed property `address` (object)\r\n\r\n * Added property `identifier` (string)\r\n\r\n### `GET` /dms/customer/insurance-information\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `insurer_address` (object)\r\n\r\n * Added property `identifier` (string)\r\n\r\n### `POST` /dms/customer/insurance-information\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Added property `identifier` (string)\r\n\r\n* Changed property `insurer_address` (object)\r\n\r\n * Added property `identifier` (string)\r\n\r\n#### Return Type:\r\n\r\nChanged response : **201 Created**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `insurer_address` (object)\r\n\r\n * Added property `identifier` (string)\r\n\r\n### `PATCH` /dms/customer/insurance-information\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Changed property `insurer_address` (object)\r\n\r\n * Added property `identifier` (string)\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `insurer_address` (object)\r\n\r\n * Added property `identifier` (string)\r\n\r\n### `GET` /dms/customer/insurance-information-by-customer\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `insurer_address` (object)\r\n\r\n * Added property `identifier` (string)\r\n\r\n### `GET` /dms/customer/insurance-information-by-order\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `insurer_address` (object)\r\n\r\n * Added property `identifier` (string)\r\n\r\n### `PATCH` /dms/configure/quotation/{order_id}\r\n\r\n\r\n### `GET` /dms/configure/document-package\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `documents` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `meta_data` (object)\r\n\r\n### `POST` /dms/configure/document-package\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Added property `identifier` (string)\r\n\r\n* Changed property `documents` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `meta_data` (object)\r\n\r\n * Added property `identifier` (string)\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `documents` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `meta_data` (object)\r\n\r\n### `GET` /dms/configure/document-package-by-reference-id\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `documents` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `meta_data` (object)\r\n\r\n### `GET` /dms/customer/all-customers\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `result` (array)\r\n\r\n Changed items (object):\r\n\r\n * Changed property `payments_info` (array)\r\n\r\n Changed items (object):\r\n\r\n * Changed property `last4` (string -> integer)\r\n\r\n### `POST` /dms/customer/all-customers-dynamic-search\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `result` (array)\r\n\r\n Changed items (object):\r\n\r\n * Changed property `payments_info` (array)\r\n\r\n Changed items (object):\r\n\r\n * Changed property `last4` (string -> integer)\r\n\r\n\r\n\r\n# API Docs Version 1.3.12\r\n---\r\n## What's New\r\n\r\n\r\n### `POST` /dms/customer/all-customers-dynamic-search\r\n\r\n> Get all customer records dynamic search\r\n\r\n\r\n### `GET` /dms/customers\r\n\r\n> Gets customer names by customer reference ids\r\n\r\n\r\n### `GET` /dms/configure/assets-by-trim-code/{trim_code}\r\n\r\n> Get assets by trim code\r\n\r\n\r\n### `GET` /dms/configure/order/status-by-dealer\r\n\r\n> Get order status by dealer\r\n\r\n\r\n### `GET` /dms/customer/document-history\r\n\r\n> Get customer document upload history\r\n\r\n\r\n## What's Deleted\r\n\r\n\r\n### `GET` /dms/quote-comparison/{trim_code}\r\n\r\n> Quote Comparison\r\n\r\n\r\n### `GET` /dms/customer/document/\r\n\r\n> Get customer document upload history\r\n\r\n\r\n## What's Changed\r\n\r\n\r\n### `PATCH` /dms/check-customer-by-email\r\n\r\n\r\n#### Parameters:\r\n\r\nDeleted: `email` in `query`\r\n\r\n#### Request:\r\n\r\nNew content type : `application/json`\r\n\r\n### `POST` /dms/customer/employment-info\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\nNew required properties:\r\n- `employment_type`\r\n- `reference_id`\r\n\r\n### `GET` /dms/customer/personal-finance\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n New required properties:\r\n - `reference_id`\r\n\r\n * Changed property `reference_id` (string)\r\n > Reference Id\r\n\r\n\r\n### `POST` /dms/customer/personal-finance\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\nNew required properties:\r\n- `reference_id`\r\n\r\n* Changed property `reference_id` (string)\r\n > Reference Id\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **201 Created**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n New required properties:\r\n - `reference_id`\r\n\r\n * Changed property `reference_id` (string)\r\n > Reference Id\r\n\r\n\r\n### `PATCH` /dms/customer/personal-finance\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\nNew required properties:\r\n- `reference_id`\r\n\r\n* Added property `reference_id` (string)\r\n > Reference Id\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n New required properties:\r\n - `reference_id`\r\n\r\n * Changed property `reference_id` (string)\r\n > Reference Id\r\n\r\n\r\n### `POST` /dms/customer/payment-information/\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\nNew required properties:\r\n- `reference_id`\r\n- `type`\r\n\r\n* Changed property `type` (string)\r\n > Payment type\r\n\r\n\r\n* Changed property `last4` (string -> integer)\r\n\r\n* Changed property `reference_id` (string)\r\n > Reference Id\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **201 Created**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n New required properties:\r\n - `reference_id`\r\n\r\n * Changed property `reference_id` (string)\r\n > Reference Id\r\n\r\n\r\n### `GET` /dms/customer/payment-information\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n Changed items (object):\r\n\r\n New required properties:\r\n - `reference_id`\r\n\r\n * Changed property `reference_id` (string)\r\n > Reference Id\r\n\r\n\r\n### `PATCH` /dms/customer/payment-information\r\n\r\n\r\n#### Parameters:\r\n\r\nDeleted: `reference_id` in `query`\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\nNew required properties:\r\n- `reference_id`\r\n- `type`\r\n\r\n* Added property `reference_id` (string)\r\n > Reference Id\r\n\r\n\r\n* Changed property `type` (string)\r\n > Payment type\r\n\r\n\r\n* Changed property `last4` (string -> integer)\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n New required properties:\r\n - `reference_id`\r\n\r\n * Changed property `reference_id` (string)\r\n > Reference Id\r\n\r\n\r\n### `GET` /dms/customer/insurance-information\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `created_by` (string)\r\n\r\n * Added property `updated_by` (string)\r\n\r\n * Changed property `insurance_documents` (array)\r\n\r\n Changed items (object):\r\n\r\n New required properties:\r\n - `content_type`\r\n - `meta_data`\r\n\r\n New optional properties:\r\n - `document_ext`\r\n - `document_name`\r\n\r\n * Added property `content_type` (string)\r\n\r\n * Added property `meta_data` (object)\r\n\r\n * Property `name` (string)\r\n\r\n * Property `size` (string)\r\n\r\n * Deleted property `document_ext` (string)\r\n\r\n * Deleted property `document_name` (string)\r\n\r\n### `POST` /dms/customer/insurance-information\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Added property `created_by` (string)\r\n\r\n* Changed property `insurance_documents` (array)\r\n\r\n Changed items (object):\r\n\r\n New required properties:\r\n - `content_type`\r\n - `meta_data`\r\n\r\n New optional properties:\r\n - `document_ext`\r\n - `document_name`\r\n\r\n * Added property `content_type` (string)\r\n\r\n * Added property `meta_data` (object)\r\n\r\n * Deleted property `document_ext` (string)\r\n\r\n * Deleted property `document_name` (string)\r\n\r\n#### Return Type:\r\n\r\nChanged response : **201 Created**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `created_by` (string)\r\n\r\n * Added property `updated_by` (string)\r\n\r\n * Changed property `insurance_documents` (array)\r\n\r\n Changed items (object):\r\n\r\n New required properties:\r\n - `content_type`\r\n - `meta_data`\r\n\r\n New optional properties:\r\n - `document_ext`\r\n - `document_name`\r\n\r\n * Added property `content_type` (string)\r\n\r\n * Added property `meta_data` (object)\r\n\r\n * Deleted property `document_ext` (string)\r\n\r\n * Deleted property `document_name` (string)\r\n\r\n### `PATCH` /dms/customer/insurance-information\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Added property `updated_by` (string)\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `created_by` (string)\r\n\r\n * Added property `updated_by` (string)\r\n\r\n * Changed property `insurance_documents` (array)\r\n\r\n Changed items (object):\r\n\r\n New required properties:\r\n - `content_type`\r\n - `meta_data`\r\n\r\n New optional properties:\r\n - `document_ext`\r\n - `document_name`\r\n\r\n * Added property `content_type` (string)\r\n\r\n * Added property `meta_data` (object)\r\n\r\n * Deleted property `document_ext` (string)\r\n\r\n * Deleted property `document_name` (string)\r\n\r\n### `GET` /dms/customer/insurance-information-by-customer\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `created_by` (string)\r\n\r\n * Added property `updated_by` (string)\r\n\r\n * Changed property `insurance_documents` (array)\r\n\r\n Changed items (object):\r\n\r\n New required properties:\r\n - `content_type`\r\n - `meta_data`\r\n\r\n New optional properties:\r\n - `document_ext`\r\n - `document_name`\r\n\r\n * Added property `content_type` (string)\r\n\r\n * Added property `meta_data` (object)\r\n\r\n * Deleted property `document_ext` (string)\r\n\r\n * Deleted property `document_name` (string)\r\n\r\n### `GET` /dms/customer/insurance-information-by-order\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `created_by` (string)\r\n\r\n * Added property `updated_by` (string)\r\n\r\n * Changed property `insurance_documents` (array)\r\n\r\n Changed items (object):\r\n\r\n New required properties:\r\n - `content_type`\r\n - `meta_data`\r\n\r\n New optional properties:\r\n - `document_ext`\r\n - `document_name`\r\n\r\n * Added property `content_type` (string)\r\n\r\n * Added property `meta_data` (object)\r\n\r\n * Deleted property `document_ext` (string)\r\n\r\n * Deleted property `document_name` (string)\r\n\r\n### `POST` /dms/customer/insurance-information/add-document\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\nNew required properties:\r\n- `content_type`\r\n- `meta_data`\r\n\r\nNew optional properties:\r\n- `document_ext`\r\n- `document_name`\r\n\r\n* Added property `content_type` (string)\r\n\r\n* Added property `meta_data` (object)\r\n\r\n* Deleted property `document_ext` (string)\r\n\r\n* Deleted property `document_name` (string)\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n Changed items (object):\r\n\r\n New required properties:\r\n - `content_type`\r\n - `meta_data`\r\n\r\n New optional properties:\r\n - `document_ext`\r\n - `document_name`\r\n\r\n * Added property `content_type` (string)\r\n\r\n * Added property `meta_data` (object)\r\n\r\n * Deleted property `document_ext` (string)\r\n\r\n * Deleted property `document_name` (string)\r\n\r\n### `GET` /dms/customer/status-flag\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n Changed items (object):\r\n\r\n * Added property `created_by` (string)\r\n\r\n * Added property `updated_by` (string)\r\n\r\n### `POST` /dms/customer/status-flag\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Added property `created_by` (string)\r\n\r\n#### Return Type:\r\n\r\nChanged response : **201 Created**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `created_by` (string)\r\n\r\n * Added property `updated_by` (string)\r\n\r\n### `GET` /dms/customer/status-flag-hitsory\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `result` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `created_by` (string)\r\n\r\n * Added property `updated_by` (string)\r\n\r\n * Added property `is_deleted` (boolean)\r\n\r\n### `POST` /dms/configure/order-fees\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Added property `identifier` (string)\r\n\r\n* Deleted property `id` (integer)\r\n\r\n#### Return Type:\r\n\r\nChanged response : **201 Created**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `identifier` (string)\r\n\r\n * Deleted property `id` (integer)\r\n\r\n### `DELETE` /dms/configure/order-fees/{order_fee_id}\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `identifier` (string)\r\n\r\n * Deleted property `id` (integer)\r\n\r\n### `PATCH` /dms/configure/order-fees/{order_fee_id}\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Added property `identifier` (string)\r\n\r\n* Deleted property `id` (integer)\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `identifier` (string)\r\n\r\n * Deleted property `id` (integer)\r\n\r\n### `GET` /dms/configure/order-fees/{order_id}\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n Changed items (object):\r\n\r\n * Added property `identifier` (string)\r\n\r\n * Deleted property `id` (integer)\r\n\r\n### `POST` /dms/configure/order-options\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Added property `identifier` (string)\r\n\r\n* Deleted property `id` (integer)\r\n\r\n#### Return Type:\r\n\r\nChanged response : **201 Created**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `identifier` (string)\r\n\r\n * Deleted property `id` (integer)\r\n\r\n### `DELETE` /dms/configure/order-options/{order_option_id}\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `identifier` (string)\r\n\r\n * Deleted property `id` (integer)\r\n\r\n### `PATCH` /dms/configure/order-options/{order_option_id}\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Added property `identifier` (string)\r\n\r\n* Deleted property `id` (integer)\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `identifier` (string)\r\n\r\n * Deleted property `id` (integer)\r\n\r\n### `GET` /dms/configure/order-options/{order_id}\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n Changed items (object):\r\n\r\n * Added property `identifier` (string)\r\n\r\n * Deleted property `id` (integer)\r\n\r\n### `POST` /dms/configure/order-fni\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Deleted property `id` (integer)\r\n\r\n#### Return Type:\r\n\r\nChanged response : **201 Created**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `identifier` (string)\r\n\r\n * Deleted property `id` (integer)\r\n\r\n### `DELETE` /dms/configure/order-fni/{order_fni_id}\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Deleted property `id` (integer)\r\n\r\n### `PATCH` /dms/configure/order-fni/{order_fni_id}\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Deleted property `id` (integer)\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Deleted property `id` (integer)\r\n\r\n### `GET` /dms/configure/order-fni/{order_id}\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n Changed items (object):\r\n\r\n * Deleted property `id` (integer)\r\n\r\n### `POST` /dms/configure/order/tradein\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Deleted property `id` (integer)\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n New required properties:\r\n - `identifier`\r\n\r\n * Added property `identifier` (string)\r\n\r\n * Deleted property `id` (integer)\r\n\r\n### `GET` /dms/configure/order/tradein/{order_id}\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Deleted property `id` (integer)\r\n\r\n### `PATCH` /dms/configure/order/tradein/{order_id}\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Deleted property `id` (integer)\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Deleted property `id` (integer)\r\n\r\n### `DELETE` /dms/configure/order/tradein/{tradein_id}\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Deleted property `id` (integer)\r\n\r\n### `POST` /dms/configure/appointment\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Deleted property `id` (integer)\r\n\r\n### `GET` /dms/customer/document\r\n\r\n\r\n#### Parameters:\r\n\r\nAdded: `category` in `query`\r\n\r\n### `PATCH` /dms/customer/document\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\nNew required properties:\r\n- `content_type`\r\n\r\n* Added property `content_type` (string)\r\n\r\n* Added property `updated_by` (string)\r\n\r\n* Deleted property `document_extension` (string)\r\n\r\n### `POST` /dms/customer/additional-document\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\nNew required properties:\r\n- `content_type`\r\n\r\n* Added property `content_type` (string)\r\n\r\n* Deleted property `document_extension` (string)\r\n\r\n### `POST` /dms/configure/{document_package_id}/{document_id}/{signature_id}\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **404 Not Found**\r\n> Not Found\r\n\r\n\r\n* New content type : `application/json`\r\n\r\nChanged response : **422 Unprocessable Entity**\r\n> Validation Error\r\n\r\n\r\n* New content type : `application/json`\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n### `GET` /dms/customer/insurance-information-history\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `result` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `created_by` (string)\r\n\r\n * Added property `updated_by` (string)\r\n\r\n * Changed property `insurance_documents` (array)\r\n\r\n Changed items (object):\r\n\r\n New required properties:\r\n - `content_type`\r\n - `meta_data`\r\n\r\n New optional properties:\r\n - `document_ext`\r\n - `document_name`\r\n\r\n * Added property `content_type` (string)\r\n\r\n * Added property `meta_data` (object)\r\n\r\n * Deleted property `document_ext` (string)\r\n\r\n * Deleted property `document_name` (string)\r\n\r\n### `GET` /dms/configure/quotation\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n New required properties:\r\n - `identifier`\r\n\r\n New optional properties:\r\n - `id`\r\n\r\n * Added property `identifier` (string)\r\n\r\n * Deleted property `id` (integer)\r\n\r\n * Changed property `order_fees` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `identifier` (string)\r\n\r\n * Changed property `order_options` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `identifier` (string)\r\n\r\n * Changed property `order_fnI` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `identifier` (string)\r\n\r\n * Changed property `order_asset` (object)\r\n\r\n * Added property `identifier` (string)\r\n\r\n * Changed property `order_tradein` (object)\r\n\r\n * Added property `identifier` (string)\r\n\r\n### `GET` /dms/configure/all-quotation\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n Changed items (object):\r\n\r\n New required properties:\r\n - `identifier`\r\n\r\n New optional properties:\r\n - `id`\r\n\r\n * Added property `identifier` (string)\r\n\r\n * Deleted property `id` (integer)\r\n\r\n * Changed property `order_fees` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `identifier` (string)\r\n\r\n * Changed property `order_options` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `identifier` (string)\r\n\r\n * Changed property `order_fnI` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `identifier` (string)\r\n\r\n * Changed property `order_asset` (object)\r\n\r\n * Added property `identifier` (string)\r\n\r\n * Changed property `order_tradein` (object)\r\n\r\n * Added property `identifier` (string)\r\n\r\n### `GET` /dms/configure/all-quotations\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n Changed items (object):\r\n\r\n New required properties:\r\n - `identifier`\r\n\r\n New optional properties:\r\n - `id`\r\n\r\n * Added property `identifier` (string)\r\n\r\n * Deleted property `id` (integer)\r\n\r\n * Changed property `order_fees` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `identifier` (string)\r\n\r\n * Changed property `order_options` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `identifier` (string)\r\n\r\n * Changed property `order_fnI` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `identifier` (string)\r\n\r\n * Changed property `order_asset` (object)\r\n\r\n * Added property `identifier` (string)\r\n\r\n * Changed property `order_tradein` (object)\r\n\r\n * Added property `identifier` (string)\r\n\r\n### `PATCH` /dms/configure/quotation/{order_id}\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Changed property `order_fees` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `identifier` (string)\r\n\r\n* Changed property `order_options` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `identifier` (string)\r\n\r\n* Changed property `order_fnI` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `identifier` (string)\r\n\r\n* Changed property `order_asset` (object)\r\n\r\n * Added property `identifier` (string)\r\n\r\n* Changed property `order_tradein` (object)\r\n\r\n * Added property `identifier` (string)\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `order_fees` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `identifier` (string)\r\n\r\n * Changed property `order_options` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `identifier` (string)\r\n\r\n * Changed property `order_fnI` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `identifier` (string)\r\n\r\n * Changed property `order_asset` (object)\r\n\r\n * Added property `identifier` (string)\r\n\r\n * Changed property `order_tradein` (object)\r\n\r\n * Added property `identifier` (string)\r\n\r\n### `POST` /dms/configure/save-quotation\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\nChanged items (object):\r\n\r\n* Changed property `order_fees` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `identifier` (string)\r\n\r\n* Changed property `order_options` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `identifier` (string)\r\n\r\n* Changed property `order_fnI` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `identifier` (string)\r\n\r\n* Changed property `order_asset` (object)\r\n\r\n * Added property `identifier` (string)\r\n\r\n* Changed property `order_tradein` (object)\r\n\r\n * Added property `identifier` (string)\r\n\r\n#### Return Type:\r\n\r\nChanged response : **201 Created**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n Changed items (object):\r\n\r\n New required properties:\r\n - `identifier`\r\n\r\n New optional properties:\r\n - `id`\r\n\r\n * Added property `identifier` (string)\r\n\r\n * Deleted property `id` (integer)\r\n\r\n * Changed property `order_fees` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `identifier` (string)\r\n\r\n * Changed property `order_options` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `identifier` (string)\r\n\r\n * Changed property `order_fnI` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `identifier` (string)\r\n\r\n * Changed property `order_asset` (object)\r\n\r\n * Added property `identifier` (string)\r\n\r\n * Changed property `order_tradein` (object)\r\n\r\n * Added property `identifier` (string)\r\n\r\n### `PATCH` /dms/configure/order/update-status/{order_id}\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `order_fees` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `identifier` (string)\r\n\r\n * Changed property `order_options` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `identifier` (string)\r\n\r\n * Changed property `order_fnI` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `identifier` (string)\r\n\r\n * Changed property `order_asset` (object)\r\n\r\n * Added property `identifier` (string)\r\n\r\n * Changed property `order_tradein` (object)\r\n\r\n * Added property `identifier` (string)\r\n\r\n### `POST` /dms/configure/document-package\r\n\r\n\r\n#### Return Type:\r\n\r\nNew response : **412 Precondition Failed**\r\n> Precondition Failed\r\n\r\nChanged response : **404 Not Found**\r\n> Not Found\r\n\r\n\r\n* New content type : `application/json`\r\n\r\nChanged response : **422 Unprocessable Entity**\r\n> Validation Error\r\n\r\n\r\n* New content type : `application/json`\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n### `GET` /dms/configure/document-package-by-reference-id\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **404 Not Found**\r\n> Not Found\r\n\r\n\r\n* New content type : `application/json`\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n\r\n# API Docs Version 1.3.9\r\n---\r\n## What's Changed\r\n\r\n\r\n### `GET` /dms/customer/document/\r\n\r\n\r\n### `GET` /dms/configure/document-package/document\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `signatures` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `date_field_id` (string)\r\n\r\n### `POST` /dms/configure/{document_package_id}/{document_id}/{signature_id}\r\n\r\n\r\n#### Parameters:\r\n\r\nAdded: `date_time_format` in `query`\r\n\r\nAdded: `time_zone` in `query`\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `signatures` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `date_field_id` (string)\r\n\r\n### `GET` /dms/configure/document-package\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `documents` (array)\r\n\r\n Changed items (object):\r\n\r\n * Changed property `signatures` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `date_field_id` (string)\r\n\r\n### `POST` /dms/configure/document-package\r\n\r\n\r\n#### Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Changed property `documents` (array)\r\n\r\n Changed items (object):\r\n\r\n * Changed property `signatures` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `date_field_id` (string)\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `documents` (array)\r\n\r\n Changed items (object):\r\n\r\n * Changed property `signatures` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `date_field_id` (string)\r\n\r\n### `GET` /dms/configure/document-package-by-reference-id\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `documents` (array)\r\n\r\n Changed items (object):\r\n\r\n * Changed property `signatures` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `date_field_id` (string)\r\n\r\n\r\n\r\n\r\n# API Docs Version 1.3.5\r\n---\r\n## What's Changed\r\n\r\n### `POST` /dms/configure/document-package\r\n\r\n\r\nReturn Type:\r\n\r\nDeleted response : **201 Created**\r\n> Successful\r\n\r\n\r\n# API Docs Version 1.3.3\r\n---\r\n\r\n## What's New\r\n\r\n\r\n### `POST` /dms/customer/insurance-information/add-document\r\n\r\n> Add insurance document\r\n\r\n\r\n### `POST` /dms/customer/insurance-information/remove-document\r\n\r\n> Delete insurance document\r\n\r\n\r\n### `POST` /dms/email/\r\n\r\n> Get customer record\r\n\r\n\r\n### `GET` /dms/customer/document/\r\n\r\n> Get customer document upload history\r\n\r\n\r\n### `POST` /dms/customer/additional-document\r\n\r\n> Creates customer document\r\n\r\n\r\n### `POST` /dms/configure/order-status/\r\n\r\n> Get orders record filtered on order status\r\n\r\n\r\n### `POST` /dms/configure/order/status/\r\n\r\n> Update order status history record by order refrence number\r\n\r\n\r\n### `POST` /dms/consents/\r\n\r\n> Delete consents\r\n\r\n\r\n### `GET` /dms/customer/insurance-information\r\n\r\n> Get customer insurance information by customer reference id and order reference number\r\n\r\n\r\n### `POST` /dms/configure/appointments/\r\n\r\n> Delete created appointment\r\n\r\n\r\n## What's Deleted\r\n\r\n\r\n### `POST` /dms/customer/search\r\n\r\n> Search Customers\r\n\r\n\r\n### `GET` /dms/vehicle/status/{vin}\r\n\r\n> Get vehicle status\r\n\r\n\r\n### `GET` /dms/email/{email}\r\n\r\n> Get customer record\r\n\r\n\r\n### `GET` /dms/configure/order-status/\r\n\r\n> Get orders record filtered on order status\r\n\r\n\r\n### `GET` /dms/configure/order/status/\r\n\r\n> Update order status history record by order refrence number\r\n\r\n\r\n### `DELETE` /dms/consents/\r\n\r\n> Delete consents\r\n\r\n\r\n### `DELETE` /dms/configure/appointments/\r\n\r\n> Delete created appointment\r\n\r\n\r\n### `DELETE` /dms/configure/quotation/{order_id}\r\n\r\n> Delete configured record\r\n\r\n\r\n## What's Changed\r\n\r\n\r\n### `GET` /dms/consents/\r\n\r\n\r\n### `GET` /dms/referral-detail\r\n\r\n\r\n### `PATCH` /dms/check-customer-by-email\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `id` (integer)\r\n\r\n * Added property `consent` (object)\r\n\r\n * Deleted property `customer_addresses` (array)\r\n\r\n * Deleted property `income_info` (object)\r\n\r\n * Deleted property `payments_info` (array)\r\n\r\n * Deleted property `license_info` (object)\r\n\r\n### `GET` /dms/customer/license-info-history\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n Changed items (object):\r\n\r\n * Added property `is_pdf_417` (boolean)\r\n\r\n### `POST` /dms/customer/insurance-information\r\n\r\n\r\nRequest:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Added property `insurance_documents` (array)\r\n\r\n Items (object):\r\n\r\n * Property `document` (string)\r\n\r\n * Property `document_ext` (string)\r\n\r\n * Property `document_name` (string)\r\n\r\n * Property `created_at` (string)\r\n\r\n* Deleted property `images` (array)\r\n\r\n#### Return Type:\r\n\r\nChanged response : **201 Created**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `insurance_documents` (array)\r\n\r\n * Deleted property `images` (array)\r\n\r\n### `PATCH` /dms/customer/insurance-information\r\n\r\n\r\nRequest:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Deleted property `images` (array)\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `insurance_documents` (array)\r\n\r\n * Deleted property `images` (array)\r\n\r\n### `GET` /dms/customer/insurance-information-history\r\n\r\n\r\n#### Parameters:\r\n\r\nAdded: `page_number` in `query`\r\n\r\nAdded: `page_size` in `query`\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n### `GET` /dms/customer/insurance-information-by-customer\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `insurance_documents` (array)\r\n\r\n * Deleted property `images` (array)\r\n\r\n### `GET` /dms/customer/insurance-information-by-order\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `insurance_documents` (array)\r\n\r\n * Deleted property `images` (array)\r\n\r\n### `GET` /dms/customer/status-flag-hitsory\r\n\r\n\r\n#### Parameters:\r\n\r\nAdded: `page_number` in `query`\r\n\r\nAdded: `page_size` in `query`\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n### `GET` /dms/order/expiry/{order_stage}/{dealer_id}\r\n\r\n\r\n### `POST` /dms/configure/order-fees\r\n\r\n\r\n### `DELETE` /dms/configure/order-fees/{order_fee_id}\r\n\r\n\r\n### `PATCH` /dms/configure/order-fees/{order_fee_id}\r\n\r\n\r\n### `GET` /dms/configure/order-fees/{order_id}\r\n\r\n\r\n### `POST` /dms/configure/order-options\r\n\r\n\r\n### `DELETE` /dms/configure/order-options/{order_option_id}\r\n\r\n\r\n### `PATCH` /dms/configure/order-options/{order_option_id}\r\n\r\n\r\n#### Parameters:\r\n\r\nChanged: `order_option_id` in `path`\r\n\r\n### `GET` /dms/configure/order-options/{order_id}\r\n\r\n\r\n### `POST` /dms/configure/order-fni\r\n\r\n\r\n### `DELETE` /dms/configure/order-fni/{order_fni_id}\r\n\r\n\r\n### `PATCH` /dms/configure/order-fni/{order_fni_id}\r\n\r\n\r\n### `GET` /dms/configure/order-fni/{order_id}\r\n\r\n\r\n### `POST` /dms/configure/order/tradein\r\n\r\n\r\n### `GET` /dms/configure/order/tradein/{order_id}\r\n\r\n\r\n### `PATCH` /dms/configure/order/tradein/{order_id}\r\n\r\n\r\n### `DELETE` /dms/configure/order/tradein/{tradein_id}\r\n\r\n\r\n### `GET` /dms/configure/orders\r\n\r\n\r\n### `GET` /dms/configure/order/filter\r\n\r\n\r\n### `POST` /dms/configure/workqueue\r\n\r\n\r\nRequest:\r\n\r\nChanged content type : `application/json`\r\n\r\nNew required properties:\r\n- `dealer_id`\r\n- `expired_at`\r\n- `order_id`\r\n- `request_type`\r\n\r\n### `GET` /dms/configure/workqueue/search\r\n\r\n\r\n### `PATCH` /dms/configure/workqueue/create_application/{workqueue_id}\r\n\r\n\r\n### `POST` /dms/quote/calculation\r\n\r\n\r\n### `POST` /dms/quote/calculation/quantity\r\n\r\n\r\n### `POST` /dms/consents\r\n\r\n\r\n### `GET` /dms/consents/{consents_id}\r\n\r\n\r\n### `PATCH` /dms/consents/{consents_id}\r\n\r\n\r\n### `POST` /dms/referral\r\n\r\n\r\n### `GET` /dms/customer/document/review\r\n\r\n> Get customer document reviews\r\n\r\n\r\n### `GET` /dms/configure/document-package/document\r\n\r\n> Get document from document package by identifier\r\n\r\n\r\n#### Return Type:\r\n\r\nNew response : **404 Not Found**\r\n> Record not found\r\n\r\nChanged response : **200 OK**\r\n> Successful\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `generated_document_uri` (string)\r\n\r\n * Deleted property `generated_document_url` (string)\r\n\r\n### `POST` /dms/configure/{document_package_id}/{document_id}/{signature_id}\r\n\r\n> Sign document\r\n\r\n\r\n#### Return Type:\r\n\r\nNew response : **404 Not Found**\r\n> Record not found\r\n\r\nChanged response : **422 Unprocessable Entity**\r\n> Signature type must be initials or signature\r\n\r\n\r\n* Deleted content type : `application/json`\r\n\r\nChanged response : **200 OK**\r\n> Successful\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `generated_document_uri` (string)\r\n\r\n * Deleted property `generated_document_url` (string)\r\n\r\n### `POST` /dms/customer/\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **201 Created**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `license_info` (object)\r\n\r\n * Added property `is_pdf_417` (boolean)\r\n\r\n### `GET` /dms/customer\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `license_info` (object)\r\n\r\n * Added property `is_pdf_417` (boolean)\r\n\r\n### `PATCH` /dms/customer\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `license_info` (object)\r\n\r\n * Added property `is_pdf_417` (boolean)\r\n\r\n### `GET` /dms/customer-by-email\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `license_info` (object)\r\n\r\n * Added property `is_pdf_417` (boolean)\r\n\r\n### `PATCH` /dms/customer/license-info\r\n\r\n\r\nRequest:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Added property `is_pdf_417` (boolean)\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `is_pdf_417` (boolean)\r\n\r\n### `POST` /dms/customer/license-info\r\n\r\n\r\nRequest:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Added property `is_pdf_417` (boolean)\r\n\r\n#### Return Type:\r\n\r\nChanged response : **201 Created**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `is_pdf_417` (boolean)\r\n\r\n### `GET` /dms/customer/third-party-response-history\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n Changed items (object):\r\n\r\n * Changed property `license_detail` (object)\r\n\r\n * Added property `is_pdf_417` (boolean)\r\n\r\n### `GET` /dms/configure/quotation\r\n\r\n\r\n### `GET` /dms/configure/all-quotation\r\n\r\n\r\n### `GET` /dms/configure/all-quotations\r\n\r\n\r\n### `PATCH` /dms/configure/quotation/{order_id}\r\n\r\n\r\n### `POST` /dms/configure/save-quotation\r\n\r\n\r\n### `PATCH` /dms/configure/order/update-status/{order_id}\r\n\r\n\r\n### `DELETE` /dms/configure/document-package\r\n\r\n> Cancel document package and document by identifier\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful\r\n\r\n### `GET` /dms/configure/document-package\r\n\r\n> Get document package by identifier\r\n\r\n\r\n#### Return Type:\r\n\r\nNew response : **404 Not Found**\r\n> Record not found\r\n\r\nChanged response : **200 OK**\r\n> Successful\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `documents` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `generated_document_uri` (string)\r\n\r\n * Deleted property `generated_document_url` (string)\r\n\r\n### `POST` /dms/configure/document-package\r\n\r\n> Create document package\r\n\r\n\r\n#### Return Type:\r\n\r\nNew response : **201 Created**\r\n> Successful\r\n\r\nNew response : **404 Not Found**\r\n> Record not found\r\n\r\nChanged response : **422 Unprocessable Entity**\r\n> Signature type must be initials or signature\r\n\r\n\r\n* Deleted content type : `application/json`\r\n\r\nChanged response : **200 OK**\r\n> Successful\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `documents` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `generated_document_uri` (string)\r\n\r\n * Deleted property `generated_document_url` (string)\r\n\r\n### `GET` /dms/configure/document-package-by-reference-id\r\n\r\n> Get document package by reference_id\r\n\r\n\r\n#### Return Type:\r\n\r\nNew response : **404 Not Found**\r\n> Record not found\r\n\r\nChanged response : **200 OK**\r\n> Successful\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `documents` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `generated_document_uri` (string)\r\n\r\n * Deleted property `generated_document_url` (string)\r\n\r\n### `GET` /dms/customer/all-customers\r\n\r\n\r\n#### Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `result` (array)\r\n\r\n Changed items (object):\r\n\r\n * Changed property `license_info` (object)\r\n\r\n * Added property `is_pdf_417` (boolean)\r\n\r\n\r\n\r\n# API Docs Version 1.3.2\r\n---\r\n## What's New\r\n\r\n\r\n### `POST` /dms/customer/search\r\n\r\n> Search Customers\r\n\r\n\r\n## What's Changed\r\n\r\n\r\n### `POST` /dms/configure/appointment\r\n\r\n\r\n### `GET` /dms/configure/appointment/{appointment_id}\r\n\r\n\r\n### `GET` /dms/configure/appointments\r\n\r\n\r\n### `DELETE` /dms/configure/appointments/\r\n\r\n\r\n### `PATCH` /dms/configure/appointments/\r\n\r\n\r\nRequest:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Added property `key_id` (integer)\r\n\r\n### `PATCH` /dms/customer/document\r\n\r\n\r\nRequest:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Changed property `category` (string)\r\n > An enumeration.\r\n\r\n\r\n Added enum values:\r\n\r\n * `STIP`\r\n * `NON_STIP`\r\n### `GET` /dms/configure/document-package/document\r\n\r\n\r\nReturn Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `template` (string)\r\n\r\n * Deleted property `template_url` (string)\r\n\r\n### `POST` /dms/configure/{document_package_id}/{document_id}/{signature_id}\r\n\r\n\r\nReturn Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `template` (string)\r\n\r\n * Deleted property `template_url` (string)\r\n\r\n### `GET` /dms/configure/document-package\r\n\r\n\r\nReturn Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `documents` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `template` (string)\r\n\r\n * Deleted property `template_url` (string)\r\n\r\n### `POST` /dms/configure/document-package\r\n\r\n\r\nRequest:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Changed property `documents` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `template` (string)\r\n\r\n * Deleted property `template_url` (string)\r\n\r\nReturn Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `documents` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `template` (string)\r\n\r\n * Deleted property `template_url` (string)\r\n\r\n### `GET` /dms/configure/document-package-by-reference-id\r\n\r\n\r\nReturn Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `documents` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `template` (string)\r\n\r\n * Deleted property `template_url` (string)\r\n\r\n\r\n\r\n# API Docs Version 1.3.1\r\n---\r\n## What's New\r\n\r\n\r\n### `PATCH` /dms/delete-customer\r\n\r\n> Delete customer\r\n\r\n\r\n### `PATCH` /dms/customer/delete-signature\r\n\r\n> Delete single customer signature record\r\n\r\n\r\n### `GET` /dms/customer/status-flag-hitsory\r\n\r\n> Get status flag history\r\n\r\n\r\n### `GET` /dms/configure/all-quotations\r\n\r\n> Get Specific quotation\r\n\r\n\r\n### `GET` /dms/configure/order-status/\r\n\r\n> Get orders record filtered on order status\r\n\r\n\r\n### `GET` /dms/configure/order/status/\r\n\r\n> Update order status history record by order refrence number\r\n\r\n\r\n### `DELETE` /dms/configure/appointments/\r\n\r\n> Delete created appointment\r\n\r\n\r\n### `PATCH` /dms/configure/appointments/\r\n\r\n> Update an created appointment\r\n\r\n\r\n### `DELETE` /dms/consents/\r\n\r\n> Delete consents\r\n\r\n\r\n## What's Deleted\r\n\r\n\r\n### `GET` /dms/configure/order-status/{order_status}\r\n\r\n> Get orders record filtered on order status\r\n\r\n\r\n### `GET` /dms/configure/order/status/{order_reference_number}\r\n\r\n> Update order status history record by order refrence number\r\n\r\n\r\n### `DELETE` /dms/configure/appointments/{appointment_id}\r\n\r\n> Delete created appointment\r\n\r\n\r\n### `PATCH` /dms/configure/appointments/{appointment_id}\r\n\r\n> Update an created appointment\r\n\r\n\r\n### `DELETE` /dms/consents/{consents_id}\r\n\r\n> Delete consents\r\n\r\n\r\n## What's Deprecated\r\n\r\n\r\n### `DELETE` /dms/customer/signature\r\n\r\n> Deprecate signature delete enpoint. Use [delete-signature] instead\r\n\r\n\r\n### `DELETE` /dms/customer\r\n\r\n> Deprecate customer delete enpoint. Use [delete-customer] instead\r\n\r\n\r\n## What's Changed\r\n\r\n\r\n### `GET` /dms/consents/\r\n\r\n\r\nReturn Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n### `GET` /dms/customer/customer-history\r\n\r\n\r\nParameters:\r\n\r\nAdded: `from_date` in `query`\r\n> Format: YYYY-MM-DD\r\n\r\n\r\nAdded: `to_date` in `query`\r\n> Format: YYYY-MM-DD\r\n\r\n\r\n### `PATCH` /dms/check-customer-by-email\r\n\r\n\r\nReturn Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n### `GET` /dms/customer/license-info-history\r\n\r\n\r\nParameters:\r\n\r\nAdded: `from_date` in `query`\r\n> Format: YYYY-MM-DD\r\n\r\n\r\nAdded: `to_date` in `query`\r\n> Format: YYYY-MM-DD\r\n\r\n\r\n### `DELETE` /dms/customer/signature\r\n\r\n> Deprecate signature delete enpoint. Use [delete-signature] instead\r\n\r\n\r\n### `GET` /dms/customer/insurance-information-history\r\n\r\n\r\nParameters:\r\n\r\nAdded: `from_date` in `query`\r\n> Format: YYYY-MM-DD\r\n\r\n\r\nAdded: `to_date` in `query`\r\n> Format: YYYY-MM-DD\r\n\r\n\r\n### `POST` /dms/quote/calculation\r\n\r\n\r\nReturn Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n### `POST` /dms/configure/appointment\r\n\r\n\r\nRequest:\r\n\r\nChanged content type : `application/json`\r\n\r\nNew required properties:\r\n- `appointment_date`\r\n- `customer_id`\r\n- `dealer_id`\r\n- `order_id`\r\n\r\n### `GET` /dms/customer/document\r\n\r\n\r\nReturn Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n Changed items (object):\r\n\r\n * Added property `comment` (string)\r\n\r\n * Added property `category` (string)\r\n\r\n### `POST` /dms/customer/document\r\n\r\n\r\nReturn Type:\r\n\r\nChanged response : **201 Created**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `comment` (string)\r\n\r\n * Added property `category` (string)\r\n\r\n### `PATCH` /dms/customer/document\r\n\r\n\r\nRequest:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Added property `comment` (string)\r\n\r\n* Added property `category` (string)\r\n\r\nReturn Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `comment` (string)\r\n\r\n * Added property `category` (string)\r\n\r\n### `GET` /dms/customer/document/status\r\n\r\n\r\nReturn Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `comment` (string)\r\n\r\n * Added property `category` (string)\r\n\r\n### `PATCH` /dms/customer/document/status\r\n\r\n\r\nReturn Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `comment` (string)\r\n\r\n * Added property `category` (string)\r\n\r\n### `POST` /dms/customer/document/review\r\n\r\n\r\nRequest:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Changed property `review_status` (string)\r\n > An enumeration.\r\n\r\n\r\n Added enum values:\r\n\r\n * `Draft`\r\n * `InProgress`\r\n### `PATCH` /dms/customer/document/uploading-status\r\n\r\n\r\nReturn Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `comment` (string)\r\n\r\n * Added property `category` (string)\r\n\r\n### `DELETE` /dms/customer\r\n\r\n> Deprecate customer delete enpoint. Use [delete-customer] instead\r\n\r\n\r\n### `GET` /dms/customer\r\n\r\n\r\nParameters:\r\n\r\nAdded: `ssn` in `query`\r\n\r\nChanged: `reference_id` in `query`\r\n\r\n### `GET` /dms/customer/third-party-response-history\r\n\r\n\r\nReturn Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n Changed items (object):\r\n\r\n * Changed property `license_detail` (object)\r\n\r\n * Added property `address` (object)\r\n\r\n * Property `address_line_1` (string)\r\n > Address line one\r\n\r\n\r\n * Property `address_line_2` (string)\r\n > Address line two\r\n\r\n\r\n * Property `state_name` (string)\r\n > Address state name\r\n\r\n\r\n * Property `zip_code` (string)\r\n > Zip code\r\n\r\n\r\n * Property `county` (string)\r\n > Address county\r\n\r\n\r\n * Property `city` (string)\r\n > Address city\r\n\r\n\r\n * Property `contact_number` (string)\r\n > Contact number\r\n\r\n\r\n * Property `verified` (boolean)\r\n > Is Address verified\r\n\r\n\r\n### `GET` /dms/configure/all-quotation\r\n\r\n\r\nParameters:\r\n\r\nAdded: `reference_number` in `query`\r\n\r\nReturn Type:\r\n\r\nNew response : **422 Unprocessable Entity**\r\n> Validation Error\r\n\r\n### `GET` /dms/customer/all-customers\r\n\r\n\r\nParameters:\r\n\r\nChanged: `sort_by` in `query`\r\n\r\n\r\n\r\n# API Docs Version 1.3.0\r\n--- \r\n\r\n## What's New\r\n\r\n\r\n### `GET` /dms/customer/document/download\r\n\r\n> Get customer document url by artifect_id\r\n\r\n\r\n### `GET` /dms/configure/document-package-by-reference-id\r\n\r\n> Get Document Package by Identifier\r\n\r\n\r\n## What's Changed\r\n\r\n\r\n### `GET` /dms/health\r\n\r\n\r\n### `GET` /dms/customer/customer-history\r\n\r\n\r\n### `PATCH` /dms/check-customer-by-email\r\n\r\n\r\nReturn Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n### `GET` /dms/customer/license-info-history\r\n\r\n\r\n### `GET` /dms/customer/employment-info\r\n\r\n\r\n### `POST` /dms/customer/employment-info\r\n\r\n\r\n### `DELETE` /dms/customer/employment-info\r\n\r\n\r\n### `PATCH` /dms/customer/employment-info\r\n\r\n\r\n### `GET` /dms/customer/personal-finance\r\n\r\n\r\n### `POST` /dms/customer/personal-finance\r\n\r\n\r\n### `DELETE` /dms/customer/personal-finance\r\n\r\n\r\n### `PATCH` /dms/customer/personal-finance\r\n\r\n\r\n### `POST` /dms/customer/payment-information/\r\n\r\n\r\n### `GET` /dms/customer/payment-information\r\n\r\n\r\n### `DELETE` /dms/customer/payment-information\r\n\r\n\r\n### `PATCH` /dms/customer/payment-information\r\n\r\n\r\n### `GET` /dms/customer/signature\r\n\r\n\r\n### `POST` /dms/customer/signature\r\n\r\n\r\n### `DELETE` /dms/customer/signature\r\n\r\n\r\n### `PATCH` /dms/customer/signature\r\n\r\n\r\n### `GET` /dms/address\r\n\r\n\r\n### `POST` /dms/address\r\n\r\n\r\n### `DELETE` /dms/address\r\n\r\n\r\n### `PATCH` /dms/address\r\n\r\n\r\n### `POST` /dms/customer/insurance-information\r\n\r\n\r\n### `DELETE` /dms/customer/insurance-information\r\n\r\n\r\n### `PATCH` /dms/customer/insurance-information\r\n\r\n\r\n### `GET` /dms/customer/insurance-information-history\r\n\r\n\r\n### `GET` /dms/customer/insurance-information-by-customer\r\n\r\n\r\n### `GET` /dms/customer/insurance-information-by-order\r\n\r\n\r\n### `GET` /dms/customer/status-flag\r\n\r\n\r\n### `POST` /dms/customer/status-flag\r\n\r\n\r\n### `DELETE` /dms/customer/status-flag\r\n\r\n\r\n### `POST` /dms/customer/comment\r\n\r\n\r\n### `PATCH` /dms/customer/comment\r\n\r\n\r\n### `GET` /dms/customer/comments\r\n\r\n\r\nParameters:\r\n\r\nAdded: `page_number` in `query`\r\n\r\nAdded: `page_size` in `query`\r\n\r\nReturn Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n### `GET` /dms/configure/disclaimer\r\n\r\n\r\n### `POST` /dms/configure/disclaimer\r\n\r\n\r\n### `GET` /dms/configure/disclaimer-by-name/{name}\r\n\r\n\r\n### `GET` /dms/configure/all-disclaimer\r\n\r\n\r\n### `PATCH` /dms/configure/disclaimer-status\r\n\r\n\r\n### `PATCH` /dms/configure/disclaimer/{name}\r\n\r\n\r\n### `GET` /dms/configure/disclaimer-agreement\r\n\r\n\r\n### `POST` /dms/configure/disclaimer-agreement\r\n\r\n\r\n### `DELETE` /dms/configure/disclaimer-agreement\r\n\r\n\r\n### `GET` /dms/configure/disclaimer-agreement-datetime\r\n\r\n\r\n### `GET` /dms/customer/document\r\n\r\n\r\nReturn Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n Changed items (object):\r\n\r\n New required properties:\r\n - `document_reviews`\r\n\r\n * Added property `document_reviews` (array)\r\n\r\n Items (object):\r\n\r\n * Property `reviewed_by` (string)\r\n\r\n * Property `review_date_time` (string)\r\n > format: YYYY-MM-DD hh:mm:ss\r\n\r\n\r\n * Property `review_status` (string)\r\n\r\n * Property `review_notes` (string)\r\n\r\n * Property `identifier` (string)\r\n\r\n### `POST` /dms/customer/document\r\n\r\n\r\nRequest:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Deleted property `document_status` (string)\r\n\r\n### `DELETE` /dms/customer/document\r\n\r\n\r\n### `PATCH` /dms/customer/document\r\n\r\n\r\nRequest:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Deleted property `document_status` (string)\r\n\r\n### `GET` /dms/customer/document/status\r\n\r\n\r\n### `PATCH` /dms/customer/document/status\r\n\r\n\r\nRequest:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Changed property `document_status` (string)\r\n > An enumeration.\r\n\r\n\r\n Added enum values:\r\n\r\n * `Draft`\r\n * `InProgress`\r\n * `Approved`\r\n * `SoftReject`\r\n * `Reject`\r\n### `GET` /dms/customer/document/review\r\n\r\n> Get customer document status\r\n\r\n\r\n### `POST` /dms/customer/document/review\r\n\r\n\r\nRequest:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Changed property `review_status` (string)\r\n > An enumeration.\r\n\r\n\r\n Added enum values:\r\n\r\n * `Approved`\r\n * `SoftReject`\r\n * `Reject`\r\n### `GET` /dms/customer/document/uploading-status\r\n\r\n\r\n### `PATCH` /dms/customer/document/uploading-status\r\n\r\n\r\n### `GET` /dms/configure/document-package/document\r\n\r\n\r\nReturn Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Deleted property `document_storage_artifact_id` (string)\r\n\r\n### `POST` /dms/configure/{document_package_id}/{document_id}/{signature_id}\r\n\r\n\r\nReturn Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Deleted property `document_storage_artifact_id` (string)\r\n\r\n### `POST` /dms/customer/\r\n\r\n\r\n### `DELETE` /dms/customer\r\n\r\n\r\n### `GET` /dms/customer\r\n\r\n\r\n### `PATCH` /dms/customer\r\n\r\n\r\n### `GET` /dms/customer-by-email\r\n\r\n\r\n### `GET` /dms/customer/license-info\r\n\r\n\r\n### `DELETE` /dms/customer/license-info\r\n\r\n\r\n### `PATCH` /dms/customer/license-info\r\n\r\n\r\n### `POST` /dms/customer/license-info\r\n\r\n\r\n### `GET` /dms/customer/third-party-response-history\r\n\r\n\r\n### `DELETE` /dms/configure/document-package\r\n\r\n\r\n### `GET` /dms/configure/document-package\r\n\r\n\r\nReturn Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `documents` (array)\r\n\r\n Changed items (object):\r\n\r\n * Deleted property `document_storage_artifact_id` (string)\r\n\r\n### `POST` /dms/configure/document-package\r\n\r\n\r\nReturn Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `documents` (array)\r\n\r\n Changed items (object):\r\n\r\n * Deleted property `document_storage_artifact_id` (string)\r\n\r\n### `GET` /dms/customer/all-customers\r\n\r\n\r\n\r\n\r\n# API Docs Version 1.2.10\r\n---\r\n## What's New\r\n\r\n\r\n### `GET` /dms/customer/status-flag\r\n\r\n> Get all customer status flag\r\n\r\n\r\n### `POST` /dms/customer/status-flag\r\n\r\n> Create customer status flag\r\n\r\n\r\n### `DELETE` /dms/customer/status-flag\r\n\r\n> Remove customer status flag\r\n\r\n\r\n### `POST` /dms/customer/comment\r\n\r\n> Create customer comment dairy\r\n\r\n\r\n### `PATCH` /dms/customer/comment\r\n\r\n> Update customer comment dairy\r\n\r\n\r\n### `GET` /dms/customer/comments\r\n\r\n> Get customer comment dairy\r\n\r\n\r\n## What's Changed\r\n\r\n\r\n### `GET` /dms/customer/license-info-history\r\n\r\n\r\n Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n Changed items (object):\r\n\r\n * Added property `call_type` (string)\r\n > An enumeration.\r\n\r\n\r\n Enum values:\r\n\r\n * `manual`\r\n * `auto`\r\n### `GET` /dms/customer/third-party-response-history\r\n\r\n\r\n Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n Changed items (object):\r\n\r\n * Added property `status` (string)\r\n\r\n * Added property `license_detail` (object)\r\n\r\n * Property `first_name` (string)\r\n > First name\r\n\r\n\r\n * Property `last_name` (string)\r\n > Last name\r\n\r\n\r\n * Property `date_of_birth` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n * Property `license_number` (string)\r\n > license number\r\n\r\n\r\n * Property `issue_date` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n * Property `expiry_date` (string)\r\n > format: YYYY-MM-DD\r\n\r\n\r\n * Property `front_image` (string)\r\n > license front image\r\n\r\n\r\n * Property `back_image` (string)\r\n > license back image\r\n\r\n\r\n * Property `status` (string)\r\n\r\n * Property `call_type` (string)\r\n > An enumeration.\r\n\r\n\r\n * Property `selfie_image` (string)\r\n\r\n * Property `cropped_front_image` (string)\r\n\r\n * Property `cropped_back_image` (string)\r\n\r\n * Property `cropped_selfie_image` (string)\r\n\r\n * Property `is_selfie_verified` (boolean)\r\n\r\n * Property `created_by` (string)\r\n\r\n### `POST` /dms/customer/insurance-information\r\n\r\n\r\n Return Type:\r\n\r\nChanged response : **201 Created**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `status` (string)\r\n > An enumeration.\r\n\r\n\r\n Enum values:\r\n\r\n * `Verified`\r\n * `Unverified`\r\n * `Expired`\r\n### `PATCH` /dms/customer/insurance-information\r\n\r\n\r\n Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Added property `status` (string)\r\n > An enumeration.\r\n\r\n\r\n* Added property `insurer_address` (object)\r\n\r\n * Property `address_line_1` (string)\r\n > Address line one\r\n\r\n\r\n * Property `address_line_2` (string)\r\n > Address line two\r\n\r\n\r\n * Property `state_name` (string)\r\n > Address state name\r\n\r\n\r\n * Property `zip_code` (string)\r\n > Zip code\r\n\r\n\r\n * Property `county` (string)\r\n > Address county\r\n\r\n\r\n * Property `city` (string)\r\n > Address city\r\n\r\n\r\n * Property `contact_number` (string)\r\n > Contact number\r\n\r\n\r\n * Property `verified` (boolean)\r\n > Is Address verified\r\n\r\n\r\n Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `insurer_address` (object)\r\n\r\n * Added property `status` (string)\r\n > An enumeration.\r\n\r\n\r\n### `GET` /dms/customer/insurance-information-history\r\n\r\n\r\n Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n Changed items (object):\r\n\r\n * Added property `status` (string)\r\n > An enumeration.\r\n\r\n\r\n### `GET` /dms/customer/insurance-information-by-customer\r\n\r\n\r\n Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `status` (string)\r\n > An enumeration.\r\n\r\n\r\n### `GET` /dms/customer/insurance-information-by-order\r\n\r\n\r\n Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `status` (string)\r\n > An enumeration.\r\n\r\n\r\n### `GET` /dms/customer/license-info\r\n\r\n> Get license info record by reference id\r\n\r\n\r\n### `PATCH` /dms/customer/license-info\r\n\r\n\r\n Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Added property `call_type` (string)\r\n > An enumeration.\r\n\r\n\r\n Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `call_type` (string)\r\n > An enumeration.\r\n\r\n\r\n### `POST` /dms/customer/license-info\r\n\r\n\r\n Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Added property `call_type` (string)\r\n > An enumeration.\r\n\r\n\r\n Return Type:\r\n\r\nChanged response : **201 Created**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `call_type` (string)\r\n > An enumeration.\r\n\r\n\r\n\r\n\r\n# Docs Version 1.2.9\r\n---\r\n## What's Changed\r\n### `GET` /dms/customer/license-info-history\r\n\r\n\r\n Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n Changed items (object):\r\n\r\n * Added property `created_by` (string)\r\n\r\n### `PATCH` /dms/configure/disclaimer/{name}\r\n\r\n\r\n Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Added property `meta_data` (object)\r\n\r\n### `GET` /dms/customer/document\r\n\r\n\r\n Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n Changed items (object):\r\n\r\n * Added property `document_name` (string)\r\n\r\n * Added property `reason_by_system` (string)\r\n\r\n * Added property `reason_for_customer` (string)\r\n\r\n * Added property `document_upload_indicator` (boolean)\r\n\r\n * Added property `created_by` (string)\r\n\r\n * Deleted property `document_location` (string)\r\n\r\n * Deleted property `document` (string)\r\n\r\n### `POST` /dms/customer/document\r\n\r\n\r\n Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Added property `created_by` (string)\r\n\r\n### `PATCH` /dms/customer/document\r\n\r\n\r\n Request:\r\n\r\nChanged content type : `application/json`\r\n\r\nNew required properties:\r\n- `customer_reference_id`\r\n\r\n* Added property `customer_reference_id` (string)\r\n\r\n### `GET` /dms/configure/document-package/document\r\n\r\n\r\n Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `signatures` (array)\r\n\r\n Changed items (object):\r\n\r\n New required properties:\r\n - `id`\r\n - `type`\r\n\r\n### `POST` /dms/configure/{document_package_id}/{document_id}/{signature_id}\r\n\r\n\r\n Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `signatures` (array)\r\n\r\n Changed items (object):\r\n\r\n New required properties:\r\n - `id`\r\n - `type`\r\n\r\n### `PATCH` /dms/customer/license-info\r\n\r\n\r\n Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Added property `created_by` (string)\r\n\r\n Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `created_by` (string)\r\n\r\n### `POST` /dms/customer/license-info\r\n\r\n\r\n Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Added property `created_by` (string)\r\n\r\n Return Type:\r\n\r\nChanged response : **201 Created**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `created_by` (string)\r\n\r\n### `GET` /dms/configure/document-package\r\n\r\n\r\n Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `documents` (array)\r\n\r\n Changed items (object):\r\n\r\n * Changed property `signatures` (array)\r\n\r\n Changed items (object):\r\n\r\n New required properties:\r\n - `id`\r\n - `type`\r\n\r\n### `POST` /dms/configure/document-package\r\n\r\n\r\n Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Changed property `documents` (array)\r\n\r\n Changed items (object):\r\n\r\n * Changed property `signatures` (array)\r\n\r\n Changed items (object):\r\n\r\n New required properties:\r\n - `id`\r\n - `type`\r\n\r\n Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `documents` (array)\r\n\r\n Changed items (object):\r\n\r\n * Changed property `signatures` (array)\r\n\r\n Changed items (object):\r\n\r\n New required properties:\r\n - `id`\r\n - `type`\r\n\r\n### `GET` /dms/customer/all-customers\r\n\r\n\r\n Parameters:\r\n\r\nAdded: `sort` in `query`\r\n\r\nAdded: `sort_by` in `query`\r\n\r\n\r\n\r\n\r\n# Docs Version 1.2.8\r\n---\r\n\r\nFollowing methods have been removed:\r\n- GET /dms/dealer Get all dealers\r\n- GET /dms/dealer-by-code/{dealer_code} Get dealer record by dealer code\r\n- GET /dms/dealers-by-lender/{lender_id} Delete dealer\r\n- POST /dms/dealer/ Create dealer record\r\n- DELETE /dms/dealer/{dealer_id} Delete dealer\r\n- POST /dms/dealer/authenticate Create authentication of dealer\r\n- PATCH /dms/dealer/change-password/{dealer_id} Change passowrd of existing dealer\r\n- GET /dms/dealer/option Get all dealer option against a dealer\r\n- POST /dms/dealer/option Creates new option-accessories\r\n- GET /dms/dealer/option/filter Get all filtered records of dealers\r\n- GET /dms/dealer/option-trim-code Get all option accessories by trim id\r\n- GET /dms/dealer/option/{option_id} Get option-accessories by ID\r\n- DELETE /dms/dealer/option/{option_id} Delete option-accessories record\r\n- PATCH /dms/dealer/option/{option_id} Update dealer option by dealer option ID\r\n- GET /dms/dealer/fee Get all dealer fees\r\n- POST /dms/dealer/fee Create new dealer fee\r\n- GET /dms/dealer/{dealer_id}/fees Get fee by fee ID\r\n- GET /dms/dealer/{dealer_id}/fees/{state_id} Get all dealer fee with respect to state\r\n- GET /dms/dealer/fee/{fee_id} Get fee by fee ID\r\n- DELETE /dms/dealer/fee/{fee_id} Delete dealer fee by fee ID\r\n- PATCH /dms/dealer/fee/{fee_id} Update fee by fee ID\r\n\r\nFollowing methods have been updated:\r\n- `GET` /dms/customer/customer-history\r\n\r\n\r\n Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n Changed items (object):\r\n\r\n * Added property `stripe_customer_id` (string)\r\n\r\n- `POST` /dms/customer/payment-information/\r\n\r\n\r\n Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Deleted property `stripe_customer_id` (string)\r\n\r\n Return Type:\r\n\r\nChanged response : **201 Created**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Deleted property `stripe_customer_id` (string)\r\n\r\n- `GET` /dms/customer/payment-information\r\n\r\n\r\n Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n Changed items (object):\r\n\r\n * Deleted property `stripe_customer_id` (string)\r\n\r\n- `PATCH` /dms/customer/payment-information\r\n\r\n\r\n Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Deleted property `stripe_customer_id` (string)\r\n\r\n Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Deleted property `stripe_customer_id` (string)\r\n\r\n- `DELETE` /dms/customer/signature\r\n\r\n\r\n Request:\r\n\r\nNew content type : `application/json`\r\n\r\n- `PATCH` /dms/customer/signature\r\n\r\n\r\n Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Added property `updated_by` (string)\r\n\r\n- `POST` /dms/customer/insurance-information\r\n\r\n\r\n Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Added property `insurer_address` (object)\r\n\r\n * Property `address_line_1` (string)\r\n > Address line one\r\n\r\n\r\n * Property `address_line_2` (string)\r\n > Address line two\r\n\r\n\r\n * Property `state_name` (string)\r\n > Address state name\r\n\r\n\r\n * Property `zip_code` (string)\r\n > Zip code\r\n\r\n\r\n * Property `county` (string)\r\n > Address county\r\n\r\n\r\n * Property `city` (string)\r\n > Address city\r\n\r\n\r\n * Property `contact_number` (string)\r\n > Contact number\r\n\r\n\r\n * Property `verified` (boolean)\r\n > Is Address verified\r\n\r\n\r\n* Deleted property `insurance_address` (object)\r\n\r\n Return Type:\r\n\r\nChanged response : **201 Created**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `insurer_address` (object)\r\n\r\n * Deleted property `insurance_address` (object)\r\n\r\n- `GET` /dms/customer/insurance-information-by-customer\r\n\r\n\r\n Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `insurer_address` (object)\r\n\r\n * Deleted property `insurance_address` (object)\r\n\r\n- `GET` /dms/customer/insurance-information-by-order\r\n\r\n\r\n Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `insurer_address` (object)\r\n\r\n * Deleted property `insurance_address` (object)\r\n\r\n- `GET` /dms/customer/document\r\n\r\n\r\n Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n Changed items (object):\r\n\r\n * Added property `document_location` (string)\r\n\r\n- `GET` /dms/configure/document-package/document\r\n\r\n\r\n Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `pdf` (string)\r\n\r\n * Changed property `signatures` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `type` (string)\r\n\r\n * Added property `signer` (string)\r\n\r\n * Added property `signed_at` (string)\r\n\r\n * Added property `x` (integer)\r\n\r\n * Added property `y` (integer)\r\n\r\n * Added property `width` (integer)\r\n\r\n * Added property `height` (integer)\r\n\r\n * Added property `page` (integer)\r\n\r\n- `POST` /dms/configure/{document_package_id}/{document_id}/{signature_id}\r\n\r\n\r\n Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n- `POST` /dms/customer/\r\n\r\n\r\n Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Changed property `customer_profile` (object)\r\n\r\n * Added property `stripe_customer_id` (string)\r\n\r\n Return Type:\r\n\r\nChanged response : **201 Created**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `stripe_customer_id` (string)\r\n\r\n * Changed property `payments_info` (array)\r\n\r\n Changed items (object):\r\n\r\n * Deleted property `stripe_customer_id` (string)\r\n\r\n- `PATCH` /dms/check-customer-by-email\r\n\r\n\r\n Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `stripe_customer_id` (string)\r\n\r\n * Changed property `payments_info` (array)\r\n\r\n Changed items (object):\r\n\r\n * Deleted property `stripe_customer_id` (string)\r\n\r\n- `DELETE` /dms/customer\r\n\r\n\r\n Request:\r\n\r\nNew content type : `application/json`\r\n\r\n- `GET` /dms/customer\r\n\r\n\r\n Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `stripe_customer_id` (string)\r\n\r\n * Changed property `payments_info` (array)\r\n\r\n Changed items (object):\r\n\r\n * Deleted property `stripe_customer_id` (string)\r\n\r\n- `PATCH` /dms/customer\r\n\r\n\r\n Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Changed property `customer_profile` (object)\r\n\r\n * Added property `stripe_customer_id` (string)\r\n\r\n * Added property `updated_by` (string)\r\n\r\n Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `stripe_customer_id` (string)\r\n\r\n * Changed property `payments_info` (array)\r\n\r\n Changed items (object):\r\n\r\n * Deleted property `stripe_customer_id` (string)\r\n\r\n- `GET` /dms/customer-by-email\r\n\r\n\r\n Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Added property `stripe_customer_id` (string)\r\n\r\n * Changed property `payments_info` (array)\r\n\r\n Changed items (object):\r\n\r\n * Deleted property `stripe_customer_id` (string)\r\n\r\n- `GET` /dms/configure/document-package\r\n\r\n\r\n Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `documents` (array)\r\n\r\n Changed items (object):\r\n\r\n * Changed property `signatures` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `type` (string)\r\n\r\n * Added property `signer` (string)\r\n\r\n * Added property `signed_at` (string)\r\n\r\n * Added property `x` (integer)\r\n\r\n * Added property `y` (integer)\r\n\r\n * Added property `width` (integer)\r\n\r\n * Added property `height` (integer)\r\n\r\n * Added property `page` (integer)\r\n\r\n- `POST` /dms/configure/document-package\r\n\r\n\r\n Request:\r\n\r\nChanged content type : `application/json`\r\n\r\n* Changed property `documents` (array)\r\n\r\n Changed items (object):\r\n\r\n * Changed property `signatures` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `type` (string)\r\n\r\n * Added property `signer` (string)\r\n\r\n * Added property `signed_at` (string)\r\n\r\n * Added property `x` (integer)\r\n\r\n * Added property `y` (integer)\r\n\r\n * Added property `width` (integer)\r\n\r\n * Added property `height` (integer)\r\n\r\n * Added property `page` (integer)\r\n\r\n Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `documents` (array)\r\n\r\n Changed items (object):\r\n\r\n * Changed property `signatures` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `type` (string)\r\n\r\n * Added property `signer` (string)\r\n\r\n * Added property `signed_at` (string)\r\n\r\n * Added property `x` (integer)\r\n\r\n * Added property `y` (integer)\r\n\r\n * Added property `width` (integer)\r\n\r\n * Added property `height` (integer)\r\n\r\n * Added property `page` (integer)\r\n\r\n- `GET` /dms/customer/all-customers\r\n\r\n\r\n Return Type:\r\n\r\nChanged response : **200 OK**\r\n> Successful Response\r\n\r\n\r\n* Changed content type : `application/json`\r\n\r\n * Changed property `result` (array)\r\n\r\n Changed items (object):\r\n\r\n * Added property `stripe_customer_id` (string)\r\n\r\n * Changed property `payments_info` (array)\r\n\r\n Changed items (object):\r\n\r\n * Deleted property `stripe_customer_id` (string)\r\n\r\n\r\n\r\n# Docs Version 1.2.7\r\n---\r\n\r\n- GET/dms/customer/customer-history method added\r\n- GET/dms/customer/license-info-history method added\r\n- GET/dms/customer/third-party-response-history method added\r\n- `POST` /dms/customer/insurance-information method updated\r\n- `PATCH` /dms/customer/insurance-information method updated\r\n- `GET` /dms/customer/insurance-information-by-customer method updated\r\n- `GET` /dms/customer/insurance-information-by-order method updated\r\n- `GET` /dms/customer/insurance-information-history method updated\r\n- `GET` /dms/configure/disclaimer method updated\r\n- `POST` /dms/configure/disclaimer method updated\r\n- `GET` /dms/configure/disclaimer-by-name/{name} method updated\r\n- `GET` /dms/configure/all-disclaimer method updated\r\n- `PATCH` /dms/configure/disclaimer/{name} method updated\r\n- `POST` /dms/customer/ method updated\r\n- `PATCH` /dms/check-customer-by-email method updated\r\n- `GET` /dms/customer method updated\r\n- `PATCH` /dms/customer method updated\r\n- `GET` /dms/customer-by-email method updated\r\n- `DELETE` /dms/customer/license-info method updated\r\n- `PATCH` /dms/customer/license-info method updated\r\n- `GET` /dms/customer/all-customers method updated\r\n\r\n# Docs Version 1.2.6\r\n---\r\n\r\n- GET/dms/customer/all-customers method parameter and response update\r\n- GET/dms/configure/document-package/document method response update\r\n- POST/dms/customer/ methods request and response update\r\n- PATCH/dms/check-customer-by-email method response update\r\n- GET/dms/customer method request/response update\r\n- PATCH/dms/customer method request/response update\r\n- GET/dms/customer-by-email method request/response update\r\n- GET/dms/configure/document-package method request/response update\r\n- POST/dms/configure/document-package method request/response update\r\n \r\n\r\n# Docs Version 1.2.5\r\n---\r\n\r\n- GET /dms/customer/customer_history Get all customer records history method deleted\r\n- POST/dms/customer/insurance-information method request and response updated\r\n- PATCH/dms/customer/insurance-information method request and response updated\r\n- GET/dms/customer/insurance-information-by-customer method response updated\r\n- GET/dms/customer/insurance-information-by-order method response updated\r\n- GET/dms/customer/insurance-information-history method response updated\r\n\r\n# Docs Version 1.2.4\r\n---\r\n- GET/dms/customer/document/review method response updated\r\n- POST/dms/customer/document/review method response updated\r\n- GET/dms/configure/document-package method response updated\r\n\r\n\r\n# Docs Version 1.2.3\r\n---\r\n\r\n- GET /dms/customer/customer-history method added\r\n- PATCH/dms/check-customer-by-email method response updated\r\n- GET/dms/customer/document method response updated\r\n- POST/dms/customer/document method request and response updated\r\n- PATCH/dms/customer/document method request and response updated\r\n- GET/dms/customer/document/status method response updated\r\n- PATCH/dms/customer/document/status method response updated\r\n- PATCH/dms/customer/document/uploading-status method response updated\r\n\r\n# Docs Version 1.2.2\r\n---\r\n- GET /dms/customer/document method response updated\r\n- POST /dms/customer/document method response updated\r\n- PATCH /dms/customer/document method request and response updated\r\n- GET /dms/customer/document/status method response updated\r\n- PATCH /dms/customer/document/status method response updated\r\n- PATCH /dms/customer/document/uploading-status method response updated\r\n \r\n\r\n# Docs Version 1.2.1\r\n---\r\n- POST /dms/quote/calculation/quantity method added\r\n- POST /dms/configure/save-quotation method request and response updated\r\n- POST /dms/quote/calculation method request updated\r\n- POST /dms/quote/calculation/multi-assets method request updated\r\n- PATCH /dms/customer/document method request updated\r\n- GET /dms/configure/quotation method response updated\r\n- GET /dms/configure/all-quotation method response updated\r\n- DELETE /dms/configure/quotation/{order_id} method response updated\r\n- PATCH /dms/configure/quotation/{order_id} method request and response updated\r\n- PATCH /dms/configure/order/update-status/{order-id} method response updated\r\n \r\n \r\n# Docs Version 1.2.0\r\n---\r\n- /dms/order/expiry/{order_stage}/{dealer_id} GET method added\r\n- DELETE /dms/address parameters updated\r\n\r\n \r\n# Docs Version 1.1.9\r\n---\r\n- /dms/address GET, POST, DELETE and PATCH request and response updated\r\n- /dms/qoute/calculation POST request updated\r\n- /dms/qoute/calculation/multi-assets POST request updated\r\n- /dms/customer/document POST and PATCH request updated\r\n- /dms/customer/ POST request and response updated\r\n- /dms/customer/all-customers GET response updated\r\n- /dms/customer/ GET and PATCH request and response updated\r\n- /dms/customer/customer-by-email GET response updated\r\n- /dms/customer/license-info POST and PATCH response updated\r\n \r\n \r\n# Docs Version 1.1.8\r\n---\r\n- Sign Document Method added\r\n- Document-package GET Response updated\r\n- Document-package POST Request and Response updated\r\n\r\n# Docs Version 1.1.7\r\n---\r\n- insurance-information updated\r\n- insurance-information-by-customer updated\r\n- insurance-information-by-order updated\r\n- insurance-information-history updated\r\n- Schema updated\r\n\r\n# Docs Version 1.1.5\r\n---\r\n- Customer Document tag methods updated\r\n- Document Package tag methods updated\r\n- Schema updated\r\n\r\n# Docs Version 1.1.4\r\n---\r\n- Get disclaimer by identifier added\r\n- Calculate quotation for multiple assets added\r\n- Schema updated\r\n\r\n# Docs Version 1.1.3\r\n---\r\n- Document Package Management tags Added\r\n- Disclaimer Management tag updated\r\n \r\n# Docs Version 1.1.1\r\n--- \r\n- Additional tags published\r\n\r\n# Docs Version 1.1.0\r\n---\r\n- Postman collections updated\r\n- Descriptions updated\r\n- Request Authorization added\r\n\r\n# Docs Version 1.0.0\r\n---\r\n- Customer Management tag added\r\n- Disclaimer Management tag added\r\n- Customer Document tag added" paths: /dms/health: get: tags: - Health - Root summary: Health description: Health operationId: health_dms_health_get responses: '200': description: Successful Response content: application/json: schema: {} security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/version: get: tags: - Version - Root summary: Version description: version operationId: version_dms_version_get responses: '200': description: Successful Response content: application/json: schema: {} /dms/customer/: post: tags: - Customers summary: Creates customer description: Create single customer record operationId: add_customer_dms_customer__post requestBody: content: application/json: schema: $ref: '#/components/schemas/CustomerProfileModel' required: true responses: '201': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CustomerProfileModelResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/customer/send-email-to-customer: post: tags: - Customers - Send - Email - Customer summary: send email to customer description: send email to customer operationId: send_on_boarding_email_dms_customer_send_email_to_customer_post requestBody: content: application/json: schema: $ref: '#/components/schemas/SendCustomerEmailModel' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/customer/all-customers: get: tags: - Customers summary: Get all customer records description: Get all record against customers operationId: get_all_customer_dms_customer_all_customers_get parameters: - required: true schema: title: Page Number type: integer name: page_number in: query - required: true schema: title: Page Size minimum: 1 type: integer name: page_size in: query - required: false schema: allOf: - $ref: '#/components/schemas/SortEnum' default: asc name: sort in: query - required: false schema: allOf: - $ref: '#/components/schemas/SortByEnum' default: created_at name: sort_by in: query responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CustomerProfilePaginationResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/customer/all-customers-dynamic-search: post: tags: - Customers - Dynamic - Search summary: Get all customer records dynamic search description: Get all customer records dynamic search operationId: >- get_all_customer_dynamic_search_dms_customer_all_customers_dynamic_search_post parameters: - required: true schema: title: Page Number type: integer name: page_number in: query - required: true schema: title: Page Size minimum: 1 type: integer name: page_size in: query - required: false schema: $ref: '#/components/schemas/SortEnum' name: sort in: query - required: false schema: $ref: '#/components/schemas/SortByEnum' name: sort_by in: query - description: 'Format: YYYY-MM-DD' required: false schema: title: From Date type: string description: 'Format: YYYY-MM-DD' format: date name: from_date in: query - description: 'Format: YYYY-MM-DD' required: false schema: title: To Date type: string description: 'Format: YYYY-MM-DD' format: date name: to_date in: query requestBody: content: application/json: schema: title: Filters type: array items: $ref: '#/components/schemas/FilterModel' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/customer/customer-history: get: tags: - Customers - History summary: Get all customers records history description: Get all customers records history operationId: get_customer_history_dms_customer_customer_history_get parameters: - required: true schema: title: Reference Id type: string name: reference_id in: query - description: 'Format: YYYY-MM-DD' required: false schema: title: From Date type: string description: 'Format: YYYY-MM-DD' format: date name: from_date in: query - description: 'Format: YYYY-MM-DD' required: false schema: title: To Date type: string description: 'Format: YYYY-MM-DD' format: date name: to_date in: query responses: '200': description: Successful Response content: application/json: schema: title: >- Response Get Customer History Dms Customer Customer History Get type: array items: $ref: '#/components/schemas/CustomerProfileModelResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/check-customer-by-email: patch: tags: - Checks - Customers - Email summary: Check customer, create if does not exist description: Check customer, create if does not exist operationId: check_customer_dms_check_customer_by_email_patch requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateCustomerModel' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CustomerProfileModelResponseWithID' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/update-dms-customer: patch: tags: - Dms - Customers summary: Update Dms Customer operationId: update_dms_customer_dms_update_dms_customer_patch parameters: - required: false schema: title: Reference Id type: string name: reference_id in: query - required: false schema: title: Dealer Code type: string name: dealer_code in: query responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/customer: get: tags: - Customers summary: Get customer record description: Get customer record by customer ID operationId: find_customer_by_reference_dms_customer_get parameters: - required: false schema: title: Reference Id type: string name: reference_id in: query - required: false schema: title: Ssn type: string name: ssn in: query - required: false schema: title: Email type: string name: email in: query responses: '200': description: Successful Response content: application/json: schema: $ref: >- #/components/schemas/CustomerProfileModelResponseWithDisclaimer '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] delete: tags: - Customers summary: Deprecate customer delete enpoint. Use [delete-customer] instead description: Delete customer record by customer ID operationId: remove_customer_deprecated_dms_customer_delete parameters: - required: true schema: title: Reference Id type: string name: reference_id in: query requestBody: content: application/json: schema: $ref: '#/components/schemas/DeleteRequestModel' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' deprecated: true security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] patch: tags: - Customers summary: Updates customer description: Update customer record by customer ID operationId: update_customer_dms_customer_patch parameters: - required: true schema: title: Reference Id type: string name: reference_id in: query - required: false schema: title: Dealer Code type: string name: dealer_code in: query requestBody: content: application/json: schema: $ref: '#/components/schemas/CustomerProfileUpdateModel' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CustomerProfileModelResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/check-dms-customer: get: tags: - Checks - Customers summary: Get customer record description: Get customer record by customer ID operationId: fetch_dms_customer_dms_check_dms_customer_get parameters: - required: false schema: title: Reference Id type: string name: reference_id in: query - required: false schema: title: Dealer Code type: string name: dealer_code in: query responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/customer-by-email: get: tags: - Customers - Email summary: Get Customer Record by email description: Gets a customer record by email operationId: find_customer_info_by_email_dms_customer_by_email_get parameters: - required: true schema: title: Email type: string name: email in: query responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CustomerProfileModelResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/delete-customer: patch: tags: - Customer summary: Delete customer description: Delete customer record by customer ID operationId: remove_customer_dms_delete_customer_patch parameters: - required: true schema: title: Reference Id type: string name: reference_id in: query requestBody: content: application/json: schema: $ref: '#/components/schemas/DeleteRequestModel' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/customer/license-info: get: tags: - Customers - Licenses - Information summary: Get license info record by reference id description: Get license info record by reference id operationId: findone_license_info_dms_customer_license_info_get parameters: - required: true schema: title: Reference Id type: string name: reference_id in: query - required: false schema: title: Is Presigned Url Required type: boolean default: false name: is_presigned_url_required in: query responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] post: tags: - Customers - Licenses - Information summary: Creates license information description: Create license information against customer operationId: add_license_info_dms_customer_license_info_post parameters: - required: false schema: title: Dealer Code type: string name: dealer_code in: query requestBody: content: application/json: schema: $ref: '#/components/schemas/LisenceInfoWithAdress' required: true responses: '201': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/LicenseInfoResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] delete: tags: - Customers - Licenses - Information summary: Delete single license information record description: Delete customer license information record of customer record ID operationId: delete_license_by_reference_id_dms_customer_license_info_delete parameters: - required: true schema: title: Reference Id type: string name: reference_id in: query responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] patch: tags: - Customers - Licenses - Information summary: Updates License Info Record description: Updates a license info setup record by license id operationId: update_license_info_dms_customer_license_info_patch parameters: - required: true schema: title: Reference Id type: string name: reference_id in: query - required: false schema: title: Is Presigned Url Required type: boolean default: false name: is_presigned_url_required in: query - required: false schema: title: Dealer Code type: string name: dealer_code in: query requestBody: content: application/json: schema: $ref: '#/components/schemas/LisenceInfoUpdateModel' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/LicenseInfoUpdateResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/customers: get: tags: - Customers summary: Gets customer names by customer reference ids description: Gets customer names by reference ids operationId: find_customer_names_dms_customers_get parameters: - required: true schema: title: Reference Ids type: array items: type: string name: reference_ids in: query responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] post: tags: - Customers summary: Gets customer names by customer reference ids description: Gets customer names by reference ids operationId: find_customer_data_dms_customers_post requestBody: content: application/json: schema: $ref: '#/components/schemas/CustomersParamsModel' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/customer/license-info-history: get: tags: - Customers - Licenses - Information - History summary: Get all customer license information history description: Get all customer license information history operationId: get_license_information_history_dms_customer_license_info_history_get parameters: - required: true schema: title: Reference Id type: string name: reference_id in: query - required: true schema: title: Page Number type: integer name: page_number in: query - required: true schema: title: Page Size minimum: 1 type: integer name: page_size in: query - description: 'Format: YYYY-MM-DD' required: false schema: title: From Date type: string description: 'Format: YYYY-MM-DD' name: from_date in: query - description: 'Format: YYYY-MM-DD' required: false schema: title: To Date type: string description: 'Format: YYYY-MM-DD' name: to_date in: query responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/LicenseInfoPaginationResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/customer/third-party-response-history: get: tags: - Customers - Party - Response - History summary: Get third party response history description: Get third party response history operationId: >- get_third_part_response_history_dms_customer_third_party_response_history_get parameters: - required: true schema: title: Reference Id type: string name: reference_id in: query - required: false schema: title: Identifier type: string name: identifier in: query - required: false schema: title: Include Images type: boolean default: false name: include_images in: query - required: false schema: title: Include Response type: boolean default: false name: include_response in: query - required: false schema: title: Type List type: array items: type: string name: type_list in: query responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/customer/employment-info: get: tags: - Customers - Employment - Information summary: Get single employment information record description: Get employment information by customer ID operationId: findone_employment_info_dms_customer_employment_info_get parameters: - required: true schema: title: Reference Id type: string name: reference_id in: query responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/EmploymentInfoResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] post: tags: - Customers - Employment - Information summary: Creates employment information description: Create employment information against customer operationId: add_customer_employment_info_dms_customer_employment_info_post parameters: - required: false schema: title: Dealer Code type: string name: dealer_code in: query requestBody: content: application/json: schema: $ref: '#/components/schemas/EmploymentInfoCreateModelEmpTypeMendatory' required: true responses: '201': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/EmploymentInfoResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] delete: tags: - Customers - Employment - Information summary: Delete single employment information record description: Delete employment information record of customer employment record ID operationId: delete_employment_info_by_id_dms_customer_employment_info_delete parameters: - required: true schema: title: Reference Id type: string name: reference_id in: query responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] patch: tags: - Customers - Employment - Information summary: Updates employment information description: Update employment information against customer operationId: update_customer_employment_info_dms_customer_employment_info_patch parameters: - required: true schema: title: Reference Id type: string name: reference_id in: query - required: false schema: title: Dealer Code type: string name: dealer_code in: query requestBody: content: application/json: schema: $ref: '#/components/schemas/EmploymentInfoUpdateModel' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/EmploymentInfoResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/customer/personal-finance: get: tags: - Customers - Personal - Finance summary: Get single personal finance information record description: Get personal finance information by customer ID operationId: findone_personal_finance_info_dms_customer_personal_finance_get parameters: - required: true schema: title: Reference Id minLength: 1 type: string name: reference_id in: query responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CustomerPersonalFinanceResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] post: tags: - Customers - Personal - Finance summary: Creates personal finance information description: Create personal finance information against customer operationId: add_personal_finance_info_dms_customer_personal_finance_post parameters: - required: false schema: title: Dealer Code type: string name: dealer_code in: query requestBody: content: application/json: schema: $ref: '#/components/schemas/PersonalFinanceModel' required: true responses: '201': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CustomerPersonalFinanceResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] delete: tags: - Customers - Personal - Finance summary: Delete single personal finance information record description: >- Delete personal finance information record of customer employment record ID operationId: delete_personal_finance_info_by_id_dms_customer_personal_finance_delete parameters: - required: true schema: title: Reference Id minLength: 1 type: string name: reference_id in: query responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] patch: tags: - Customers - Personal - Finance summary: Updates personal finance information description: Update personal finance information against customer operationId: update_personal_finance_info_dms_customer_personal_finance_patch parameters: - required: true schema: title: Reference Id type: string name: reference_id in: query - required: false schema: title: Dealer Code type: string name: dealer_code in: query requestBody: content: application/json: schema: $ref: '#/components/schemas/PersonalFinanceUpdateModel' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CustomerPersonalFinanceResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/customer/payment-information: get: tags: - Customers - Payments - Information summary: Get customer payment information description: Get customer payment information operationId: get_customer_payment_info_by_dms_customer_payment_information_get parameters: - required: true schema: title: Reference Id minLength: 1 type: string name: reference_id in: query responses: '200': description: Successful Response content: application/json: schema: title: >- Response Get Customer Payment Info By Dms Customer Payment Information Get type: array items: $ref: '#/components/schemas/CustomerPaymentInformationResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] post: tags: - Customers - Payments - Information summary: Create customer payment information description: Create customer payment information operationId: add_customer_payment_info_dms_customer_payment_information_post requestBody: content: application/json: schema: $ref: '#/components/schemas/CustomerPaymentModelTypeMandatory' required: true responses: '201': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CustomerPaymentInformationResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] delete: tags: - Customers - Payments - Information summary: Delete customer payment information description: Delete all customer payment information operationId: >- delete_customer_payment_info_by_id_dms_customer_payment_information_delete parameters: - required: true schema: title: Reference Id minLength: 1 type: string name: reference_id in: query responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] patch: tags: - Customers - Payments - Information summary: Update customer payment information description: Update customer payment information operationId: update_customer_payment_dms_customer_payment_information_patch requestBody: content: application/json: schema: $ref: '#/components/schemas/CustomerPaymentModelTypeMandatory' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CustomerPaymentInformationResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/customer/signature: get: tags: - Customers - Signatures summary: Gets a customer signature record by customer signature id description: Gets a customer signature record by customer signature id operationId: findone_customer_signature_dms_customer_signature_get parameters: - required: true schema: title: Reference Id type: string name: reference_id in: query responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CustomerSignatureResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] post: tags: - Customers - Signatures summary: 'Creates customer signature ' description: 'Creates customer signature ' operationId: add_customer_signature_dms_customer_signature_post requestBody: content: application/json: schema: $ref: '#/components/schemas/CustomerSignatureModel' required: true responses: '201': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CustomerSignatureResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] delete: tags: - Customers - Signatures summary: Deprecate signature delete enpoint. Use [delete-signature] instead description: Delete single customer signature record operationId: delete_customer_signature_deprecated_dms_customer_signature_delete parameters: - required: true schema: title: Reference Id type: string name: reference_id in: query requestBody: content: application/json: schema: $ref: '#/components/schemas/DeleteRequestModel' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' deprecated: true security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] patch: tags: - Customers - Signatures summary: 'Updates customer signature ' description: 'Updates customer signature ' operationId: update_customer_signature_dms_customer_signature_patch parameters: - required: false schema: title: Reference Id type: string name: reference_id in: query - required: false schema: title: Dealer Id type: string name: dealer_id in: query requestBody: content: application/json: schema: $ref: '#/components/schemas/CustomerSignatureUpdateModel' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CustomerSignatureResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/customer/delete-signature: patch: tags: - Customers - Signature summary: Delete single customer signature record description: Delete single customer signature record operationId: delete_customer_signature_dms_customer_delete_signature_patch parameters: - required: true schema: title: Reference Id type: string name: reference_id in: query requestBody: content: application/json: schema: $ref: '#/components/schemas/DeleteRequestModel' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/customer/signature/by-dealer-id: get: tags: - Customers - Signatures - Dealer summary: Gets a customer signature record by dealer id description: Gets a customer signature record by dealer id operationId: >- findone_customer_signature_by_dealer_dms_customer_signature_by_dealer_id_get parameters: - required: true schema: title: Dealer Id type: string name: dealer_id in: query responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CustomerSignatureResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/address: get: tags: - Address summary: Get existing record of address description: Get existing record of address operationId: get_addresses_by_customer_or_reference_id_dms_address_get parameters: - required: true schema: title: Reference Id type: string name: reference_id in: query responses: '200': description: Successful Response content: application/json: schema: title: >- Response Get Addresses By Customer Or Reference Id Dms Address Get type: array items: $ref: '#/components/schemas/AddressResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] post: tags: - Address summary: Create an address description: Create single address record operationId: add_customer_address_dms_address_post requestBody: content: application/json: schema: $ref: '#/components/schemas/AddressCreateModel' required: true responses: '201': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/AddressResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] delete: tags: - Address summary: Delete existing record of address description: Delete existing record of address operationId: delete_address_by_address_id_dms_address_delete parameters: - required: true schema: $ref: '#/components/schemas/AddressTypes' name: address_type in: query - required: true schema: title: Reference Id type: string name: reference_id in: query responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] patch: tags: - Address summary: Update an address description: Update an existing record of address operationId: update_customer_address_dms_address_patch parameters: - required: true schema: title: Reference Id type: string name: reference_id in: query requestBody: content: application/json: schema: $ref: '#/components/schemas/CustomerUpdateAddressModel' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/AddressResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/address/history: get: tags: - Address - History summary: Delete existing record of address description: Delete existing record of address operationId: address_history_dms_address_history_get parameters: - required: true schema: $ref: '#/components/schemas/AddressTypesEnum' name: address_type in: query - required: true schema: title: Reference Id type: string name: reference_id in: query responses: '200': description: Successful Response content: application/json: schema: title: Response Address History Dms Address History Get type: array items: $ref: '#/components/schemas/AddressResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/customer/insurance-information: get: tags: - Customers - Insurance - Information summary: >- Get customer insurance information by customer reference id and order reference number description: >- Get customer insurance information by customer reference id and order reference number operationId: >- get_insurance_info_by_order_and_customer_reference_number_dms_customer_insurance_information_get parameters: - description: provide valid reference_id required: true schema: title: Reference Id minLength: 1 type: string description: provide valid reference_id name: reference_id in: query - description: provide valid order_reference_id required: true schema: title: Order Reference Id minLength: 1 type: string description: provide valid order_reference_id name: order_reference_id in: query responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/InsuranceInformationResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] post: tags: - Customers - Insurance - Information summary: Create customer insurance information description: Create customer insurance information operationId: create_insurance_information_dms_customer_insurance_information_post requestBody: content: application/json: schema: $ref: '#/components/schemas/InsuranceInformationWithAddressesModel' required: true responses: '201': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/InsuranceInformationResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] delete: tags: - Customers - Insurance - Information summary: Delete single customer insurance information description: Delete single customer insurance information operationId: delete_insurance_information_dms_customer_insurance_information_delete parameters: - required: true schema: title: Reference Id type: string name: reference_id in: query responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' deprecated: true security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] patch: tags: - Customers - Insurance - Information summary: Updates customer insurance information description: Updates customer insurance information operationId: update_insurance_information_dms_customer_insurance_information_patch parameters: - required: true schema: title: Reference Id type: string name: reference_id in: query - required: false schema: title: Order Reference Id type: string name: order_reference_id in: query requestBody: content: application/json: schema: $ref: '#/components/schemas/InsuranceInformationUpdateModel' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/InsuranceInformationResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/customer/update-insurance-information: patch: tags: - Customers - Insurance - Information summary: Updates customer insurance information description: Updates customer insurance information operationId: update_insurance_dms_customer_update_insurance_information_patch parameters: - required: true schema: title: Reference Id type: string name: reference_id in: query - required: false schema: title: Order Reference Id type: string name: order_reference_id in: query requestBody: content: application/json: schema: $ref: '#/components/schemas/InsuranceInformationUpdateModel' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/InsuranceInformationResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/customer/insurance-information-history: get: tags: - Customers - Insurance - Information - History summary: Get customer insurance information history description: Get customer insurance information history operationId: >- get_insurance_information_history_dms_customer_insurance_information_history_get parameters: - required: true schema: title: Reference Id type: string name: reference_id in: query - required: true schema: title: Page Number type: integer name: page_number in: query - required: true schema: title: Page Size minimum: 1 type: integer name: page_size in: query - description: 'Format: YYYY-MM-DD' required: false schema: title: From Date type: string description: 'Format: YYYY-MM-DD' format: date name: from_date in: query - description: 'Format: YYYY-MM-DD' required: false schema: title: To Date type: string description: 'Format: YYYY-MM-DD' format: date name: to_date in: query responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/InsuranceInfoPaginationResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' deprecated: true security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/customer/insurance-information-by-customer: get: tags: - Customers - Insurance - Information - Customer summary: Get customer insurance information by customer reference id description: Get customer insurance information by customer reference id operationId: >- get_insurance_information_by_reference_id_dms_customer_insurance_information_by_customer_get parameters: - required: true schema: title: Reference Id type: string name: reference_id in: query responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/InsuranceInformationResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/customer/insurance-information-by-order: get: tags: - Customers - Insurance - Information - Order summary: Get customer insurance information by order reference number description: Get customer insurance information by order reference number operationId: >- get_insurance_information_by_order_reference_number_dms_customer_insurance_information_by_order_get parameters: - required: true schema: title: Order Reference Id type: string name: order_reference_id in: query responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/InsuranceInformationResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/customer/insurance-information/document-history: get: tags: - Customers - Insurance - Information - Documents - History summary: Get customer insurance information document history description: Get customer insurance information document history operationId: >- get_insurance_documents_dms_customer_insurance_information_document_history_get parameters: - description: provide valid reference_id required: true schema: title: Reference Id minLength: 1 type: string description: provide valid reference_id name: reference_id in: query responses: '200': description: Successful Response content: application/json: schema: title: >- Response Get Insurance Documents Dms Customer Insurance Information Document History Get type: array items: $ref: '#/components/schemas/InsuranceDocumentsResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/customer/delete-insurance-information: patch: tags: - Customers - Insurance - Information summary: Delete single customer insurance information description: Delete single customer insurance information operationId: delete_insurance_info_dms_customer_delete_insurance_information_patch parameters: - required: true schema: title: Reference Id type: string name: reference_id in: query requestBody: content: application/json: schema: $ref: '#/components/schemas/DeleteRequestModel' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/customer/insurance-information/add-document: post: tags: - Customers - Insurance - Information - Add - Documents summary: Add insurance document description: Add insurance document operationId: >- add_insurance_document_dms_customer_insurance_information_add_document_post parameters: - required: true schema: title: Reference Id type: string name: reference_id in: query requestBody: content: application/json: schema: $ref: '#/components/schemas/InsuranceDocumentsModel' required: true responses: '200': description: Successful Response content: application/json: schema: title: >- Response Add Insurance Document Dms Customer Insurance Information Add Document Post type: array items: $ref: '#/components/schemas/InsuranceDocumentsResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/customer/insurance-information/remove-document: delete: tags: - Customers - Insurance - Information - Documents summary: 'Delete insurance document ' description: 'Delete insurance document ' operationId: >- remove_insurance_document_depreceted_dms_customer_insurance_information_remove_document_delete parameters: - required: true schema: title: Reference Id type: string name: reference_id in: query - required: true schema: title: Identifier type: string name: identifier in: query responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' deprecated: true security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/customer/insurance-information/remove-insurance-document: patch: tags: - Customers - Insurance - Information - Documents summary: 'Delete insurance document ' description: 'Delete insurance document ' operationId: >- remove_insurance_document_dms_customer_insurance_information_remove_insurance_document_patch parameters: - required: true schema: title: Reference Id type: string name: reference_id in: query - required: true schema: title: Identifier type: string name: identifier in: query requestBody: content: application/json: schema: $ref: '#/components/schemas/DeleteRequestModel' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/customer/status-flag: get: tags: - Customers - Status - Flags summary: Get all customer status flag description: Get all customer status flag operationId: get_all_status_flag_dms_customer_status_flag_get parameters: - required: true schema: title: Reference Id type: string name: reference_id in: query responses: '200': description: Successful Response content: application/json: schema: title: Response Get All Status Flag Dms Customer Status Flag Get type: array items: $ref: '#/components/schemas/CustomerStatusFlagResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] post: tags: - Customers - Status - Flags summary: Create customer status flag description: Create customer status flag operationId: add_status_flag_dms_customer_status_flag_post requestBody: content: application/json: schema: $ref: '#/components/schemas/CustomerStatusFlagModel' required: true responses: '201': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CustomerStatusFlagResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] delete: tags: - Customers - Status - Flags summary: Remove customer status flag description: Remove customer status flag operationId: delete_status_dms_customer_status_flag_delete parameters: - required: true schema: title: Identifier type: string name: identifier in: query responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CustomerDeleteModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' deprecated: true security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/customer/remove-status-flag: patch: tags: - Customers - Status - Flags summary: Remove customer status flag description: Remove customer status flag operationId: delete_status_flag_dms_customer_remove_status_flag_patch parameters: - required: true schema: title: Identifier type: string name: identifier in: query requestBody: content: application/json: schema: $ref: '#/components/schemas/DeleteRequestModel' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CustomerDeleteModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/customer/comment: post: tags: - Customers - Comments summary: Create customer comment diary description: Create customer comment diary operationId: add_comment_dms_customer_comment_post requestBody: content: application/json: schema: $ref: '#/components/schemas/CustomerCommentDiaryModel' required: true responses: '201': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CustomerCommentDiaryResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] patch: tags: - Customers - Comments summary: Update customer comment diary description: Update customer comment diary operationId: update_comment_dms_customer_comment_patch parameters: - required: true schema: title: Identifier type: string name: identifier in: query requestBody: content: application/json: schema: $ref: '#/components/schemas/CustomerCommentDiaryUpdateModel' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CustomerCommentDiaryResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/customer/comments: get: tags: - Customers - Comments summary: Get customer comment diary description: Get customer comment diary operationId: get_all_comments_dms_customer_comments_get parameters: - required: false schema: title: Reference Id type: string name: reference_id in: query - required: false schema: title: Page Number type: integer name: page_number in: query - required: false schema: title: Page Size minimum: 1 type: integer name: page_size in: query - required: false schema: title: Order Reference Id type: string name: order_reference_id in: query - required: false schema: title: Comment type: string name: comment in: query - description: Accepts only string values required: false schema: title: Comment Category type: array items: type: string description: Accepts only string values name: category in: query responses: '200': description: Successful Response content: application/json: schema: $ref: >- #/components/schemas/CustomerCommentDiaryPaginatedResponseModel '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/customer/license-verification: post: tags: - Customers - Licenses - Verifications summary: License verification through MiTek description: license-verification through MiTek operationId: verify_license_dms_customer_license_verification_post requestBody: content: application/json: schema: $ref: '#/components/schemas/LicenseVerificationModel' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/customer/fraud-check: post: tags: - Customers - Fraud - Checks summary: Creates personal finance information description: Create personal finance information against customer operationId: add_customer_fraud_check_dms_customer_fraud_check_post requestBody: content: application/json: schema: $ref: '#/components/schemas/FraudCheckModel' required: true responses: '201': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/customer/all-customers-orders-dynamic-search: post: tags: - Customers - Orders - Dynamic - Search summary: Get all customer records along with its orders dynamic search description: Get all customer records along with order dynamic search operationId: >- get_all_customer_order_dynamic_search_dms_customer_all_customers_orders_dynamic_search_post parameters: - required: true schema: title: Page Number type: integer name: page_number in: query - required: true schema: title: Page Size minimum: 1 type: integer name: page_size in: query - required: false schema: $ref: '#/components/schemas/SortEnum' name: sort in: query - required: false schema: $ref: '#/components/schemas/SortByEnum' name: sort_by in: query - description: 'Format: YYYY-MM-DD' required: false schema: title: From Date type: string description: 'Format: YYYY-MM-DD' format: date name: from_date in: query - description: 'Format: YYYY-MM-DD' required: false schema: title: To Date type: string description: 'Format: YYYY-MM-DD' format: date name: to_date in: query - required: false schema: title: Is Dealer type: boolean default: true name: is_dealer in: query requestBody: content: application/json: schema: title: Filters type: array items: $ref: '#/components/schemas/FilterModel' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/customer/send-order-link: post: tags: - Customers - Send - Order - Links summary: send order link description: send order link operationId: send_order_link_dms_customer_send_order_link_post parameters: - required: true schema: title: Reference Number type: string name: reference_number in: query responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/customers/reference-id: get: tags: - Customers - References summary: Get reference id by email description: Retrieve the reference id associated with the given email of customer. operationId: get_reference_number_dms_customers_reference_id_get parameters: - required: true schema: title: Email type: string name: email in: query responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/send-notification-email-sqs: post: tags: - Send - Notifications - Email summary: Send Email Notification Through SQS description: Send Email Notification Through SQS operationId: send_sqs_message_dms_send_notification_email_sqs_post requestBody: content: application/json: schema: $ref: '#/components/schemas/EmailSqsModel' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/send-notification-email: post: tags: - Send - Notifications - Email summary: Send Email Notification description: Send Email Notification operationId: send_notification_email_dms_send_notification_email_post requestBody: content: application/json: schema: $ref: '#/components/schemas/EmailSqsModel' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/order/expiry/{order_stage}/{dealer_id}: get: tags: - Order - Expiry - Dealer_id summary: Order expiry date description: Get order expiry date operationId: get_order_expiry_dms_order_expiry__order_stage___dealer_id__get parameters: - required: true schema: title: Order Stage type: integer name: order_stage in: path - required: true schema: title: Dealer Id type: integer name: dealer_id in: path responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/configure/quotation: get: tags: - Configure - Quotation summary: Get Specific quotation description: Get Specific quotation operationId: get_order_quotation_by_reference_number_dms_configure_quotation_get parameters: - required: true schema: title: Reference Number type: string name: reference_number in: query responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/OrderQuotationResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/configure/all-quotation/{reference_number}: get: tags: - Configure - Quotation - Order Management summary: Get Specific quotation description: Get Specific quotation operationId: >- get_all_order_quotation_by_reference_number_dms_configure_all_quotation__reference_number__get parameters: - required: true schema: title: Reference Number type: string name: reference_number in: path responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/configure/all-quotations: get: tags: - Configure - Order Management summary: Get Specific quotation description: Get Specific quotation operationId: get_all_order_quotation_dms_configure_all_quotations_get responses: '200': description: Successful Response content: application/json: schema: title: >- Response Get All Order Quotation Dms Configure All Quotations Get type: array items: $ref: '#/components/schemas/OrderQuotationResponseModel' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/configure/quotation/{identifier}: patch: tags: - Configure - Quotation - Order Management summary: Update an configured quotation description: Update an configured quotation operationId: update_order_quotation_dms_configure_quotation__identifier__patch parameters: - required: true schema: title: Identifier name: identifier in: path requestBody: content: application/json: schema: $ref: '#/components/schemas/OrderQuotationModel' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/OrderQuotationUpdateModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/configure/save-quotation: post: tags: - Configure - Save - Quotation summary: Save a new order quotation description: >- Save a new order quotation and child objects orderoffer, orderfee, orderoption, orderFnI, orderTradeIn operationId: save_quotation_dms_configure_save_quotation_post requestBody: content: application/json: schema: title: Quotation List type: array items: $ref: '#/components/schemas/OrderQuotationCreateModel' required: true responses: '201': description: Successful Response content: application/json: schema: title: Response Save Quotation Dms Configure Save Quotation Post type: array items: $ref: '#/components/schemas/OrderQuotationResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/configure/order-fees: post: tags: - Configure - Order - Fees summary: Creates fee record for order description: Creates fee record for order operationId: add_order_fee_dms_configure_order_fees_post requestBody: content: application/json: schema: $ref: '#/components/schemas/OrderFeeModel' required: true responses: '201': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/OrderFeeModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/configure/order-fees/{identifier}: get: tags: - Configure - Order - Fees - Order Management summary: Get all order fees for order description: Get all order fees for order operationId: get_order_fee_by_id_dms_configure_order_fees__identifier__get parameters: - required: true schema: title: Identifier type: string name: identifier in: path responses: '200': description: Successful Response content: application/json: schema: title: >- Response Get Order Fee By Id Dms Configure Order Fees Identifier Get type: array items: $ref: '#/components/schemas/OrderFeeModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] delete: tags: - Configure - Order - Fees - Order Management summary: Delete all orders fees filtered on identifier description: Delete all orders fees filtered on identifier operationId: delete_order_fees_dms_configure_order_fees__identifier__delete parameters: - required: true schema: title: Identifier type: string name: identifier in: path responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/OrderFeeModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] patch: tags: - Configure - Order - Fees - Order Management summary: Update fee record for order description: Update fee record for order operationId: update_order_fee_dms_configure_order_fees__identifier__patch parameters: - required: true schema: title: Identifier type: string name: identifier in: path requestBody: content: application/json: schema: $ref: '#/components/schemas/OrderFeeModel' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/OrderFeeModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/configure/order-options: post: tags: - Configure - Order - Options summary: Create a new order option record description: Create a new order option record operationId: add_order_option_dms_configure_order_options_post requestBody: content: application/json: schema: $ref: '#/components/schemas/OrderOptionModel' required: true responses: '201': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/OrderOptionModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/configure/order-options/{identifier}: get: tags: - Configure - Order - Options - Order Management summary: Get order option details description: Get order all options against an identifier operationId: >- get_order_options_by_identifier_dms_configure_order_options__identifier__get parameters: - required: true schema: title: Identifier type: string name: identifier in: path responses: '200': description: Successful Response content: application/json: schema: title: >- Response Get Order Options By Identifier Dms Configure Order Options Identifier Get type: array items: $ref: '#/components/schemas/OrderOptionModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] delete: tags: - Configure - Order - Options - Order Management summary: Delete order option record description: Delete all order option records against identifier operationId: delete_order_option_dms_configure_order_options__identifier__delete parameters: - required: true schema: title: Identifier type: string name: identifier in: path responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/OrderOptionModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] patch: tags: - Configure - Order - Options - Order Management summary: Update an order option record description: Update an order option record operationId: update_order_option_dms_configure_order_options__identifier__patch parameters: - required: true schema: title: Identifier type: string name: identifier in: path requestBody: content: application/json: schema: $ref: '#/components/schemas/OrderOptionModel' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/OrderOptionModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/configure/order-fni: post: tags: - Configure - Order - Order Management summary: Create finance insurance product record for order description: Create finance insurance product record for order operationId: add_order_fni_dms_configure_order_fni_post requestBody: content: application/json: schema: $ref: '#/components/schemas/OrderFinancialInsuranceProductModel' required: true responses: '201': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/OrderFIPResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/configure/order-fni/{identifier}: get: tags: - Configure - Order - Identifiers summary: Get orders finance insurance product filtered on identifier description: Get orders finance insurance product filtered on identifier operationId: get_order_fni_by_identifier_dms_configure_order_fni__identifier__get parameters: - required: true schema: title: Identifier type: string name: identifier in: path responses: '200': description: Successful Response content: application/json: schema: title: >- Response Get Order Fni By Identifier Dms Configure Order Fni Identifier Get type: array items: $ref: '#/components/schemas/OrderFinancialInsuranceProductModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] delete: tags: - Configure - Order - Identifiers summary: Delete all orders finance insurance product filtered on identifier description: Delete all orders finance insurance product filtered on identifier operationId: delete_order_fni_dms_configure_order_fni__identifier__delete parameters: - required: true schema: title: Identifier type: string name: identifier in: path responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/OrderFinancialInsuranceProductModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] patch: tags: - Configure - Order - Identifiers summary: Update finance insurance product record for order description: Update finance insurance product record for order operationId: update_order_fni_dms_configure_order_fni__identifier__patch parameters: - required: true schema: title: Identifier type: string name: identifier in: path requestBody: content: application/json: schema: $ref: '#/components/schemas/OrderFinancialInsuranceProductModel' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/OrderFinancialInsuranceProductModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/configure/order/tradein: post: tags: - Configure - Order - Order Management summary: Creates an order tradein info setup record description: Creates an order tradein info setup record operationId: add_order_tradein_dms_configure_order_tradein_post requestBody: content: application/json: schema: $ref: '#/components/schemas/OrderTradeInModel' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/OrderTradeInResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/configure/order/tradein/{identifier}: get: tags: - Configure - Order - Identifiers summary: Get a order tradein info setup record description: Get a order tradein info setup record identifier operationId: get_order_tradein_dms_configure_order_tradein__identifier__get parameters: - required: true schema: title: Identifier type: string name: identifier in: path responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/OrderTradeInModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] delete: tags: - Configure - Order - Identifiers summary: Delete order tradein info setup record description: Delete order tradein info setup record identifier operationId: delete_order_tradein_dms_configure_order_tradein__identifier__delete parameters: - required: true schema: title: Identifier type: string name: identifier in: path responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/OrderTradeInModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] patch: tags: - Configure - Order - Identifiers summary: Updates a order tradei info setup record description: Updates a order tradei info setup record by identifier operationId: update_order_tradein_dms_configure_order_tradein__identifier__patch parameters: - required: true schema: title: Identifier type: string name: identifier in: path requestBody: content: application/json: schema: $ref: '#/components/schemas/OrderTradeInModel' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/OrderTradeInModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/configure/orders: get: tags: - Configure - Orders summary: Get all order record description: Get all order record operationId: get_orders_dms_configure_orders_get parameters: - required: true schema: title: Page Number type: integer name: page_number in: query - required: true schema: title: Page Size type: integer name: page_size in: query - required: false schema: title: Order Status type: string name: order_status in: query responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/configure/order/filter: get: tags: - Configure - Order - Filter summary: Search orders based on filters description: Search orders based on filters operationId: get_filter_order_dms_configure_order_filter_get parameters: - required: true schema: title: Page Number type: string name: page_number in: query - required: true schema: title: Page Size type: string name: page_size in: query - required: false schema: title: Order Status type: string name: order_status in: query - required: false schema: title: Order Id type: string name: order_id in: query - required: false schema: title: Ref Number type: string name: ref_number in: query - required: false schema: title: Finance Type type: string name: finance_type in: query - required: false schema: title: Amount type: string name: amount in: query - required: false schema: title: Created At type: string name: created_at in: query - required: false schema: title: Expiry Date type: string name: expiry_date in: query responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/configure/order-status/: post: tags: - Configure - Order - Status summary: Get orders record filtered on order status description: Get orders record filtered on order status operationId: get_orders_by_status_dms_configure_order_status__post requestBody: content: application/json: schema: $ref: '#/components/schemas/GetOrderStatusModel' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/configure/order/update-status/{reference_number}: patch: tags: - Configure - Order - Status - Order Management summary: Update order status record by order reference number description: Update order status record by order reference number operationId: >- update_order_status_by_reference_number_dms_configure_order_update_status__reference_number__patch parameters: - required: true schema: title: Reference Number type: string name: reference_number in: path - required: false schema: title: Is Inventory Check type: boolean default: false name: is_inventory_check in: query requestBody: content: application/json: schema: $ref: '#/components/schemas/OrderStatusRequestModel' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/configure/order-to-quotation/{identifier}/{reference_number}: patch: tags: - Configure - Order - Quotation - Reference_number summary: Convert specific Order to Quotation description: Update order record from application to quotation operationId: >- convert_order_to_quotation_dms_configure_order_to_quotation__identifier___reference_number__patch parameters: - required: true schema: title: Identifier name: identifier in: path - required: true schema: title: Reference Number name: reference_number in: path responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/configure/order/status/: post: tags: - Configure - Order - Status summary: Update order status history record by order reference number description: Update order status history record by order reference number operationId: get_orders_status_history_dms_configure_order_status__post requestBody: content: application/json: schema: $ref: '#/components/schemas/OrderStatusHistoryModel' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /dms/configure/assets-by-trim-code/{trim_code}: get: tags: - Configure - Assets - Trim - Code - Order Management summary: Get assets by trim code description: Get assets by trim code operationId: quote_comparison_dms_configure_assets_by_trim_code__trim_code__get parameters: - required: true schema: title: Trim Code minLength: 1 type: string name: trim_code in: path responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/AssetsByTrimCodeResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/configure/order/status-by-dealer: get: tags: - Configure - Order - Status - Dealer summary: Get order status by dealer description: Get order status by dealer operationId: >- get_order_status_by_delaer_id_and_reference_number_dms_configure_order_status_by_dealer_get parameters: - required: true schema: title: Dealer Id type: integer name: dealer_id in: query - required: true schema: title: Reference Number type: string name: reference_number in: query responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/StatusResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/order/order_information_for_submitted_order: get: tags: - Order - Order Management summary: Get order by order status description: Get order by order status operationId: get_order_details_dms_order_order_information_for_submitted_order_get parameters: - required: true schema: title: Page Number type: integer name: page_number in: query - required: true schema: title: Page Size minimum: 1 type: integer name: page_size in: query - required: true schema: title: Order Status type: string name: order_status in: query - required: false schema: title: Reference Number type: string name: reference_number in: query - required: false schema: title: Order Fee type: boolean name: order_fee in: query - required: false schema: title: Order Option type: boolean name: order_option in: query - required: false schema: title: Order Fni type: boolean name: order_fni in: query - required: false schema: title: Order Tradein type: boolean name: order_tradein in: query - required: false schema: title: Order Assets type: boolean name: order_assets in: query responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/OrderPaginationResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /dms/order/order_information/{reference_number}: get: tags: - Order - Reference_number summary: Get order by order status description: Get order by order status operationId: get_order_information_dms_order_order_information__reference_number__get parameters: - required: true schema: title: Reference Number type: string name: reference_number in: path responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/order/order_insurance_documents/{reference_number}: get: tags: - Order - Reference_number summary: Get order insurance documents by order ID description: Get order insurance documents by order ID operationId: >- get_order_insurance_documents_dms_order_order_insurance_documents__reference_number__get parameters: - required: true schema: title: Reference Number type: string name: reference_number in: path responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /dms/order/credit-decision: get: tags: - Order - Credit - Decisions summary: Get credit decision description: Get credit decision operationId: get_credit_decision_dms_order_credit_decision_get parameters: - required: true schema: title: Reference Number type: string name: reference_number in: query responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] post: tags: - Order - Credit - Decisions summary: Add credit decision description: Add credit decision operationId: create_credit_decision_dms_order_credit_decision_post parameters: - required: true schema: title: Reference Number type: string name: reference_number in: query requestBody: content: application/json: schema: $ref: '#/components/schemas/OrderCreditDecisionModel' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/OrderCreditDecisionResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /dms/order/order-checklist: get: tags: - Order - Order Management summary: Get Order checklist description: Get Order checklist operationId: get_order_checklist_dms_order_order_checklist_get parameters: - required: true schema: title: Customer Reference Id type: string name: customer_reference_id in: query - required: true schema: title: Checklist Identifier type: string name: checklist_identifier in: query - required: false schema: title: Order Reference Id type: string name: order_reference_id in: query responses: '200': description: Successful Response content: application/json: schema: title: Response Get Order Checklist Dms Order Order Checklist Get type: array items: $ref: '#/components/schemas/OrderChecklistResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] post: tags: - Order - Order Management summary: Add Order checklist description: Add Order checklist operationId: add_order_checklist_dms_order_order_checklist_post requestBody: content: application/json: schema: title: Items type: array items: $ref: '#/components/schemas/OrderChecklistModel' required: true responses: '200': description: Successful Response content: application/json: schema: title: Response Add Order Checklist Dms Order Order Checklist Post type: array items: $ref: '#/components/schemas/OrderChecklistResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] delete: tags: - Order - Order Management summary: Delete Order checklist description: Delete Order checklist operationId: delete_order_checklist_dms_order_order_checklist_delete parameters: - required: true schema: title: Customer Reference Id type: string name: customer_reference_id in: query - required: true schema: title: Order Reference Id type: string name: order_reference_id in: query responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] patch: tags: - Order - Order Management summary: Update Order checklist description: Update Order checklist operationId: update_order_checklist_dms_order_order_checklist_patch parameters: - required: true schema: title: Order Reference Id type: string name: order_reference_id in: query requestBody: content: application/json: schema: title: Request type: array items: $ref: '#/components/schemas/OrderChecklistUpdateModel' required: true responses: '200': description: Successful Response content: application/json: schema: title: >- Response Update Order Checklist Dms Order Order Checklist Patch type: array items: $ref: '#/components/schemas/OrderChecklistResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/order/order-checklist-update-history: get: tags: - Order - History summary: Get Order Checklist Update History operationId: >- get_order_checklist_update_history_dms_order_order_checklist_update_history_get parameters: - required: true schema: title: Customer Reference Id type: string name: customer_reference_id in: query - required: true schema: title: Event type: string name: event in: query - required: true schema: title: Order Reference Id type: string name: order_reference_id in: query responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/order/update-credit-approver-decision/{reference_number}: patch: tags: - Order - Credit - Decisions - Order Management summary: Update decision status after receiving decision from credit approver description: Update an configured quotation operationId: >- update_credit_approver_decision_dms_order_update_credit_approver_decision__reference_number__patch parameters: - required: true schema: title: Reference Number type: string name: reference_number in: path responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/OrderQuotationModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/order/update-payment-status/{reference_number}: patch: tags: - Order - Payment - Status - Order Management summary: Update Payment Status operationId: >- update_payment_status_dms_order_update_payment_status__reference_number__patch parameters: - required: true schema: title: Reference Number type: string name: reference_number in: path - required: true schema: title: Payment Indicator type: boolean name: payment_indicator in: query - required: false schema: title: Order Status type: string name: order_status in: query responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /dms/order/order-verify-document/{identifier}: post: tags: - Order - Verify - Documents - Order Management summary: Verify Order Documents description: Verify Order Documents operationId: verify_order_document_dms_order_order_verify_document__identifier__post parameters: - required: true schema: title: Identifier type: string name: identifier in: path responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/order/upload-signed-document/{identifier}: post: tags: - Order - Uploads - Signed - Documents - Order Management summary: Upload Signed Document description: Upload Signed Document operationId: >- upload_order_signed_document_dms_order_upload_signed_document__identifier__post parameters: - required: true schema: title: Identifier type: string name: identifier in: path requestBody: content: application/json: schema: $ref: '#/components/schemas/UploadFile' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/configure/quotation-to-order/{identifier}: patch: tags: - Configure - Quotation - Order - Order Management summary: Convert specific Quotation to Application description: >- Convert specific Quotation stage to Application and save all financial data operationId: >- convert_quotation_to_order_dms_configure_quotation_to_order__identifier__patch parameters: - required: true schema: title: Identifier name: identifier in: path requestBody: content: application/json: schema: $ref: '#/components/schemas/OrderQuotationUpdateModel' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/OrderQuotationUpdateModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/configure/insurance: post: tags: - Configure - Insurance summary: Add insurance description: Add insurance information operationId: create_insurance_information_dms_configure_insurance_post requestBody: content: application/json: schema: $ref: '#/components/schemas/InsuranceInformationWithAddressesModel' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/InsuranceInformationResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/configure/quotation-by-customers: get: tags: - Configure - Quotation - Customers summary: Get all orders of a customer description: Get all orders of a customer operationId: get_orders_by_customers_dms_configure_quotation_by_customers_get parameters: - required: true schema: title: Email type: string name: email in: query - required: false schema: title: Finance Type type: string name: finance_type in: query - required: false schema: title: Dealer Id type: string name: dealer_id in: query - required: false schema: title: Order Status type: string name: order_status in: query responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/all-quotation-by-reference-number/: get: tags: - Quotation - Reference - Numbers summary: Get all quotations based on reference number description: Get all quotations based on reference number operationId: >- get_all_order_quotation_by_multiple_reference_number_dms_all_quotation_by_reference_number__get parameters: - required: false schema: title: Reference Number type: array items: {} name: reference_number in: query responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/order/quick_quotation: post: tags: - Order - Order Management summary: Save Single Quotation description: Save Single Quotation operationId: save_quotations_dms_order_quick_quotation_post requestBody: content: application/json: schema: $ref: '#/components/schemas/QuickQuotationModel' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/QuickQuotationResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] patch: tags: - Order - Order Management summary: Update Quotation description: Update Quotation operationId: update_quotations_dms_order_quick_quotation_patch parameters: - required: true schema: title: Identifier type: string name: identifier in: query requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateQuickOrderModel' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/QuickQuotationResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/configure/quick-quotation-by-identifier/{identifier}: get: tags: - Configure - Quotation - Identifiers summary: Get Specific quotation description: Get Specific quotation operationId: >- get_all_order_quotation_by_identifier_dms_configure_quick_quotation_by_identifier__identifier__get parameters: - required: true schema: title: Identifier type: string name: identifier in: path responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/QuickQuotationResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/configure/quick-quotation-by-vendor: get: tags: - Configure - Quotation - Vendor summary: Get all orders of a customer description: Get all orders of a customer operationId: get_orders_by_customer_data_dms_configure_quick_quotation_by_vendor_get parameters: - description: Accepts only string values required: false schema: title: statuses type: array items: type: string description: Accepts only string values name: statuses in: query - required: false schema: title: Dealer Id type: integer name: dealer_id in: query - required: false schema: title: Broker Id type: integer name: broker_id in: query - required: false schema: title: Customer Email type: string name: customer_email in: query - required: false schema: title: Customer Name type: string name: customer_name in: query - required: false schema: title: Lender Name type: string name: lender_name in: query - required: false schema: title: Dealer Name type: string name: dealer_name in: query - required: false schema: title: Contact Number type: string name: contact_number in: query - required: false schema: title: Vendor Name type: string name: vendor_name in: query - required: false schema: title: Introducer Name type: string name: introducer_name in: query - required: false schema: title: Vendor Email type: string name: vendor_email in: query - required: false schema: title: Reference Number type: string name: reference_number in: query - required: false schema: title: Name type: string name: name in: query - required: false schema: title: Finance Type type: string name: finance_type in: query - required: false schema: title: Product Type type: string name: product_type in: query - required: false schema: title: Finance Amount type: number name: finance_amount in: query - required: false schema: title: Updated At type: string name: updated_at in: query - required: false schema: title: Date Submitted type: string name: date_submitted in: query - required: false schema: title: Start Date type: string name: start_date in: query - required: false schema: title: End Date type: string name: end_date in: query - required: false schema: $ref: '#/components/schemas/SortByQuickQuotation' name: sort_by in: query - required: false schema: $ref: '#/components/schemas/SortEnum' name: sort_order in: query - required: false schema: $ref: '#/components/schemas/OrderStageTypes' name: order_stage in: query responses: '200': description: Successful Response content: application/json: schema: title: >- Response Get Orders By Customer Data Dms Configure Quick Quotation By Vendor Get type: array items: $ref: '#/components/schemas/QuickQuotationResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/order/workqueue: get: tags: - Order - Order Management summary: Get all orders for workqueue. description: Get all orders for workqueue. operationId: get_orders_workqueue_dms_order_workqueue_get parameters: - description: Accepts only string values required: false schema: title: statuses type: array items: type: string description: Accepts only string values name: statuses in: query - required: false schema: title: Dealer Id type: integer name: dealer_id in: query - required: false schema: title: Broker Id type: integer name: broker_id in: query - required: false schema: title: Customer Email type: string name: customer_email in: query - required: false schema: title: Customer Name type: string name: customer_name in: query - required: false schema: title: Lender Name type: string name: lender_name in: query - required: false schema: title: Dealer Name type: string name: dealer_name in: query - required: false schema: title: Contact Number type: string name: contact_number in: query - required: false schema: title: Vendor Name type: string name: vendor_name in: query - required: false schema: title: Introducer Name type: string name: introducer_name in: query - required: false schema: title: Vendor Email type: string name: vendor_email in: query - required: false schema: title: Reference Number type: string name: reference_number in: query - required: false schema: title: Name type: string name: name in: query - required: false schema: title: Finance Type type: string name: finance_type in: query - required: false schema: title: Product Type type: string name: product_type in: query - required: false schema: title: Finance Amount type: number name: finance_amount in: query - required: false schema: title: Updated At type: string name: updated_at in: query - required: false schema: title: Date Submitted type: string name: date_submitted in: query - required: false schema: title: Start Date type: string name: start_date in: query - required: false schema: title: End Date type: string name: end_date in: query - required: false schema: $ref: '#/components/schemas/SortByQuickQuotation' name: sort_by in: query - required: false schema: $ref: '#/components/schemas/SortEnum' name: sort_order in: query - required: false schema: $ref: '#/components/schemas/OrderStageTypes' name: order_stage in: query - required: false schema: title: Page Number type: integer name: page_number in: query - required: false schema: title: Page Size type: integer name: page_size in: query responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/OrderWorkqueueResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/get-reference-data/{dealer_code}: get: tags: - Reference - Data - Order Management summary: Get Reference Data By Dealer Code description: >- This method returns the data of inventory from Configuration By Dealer Code operationId: get_reference_data_dms_get_reference_data__dealer_code__get parameters: - required: true schema: title: Dealer Code type: string name: dealer_code in: path responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/get-inventory: get: tags: - Inventory summary: Get Filtered Inventory description: 'This will get filtered inventory ' operationId: get_filtered_inventory_dms_get_inventory_get parameters: - required: true schema: title: Dealer Code type: string name: dealer_code in: query - required: true schema: title: Page Number minimum: 0 type: integer name: page_number in: query - required: true schema: title: Page Size minimum: 0 type: integer name: page_size in: query - required: false schema: title: Make Model type: string name: make_model in: query - required: false schema: title: Stock Number type: string name: stock_number in: query - required: false schema: title: Vin type: string name: vin in: query - required: false schema: title: Mileage type: string name: mileage in: query - required: false schema: title: Msrp type: string name: msrp in: query - required: false schema: title: Internet Price type: string name: internet_price in: query - required: false schema: title: Internet Price From type: integer name: internet_price_from in: query - required: false schema: title: Internet Price To type: integer name: internet_price_to in: query - required: false schema: title: Vehicle Status type: string name: vehicle_status in: query - required: false schema: title: Listing Status type: string name: listing_status in: query - required: false schema: title: Daily Update type: array items: type: boolean name: daily_update in: query - required: false schema: title: Asset Condition type: string name: asset_condition in: query - required: false schema: title: Year From type: integer name: year_from in: query - required: false schema: title: Year To type: integer name: year_to in: query - required: false schema: title: Order By Price type: string name: order_by_price in: query - required: false schema: title: Multiple Asset Condition type: array items: {} name: multiple_asset_condition in: query - required: false schema: title: Multiple Asset Make type: array items: {} name: multiple_asset_make in: query - required: false schema: title: Multiple Asset Model type: array items: {} name: multiple_asset_model in: query - required: false schema: title: Multiple Asset Trim type: array items: {} name: multiple_asset_trim in: query responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/get-setup-data: get: tags: - Setup - Data summary: Setup Data description: This method will return setup data. operationId: get_setup_data_dms_get_setup_data_get parameters: - required: true schema: title: Company Id type: integer name: company_id in: query - required: false schema: title: Setup Data Indicators type: array items: type: string style: csv name: setup_data_indicators in: query responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/an-order-statuses: get: tags: - Order - Statuses summary: Get AN Order Statuses description: Get AN Order Statuses operationId: get_an_order_statuses_dms_an_order_statuses_get responses: '200': description: Successful Response content: application/json: schema: {} /dms/order/asset/{reference_number}: patch: tags: - Order - Assets - Order Management summary: Updates an order asset record description: Updates an order asset record operationId: update_order_asset_dms_order_asset__reference_number__patch parameters: - required: true schema: title: Reference Number type: string name: reference_number in: path requestBody: content: application/json: schema: $ref: '#/components/schemas/OrderAssetUpdateModel' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/update-order-submission: post: tags: - Order - Order Management summary: Update Order Submission Status description: Updates an order submission status by hubex response operationId: update_order_submission_dms_update_order_submission_post responses: '200': description: Successful Response content: application/json: schema: {} security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/order/approve-order-by-lender/{reference_number}/{lender_id}: patch: tags: - Order - Approve - Lender - Lender_id summary: Update Order Status and Lender Id description: Update the order status to approve and replace lender id operationId: >- approve_order_by_lender_dms_order_approve_order_by_lender__reference_number___lender_id__patch parameters: - required: true schema: title: Reference Number type: string name: reference_number in: path - required: true schema: title: Lender Id type: integer name: lender_id in: path - required: false schema: title: Order Status type: string name: order_status in: query responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/order/get-customer-order-submissions/{customer_reference_id}/{submission_status}: post: tags: - Order - Customer - Customer_reference_id - Order Management summary: Get order lender submissions of customer by status and Lender ids description: Get order lender submission records of customer by status and lender ids operationId: >- get_customer_order_submissions_dms_order_get_customer_order_submissions__customer_reference_id___submission_status__post parameters: - required: true schema: title: Customer Reference Id type: string name: customer_reference_id in: path - required: true schema: title: Submission Status type: string name: submission_status in: path responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/order/get-order-submission-by-id/{submission_id}: get: tags: - Order - Submission_id summary: Get single order submission by primary key description: Gets single order submission record against given id operationId: >- get_order_submission_by_id_dms_order_get_order_submission_by_id__submission_id__get parameters: - required: true schema: title: Submission Id type: integer name: submission_id in: path responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /dms/order/re-submit/{identifier}: patch: tags: - Order - Submit - Order Management summary: Update order and re-send deal to lender description: >- Update the order and resubmit deal to lenders with deffering existing submission records. operationId: resubmit_order_dms_order_re_submit__identifier__patch parameters: - required: true schema: title: Identifier name: identifier in: path requestBody: content: application/json: schema: $ref: '#/components/schemas/OrderQuotationModel' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/configure/individualized-agreement: patch: tags: - Configure - Agreement summary: Creates an order individualized agreement info setup record description: Creates an order individualized agreement info setup record operationId: >- add_individualized_agreement_dms_configure_individualized_agreement_patch requestBody: content: application/json: schema: $ref: '#/components/schemas/OrderIndividualizedModel' required: true responses: '201': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/configure/update-financial-indicator/{reference_number}/{is_payment_updated}: patch: tags: - Configure - Financial - Indicators - Is_payment_updated summary: Update Financial Indicator description: Update Financial Indicator operationId: >- update_financial_indicator_dms_configure_update_financial_indicator__reference_number___is_payment_updated__patch parameters: - required: true schema: title: Reference Number type: string name: reference_number in: path - required: true schema: title: Is Payment Updated type: boolean name: is_payment_updated in: path responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/order/proposal: post: tags: - Order - Proposals summary: Create new order proposal for broker operationId: save_proposal_dms_order_proposal_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ProposalRequestModel' required: true responses: '201': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ProposalResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] patch: tags: - Order - Proposals summary: Update order proposal for broker operationId: update_proposal_dms_order_proposal_patch parameters: - required: true schema: title: Identifier type: string name: identifier in: query requestBody: content: application/json: schema: $ref: '#/components/schemas/ProposalRequestModel' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ProposalResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/order/change-proposal-status: patch: tags: - Order - Changes - Proposals - Status summary: Update order proposal status operationId: update_proposal_status_dms_order_change_proposal_status_patch requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateProposalStatusRequestModel' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/order/proposal-dashboard-analytics: get: tags: - Order - Proposals - Dashboard - Analytics summary: Get order proposal analytics for broker dashboard operationId: >- get_proposal_dashboard_analytics_dms_order_proposal_dashboard_analytics_get parameters: - description: Accepts only string values required: false schema: title: statuses type: array items: type: string description: Accepts only string values name: statuses in: query - required: false schema: title: Dealer Id type: string name: dealer_id in: query - required: false schema: title: Broker Id type: string name: broker_id in: query - required: false schema: title: Name type: string name: name in: query - required: false schema: title: Product Type type: string name: product_type in: query - required: false schema: title: Finance Type type: string name: finance_type in: query - required: false schema: title: Customer Name type: string name: customer_name in: query - required: false schema: title: Lender Name type: string name: lender_name in: query - required: false schema: title: Dealer Name type: string name: dealer_name in: query - required: false schema: title: Introducer Name type: string name: introducer_name in: query - required: false schema: title: Date Submitted type: string name: date_submitted in: query - required: false schema: title: Start Date type: string name: start_date in: query - required: false schema: title: End Date type: string name: end_date in: query - required: false schema: title: Finance Amount type: number name: finance_amount in: query - required: false schema: title: Updated At type: string name: updated_at in: query - required: false schema: $ref: '#/components/schemas/SortByQuickQuotation' name: sort_by in: query - required: false schema: $ref: '#/components/schemas/SortEnum' name: sort_order in: query - required: false schema: title: Updated At From type: string name: updated_at_from in: query - required: false schema: title: Updated At To type: string name: updated_at_to in: query responses: '200': description: Successful Response content: application/json: schema: title: >- Response Get Proposal Dashboard Analytics Dms Order Proposal Dashboard Analytics Get type: array items: $ref: '#/components/schemas/ProposalDashboardAnalyticsModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/order/generate-document/{event_name}: post: tags: - Order - Generate - Documents - Document Generation summary: Generate Document for respective event operationId: generate_documents_dms_order_generate_document__event_name__post parameters: - required: true schema: $ref: '#/components/schemas/Events' name: event_name in: path requestBody: content: application/json: schema: $ref: '#/components/schemas/DocumentGenerationWithSignatoryModel' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/order/download_document_by_event/{event_name}: post: tags: - Order - Event_name summary: Get generated document(s) key(s) against specific event operationId: >- get_document_key_by_event_dms_order_download_document_by_event__event_name__post parameters: - required: true schema: $ref: '#/components/schemas/Events' name: event_name in: path requestBody: content: application/json: schema: $ref: '#/components/schemas/GenerateDocumentData' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/order/send-email/{event_name}: post: tags: - Order - Send - Email - Send Email Notification summary: send Email notification operationId: send_email_dms_order_send_email__event_name__post parameters: - required: true schema: $ref: '#/components/schemas/Events' name: event_name in: path requestBody: content: application/json: schema: $ref: '#/components/schemas/EmailNotificationRequestModel' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/order/stakeholder/: get: tags: - Order - Order Stakeholder Management summary: Get order stakeholder operationId: get_order_stakeholder_dms_order_stakeholder__get parameters: - required: false schema: title: Identifier type: string name: identifier in: query - required: false schema: title: Order Identifier type: string name: order_identifier in: query - required: false schema: title: Stakeholder Reference Id type: string name: stakeholder_reference_id in: query - required: false schema: title: Name type: string name: name in: query - required: false schema: title: Role type: string name: role in: query - required: false schema: title: Email type: string name: email in: query - required: false schema: title: Position type: string name: position in: query - required: false schema: $ref: '#/components/schemas/SortByOrderStakeholder' name: sort_by in: query - required: false schema: $ref: '#/components/schemas/SortEnum' name: sort_order in: query responses: '200': description: Successful Response content: application/json: schema: title: Response Get Order Stakeholder Dms Order Stakeholder Get type: array items: $ref: '#/components/schemas/OrderStakeholderValidationModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' post: tags: - Order - Order Stakeholder Management summary: Create new order stakeholder operationId: create_order_stakeholder_dms_order_stakeholder__post requestBody: content: application/json: schema: $ref: '#/components/schemas/OrderStakeholderValidationModel' required: true responses: '201': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/OrderStakeholderValidationModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' delete: tags: - Order - Order Stakeholder Management summary: Update order stakeholder operationId: delete_order_stakeholder_dms_order_stakeholder__delete parameters: - required: true schema: title: Identifier type: string name: identifier in: query responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' patch: tags: - Order - Order Stakeholder Management summary: Update order stakeholder operationId: update_order_stakeholder_dms_order_stakeholder__patch parameters: - required: true schema: title: Identifier type: string name: identifier in: query requestBody: content: application/json: schema: $ref: '#/components/schemas/OrderStakeholderValidationModel' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/OrderStakeholderValidationModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /dms/configure/disclaimer: get: tags: - Configure - Disclaimers summary: Get Disclaimer Details by Disclaimer Name and Disclaimer Version operationId: get_disclaimer_details_by_id_version_dms_configure_disclaimer_get parameters: - required: true schema: title: Disclaimer Name type: string name: disclaimer_name in: query - required: true schema: title: Disclaimer Version type: string name: disclaimer_version in: query responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/DisclaimerResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] post: tags: - Configure - Disclaimers summary: Create disclaimer operationId: create_disclaimer_dms_configure_disclaimer_post requestBody: content: application/json: schema: $ref: '#/components/schemas/DisclaimerModel' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/DisclaimerResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/configure/disclaimer-by-name/{name}: get: tags: - Configure - Disclaimers - Name summary: Get Disclaimer by Name operationId: get_disclaimer_by_name_dms_configure_disclaimer_by_name__name__get parameters: - required: true schema: title: Name type: string name: name in: path responses: '200': description: Successful Response content: application/json: schema: title: >- Response Get Disclaimer By Name Dms Configure Disclaimer By Name Name Get type: array items: $ref: '#/components/schemas/DisclaimerResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/configure/customer-mandatory-disclaimers: get: tags: - Configure - Customers - Disclaimers summary: Get customer mandatory Disclaimers operationId: >- get_mandatory_disclaimers_dms_configure_customer_mandatory_disclaimers_get responses: '200': description: Successful Response content: application/json: schema: title: >- Response Get Mandatory Disclaimers Dms Configure Customer Mandatory Disclaimers Get type: array items: $ref: '#/components/schemas/DisclaimerResponseModel' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/configure/all-disclaimer: get: tags: - Configure - Disclaimer summary: Get all Disclaimers operationId: get_all_disclaimer_dms_configure_all_disclaimer_get parameters: - required: false schema: title: Disclaimer Status type: string name: disclaimer_status in: query responses: '200': description: Successful Response content: application/json: schema: title: Response Get All Disclaimer Dms Configure All Disclaimer Get type: array items: $ref: '#/components/schemas/DisclaimerResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/configure/disclaimer-status: patch: tags: - Configure - Disclaimers - Status summary: Update Disclaimer status operationId: update_disclaimer_status_by_id_dms_configure_disclaimer_status_patch parameters: - required: true schema: title: Name type: string name: name in: query - required: true schema: title: Change Status type: string name: change_status in: query responses: '200': description: Successful Response content: application/json: schema: title: >- Response Update Disclaimer Status By Id Dms Configure Disclaimer Status Patch type: boolean '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/configure/disclaimer-accord: patch: tags: - Configure - Disclaimers - Accord summary: Update Disclaimer accord operationId: update_disclaimer_accord_by_name_dms_configure_disclaimer_accord_patch parameters: - required: true schema: title: Name type: string name: name in: query - required: true schema: title: Change Accord type: boolean name: change_accord in: query responses: '200': description: Successful Response content: application/json: schema: title: >- Response Update Disclaimer Accord By Name Dms Configure Disclaimer Accord Patch type: boolean '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/configure/disclaimer/{name}: patch: tags: - Configure - Disclaimers - Name summary: Update Disclaimer details operationId: update_disclaimer_by_identifier_dms_configure_disclaimer__name__patch parameters: - required: true schema: title: Name type: string name: name in: path requestBody: content: application/json: schema: $ref: '#/components/schemas/DisclaimerUpdateParamsModel' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/DisclaimerResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/configure/disclaimer-agreement: get: tags: - Configure - Disclaimers - Agreement summary: Get Saved Disclaimer Agreement operationId: >- get_disclaimer_acceptance_agreement_dms_configure_disclaimer_agreement_get parameters: - required: true schema: title: Customer Reference Id type: string name: customer_reference_id in: query - required: false schema: title: Order Reference Id type: string name: order_reference_id in: query responses: '200': description: Successful Response content: application/json: schema: title: >- Response Get Disclaimer Acceptance Agreement Dms Configure Disclaimer Agreement Get type: array items: $ref: '#/components/schemas/DisclaimerAcceptanceModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] post: tags: - Configure - Disclaimers - Agreement summary: Create Disclaimer Agreement operationId: create_disclaimer_acceptance_dms_configure_disclaimer_agreement_post requestBody: content: application/json: schema: $ref: '#/components/schemas/DisclaimerAcceptanceParamsModel' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/DisclaimerAcceptanceModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] delete: tags: - Configure - Disclaimers - Agreement summary: Delete Disclaimer Agreement operationId: remove_disclaimer_acceptance_dms_configure_disclaimer_agreement_delete parameters: - required: true schema: title: Customer Reference Id type: string name: customer_reference_id in: query - required: true schema: title: Disclaimer Name type: string name: disclaimer_name in: query responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/configure/disclaimer-agreement-datetime: get: tags: - Configure - Disclaimers - Agreement - Disclaimer Management summary: Get Disclaimer Agreement Date Time by Customer ID/Order ID operationId: >- get_disclaimer_acceptance_date_time_dms_configure_disclaimer_agreement_datetime_get parameters: - required: false schema: title: Customer Reference No type: string name: customer_reference_no in: query - required: false schema: title: Order Reference Number type: string name: order_reference_number in: query responses: '200': description: Successful Response content: application/json: schema: title: >- Response Get Disclaimer Acceptance Date Time Dms Configure Disclaimer Agreement Datetime Get type: string format: date-time '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/configure/multiple-disclaimers: post: tags: - Configure - Disclaimers summary: Create multiple disclaimers operationId: create_multiple_disclaimers_dms_configure_multiple_disclaimers_post requestBody: content: application/json: schema: title: Disclaimers type: array items: $ref: '#/components/schemas/DisclaimerModel' required: true responses: '200': description: Successful Response content: application/json: schema: title: >- Response Create Multiple Disclaimers Dms Configure Multiple Disclaimers Post type: array items: $ref: '#/components/schemas/DisclaimerResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/configure/workqueue: post: tags: - Configure - Workqueue Management summary: Creates workqueue after Order creation description: Creates workqueue after Order creation operationId: create_appointment_dms_configure_workqueue_post requestBody: content: application/json: schema: $ref: '#/components/schemas/WorkqueueModel' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/configure/workqueue/search: get: tags: - Configure - Search summary: Search workqueue based on filters description: Search workqueue based on filters operationId: get_filter_workqueue_dms_configure_workqueue_search_get parameters: - required: true schema: title: Page Number type: integer name: page_number in: query - required: true schema: title: Page Size type: integer name: page_size in: query - required: false schema: title: Year type: string name: year in: query - required: false schema: title: Make type: string name: make in: query - required: false schema: title: Model type: string name: model in: query - required: false schema: title: Trim type: string name: trim in: query - required: false schema: title: Request Type type: string name: request_type in: query - required: false schema: title: Order Status type: string name: order_status in: query - required: false schema: title: Vin type: string name: vin in: query - required: false schema: title: Stock type: string name: stock in: query - required: false schema: title: Customer Name type: string name: customer_name in: query - required: false schema: title: Customer Type type: string name: customer_type in: query - required: false schema: title: Finance Type type: string name: finance_type in: query - required: false schema: title: Amount type: string name: amount in: query - required: false schema: title: Program type: string name: program in: query - required: false schema: title: Created At type: string name: created_at in: query - required: false schema: title: Updated At type: string name: updated_at in: query - required: false schema: title: Expiry Date type: string name: expiry_date in: query - required: false schema: title: Appointment Date type: string name: appointment_date in: query - required: false schema: title: Reference Number type: string name: reference_number in: query - required: false schema: title: Multiple Order Status type: array items: {} name: multiple_order_status in: query - required: false schema: title: Customer Reference Id type: string name: customer_reference_id in: query - required: false schema: title: Make Model Trim type: string name: make_model_trim in: query - required: false schema: title: Vehicle Condition type: string name: vehicle_condition in: query - required: false schema: title: Reason type: string name: reason in: query - required: false schema: title: Selling Price type: string name: selling_price in: query - required: false schema: title: Dealer Email type: string name: dealer_email in: query - required: false schema: title: Latest Order type: boolean default: false name: latest_order in: query responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/configure/workqueue/create_application/{workqueue_id}: patch: tags: - Configure - Create_application - Workqueue Management summary: Creates workqueue after Order stage change to application description: Creates workqueue after Order stage change to application operationId: >- update_expiry_by_id_dms_configure_workqueue_create_application__workqueue_id__patch parameters: - required: true schema: title: Workqueue Id type: integer name: workqueue_id in: path responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/quote/calculation: post: tags: - Quote - Calculations summary: Calculate Quotation description: Calculate Quotation operationId: calculate_order_dms_quote_calculation_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ProgramEvaluationForCalculationModel' required: true responses: '200': description: Successful Response content: application/json: schema: title: Response Calculate Order Dms Quote Calculation Post type: array items: $ref: '#/components/schemas/OrderCalculationResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' deprecated: true security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/quote/calculate-order: post: tags: - Quote - Calculate - Order summary: Calculate Quotation description: Calculate Quotation operationId: calculate_order2_dms_quote_calculate_order_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ProgramEvaluationForCalculationModel' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/quote/calculate-nfa: post: tags: - Quote - Calculate - Order Calculations summary: Calculate NFA [Net Financed Amount] description: Calculate NFA [Net Financed Amount] operationId: calculate_nfa_dms_quote_calculate_nfa_post requestBody: content: application/json: schema: $ref: '#/components/schemas/NFACalculationParams' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CalculateNFAResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/quote/calculation/V2: post: tags: - Quote - Calculations summary: Calculate Rental description: Calculate Rental operationId: calculate_v2_dms_quote_calculation_V2_post requestBody: content: application/json: schema: $ref: '#/components/schemas/CalculationV2Model' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CalculationResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/quote/create: post: tags: - Quote summary: Create Quote description: Create Quote operationId: create_quote_dms_quote_create_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ANQuotation' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /dms/an-dealers: get: tags: - Dealers summary: Get Dealers description: Get Dealers operationId: get_an_dealers_dms_an_dealers_get responses: '200': description: Successful Response content: application/json: schema: {} /dms/quote/calculation/multi-assets: post: tags: - Quote - Calculations - Multi - Assets summary: Calculate Quotation for Multiple Assets description: Calculate Quotation for Multiple Assets operationId: calculate_order_multi_assets_dms_quote_calculation_multi_assets_post requestBody: content: application/json: schema: title: Asset Params type: array items: $ref: '#/components/schemas/ProgramEvaluationParamsModel' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/quote/calculation/quantity: post: tags: - Quote - Calculations - Quantity summary: Calculate Quotation description: Calculate Quotation operationId: calculate_order_with_quantity_dms_quote_calculation_quantity_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ProgramEvaluationParamsModel' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/quote/calculation/monthlyImpact: post: tags: - Quote - Calculations - Impact summary: Calculate Monthly Impact description: Calculate Monthly Impact operationId: calculate_monthly_impact_dms_quote_calculation_monthlyImpact_post requestBody: content: application/json: schema: $ref: '#/components/schemas/CalculationV2Model' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/configure/appointment: post: tags: - Configure - Appointment summary: Creates Appointment after Order Confirmation description: Creates an appointment after order confirmation operationId: create_appointment_dms_configure_appointment_post requestBody: content: application/json: schema: $ref: >- #/components/schemas/libdms__appointment_models__CreateAppointmentModel required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] patch: tags: - Configure - Appointment summary: Update an created appointment description: Update an created appointment operationId: update_appointment_dms_configure_appointment_patch requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateAppointmentModel' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/configure/appointment/{appointment_id}: get: tags: - Configure - Appointment - Appointment Management summary: Get Appointment by id description: Get Appointment by id operationId: get_appointment_dms_configure_appointment__appointment_id__get parameters: - required: true schema: title: Appointment Id type: integer name: appointment_id in: path responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] patch: tags: - Configure - Appointment - Appointment Management summary: Delete created appointment description: Delete created appointment operationId: delete_appointment_dms_configure_appointment__appointment_id__patch parameters: - required: true schema: title: Appointment Id type: integer name: appointment_id in: path responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/configure/appointments: post: tags: - Configure - Appointment Management summary: Get paginated list of Appointments description: Get paginated list of Appointments operationId: filter_appointments_dms_configure_appointments_post requestBody: content: application/json: schema: $ref: '#/components/schemas/AppointmentFilterModel' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/email/: post: tags: - Email summary: Get customer record description: Get customer record by customer email operationId: find_customer_by_email_dms_email__post requestBody: content: application/json: schema: $ref: '#/components/schemas/GetConsentModel' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/consents: post: tags: - Consents summary: Create consents description: Create consents record operationId: add_consent_dms_consents_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ConsentsModel' required: true responses: '201': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ConsentsModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/consents/: get: tags: - Consents summary: Get all consents records description: Get all record of consents operationId: get_all_consents_dms_consents__get responses: '200': description: Successful Response content: application/json: schema: title: Response Get All Consents Dms Consents Get type: array items: $ref: '#/components/schemas/ConsentsModel' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] post: tags: - Consents summary: Delete consents description: Delete consents record by consents ID operationId: remove_consent_dms_consents__post requestBody: content: application/json: schema: $ref: '#/components/schemas/DeleteConsentModel' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ConsentsModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/consents/{consents_id}: get: tags: - Consents - Customer Consent summary: Get consents record description: Get consents record by consents ID operationId: find_one_consent_dms_consents__consents_id__get parameters: - required: true schema: title: Consents Id name: consents_id in: path responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ConsentsModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] patch: tags: - Consents - Customer Consent summary: Update consents description: Update consents record by consents ID operationId: update_consent_dms_consents__consents_id__patch parameters: - required: true schema: title: Consents Id type: integer name: consents_id in: path requestBody: content: application/json: schema: $ref: '#/components/schemas/ConsentsModel' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ConsentsModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/customer/document: get: tags: - Customers - Documents summary: Get customer documents operationId: get_customer_documents_dms_customer_document_get parameters: - required: false schema: title: External Reference Id type: string name: external_reference_id in: query - required: false schema: title: Customer Reference Id type: string name: customer_reference_id in: query - required: false schema: title: Stipulation Code type: string name: stipulation_code in: query - required: false schema: title: Category type: string name: category in: query - required: false schema: title: Document Type type: string name: document_type in: query - description: Accepts only string values required: false schema: title: document_status type: array items: type: string description: Accepts only string values name: document_status in: query responses: '200': description: Successful Response content: application/json: schema: title: Response Get Customer Documents Dms Customer Document Get type: array items: $ref: >- #/components/schemas/CustomerDocumentWithReviewsResponseModel '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] post: tags: - Customers - Documents summary: Creates customer document operationId: add_customer_document_dms_customer_document_post requestBody: content: application/json: schema: $ref: '#/components/schemas/CustomerDocumentModel' required: true responses: '201': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CustomerDocumentResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] delete: tags: - Customers - Documents summary: Delete customer document by identifier operationId: delete_customer_document_dms_customer_document_delete parameters: - required: true schema: title: Document Identifier type: string name: document_identifier in: query responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CustomerDeleteModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' deprecated: true security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] patch: tags: - Customers - Documents summary: Update customer document by identifier operationId: update_customer_document_dms_customer_document_patch parameters: - required: true schema: title: Document Identifier type: string name: document_identifier in: query requestBody: content: application/json: schema: $ref: '#/components/schemas/CustomerDocumentUpdateModel' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CustomerDocumentResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/customer/document/status: get: tags: - Customers - Documents - Status summary: Get customer document by identifier operationId: get_customer_document_identifier_dms_customer_document_status_get parameters: - required: true schema: title: Document Identifier type: string name: document_identifier in: query responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CustomerDocumentResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] patch: tags: - Customers - Documents - Status summary: Update customer document status operationId: update_customer_document_status_dms_customer_document_status_patch parameters: - required: true schema: title: Document Identifier type: string name: document_identifier in: query requestBody: content: application/json: schema: $ref: '#/components/schemas/CustomerDocumentStatus' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CustomerDocumentResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/customer/document-history: get: tags: - Customers - Documents - History summary: Get customer document history operationId: get_customer_document_history_dms_customer_document_history_get parameters: - required: true schema: title: Customer Reference Id type: string name: customer_reference_id in: query - required: true schema: title: Page Number type: integer name: page_number in: query - required: true schema: title: Page Size minimum: 1 type: integer name: page_size in: query - description: 'Format: YYYY-MM-DD' required: false schema: title: From Date type: string description: 'Format: YYYY-MM-DD' format: date name: from_date in: query - description: 'Format: YYYY-MM-DD' required: false schema: title: To Date type: string description: 'Format: YYYY-MM-DD' format: date name: to_date in: query responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CustomerStipulationPaginationResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/customer/documents/{customer_reference_id}: patch: tags: - Customers - Documents - Customer Document summary: Update customer document by identifier operationId: >- get_customer_document_dms_customer_documents__customer_reference_id__patch parameters: - required: true schema: title: Customer Reference Id type: string name: customer_reference_id in: path requestBody: content: application/json: schema: title: Item type: array items: $ref: '#/components/schemas/CustomerDocumentUpdateDMSModel' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/customer/delete-document: patch: tags: - Customers - Document summary: Delete customer document by identifier operationId: >- delete_customer_document_by_identifier_dms_customer_delete_document_patch parameters: - required: true schema: title: Document Identifier type: string name: document_identifier in: query requestBody: content: application/json: schema: $ref: '#/components/schemas/DeleteRequestModel' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CustomerDeleteModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/customer/document/review: get: tags: - Customers - Documents - Reviews summary: Get customer document reviews operationId: >- get_customer_document_reviews_by_identifier_dms_customer_document_review_get parameters: - required: true schema: title: Document Identifier type: string name: document_identifier in: query responses: '200': description: Successful Response content: application/json: schema: title: >- Response Get Customer Document Reviews By Identifier Dms Customer Document Review Get type: array items: $ref: '#/components/schemas/CustomerDocumentReviewResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] post: tags: - Customers - Documents - Reviews summary: Add customer document review operationId: add_customer_document_review_dms_customer_document_review_post parameters: - required: true schema: title: Document Identifier type: string name: document_identifier in: query requestBody: content: application/json: schema: $ref: '#/components/schemas/CustomerDocumentReviewModel' required: true responses: '201': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CustomerDocumentReviewResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/customer/document/uploading-status: get: tags: - Customers - Documents - Uploading - Status summary: Get customer document upload status operationId: >- get_customer_document_upload_status_dms_customer_document_uploading_status_get parameters: - required: true schema: title: Document Identifier type: string name: document_identifier in: query responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CustomerDocumentUploadStatus' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] patch: tags: - Customers - Documents - Uploading - Status summary: Update customer document upload status operationId: >- update_customer_document_uploading_status_dms_customer_document_uploading_status_patch parameters: - required: true schema: title: Document Identifier type: string name: document_identifier in: query requestBody: content: application/json: schema: $ref: '#/components/schemas/CustomerDocumentUploadStatus' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CustomerDocumentResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/customer/document/download: get: tags: - Customers - Documents - Downloads summary: Get customer document url by artifect_id description: Get customer document url by artifect_id operationId: >- get_customer_document_url_by_artifect_id_dms_customer_document_download_get parameters: - required: true schema: title: Artifect Id type: string name: artifect_id in: query responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/customer/document/download-stream: get: tags: - Customers - Documents - Downloads - Stream summary: Get customer document stream by artifect_id description: Get customer document stream by artifect_id operationId: >- get_customer_document_stream_by_artifect_id_dms_customer_document_download_stream_get parameters: - required: true schema: title: Artifect Id type: string name: artifect_id in: query responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/customer/document/signature-document: post: tags: - Customers - Documents - Signatures summary: Customer Document Signature operationId: signature_document_dms_customer_document_signature_document_post requestBody: content: application/json: schema: $ref: '#/components/schemas/SignatureCustomerDocument' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/customer/additional-document: post: tags: - Customers - Additional - Documents summary: Creates customer document operationId: add_customer_additional_document_dms_customer_additional_document_post requestBody: content: application/json: schema: $ref: '#/components/schemas/CustomerAdditionalDocumentModel' required: true responses: '201': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CustomerDocumentResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/get-an-signed-url: get: tags: - An - Signed - Get A N Signed U R L summary: Get AN Signed URL to Upload description: Get AN Signed URL to upload document operationId: get_an_signed_url_dms_get_an_signed_url_get parameters: - required: true schema: title: Document Name type: string name: document_name in: query - required: true schema: title: Content Type type: string name: content_type in: query responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /dms/configure/document-package: get: tags: - Configure - Documents - Packages summary: Get document package by identifier operationId: get_document_package_dms_configure_document_package_get parameters: - required: true schema: title: Package Id type: string name: package_id in: query responses: '200': description: Successful content: application/json: schema: $ref: '#/components/schemas/DocumentPackageResponseModel' '404': description: Record not found '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] post: tags: - Configure - Documents - Packages summary: Create document package operationId: create_document_package_new_dms_configure_document_package_post parameters: - required: false schema: title: Is Product type: boolean default: false name: is_product in: query requestBody: content: application/json: schema: $ref: '#/components/schemas/DocumentPackageRequestModel' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/DocumentPackageResponseModel' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorDetailModel' '412': description: Precondition Failed content: application/json: schema: $ref: '#/components/schemas/ErrorDetailModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] delete: tags: - Configure - Documents - Packages summary: Cancel document package and document by identifier operationId: cancel_document_package_dms_configure_document_package_delete parameters: - required: true schema: title: Package Id type: string name: package_id in: query responses: '200': description: Successful content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/configure/document-package-by-reference-id: get: tags: - Configure - Documents - Packages - Reference summary: Get document package by reference_id operationId: >- get_document_package_by_reference_id_dms_configure_document_package_by_reference_id_get parameters: - required: true schema: title: Reference Id type: string name: reference_id in: query responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/DocumentPackageResponseModel' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorDetailModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/configure/all-document-packages-by-reference-id: get: tags: - Configure - Document - Packages - Reference summary: Get document package by reference_id operationId: >- get_all_document_packages_by_reference_id_dms_configure_all_document_packages_by_reference_id_get parameters: - required: true schema: title: Reference Id type: string name: reference_id in: query - description: Order Id required: false schema: title: External Order Id type: string description: Order Id name: external_order_id in: query - description: Document Type required: false schema: type: array items: $ref: '#/components/schemas/ComparisonType' description: Document Type name: document_type in: query responses: '200': description: Successful Response content: application/json: schema: title: >- Response Get All Document Packages By Reference Id Dms Configure All Document Packages By Reference Id Get type: array items: $ref: '#/components/schemas/DocumentPackageResponseModel' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorDetailModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/configure/document-package/document: get: tags: - Configure - Documents - Packages summary: Get document from document package by identifier operationId: get_document_dms_configure_document_package_document_get parameters: - required: true schema: title: Package Id type: string name: package_id in: query - required: true schema: title: Document Id type: string name: document_id in: query responses: '200': description: Successful content: application/json: schema: $ref: '#/components/schemas/DocumentsResponseModel' '404': description: Record not found '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/configure/{document_package_id}/{document_id}/{signature_id}: post: tags: - Configure - Document_id - Document Package Management summary: Sign document operationId: >- sign_document_dms_configure__document_package_id___document_id___signature_id__post parameters: - required: true schema: title: Document Package Id type: string name: document_package_id in: path - required: true schema: title: Document Id type: string name: document_id in: path - required: true schema: title: Signature Id type: string name: signature_id in: path - required: true schema: $ref: '#/components/schemas/DateTimeFormatEnum' name: date_time_format in: query - required: true schema: title: Time Zone type: string name: time_zone in: query responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/DocumentsResponseModel' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorDetailModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/configure/by-role/{document_package_identifier}/{document_identifier}/{signature_id}/{signer_role}: post: tags: - Configure - Role - Document_identifier - Signer_role summary: Sign document operationId: >- sign_document_by_role_dms_configure_by_role__document_package_identifier___document_identifier___signature_id___signer_role__post parameters: - required: true schema: title: Document Package Identifier type: string name: document_package_identifier in: path - required: true schema: title: Document Identifier type: string name: document_identifier in: path - required: true schema: title: Signature Id type: string name: signature_id in: path - required: true schema: $ref: '#/components/schemas/SignerRole' name: signer_role in: path - required: true schema: $ref: '#/components/schemas/DateTimeFormatEnum' name: date_time_format in: query - required: true schema: title: Time Zone type: string name: time_zone in: query responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/DocumentsResponseModel' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorDetailModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/configure/document-pre-signed-url/{key}: get: tags: - Configure - Documents - Pre - Signed - Keys summary: Get document package by identifier operationId: >- get_document_pre_signed_url_dms_configure_document_pre_signed_url__key__get parameters: - required: true schema: title: Key type: string name: key in: path responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/configure/metadata: patch: tags: - Configure - Metadata summary: Add Meta Data operationId: add_meta_data_dms_configure_metadata_patch parameters: - required: true schema: title: Document Package Id type: string name: document_package_id in: query - required: true schema: title: Document Id type: string name: document_id in: query requestBody: content: application/json: schema: $ref: '#/components/schemas/DocumentMetaData' required: true responses: '200': description: Successful Response content: application/json: schema: {} '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorDetailModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/configure/document-notification-bookmarks: get: tags: - Configure - Documents - Notifications - Bookmarks summary: Get bookmarks of documents and notifications operationId: >- get_document_notification_bookmarks_dms_configure_document_notification_bookmarks_get parameters: - required: false schema: title: Event Name type: string name: event_name in: query responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /dms/submit-order: post: tags: - Submit - Order summary: Mock Credit Approver API & Fraud Check description: Mock Request operationId: get_submit_order_dms_submit_order_post parameters: - required: true schema: title: Reference Number type: string name: reference_number in: query requestBody: content: application/json: schema: $ref: '#/components/schemas/submitOrderRequest' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/credit-request: post: tags: - Credit - Request summary: Mock Credit Approver Request description: Mock Request operationId: get_credit_approver_request_dms_credit_request_post requestBody: content: application/json: schema: $ref: '#/components/schemas/CreditOrderRequest' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/contract-document: post: summary: Handle contract document description: Handle contract document operationId: contract_documents_dms_contract_document_post parameters: - required: true schema: title: Reference Number type: string name: reference_number in: query - required: true schema: title: Document Event type: string name: document_event in: query responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] tags: - Contract - Documents /dms/contract: get: tags: - Contract summary: Get active contract description: Get active contract operationId: get_active_contract_dms_contract_get parameters: - required: false schema: title: Identifier type: string name: identifier in: query - required: false schema: title: Customer Reference Id type: string name: customer_reference_id in: query - required: false schema: title: External Order Id type: string name: external_order_id in: query responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ContractResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] post: tags: - Contract summary: Create contract description: Create contract operationId: create_contract_dms_contract_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ContractCreateModel' required: true responses: '201': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ContractResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] patch: tags: - Contract summary: Update contract description: Update contract operationId: update_contract_dms_contract_patch parameters: - required: true schema: title: Identifier type: string name: identifier in: query requestBody: content: application/json: schema: $ref: '#/components/schemas/ContractUpdateModel' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ContractResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/contract/past-due-webhook: patch: tags: - Contract - Past - Due - Webhooks summary: Past due webhook description: Past due webhook operationId: past_due_webhook_dms_contract_past_due_webhook_patch requestBody: content: application/json: schema: title: Event type: object required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /dms/contract/all: get: tags: - Contract summary: Get all contract records description: Get all contract records operationId: get_all_contracts_dms_contract_all_get parameters: - required: true schema: title: Page Number type: integer name: page_number in: query - required: true schema: title: Page Size minimum: 1 type: integer name: page_size in: query - required: false schema: title: Identifier type: string name: identifier in: query - required: false schema: title: Customer Reference Id type: string name: customer_reference_id in: query - required: false schema: title: External Order Id type: string name: external_order_id in: query - description: Accepts only string values required: false schema: type: array items: $ref: '#/components/schemas/ContractStatus' description: Accepts only string values name: statuses in: query responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ContractPaginationResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/contracts: get: tags: - Contracts summary: Get contracts by external order ids description: Get contracts by external order ids operationId: find_contracts_dms_contracts_get parameters: - required: true schema: title: External Order Ids type: array items: type: string name: external_order_ids in: query responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/contracts/search: get: tags: - Contracts - Search summary: Get contracts by external order ids description: Get contracts by external order ids operationId: search_contracts_dms_contracts_search_get parameters: - description: 'Format: YYYY-MM-DDTHH:MM:SS' required: false schema: title: Subscription Start Date type: string description: 'Format: YYYY-MM-DDTHH:MM:SS' format: date-time name: subscription_start_date in: query - description: 'Format: YYYY-MM-DDTHH:MM:SS' required: false schema: title: Subscription End Date type: string description: 'Format: YYYY-MM-DDTHH:MM:SS' format: date-time name: subscription_end_date in: query - description: 'Format: YYYY-MM-DDTHH:MM:SS' required: false schema: title: Subscription Start Date From type: string description: 'Format: YYYY-MM-DDTHH:MM:SS' format: date-time name: subscription_start_date_from in: query - description: 'Format: YYYY-MM-DDTHH:MM:SS' required: false schema: title: Subscription Start Date To type: string description: 'Format: YYYY-MM-DDTHH:MM:SS' format: date-time name: subscription_start_date_to in: query - description: 'Format: YYYY-MM-DDTHH:MM:SS' required: false schema: title: Subscription End Date From type: string description: 'Format: YYYY-MM-DDTHH:MM:SS' format: date-time name: subscription_end_date_from in: query - description: 'Format: YYYY-MM-DDTHH:MM:SS' required: false schema: title: Subscription End Date To type: string description: 'Format: YYYY-MM-DDTHH:MM:SS' format: date-time name: subscription_end_date_to in: query responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/stipulation/fulfillment: get: tags: - Stipulation - Fulfillment summary: Get All Stipulation Fulfillments description: Get All Stipulation Fulfillments operationId: get_all_stipulation_fulfillment_dms_stipulation_fulfillment_get responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/StipulationFulfillmentResponseModel' post: tags: - Stipulation - Fulfillment summary: Create Stipulation Fulfillment description: Create Stipulation Fulfillment operationId: add_stipulation_fulfillment_dms_stipulation_fulfillment_post requestBody: content: application/json: schema: $ref: '#/components/schemas/StipulationFulfillmentModel' required: true responses: '201': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/StipulationFulfillmentResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] delete: tags: - Stipulation - Fulfillment summary: Delete Stipulation Fulfillments description: Delete Stipulation Fulfillments operationId: delete_stipulation_fulfillment_dms_stipulation_fulfillment_delete parameters: - required: true schema: title: Stipulation Fulfillment Id type: integer name: stipulation_fulfillment_id in: query responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' patch: tags: - Stipulation - Fulfillment summary: Delete Stipulation Fulfillments description: Delete Stipulation Fulfillments operationId: update_stipulation_fulfillment_dms_stipulation_fulfillment_patch parameters: - required: true schema: title: Stipulation Fulfillment Id type: integer name: stipulation_fulfillment_id in: query requestBody: content: application/json: schema: $ref: '#/components/schemas/StipulationFulfillmentModel' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/stipulation/fulfillment/: get: tags: - Stipulation - Fulfillment summary: Get Stipulation Fulfillments description: Get Stipulation Fulfillments operationId: get_stipulation_fulfillment_dms_stipulation_fulfillment__get parameters: - required: true schema: title: Stipulation Fulfillment Id type: integer name: stipulation_fulfillment_id in: query responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/history: get: tags: - History summary: Get all customers records history description: Get all customers records history operationId: get_customer_all_history_dms_history_get parameters: - required: true schema: title: Reference Id type: string name: reference_id in: query - required: true schema: title: Page Number type: integer name: page_number in: query - required: true schema: title: Page Size minimum: 1 type: integer name: page_size in: query - description: for stipulation, additional_document, insurance required: false schema: title: Order Reference Id type: string description: for stipulation, additional_document, insurance name: order_reference_id in: query - description: 'Format: YYYY-MM-DD' required: false schema: title: From Date type: string description: 'Format: YYYY-MM-DD' format: date name: from_date in: query - description: 'Format: YYYY-MM-DD' required: false schema: title: To Date type: string description: 'Format: YYYY-MM-DD' format: date name: to_date in: query - description: module required: false schema: type: array items: $ref: '#/components/schemas/ComparisonModule' description: module name: module_type in: query responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/HistoryPaginationResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/history-details: get: tags: - History summary: Get history detail description: Get history detail operationId: history_detail_dms_history_details_get parameters: - required: true schema: $ref: '#/components/schemas/ComparisonModule' name: module_type in: query - required: true schema: title: Identifier type: string name: identifier in: query - required: false schema: title: Order Reference Id type: string name: order_reference_id in: query responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/request: get: tags: - Request summary: Get Request description: Get Request operationId: get_request_dms_request_get parameters: - required: true schema: title: Request Id type: integer name: request_id in: query responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] post: tags: - Request summary: Create Request description: Create Request operationId: add_request_dms_request_post requestBody: content: application/json: schema: $ref: '#/components/schemas/RequestModel' required: true responses: '201': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/RequestResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] delete: tags: - Request summary: Delete Request description: Delete Request operationId: delete_request_dms_request_delete parameters: - required: true schema: title: Request Id type: integer name: request_id in: query responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' patch: tags: - Request summary: Update Request description: Update Request operationId: update_request_dms_request_patch parameters: - required: true schema: title: Request Id type: integer name: request_id in: query requestBody: content: application/json: schema: $ref: '#/components/schemas/RequestModel' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/requests: get: tags: - Request summary: Get All Requests description: Get All Requests operationId: get_all_request_dms_requests_get responses: '200': description: Successful Response content: application/json: schema: title: Response Get All Request Dms Requests Get type: array items: $ref: '#/components/schemas/RequestResponseModel' /dms/stipulation/financial: get: tags: - Stipulation - Financial summary: Get Financial Stipulation operationId: get_financial_stipulations_dms_stipulation_financial_get parameters: - required: false schema: title: External Reference Id type: string name: external_reference_id in: query - required: false schema: title: Customer Reference Id type: string name: customer_reference_id in: query responses: '200': description: Successful Response content: application/json: schema: title: >- Response Get Financial Stipulations Dms Stipulation Financial Get type: array items: $ref: '#/components/schemas/FinancialStipulationsResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] post: tags: - Stipulation - Financial summary: Create Financial Stipulation operationId: add_financial_stipulation_dms_stipulation_financial_post requestBody: content: application/json: schema: $ref: '#/components/schemas/FinancialStipulationModel' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/FinancialStipulationsResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/stipulation/stipulation-by-lender: get: tags: - Stipulation - Lender summary: Get Financial Stipulation operationId: get_order_fee_by_id_dms_stipulation_stipulation_by_lender_get parameters: - required: true schema: title: Company Id type: integer name: company_id in: query responses: '200': description: Successful Response content: application/json: schema: title: >- Response Get Order Fee By Id Dms Stipulation Stipulation By Lender Get type: array items: $ref: '#/components/schemas/StipulationResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /dms/external-orders/all: get: tags: - External - Orders summary: Get External Orders description: Get All External Orders operationId: get_all_external_orders_dms_external_orders_all_get parameters: - required: true schema: title: Userids type: string name: userIds in: query responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ExternalOrderMapper' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/external-keys/all: get: tags: - External - Keys summary: Get Keys description: Get All External Keys operationId: get_external_subscription_key_dms_external_keys_all_get responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ExternalKeys' /dms/external-orders/push-deal: post: tags: - External - Orders - Deal summary: Push Deal to Third Party description: Push Deal to Third Party operationId: push_deal_external_dms_dms_external_orders_push_deal_post requestBody: content: application/json: schema: $ref: '#/components/schemas/InternalOrderModel' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/theme-builder: get: tags: - Theme - Builder summary: Get Theme operationId: get_theme_dms_theme_builder_get parameters: - required: true schema: title: User Email type: string name: user_email in: query responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] post: tags: - Theme - Builder summary: Post Theme Builder Record description: >- This method creates theme builder record to be configured for application theme operationId: create_theme_by_user_email_dms_theme_builder_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ThemeBuilderModel' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/theme-builder/{user_email}: get: tags: - Theme - Builder - Theme Builder summary: Get theme by user email description: This method returns the theme of application with respect to user email operationId: get_theme_by_user_email_dms_theme_builder__user_email__get parameters: - required: true schema: title: User Email type: string format: email name: user_email in: path responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] patch: tags: - Theme - Builder - Theme Builder summary: Updates a theme builder record description: This method updates theme builder record provided by user_email operationId: update_theme_builder_record_dms_theme_builder__user_email__patch parameters: - required: true schema: title: User Email type: string format: email name: user_email in: path requestBody: content: application/json: schema: $ref: '#/components/schemas/ThemeBuilderPatchModel' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/affordability-check/: post: tags: - Affordability - Checks summary: Affordability Check operationId: affordability_check_dms_affordability_check__post requestBody: content: application/json: schema: $ref: '#/components/schemas/AffordabilityCheckModel' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/affordability-check/monthly-payment-calculation/V2/: post: tags: - Affordability - Checks - Payments - Calculations summary: Monthly Payment Calculation V2 operationId: >- monthly_payment_calculation_v2_dms_affordability_check_monthly_payment_calculation_V2__post requestBody: content: application/json: schema: $ref: '#/components/schemas/MonthlyPaymentCalculationModelV2' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/currencies: get: tags: - Currencies summary: Get All Currencies operationId: get_all_currencies_dms_currencies_get responses: '200': description: Successful Response content: application/json: schema: {} security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/company/by-tenant-id/{tenant_id}: get: tags: - Company - Tenant - Index Wrapper summary: Find Company By Tenant Id operationId: find_company_by_tenant_id_dms_company_by_tenant_id__tenant_id__get parameters: - required: true schema: title: Tenant Id type: integer name: tenant_id in: path responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/dealer/find/by-tenant: get: tags: - Dealer - Find - Tenant summary: Get Dealer By Tenant Id operationId: get_dealer_by_tenant_id_dms_dealer_find_by_tenant_get parameters: - required: true schema: title: Tenant Id type: integer name: tenant_id in: query - required: true schema: title: Email type: string name: email in: query responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/inventory/reference-data-by-dealer-code/{dealer_code}: get: tags: - Inventory - References - Data - Dealer - Code - Index Wrapper summary: Get Inventory Reference Data operationId: >- get_inventory_reference_data_dms_inventory_reference_data_by_dealer_code__dealer_code__get parameters: - required: true schema: title: Dealer Code type: string name: dealer_code in: path responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/inventory/filter: get: tags: - Inventory - Filter summary: Get Inventory Data operationId: get_inventory_data_dms_inventory_filter_get parameters: - required: true schema: title: Dealer Code type: string name: dealer_code in: query - required: true schema: title: Page Number minimum: 0 type: integer name: page_number in: query - required: true schema: title: Page Size minimum: 0 type: integer name: page_size in: query - required: false schema: title: Internet Price From type: integer name: internet_price_from in: query - required: false schema: title: Internet Price To type: integer name: internet_price_to in: query - required: false schema: title: Vehicle Status type: string name: vehicle_status in: query - required: false schema: title: Listing Status type: string name: listing_status in: query - required: false schema: title: Vin type: string name: vin in: query - required: false schema: title: Mileage type: string name: mileage in: query - required: false schema: title: Asset Condition type: string name: asset_condition in: query - required: false schema: title: Year From type: integer name: year_from in: query - required: false schema: title: Year To type: integer name: year_to in: query - required: false schema: title: Order By Price type: string name: order_by_price in: query - required: false schema: title: Multiple Asset Make type: array items: {} name: multiple_asset_make in: query - required: false schema: title: Multiple Asset Model type: array items: {} name: multiple_asset_model in: query - required: false schema: title: Multiple Asset Trim type: array items: {} name: multiple_asset_trim in: query - required: false schema: title: Multiple Asset Condition type: array items: {} name: multiple_asset_condition in: query - required: false schema: title: Stock Number type: string name: stock_number in: query responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/state: get: tags: - State summary: Get All States operationId: get_all_states_dms_state_get responses: '200': description: Successful Response content: application/json: schema: {} security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/contract-term: get: tags: - Contract - Term summary: Get All Contract Terms operationId: get_all_contract_terms_dms_contract_term_get parameters: - required: true schema: title: Company Id type: string name: company_id in: header responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/credit-ratings: get: tags: - Credit - Ratings summary: Get All Credit Rating operationId: get_all_credit_rating_dms_credit_ratings_get parameters: - required: true schema: title: Company Id type: string name: company_id in: header responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/integration/company: get: tags: - Integrations - Company summary: Get All Company Integration operationId: get_all_company_integration_dms_integration_company_get parameters: - required: true schema: title: Company Id type: string name: company_id in: header responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/dealer/preference-by-dealer-code/{dealer_code}: get: tags: - Dealer - Preferences - Code - Index Wrapper summary: Get Dealer Preference By Dealer Code operationId: >- get_dealer_preference_by_dealer_code_dms_dealer_preference_by_dealer_code__dealer_code__get parameters: - required: true schema: title: Dealer Code type: string name: dealer_code in: path responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/integration/by_provider_name/{dealer_code}/{integration_type}/{provider_name}: get: tags: - Integrations - Dealer_code - Provider_name summary: Get Integration By Provider Name operationId: >- get_integration_by_provider_name_dms_integration_by_provider_name__dealer_code___integration_type___provider_name__get parameters: - required: true schema: title: Dealer Code type: string name: dealer_code in: path - required: true schema: title: Integration Type type: string name: integration_type in: path - required: true schema: title: Provider Name type: string name: provider_name in: path - required: true schema: title: Company Id type: string name: company_id in: header responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/integration/configuration/{dealer_code}/{integration_type}/{provider_name}: get: tags: - Integrations - Configuration - Integration_type - Index Wrapper summary: Get Hubex Configuration By Provider Name operationId: >- get_hubex_configuration_by_provider_name_dms_integration_configuration__dealer_code___integration_type___provider_name__get parameters: - required: true schema: title: Dealer Code type: string name: dealer_code in: path - required: true schema: title: Integration Type type: string name: integration_type in: path - required: true schema: title: Provider Name type: string name: provider_name in: path - required: true schema: title: Company Id type: string name: company_id in: header responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/vehicle-detail/{vin}: get: tags: - Vehicle - Index Wrapper summary: Get Vehicle Detail By Vin operationId: get_vehicle_detail_by_vin_dms_vehicle_detail__vin__get parameters: - required: true schema: title: Vin type: string name: vin in: path responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/countries: get: tags: - Countries summary: Get All Countries operationId: get_all_countries_dms_countries_get responses: '200': description: Successful Response content: application/json: schema: {} security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/dealer/profile/{dealer_code}: get: tags: - Dealer - Profiles - Index Wrapper summary: Get Dealer Profile By Dealer Code operationId: get_dealer_profile_by_dealer_code_dms_dealer_profile__dealer_code__get parameters: - required: true schema: title: Dealer Code type: string name: dealer_code in: path responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/vehicle/{vin}: get: tags: - Vehicle - Index Wrapper summary: Get Vehicle By Vin operationId: get_vehicle_by_vin_dms_vehicle__vin__get parameters: - required: true schema: title: Vin type: string name: vin in: path responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/contract-allowed-annum-mileage: get: tags: - Contract - Allowed - Mileage summary: Get All Contract Allowed Mileages operationId: get_all_contract_allowed_mileages_dms_contract_allowed_annum_mileage_get parameters: - required: true schema: title: Company Id type: string name: company_id in: header responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/dealer/fee/dealer-code/{dealer_code}: get: tags: - Dealer - Fee - Code - Index Wrapper summary: Get All Dealer Fee By Code operationId: get_all_dealer_fee_by_code_dms_dealer_fee_dealer_code__dealer_code__get parameters: - required: true schema: title: Dealer Code type: string name: dealer_code in: path - required: false schema: title: State Code type: string name: state_code in: query responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/asset-usage/active: get: tags: - Assets - Usage - Index Wrapper summary: Get Active Asset Usages operationId: get_active_asset_usages_dms_asset_usage_active_get parameters: - required: true schema: title: Company Id type: string name: company_id in: header responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/vehicle: get: tags: - Vehicle summary: Get All Vehicles operationId: get_all_vehicles_dms_vehicle_get responses: '200': description: Successful Response content: application/json: schema: {} security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/financial-insurances/filter: get: tags: - Financial - Filter summary: Get Financial Insurance Product By Filter operationId: >- get_financial_insurance_product_by_filter_dms_financial_insurances_filter_get parameters: - required: true schema: title: Dealer Code type: string name: dealer_code in: query - required: true schema: title: Page Number minimum: 0 type: integer name: page_number in: query - required: true schema: title: Page Size minimum: 0 type: integer name: page_size in: query - required: false schema: title: Is Active type: boolean name: is_active in: query responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/dealer/option-model-name: get: tags: - Dealer - Options - Model - Name summary: Get All Dealer Options By Model Name operationId: get_all_dealer_options_by_model_name_dms_dealer_option_model_name_get parameters: - required: true schema: title: Dealer Code type: string name: dealer_code in: query - required: true schema: title: Model Name type: string name: model_name in: query responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/programs/all/: post: tags: - Programs summary: Get All Evaluated Programs operationId: get_all_evaluated_programs_dms_programs_all__post requestBody: content: application/json: schema: $ref: '#/components/schemas/ProgramParamsModel' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/get-payment-methods/{reference_number}: get: tags: - Payment - Methods - Payments summary: Get Payment Methods & Get Paid Amount description: Get Payment Methods & Get Paid Amount operationId: get_payment_methods_dms_get_payment_methods__reference_number__get parameters: - required: true schema: title: Reference Number type: string name: reference_number in: path responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/plaid-link-token/: post: tags: - Plaid - Links - Payments summary: Create Link Token description: >- Creates a link token which is required when initialing Link. Once Link is initialized, it returns a public token. operationId: create_plaid_link_token_dms_plaid_link_token__post requestBody: content: application/json: schema: $ref: '#/components/schemas/CreatePlaidLinkToken' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PlaidLinkTokenResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/create-payment/: post: tags: - Payment - Payments summary: Create payment for new Order description: Create payment for new Order operationId: create_customer_order_dms_create_payment__post requestBody: content: application/json: schema: $ref: '#/components/schemas/CreatePayment' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CreatePaymentResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/update-payment/: post: tags: - Payment - Payments summary: Update Order Payment description: This end point will be used to handle webhook. operationId: update_payment_status_dms_update_payment__post responses: '200': description: Successful Response content: application/json: schema: {} security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/add-payment-details/: post: tags: - Add - Payments summary: Add Payment Details from dealer side description: Add Payment Details from dealer side operationId: add_payment_details_dms_add_payment_details__post requestBody: content: application/json: schema: $ref: '#/components/schemas/AddPaymentDetails' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/remove-payment-details/{order_payment_detail_id}: put: tags: - Removes - Payments summary: Remove the order payment detail description: Remove the order payment detail operationId: >- remove_payment_details_dms_remove_payment_details__order_payment_detail_id__put parameters: - required: true schema: title: Order Payment Detail Id type: integer name: order_payment_detail_id in: path responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/dealer/all-dealer-distance: get: tags: - Dealer - Distance summary: Get All Dealer Distance description: Get All Dealer Distance operationId: dealer_distance_dms_dealer_all_dealer_distance_get parameters: - required: true schema: title: Company Id type: integer name: company_id in: query - required: true schema: title: Radius type: integer name: radius in: query - required: true schema: title: Zip Code type: string name: zip_code in: query responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/DealerResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/dealer/get-associated-dealers: get: tags: - Dealer - Associated - Dealer Management summary: Get All Dealer Distance description: Get All Dealer Distance operationId: get_associated_dealer_dms_dealer_get_associated_dealers_get parameters: - required: true schema: $ref: '#/components/schemas/EntityType' name: entity_type in: query responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - OAuth2PasswordBearer: [] - APIKeyHeader: [] /dms/dealer/check-actively-order: get: tags: - Dealer - Checks - Order summary: Check Dealer actively order description: Check Dealer actively order operationId: check_dealer_order_dms_dealer_check_actively_order_get parameters: - required: true schema: title: Dealer Id type: string name: dealer_id in: query responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/get-trade-in-year/: post: tags: - Trade - Year summary: Get all the year from KBB description: This method will get all the year from KBB operationId: get_trade_in_year_dms_get_trade_in_year__post parameters: - description: Vehicle valuation service to use required: false schema: allOf: - $ref: '#/components/schemas/VehicleValuationProviders' description: Vehicle valuation service to use name: x-service-provider in: header - description: Dealer code from the header required: false schema: title: X-Dealer-Code type: string description: Dealer code from the header name: x-dealer-code in: header - description: Company ID from the dealer required: false schema: title: Company-Id type: string description: Company ID from the dealer name: company-id in: header requestBody: content: application/json: schema: $ref: '#/components/schemas/TradeInYear' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/get-trade-in-make/: post: tags: - Trade - Make summary: Get all the make from KBB description: This method will get all the make from KBB operationId: get_trade_in_make_dms_get_trade_in_make__post parameters: - description: Vehicle valuation service to use required: false schema: allOf: - $ref: '#/components/schemas/VehicleValuationProviders' description: Vehicle valuation service to use name: x-service-provider in: header - description: Dealer code from the header required: false schema: title: X-Dealer-Code type: string description: Dealer code from the header name: x-dealer-code in: header - description: Company ID from the dealer required: false schema: title: Company-Id type: string description: Company ID from the dealer name: company-id in: header requestBody: content: application/json: schema: $ref: '#/components/schemas/TradeInMake' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/get-trade-in-model/: post: tags: - Trade - Model summary: Get all the models from KBB description: This method will get all the models from KBB operationId: get_trade_in_model_dms_get_trade_in_model__post parameters: - description: Vehicle valuation service to use required: false schema: allOf: - $ref: '#/components/schemas/VehicleValuationProviders' description: Vehicle valuation service to use name: x-service-provider in: header - description: Dealer code from the header required: false schema: title: X-Dealer-Code type: string description: Dealer code from the header name: x-dealer-code in: header - description: Company ID from the dealer required: false schema: title: Company-Id type: string description: Company ID from the dealer name: company-id in: header requestBody: content: application/json: schema: $ref: '#/components/schemas/TradeInModel' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/get-trade-in-trim/: post: tags: - Trade - Trim summary: Get all the trims from KBB description: This method will get all the trims from KBB operationId: get_trade_in_trim_dms_get_trade_in_trim__post parameters: - description: Vehicle valuation service to use required: false schema: allOf: - $ref: '#/components/schemas/VehicleValuationProviders' description: Vehicle valuation service to use name: x-service-provider in: header - description: Dealer code from the header required: false schema: title: X-Dealer-Code type: string description: Dealer code from the header name: x-dealer-code in: header - description: Company ID from the dealer required: false schema: title: Company-Id type: string description: Company ID from the dealer name: company-id in: header requestBody: content: application/json: schema: $ref: '#/components/schemas/TradeInTrim' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/get-trade-in-vehicle_value/: post: tags: - Trade - Trade- In summary: Get vehicle estimation from KBB description: This method will provide vehicle estimation from KBB operationId: get_trade_in_vehicle_value_dms_get_trade_in_vehicle_value__post parameters: - description: Vehicle valuation service to use required: false schema: allOf: - $ref: '#/components/schemas/VehicleValuationProviders' description: Vehicle valuation service to use name: x-service-provider in: header - description: Dealer code from the header required: false schema: title: X-Dealer-Code type: string description: Dealer code from the header name: x-dealer-code in: header - description: Company ID from the dealer required: false schema: title: Company-Id type: string description: Company ID from the dealer name: company-id in: header requestBody: content: application/json: schema: $ref: '#/components/schemas/TradeInVehicleValue' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/get-trade-in-vehicle_detail/: post: tags: - Trade - Trade- In summary: Get vehicle details from KBB description: This will give vehicle details from KBB operationId: get_trade_in_vehicle_detail_dms_get_trade_in_vehicle_detail__post parameters: - description: Vehicle valuation service to use required: false schema: allOf: - $ref: '#/components/schemas/VehicleValuationProviders' description: Vehicle valuation service to use name: x-service-provider in: header - description: Dealer code from the header required: false schema: title: X-Dealer-Code type: string description: Dealer code from the header name: x-dealer-code in: header - description: Company ID from the dealer required: false schema: title: Company-Id type: string description: Company ID from the dealer name: company-id in: header requestBody: content: application/json: schema: $ref: '#/components/schemas/TradeInVehicleDetail' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/get-vehicle-detail-by-vin/: post: tags: - Vehicle - Vin summary: Get vehicle details through VIN description: This method will provide vehicle details through VIN operationId: get_vehicle_details_by_vin_dms_get_vehicle_detail_by_vin__post parameters: - description: Vehicle valuation service to use required: false schema: allOf: - $ref: '#/components/schemas/VehicleValuationProviders' description: Vehicle valuation service to use name: x-service-provider in: header - description: Dealer code from the header required: false schema: title: X-Dealer-Code type: string description: Dealer code from the header name: x-dealer-code in: header - description: Company ID from the dealer required: false schema: title: Company-Id type: string description: Company ID from the dealer name: company-id in: header requestBody: content: application/json: schema: $ref: '#/components/schemas/TradeInDecodeVin' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/set-trade-in-inspection-status/{order_id}: patch: tags: - Set - Trade - Inspection - Status - Trade- In summary: Set Trade-in inspection status description: This method will set Trade-in inspection status operationId: >- set_trade_in_inspection_status_dms_set_trade_in_inspection_status__order_id__patch parameters: - required: true schema: title: Order Id type: integer name: order_id in: path - required: true schema: $ref: '#/components/schemas/TradeInInspectionStatus' name: inspection_status in: query responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/get-trade_in_history/{order_id}: get: tags: - Trade_in_history - Trade- In summary: Get trade in history description: This method will get all the trade in history operationId: get_trade_in_history_dms_get_trade_in_history__order_id__get parameters: - required: true schema: title: Order Id type: integer name: order_id in: path responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/get-tradein-options/: post: tags: - Tradein - Options summary: Get trade in options linked with vehicles description: This method will get all the options related to vehicle operationId: get_trade_in_options_dms_get_tradein_options__post parameters: - description: Vehicle valuation service to use required: false schema: allOf: - $ref: '#/components/schemas/VehicleValuationProviders' description: Vehicle valuation service to use name: x-service-provider in: header - description: Dealer code from the header required: false schema: title: X-Dealer-Code type: string description: Dealer code from the header name: x-dealer-code in: header - description: Company ID from the dealer required: false schema: title: Company-Id type: string description: Company ID from the dealer name: company-id in: header requestBody: content: application/json: schema: $ref: '#/components/schemas/TradeInOptions' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/event_analytic: post: tags: - Event_analytic summary: Create Event operationId: create_event_dms_event_analytic_post requestBody: content: application/json: schema: $ref: '#/components/schemas/TagsAnlyticModel' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /dms/get_event_associated_checklist/: post: tags: - Get_event_associated_checklist summary: >- This API helps to evaluate given criteria and retrieve configured checklist(s) description: >- If criteria is not given then checklist(s) configured against the given event will be returned. In case criteria is provided, specific checklist(s) that fulfills given criteria will be returned. Criteria is open ended, but must follow this pattern. **** {"event_name": "string", "criteria": { "item1": "", "item2": "" } } **** operationId: get_event_checklist_by_criteria_dms_get_event_associated_checklist__post requestBody: content: application/json: schema: title: Payload type: object required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/lead/{dealer_id}: get: tags: - Lead - Lead- Management summary: Get dealer's lead description: This method will get a dealer's leads operationId: get_leads_dms_lead__dealer_id__get parameters: - required: true schema: title: Dealer Id type: integer name: dealer_id in: path - required: false schema: title: Year Make Model Trim type: string name: year_make_model_trim in: query - required: false schema: title: Lead Status type: string name: lead_status in: query - required: false schema: title: Lead Id type: string name: lead_id in: query - required: false schema: title: Email Address type: string name: email_address in: query - required: false schema: title: First Name type: string name: first_name in: query - required: false schema: title: Last Name type: string name: last_name in: query - required: false schema: title: Contact Number type: string name: contact_number in: query - required: false schema: title: Preferred Communication type: string name: preferred_communication in: query - required: false schema: title: Vin type: string name: vin in: query - required: false schema: title: Stock type: string name: stock in: query - required: false schema: title: Created At type: string name: created_at in: query - required: false schema: title: Last Updated At type: string name: last_updated_at in: query - required: false schema: title: Last Synced Status type: string name: last_synced_status in: query - required: false schema: title: Lead Source type: string name: lead_source in: query - required: false schema: title: Page type: integer default: 1 name: page in: query - required: false schema: title: Page Size type: integer default: 10 name: page_size in: query responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/lead: patch: tags: - Lead summary: Update exisitng Draft/Active lead otherwise create new Lead description: >- This method will update exisitng Draft/Active lead otherwise create new Lead operationId: update_lead_dms_lead_patch requestBody: content: application/json: schema: $ref: '#/components/schemas/LeadModel' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/lead/change-status/{lead_id}: patch: tags: - Lead - Changes - Status - Lead- Management summary: Update exisitng lead status description: >- This method will update exisitng lead status along with any other param update operationId: change_status_dms_lead_change_status__lead_id__patch parameters: - required: true schema: title: Lead Id type: integer name: lead_id in: path requestBody: content: application/json: schema: $ref: '#/components/schemas/LeadModel' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] /dms/insurance/add-insurance: post: tags: - Insurance - Add summary: Add Insurance description: Storing Transaction id operationId: add_insurance_dms_insurance_add_insurance_post requestBody: content: application/json: schema: $ref: '#/components/schemas/InsuranceProviderRequest' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] - OAuth2PasswordBearer: [] components: schemas: ANQuotation: title: ANQuotation required: - vin - products - address type: object properties: vin: title: Vin pattern: ^([^\WioqIOQ]{17}|[^\WioqIOQ]{8}|[^\WioqIOQ]{9})$ type: string description: VIN of the vehicle downPayment: title: Downpayment minimum: 0 type: number description: Down Payment products: title: Products type: array items: $ref: '#/components/schemas/ANQuotationProducts' description: Products address: title: Address allOf: - $ref: '#/components/schemas/ANQuotationAddress' description: Address ANQuotationAddress: title: ANQuotationAddress required: - city - state - line1 - line2 - zipCode type: object properties: city: title: City type: string description: City state: title: State type: string description: State line1: title: Line1 type: string description: Line 1 line2: title: Line2 type: string description: Line 2 zipCode: title: Zipcode type: string description: Zip Code ANQuotationProducts: title: ANQuotationProducts required: - productId - productType - price type: object properties: productId: title: Productid type: string description: ID of the product productType: title: Producttype type: string description: Type of the product price: title: Price type: number description: Price of the product AddPaymentDetails: title: AddPaymentDetails required: - amount - reference_number type: object properties: amount: title: Amount type: number reference_number: title: Reference Number type: string payment_method_type: allOf: - $ref: '#/components/schemas/PaymentMethodType' default: cheque cheque_number: title: Cheque Number type: string payment_date: title: Payment Date type: string format: date-time order_payment_detail_id: title: Order Payment Detail Id type: integer Address: title: Address required: - state - zip_code type: object properties: street_address: title: Street Address type: string description: Street Address city: title: City type: string description: City state: title: State type: string description: State zip_code: title: Zip Code type: string description: Zip Code AddressBasicModel: title: AddressBasicModel type: object properties: address_line_1: title: Address Line 1 type: string description: Address line one address_line_2: title: Address Line 2 type: string description: Address line two state_name: title: State Name type: string description: Address state name zip_code: title: Zip Code type: string description: Zip code county: title: County type: string description: Address county city: title: City type: string description: Address city contact_number: title: Contact Number type: string description: Contact number verified: title: Verified type: boolean description: Is Address verified move_in_date: title: Move In Date type: string description: 'format: YYYY-MM-DD' format: date is_garaging: title: Is Garaging type: boolean description: Garaging flag default: false AddressCreateModel: title: AddressCreateModel required: - address_type type: object properties: address_line_1: title: Address Line 1 type: string description: Address line one address_line_2: title: Address Line 2 type: string description: Address line two state_name: title: State Name type: string description: Address state name zip_code: title: Zip Code type: string description: Zip code county: title: County type: string description: Address county city: title: City type: string description: Address city contact_number: title: Contact Number type: string description: Contact number verified: title: Verified type: boolean description: Is Address verified move_in_date: title: Move In Date type: string description: 'format: YYYY-MM-DD' format: date is_garaging: title: Is Garaging type: boolean description: Garaging flag default: false address_type: $ref: '#/components/schemas/AddressTypes' identifier: title: Identifier minLength: 1 type: string reference_id: title: Reference Id type: string AddressResponseModel: title: AddressResponseModel required: - address_type type: object properties: address_line_1: title: Address Line 1 type: string description: Address line one address_line_2: title: Address Line 2 type: string description: Address line two state_name: title: State Name type: string description: Address state name zip_code: title: Zip Code type: string description: Zip code county: title: County type: string description: Address county city: title: City type: string description: Address city contact_number: title: Contact Number type: string description: Contact number verified: title: Verified type: boolean description: Is Address verified move_in_date: title: Move In Date type: string description: 'format: YYYY-MM-DD' format: date is_garaging: title: Is Garaging type: boolean description: Garaging flag default: false address_type: $ref: '#/components/schemas/AddressTypes' identifier: title: Identifier type: string created_at: title: Created At type: string format: date-time created_by: title: Created By type: string updated_at: title: Updated At type: string format: date-time updated_by: title: Updated By type: string deleted_at: title: Deleted At type: string format: date-time deleted_by: title: Deleted By type: string reference_id: title: Reference Id type: string is_active: title: Is Active type: boolean AddressTypes: title: AddressTypes enum: - Mailing - Invoice - Office - Garaging - DealerAddress - DrivingLicense - Billing - InsuranceAddress - Residential - Employment type: string description: An enumeration. AddressTypesEnum: title: AddressTypesEnum enum: - Mailing - Invoice - Office - Garaging - DealerAddress - DrivingLicense - Billing - InsuranceAddress - Residential - Previous - All type: string description: An enumeration. AffordabilityCheckModel: title: AffordabilityCheckModel required: - dealer_code - company_code - lender_code - max_payment - terms type: object properties: dealer_code: title: Dealer Code type: string company_code: title: Company Code type: string description: Company code lender_code: title: Lender Code type: string max_payment: title: Max Payment type: number terms: title: Terms type: integer credit_rating: title: Credit Rating type: string upfront: title: Upfront type: number annual_usage: title: Annual Usage type: integer balloon_payment: title: Balloon Payment type: number trade_in_amount: title: Trade In Amount type: number trade_in_payoff: title: Trade In Payoff type: number AndOr: title: AndOr enum: - And - Or type: string description: An enumeration. AppointmentFilterModel: title: AppointmentFilterModel required: - page_number - page_size type: object properties: page_number: title: Page Number type: integer page_size: title: Page Size exclusiveMinimum: 0 type: integer year: title: Year type: integer make: title: Make type: string model: title: Model type: string trim: title: Trim type: string order_id: title: Order Id type: string order_status: title: Order Status type: string vin: title: Vin type: string stock: title: Stock type: string AssetInfo: title: AssetInfo type: object properties: cost: title: Cost type: string description: Asset Cost quantity: title: Quantity type: string description: Asset Quantity type: title: Type type: string description: Asset Type sub_type: title: Sub Type type: string description: Asset Sub Type condition: title: Condition type: string description: Asset Condition category: title: Category type: string description: Asset Category age: title: Age type: string description: Asset Age rv_balloon_amount: title: Rv Balloon Amount type: string description: Asset RV Balloon Amount total_cost: title: Total Cost type: string description: Asset Total Cost total_rv_balloon_amount: title: Total Rv Balloon Amount type: string description: Asset Total RV Balloon Amount supplier_name: title: Supplier Name type: string description: Asset Supplier Name description: title: Description type: string description: Asset Description AssetsByTrimCodeResponse: title: AssetsByTrimCodeResponse type: object properties: asset_make_id: title: Asset Make Id type: integer asset_model_id: title: Asset Model Id type: integer asset_trim_id: title: Asset Trim Id type: integer Buyout: title: Buyout type: object properties: buyout_option: title: Buyout Option type: string description: Buyout Option vehicle_purchase_price: title: Vehicle Purchase Price type: integer description: Vehicle Purchase Price CalculateNFAResponseModel: title: CalculateNFAResponseModel required: - net_financed_amount type: object properties: net_financed_amount: title: Net Financed Amount type: number description: Net Financed amount calculated CalculationMethod: title: CalculationMethod enum: - equal principal - annuity - flat - flat plus - annuity - actual/360 - annuity - actual/365 description: An enumeration. CalculationResponseModel: title: CalculationResponseModel type: object properties: add_ons_total: title: Add Ons Total type: number adjusted_capitalized_cost: title: Adjusted Capitalized Cost type: number base_monthly_payment: title: Base Monthly Payment type: number tax_on_capitalized_cost_reduction: title: Tax On Capitalized Cost Reduction type: number monthly_deprecation: title: Monthly Deprecation type: number capitalized_cost_reduction: title: Capitalized Cost Reduction type: number down_payment: title: Down Payment type: number due_at_signing: title: Due At Signing type: number estimated_monthly_payment: title: Estimated Monthly Payment type: number expiry_date: title: Expiry Date type: string format: date fees_total: title: Fees Total type: number final_rate: title: Final Rate type: number fni_total: title: Fni Total type: number fni_products: title: Fni Products type: array items: $ref: '#/components/schemas/FNIProductCalculationModel' gross_capitalized_cost: title: Gross Capitalized Cost type: number monthly_payment: title: Monthly Payment type: number monthly_sales_use_tax: title: Monthly Sales Use Tax type: number rebate_promotions: title: Rebate Promotions type: number rentals_stream: title: Rentals Stream rv_amount: title: Rv Amount type: number selling_price: title: Selling Price type: number subsidy: $ref: '#/components/schemas/SubsidyResponseModel' tax_amount: title: Tax Amount type: number taxes: title: Taxes CalculationV2Model: title: CalculationV2Model required: - apr - dealer_id - fees - fni_products - interest_chart_margin - insurance - per_unit_selling_price - terms - finance_type type: object properties: base_rate: title: Base Rate type: number description: Base rate annual_usage: title: Annual Usage type: integer description: Allowed Usage default: 0 apr: title: Apr type: number description: APR calculation_method: allOf: - $ref: '#/components/schemas/CalculationMethod' description: Calculation Method default: annuity dealer_id: title: Dealer Id type: integer description: Dealer Id lender_id: title: Lender Id type: integer description: Lender Id down_payment: title: Down Payment type: number description: Asset Total Down payment down_payment_paid_by_dealer: title: Down Payment Paid By Dealer type: number description: Asset Down payment paid by Dealer down_payment_paid_by_oem: title: Down Payment Paid By Oem type: number description: Asset Down payment paid by OEM fees: title: Fees type: array items: $ref: '#/components/schemas/FeeRequestModel' description: Fees net_financed_amount: title: Net Financed Amount type: number description: Asset Financed amount default: 0 fni_products: title: Fni Products type: array items: $ref: '#/components/schemas/FinanceAndInsuranceRequestModel' description: F&I Products interest_chart_margin: title: Interest Chart Margin type: number description: Interest chart margin insurance: title: Insurance type: array items: $ref: '#/components/schemas/InsuranceRequestModel' description: Insurance options: title: Options type: array items: $ref: '#/components/schemas/OptionsRequestModel' description: Options applied on asset per_unit_selling_price: title: Per Unit Selling Price type: number description: Per Unit Asset Selling Price rental_frequency: title: Rental Frequency type: string description: Rental Frequency default: Monthly rental_mode: allOf: - $ref: '#/components/schemas/RentalMode' description: Rental Mode, possible values [Advance, Arrear] vehicle: title: Vehicle allOf: - $ref: '#/components/schemas/Vehicle' description: Vehicle rv_value: title: Rv Value type: number description: rv value rv_amount: title: Rv Amount type: integer description: RV amount structure_rentals: title: Structure Rentals type: array items: $ref: '#/components/schemas/StructureRentalModel' description: Array of Structured Rentals subsidy: title: Subsidy allOf: - $ref: '#/components/schemas/SubsidyRequestModel' description: Subsidy Parameters quantity: title: Quantity type: integer description: Quantity of Financed Equipment/Assets taxes: title: Taxes type: array items: $ref: '#/components/schemas/TaxesRequestModel' description: Taxes terms: title: Terms type: string description: Terms customer_address: title: Customer Address allOf: - $ref: '#/components/schemas/Address' description: Customer Address dealer_address: title: Dealer Address allOf: - $ref: '#/components/schemas/Address' description: Dealer Address trade_in_amount: title: Trade In Amount type: number description: Trade-in amount finance_type: title: Finance Type type: string description: Finance Type markup_rate: title: Markup Rate type: number description: Markup Rate trade_ins: title: Trade Ins type: array items: $ref: '#/components/schemas/TradeIn' description: Trade Ins default: [] rebate: title: Rebate allOf: - $ref: '#/components/schemas/RebateModel' description: Rebate Model tax_on_selling_price: title: Tax On Selling Price type: number description: Selling Price Tax Calculation CallType: title: CallType enum: - manual - auto type: string description: An enumeration. CommentDiaryCategory: title: CommentDiaryCategory enum: - General - Underwriting - Change Requests type: string description: An enumeration. ComparisonModule: title: ComparisonModule enum: - CustomerProfile - InsuranceInformation - Stipulation - AdditionalDocument - StatusFlag - CustomerAdditionalDocument type: string description: An enumeration. ComparisonType: title: ComparisonType enum: - Contract - noaa - General - Compliance type: string description: An enumeration. ConsentsModel: title: ConsentsModel required: - dealer_id - customer_id - lender_id type: object properties: dealer_id: title: Dealer Id type: integer description: Dealer ID for consent customer_id: title: Customer Id type: integer description: Customer ID for consent lender_id: title: Lender Id type: integer description: Lender ID for consent ContractAssets: title: ContractAssets type: object properties: vin: title: Vin type: string ContractCreateModel: title: ContractCreateModel required: - customer_reference_id - start_date - end_date - dealer_id - allowed_miles - exceed_miles_rate - terms - created_by type: object properties: external_subscription_id: title: External Subscription Id type: string vendor_subscription_id: title: Vendor Subscription Id type: string customer_reference_id: title: Customer Reference Id type: string external_order_id: title: External Order Id type: string start_date: title: Start Date type: string format: date-time end_date: title: End Date type: string format: date-time dealer_id: title: Dealer Id type: integer starting_odometer: title: Starting Odometer type: integer default: 0 allowed_miles: title: Allowed Miles type: integer exceed_miles_rate: title: Exceed Miles Rate type: integer terms: title: Terms type: integer meta_data: title: Meta Data type: object assets: title: Assets type: array items: $ref: '#/components/schemas/ContractAssets' identifier: title: Identifier type: string created_by: title: Created By type: string ContractEventModel: title: ContractEventModel type: object properties: identifier: title: Identifier type: string type: $ref: '#/components/schemas/EventStatus' status: title: Status type: string ContractPaginationResponse: title: ContractPaginationResponse type: object properties: result: title: Result type: array items: $ref: '#/components/schemas/ContractResponseModel' page_number: title: Page Number type: integer page_size: title: Page Size type: integer total_pages: title: Total Pages type: integer total_results: title: Total Results type: integer ContractResponseModel: title: ContractResponseModel type: object properties: external_subscription_id: title: External Subscription Id type: string vendor_subscription_id: title: Vendor Subscription Id type: string customer_reference_id: title: Customer Reference Id type: string external_order_id: title: External Order Id type: string starting_odometer: title: Starting Odometer type: integer start_date: title: Start Date type: string format: date-time end_date: title: End Date type: string format: date-time dealer_id: title: Dealer Id type: integer allowed_miles: title: Allowed Miles type: integer exceed_miles_rate: title: Exceed Miles Rate type: integer terms: title: Terms type: integer meta_data: title: Meta Data type: object subscription_status: title: Subscription Status type: string received_security_deposit: title: Received Security Deposit type: integer invocation_type: title: Invocation Type type: string assets: title: Assets type: array items: $ref: '#/components/schemas/ContractAssets' buyout: title: Buyout allOf: - $ref: '#/components/schemas/Buyout' description: Vehicle Buyout identifier: title: Identifier type: string created_at: title: Created At type: string format: date-time created_by: title: Created By type: string updated_at: title: Updated At type: string format: date-time updated_by: title: Updated By type: string billing_status: title: Billing Status type: string has_draft_invoice: title: Has Draft Invoice type: boolean final_bill_invoice_id: title: Final Bill Invoice Id type: string final_bill_amount: title: Final Bill Amount type: integer first_bill_invoice_id: title: First Bill Invoice Id type: string events: title: Events type: array items: $ref: '#/components/schemas/ContractEventModel' returns: $ref: '#/components/schemas/ContractReturnModel' customer: $ref: '#/components/schemas/CustomerProfileModelResponse' ContractReturnModel: title: ContractReturnModel type: object properties: actual_return_date: title: Actual Return Date type: string vin: title: Vin type: string order_reference_number: title: Order Reference Number type: string current_odometer_reading: title: Current Odometer Reading type: integer dealer_id: title: Dealer Id type: integer noi_date: title: Noi Date type: string format: date-time identifier: title: Identifier type: string invoice_id: title: Invoice Id type: string planned_return_date: title: Planned Return Date type: string penalty_reason: title: Penalty Reason type: string check_list_start_date: title: Check List Start Date type: string penalty_amount: title: Penalty Amount type: string return_type: title: Return Type type: string et_fee: title: Et Fee type: integer status: title: Status type: string dealer_comments: title: Dealer Comments type: string reason: title: Reason type: string reason_detail: title: Reason Detail type: string allowed_usage: title: Allowed Usage type: integer external_order_id: title: External Order Id type: string customer_reference_id: title: Customer Reference Id type: string customer_first_name: title: Customer First Name type: string customer_last_name: title: Customer Last Name type: string order_checklist: title: Order Checklist type: array items: {} ContractStatus: title: ContractStatus enum: - DRAFT - ACTIVE - PENDING_RETURN - PROCESSING_RETURN - RETURN_SUBMITTED - PAUSED - RESUME - CLOSED - CANCELED - PURCHASED type: string description: An enumeration. ContractUpdateModel: title: ContractUpdateModel required: - updated_by type: object properties: external_subscription_id: title: External Subscription Id type: string vendor_subscription_id: title: Vendor Subscription Id type: string return_status: title: Return Status type: string start_date: title: Start Date type: string format: date-time end_date: title: End Date type: string format: date-time dealer_id: title: Dealer Id type: integer starting_odometer: title: Starting Odometer type: integer subscription_status: $ref: '#/components/schemas/ContractStatus' allowed_miles: title: Allowed Miles type: integer exceed_miles_rate: title: Exceed Miles Rate type: integer terms: title: Terms type: integer meta_data: title: Meta Data type: object final_bill_invoice_id: title: Final Bill Invoice Id type: string final_bill_amount: title: Final Bill Amount type: integer buyout: title: Buyout allOf: - $ref: '#/components/schemas/Buyout' description: Vehicle Buyout assets: title: Assets type: array items: $ref: '#/components/schemas/ContractAssets' updated_by: title: Updated By type: string CreateCustomerModel: title: CreateCustomerModel required: - dealer_id - email type: object properties: dealer_id: title: Dealer Id type: integer description: Dealer ID for Customer email: title: Email type: string format: email CreatePayment: title: CreatePayment required: - email - amount - reference_number type: object properties: email: title: Email type: string name: title: Name type: string amount: title: Amount type: number reference_number: title: Reference Number type: string token: title: Token type: string account_id: title: Account Id type: string payment_method_id: title: Payment Method Id type: string payment_method_type: allOf: - $ref: '#/components/schemas/PaymentMethodType' default: card CreatePaymentResponse: title: CreatePaymentResponse type: object properties: id: title: Id type: string description: Unique identifier for the object. amount: title: Amount type: number description: Amount intended to be collected by this PaymentIntent. amount_capturable: title: Amount Capturable type: integer description: Amount that can be captured from this PaymentIntent. amount_details: title: Amount Details type: object description: Details about items included in the amount. amount_received: title: Amount Received type: integer description: Amount that was collected by this PaymentIntent. application_fee_amount: title: Application Fee Amount type: integer description: >- The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owners account. client_secret: title: Client Secret type: string description: The client secret of this PaymentIntent capture_method: title: Capture Method type: string description: >- Controls when the funds will be captured from the customers account. Possible values *automatic* and *manual*. currency: title: Currency type: string description: Three-letter ISO currency code, in lowercase. customer: title: Customer type: string description: ID of the Customer this PaymentIntent belongs to, if one exists. metadata: title: Metadata type: object description: Set of key-value pairs that you can attach to an object. payment_method: title: Payment Method type: string description: ID of the payment method used in this PaymentIntent. payment_method_type: title: Payment Method Type type: string description: Payment method type of the payment, e.g. *card*, *us_bank_account* status: title: Status type: string description: Status of this PaymentIntent. payment_option: title: Payment Option allOf: - $ref: '#/components/schemas/PaymentOption' description: Detailed representation of the payment method. order_id: title: Order Id type: string description: The merchant order Id. CreatePlaidLinkToken: title: CreatePlaidLinkToken required: - user_id type: object properties: user_id: title: User Id anyOf: - type: string - type: integer description: >- A unique ID representing the end user. Typically this will be a user ID from your application. CreditDocuments: title: CreditDocuments type: object properties: name: title: Name type: string description: Document Name type: title: Type type: string description: Document Type state: title: State type: string description: Document State status: title: Status type: string description: Document Status CreditOrderRequest: title: CreditOrderRequest required: - lender_ids type: object properties: result: title: Result type: array items: $ref: '#/components/schemas/OrderInformationModel' page_number: title: Page Number type: integer page_size: title: Page Size type: integer total_pages: title: Total Pages type: integer total_results: title: Total Results type: integer lender_ids: title: Lender Ids type: array items: type: integer description: list of lender ids the order will be submitted to CustomerAdditionalDocumentModel: title: CustomerAdditionalDocumentModel required: - customer_reference_id - document_type - created_by - content_type type: object properties: customer_reference_id: title: Customer Reference Id type: string external_reference_id: title: External Reference Id type: string document_type: title: Document Type type: string document_name: title: Document Name type: string reason_by_system: title: Reason By System type: string reason_for_customer: title: Reason For Customer type: string document_upload_indicator: title: Document Upload Indicator type: boolean default: false expires_at: title: Expires At type: string description: 'format: YYYY-MM-DD hh:mm:ss' format: date-time created_by: title: Created By type: string document: title: Document type: string comment: title: Comment type: string content_type: title: Content Type type: string uploaded_by: title: Uploaded By type: string uploaded_at: title: Uploaded At type: string format: date-time document_reference_id: title: Document Reference Id type: string CustomerAddressModel: title: CustomerAddressModel required: - address_type type: object properties: address_line_1: title: Address Line 1 type: string description: Address line one address_line_2: title: Address Line 2 type: string description: Address line two state_name: title: State Name type: string description: Address state name zip_code: title: Zip Code type: string description: Zip code county: title: County type: string description: Address county city: title: City type: string description: Address city contact_number: title: Contact Number type: string description: Contact number verified: title: Verified type: boolean description: Is Address verified move_in_date: title: Move In Date type: string description: 'format: YYYY-MM-DD' format: date is_garaging: title: Is Garaging type: boolean description: Garaging flag default: false address_type: $ref: '#/components/schemas/AddressTypes' identifier: title: Identifier minLength: 1 type: string CustomerAddressPreResponseModel: title: CustomerAddressPreResponseModel required: - address_type type: object properties: address_line_1: title: Address Line 1 type: string description: Address line one address_line_2: title: Address Line 2 type: string description: Address line two state_name: title: State Name type: string description: Address state name zip_code: title: Zip Code type: string description: Zip code county: title: County type: string description: Address county city: title: City type: string description: Address city contact_number: title: Contact Number type: string description: Contact number verified: title: Verified type: boolean description: Is Address verified move_in_date: title: Move In Date type: string description: 'format: YYYY-MM-DD' format: date is_garaging: title: Is Garaging type: boolean description: Garaging flag default: false address_type: $ref: '#/components/schemas/AddressTypes' identifier: title: Identifier type: string created_at: title: Created At type: string format: date-time created_by: title: Created By type: string updated_at: title: Updated At type: string format: date-time updated_by: title: Updated By type: string deleted_at: title: Deleted At type: string format: date-time deleted_by: title: Deleted By type: string CustomerAddressWithId: title: CustomerAddressWithId required: - address_type type: object properties: address_line_1: title: Address Line 1 type: string description: Address line one address_line_2: title: Address Line 2 type: string description: Address line two state_name: title: State Name type: string description: Address state name zip_code: title: Zip Code type: string description: Zip code county: title: County type: string description: Address county city: title: City type: string description: Address city contact_number: title: Contact Number type: string description: Contact number verified: title: Verified type: boolean description: Is Address verified move_in_date: title: Move In Date type: string description: 'format: YYYY-MM-DD' format: date is_garaging: title: Is Garaging type: boolean description: Garaging flag default: false address_type: $ref: '#/components/schemas/AddressTypes' identifier: title: Identifier minLength: 1 type: string id: title: Id type: integer CustomerAddressWithoutAddressTypeModel: title: CustomerAddressWithoutAddressTypeModel type: object properties: address_line_1: title: Address Line 1 type: string description: Address line one address_line_2: title: Address Line 2 type: string description: Address line two state_name: title: State Name type: string description: Address state name zip_code: title: Zip Code type: string description: Zip code county: title: County type: string description: Address county city: title: City type: string description: Address city contact_number: title: Contact Number type: string description: Contact number verified: title: Verified type: boolean description: Is Address verified move_in_date: title: Move In Date type: string description: 'format: YYYY-MM-DD' format: date is_garaging: title: Is Garaging type: boolean description: Garaging flag default: false identifier: title: Identifier minLength: 1 type: string CustomerCommentDiaryModel: title: CustomerCommentDiaryModel required: - category - comment type: object properties: order_reference_id: title: Order Reference Id type: string reference_id: title: Reference Id type: string category: title: Category minLength: 1 type: string comment: title: Comment minLength: 1 type: string identifier: title: Identifier minLength: 1 type: string created_by: title: Created By type: string CustomerCommentDiaryPaginatedResponseModel: title: CustomerCommentDiaryPaginatedResponseModel type: object properties: result: title: Result type: array items: $ref: '#/components/schemas/CustomerCommentDiaryResponseModel' page_number: title: Page Number type: integer page_size: title: Page Size type: integer total_pages: title: Total Pages type: integer total_results: title: Total Results type: integer CustomerCommentDiaryResponseModel: title: CustomerCommentDiaryResponseModel type: object properties: order_reference_id: title: Order Reference Id type: string reference_id: title: Reference Id type: string category: title: Category type: string comment: title: Comment type: string identifier: title: Identifier type: string created_at: title: Created At type: string format: date-time updated_at: title: Updated At type: string format: date-time created_by: title: Created By type: string updated_by: title: Updated By type: string deleted_at: title: Deleted At type: string format: date-time deleted_by: title: Deleted By type: string CustomerCommentDiaryUpdateModel: title: CustomerCommentDiaryUpdateModel type: object properties: order_reference_id: title: Order Reference Id type: string category: title: Category type: string comment: title: Comment type: string updated_by: title: Updated By type: string CustomerDeleteModel: title: CustomerDeleteModel required: - success type: object properties: success: title: Success type: boolean CustomerDocumentModel: title: CustomerDocumentModel required: - customer_reference_id - external_reference_id - document_type - created_by type: object properties: customer_reference_id: title: Customer Reference Id type: string external_reference_id: title: External Reference Id type: string document_type: title: Document Type type: string document_name: title: Document Name type: string reason_by_system: title: Reason By System type: string reason_for_customer: title: Reason For Customer type: string document_upload_indicator: title: Document Upload Indicator type: boolean default: false expires_at: title: Expires At type: string description: 'format: YYYY-MM-DD hh:mm:ss' format: date-time identifier: title: Identifier minLength: 1 type: string created_by: title: Created By type: string stipulation_code: title: Stipulation Code type: string comment: title: Comment type: string CustomerDocumentResponseModel: title: CustomerDocumentResponseModel type: object properties: customer_reference_id: title: Customer Reference Id type: string external_reference_id: title: External Reference Id type: string document_type: title: Document Type type: string comment: title: Comment type: string category: title: Category type: string document_name: title: Document Name type: string document_size: title: Document Size type: string document_url: title: Document Url type: string reason_by_system: title: Reason By System type: string reason_for_customer: title: Reason For Customer type: string document_status: title: Document Status type: string document_upload_indicator: title: Document Upload Indicator type: boolean default: false expires_at: title: Expires At type: string description: 'format: YYYY-MM-DD hh:mm:ss' format: date-time created_at: title: Created At type: string description: 'format: YYYY-MM-DD hh:mm:ss' format: date-time updated_at: title: Updated At type: string description: 'format: YYYY-MM-DD hh:mm:ss' format: date-time deleted_at: title: Deleted At type: string description: 'format: YYYY-MM-DD hh:mm:ss' format: date-time updated_by: title: Updated By type: string created_by: title: Created By type: string deleted_by: title: Deleted By type: string uploaded_by: title: Uploaded By type: string uploaded_at: title: Uploaded At type: string format: date-time is_deleted: title: Is Deleted type: boolean default: false identifier: title: Identifier type: string stipulation_code: title: Stipulation Code type: string CustomerDocumentReviewModel: title: CustomerDocumentReviewModel required: - review_notes - review_status - reviewed_by type: object properties: review_notes: title: Review Notes type: string review_status: $ref: '#/components/schemas/DocumentUploadStatus' reviewed_by: title: Reviewed By type: string reason: title: Reason type: array items: type: string other_reason: title: Other Reason type: string identifier: title: Identifier minLength: 1 type: string CustomerDocumentReviewPreResponseModel: title: CustomerDocumentReviewPreResponseModel type: object properties: reviewed_by: title: Reviewed By type: string review_date_time: title: Review Date Time type: string description: 'format: YYYY-MM-DD hh:mm:ss' format: date-time review_status: title: Review Status type: string review_notes: title: Review Notes type: string reason: title: Reason type: array items: type: string other_reason: title: Other Reason type: string identifier: title: Identifier type: string CustomerDocumentReviewResponseModel: title: CustomerDocumentReviewResponseModel type: object properties: reviewed_by: title: Reviewed By type: string review_date_time: title: Review Date Time type: string description: 'format: YYYY-MM-DD hh:mm:ss' format: date-time review_status: title: Review Status type: string review_notes: title: Review Notes type: string reason: title: Reason type: array items: type: string other_reason: title: Other Reason type: string identifier: title: Identifier type: string document_identifier: title: Document Identifier type: string CustomerDocumentStatus: title: CustomerDocumentStatus required: - document_status type: object properties: document_status: $ref: '#/components/schemas/DocumentUploadStatus' CustomerDocumentUpdateDMSModel: title: CustomerDocumentUpdateDMSModel required: - customer_reference_id - content_type - updated_by type: object properties: customer_reference_id: title: Customer Reference Id type: string document: title: Document type: string document_name: title: Document Name type: string document_size: title: Document Size type: string comment: title: Comment type: string category: $ref: '#/components/schemas/StipulationCategory' content_type: title: Content Type type: string uploaded_by: title: Uploaded By type: string uploaded_at: title: Uploaded At type: string format: date-time updated_by: title: Updated By type: string expires_at: title: Expires At type: string description: 'format: YYYY-MM-DD hh:mm:ss' format: date-time document_reference_id: title: Document Reference Id type: string id: title: Id type: integer identifier: title: Identifier type: string document_type: title: Document Type type: string created_by: title: Created By type: string document_status: title: Document Status type: string external_reference_id: title: External Reference Id type: string stipulation_code: title: Stipulation Code type: string document_upload_indicator: title: Document Upload Indicator type: boolean default: false CustomerDocumentUpdateModel: title: CustomerDocumentUpdateModel required: - customer_reference_id - content_type - updated_by type: object properties: customer_reference_id: title: Customer Reference Id type: string document: title: Document type: string document_name: title: Document Name type: string document_size: title: Document Size type: string comment: title: Comment type: string category: $ref: '#/components/schemas/StipulationCategory' content_type: title: Content Type type: string uploaded_by: title: Uploaded By type: string uploaded_at: title: Uploaded At type: string format: date-time updated_by: title: Updated By type: string expires_at: title: Expires At type: string description: 'format: YYYY-MM-DD hh:mm:ss' format: date-time document_reference_id: title: Document Reference Id type: string CustomerDocumentUploadStatus: title: CustomerDocumentUploadStatus required: - document_upload_indicator type: object properties: document_upload_indicator: title: Document Upload Indicator type: boolean CustomerDocumentWithReviewsResponseModel: title: CustomerDocumentWithReviewsResponseModel required: - document_reviews type: object properties: customer_reference_id: title: Customer Reference Id type: string external_reference_id: title: External Reference Id type: string document_type: title: Document Type type: string comment: title: Comment type: string category: title: Category type: string document_name: title: Document Name type: string document_size: title: Document Size type: string document_url: title: Document Url type: string reason_by_system: title: Reason By System type: string reason_for_customer: title: Reason For Customer type: string document_status: title: Document Status type: string document_upload_indicator: title: Document Upload Indicator type: boolean default: false expires_at: title: Expires At type: string description: 'format: YYYY-MM-DD hh:mm:ss' format: date-time created_at: title: Created At type: string description: 'format: YYYY-MM-DD hh:mm:ss' format: date-time updated_at: title: Updated At type: string description: 'format: YYYY-MM-DD hh:mm:ss' format: date-time deleted_at: title: Deleted At type: string description: 'format: YYYY-MM-DD hh:mm:ss' format: date-time updated_by: title: Updated By type: string created_by: title: Created By type: string deleted_by: title: Deleted By type: string uploaded_by: title: Uploaded By type: string uploaded_at: title: Uploaded At type: string format: date-time is_deleted: title: Is Deleted type: boolean default: false identifier: title: Identifier type: string stipulation_code: title: Stipulation Code type: string document_reviews: title: Document Reviews type: array items: $ref: '#/components/schemas/CustomerDocumentReviewPreResponseModel' CustomerEmploymentInfoPreResponseModel: title: CustomerEmploymentInfoPreResponseModel type: object properties: employment_type: title: Employment Type type: string description: Employment type name: title: Name type: string description: Name phone: title: Phone type: string description: Phone employed_since: title: Employed Since type: string description: Employed since format: date occupation: title: Occupation type: string description: Occupation annual_employment_income: title: Annual Employment Income type: number description: Annual employment income annual_other_income: title: Annual Other Income type: number description: Annual other income source_of_other_income: title: Source Of Other Income type: string description: Annual other income created_at: title: Created At type: string format: date-time created_by: title: Created By type: string updated_at: title: Updated At type: string format: date-time updated_by: title: Updated By type: string deleted_at: title: Deleted At type: string format: date-time deleted_by: title: Deleted By type: string CustomerPartnerAddress: title: CustomerPartnerAddress required: - address_type type: object properties: identifier: title: Identifier type: string address_line_1: title: Address Line 1 type: string address_type: $ref: '#/components/schemas/AddressTypes' CustomerPartnerDetails: title: CustomerPartnerDetails type: object properties: identifier: title: Identifier type: string first_name: title: First Name type: string last_name: title: Last Name type: string email: title: Email type: string contact_number: title: Contact Number type: string address: $ref: '#/components/schemas/CustomerPartnerAddress' role: title: Role type: string CustomerPaymentInfoResponseModel: title: CustomerPaymentInfoResponseModel type: object properties: type: title: Type type: string stripe_payment_method_id: title: Stripe Payment Method Id type: string access_token: title: Access Token type: string account_id: title: Account Id type: string Bank_name: title: Bank Name type: string last4: title: Last4 type: integer default: title: Default type: boolean created_at: title: Created At type: string format: date-time created_by: title: Created By type: string updated_at: title: Updated At type: string format: date-time updated_by: title: Updated By type: string deleted_at: title: Deleted At type: string format: date-time deleted_by: title: Deleted By type: string CustomerPaymentInformationResponseModel: title: CustomerPaymentInformationResponseModel required: - reference_id type: object properties: type: title: Type type: string stripe_payment_method_id: title: Stripe Payment Method Id type: string access_token: title: Access Token type: string account_id: title: Account Id type: string Bank_name: title: Bank Name type: string last4: title: Last4 type: integer default: title: Default type: boolean reference_id: title: Reference Id type: string description: Reference Id created_at: title: Created At type: string format: date-time created_by: title: Created By type: string updated_at: title: Updated At type: string format: date-time updated_by: title: Updated By type: string deleted_at: title: Deleted At type: string format: date-time deleted_by: title: Deleted By type: string CustomerPaymentModelTypeMandatory: title: CustomerPaymentModelTypeMandatory required: - type - reference_id type: object properties: type: title: Type minLength: 1 type: string stripe_payment_method_id: title: Stripe Payment Method Id type: string access_token: title: Access Token type: string account_id: title: Account Id type: string Bank_name: title: Bank Name type: string last4: title: Last4 type: integer default: title: Default type: boolean reference_id: title: Reference Id minLength: 1 type: string CustomerPersonalFinanceResponseModel: title: CustomerPersonalFinanceResponseModel required: - reference_id type: object properties: residence: title: Residence type: string description: Residence monthly_payment: title: Monthly Payment type: number description: Monthly Payment bankruptcy: title: Bankruptcy type: boolean description: Bankruptcy asset_usage: title: Asset Usage type: boolean description: Asset Usage reference_id: title: Reference Id minLength: 1 type: string description: Reference Id created_at: title: Created At type: string format: date-time updated_at: title: Updated At type: string format: date-time updated_by: title: Updated By type: string deleted_at: title: Deleted At type: string format: date-time deleted_by: title: Deleted By type: string CustomerProfileIncomeInfoModel: title: CustomerProfileIncomeInfoModel type: object properties: employment_type: title: Employment Type type: string description: Employment type name: title: Name type: string description: Name phone: title: Phone type: string description: Phone employed_since: title: Employed Since type: string description: Employed since format: date occupation: title: Occupation type: string description: Occupation annual_employment_income: title: Annual Employment Income type: number description: Annual employment income annual_other_income: title: Annual Other Income type: number description: Annual other income source_of_other_income: title: Source Of Other Income type: string description: Annual other income CustomerProfileModel: title: CustomerProfileModel type: object properties: customer_profile: $ref: '#/components/schemas/CustomerRequiredEmailModel' customer_addresses: title: Customer Addresses type: array items: $ref: '#/components/schemas/CustomerAddressModel' income_info: $ref: '#/components/schemas/CustomerProfileIncomeInfoModel' customer_license: title: Customer License type: array items: $ref: '#/components/schemas/LisenceInfoWithAdress' customer_insurance: title: Customer Insurance type: array items: $ref: '#/components/schemas/InsuranceInformationWithAddressesModel' CustomerProfileModelResponse: title: CustomerProfileModelResponse type: object properties: prefix: title: Prefix type: string first_name: title: First Name type: string middle_name: title: Middle Name type: string last_name: title: Last Name type: string suffix: title: Suffix type: string ssn: title: Ssn type: string mobile_number: title: Mobile Number type: string mobile_number_verified_status: title: Mobile Number Verified Status type: boolean default: false home_number: title: Home Number type: string home_number_verified_status: title: Home Number Verified Status type: boolean default: false customer_type: title: Customer Type type: string date_of_birth: title: Date Of Birth type: string description: 'format: YYYY-MM-DD' format: date meta_data: title: Meta Data type: object stripe_customer_id: title: Stripe Customer Id type: string preferred_contact: title: Preferred Contact type: string reference_id: title: Reference Id type: string external_id: title: External Id type: string identifier: title: Identifier type: string email: title: Email type: string created_by: title: Created By type: string created_at: title: Created At type: string format: date-time updated_at: title: Updated At type: string format: date-time updated_by: title: Updated By type: string deleted_at: title: Deleted At type: string format: date-time deleted_by: title: Deleted By type: string customer_addresses: title: Customer Addresses type: array items: $ref: '#/components/schemas/CustomerAddressPreResponseModel' income_info: $ref: '#/components/schemas/CustomerEmploymentInfoPreResponseModel' payments_info: title: Payments Info type: array items: $ref: '#/components/schemas/CustomerPaymentInfoResponseModel' license_info: $ref: '#/components/schemas/LicenseInfoCustomerResponseModel' CustomerProfileModelResponseWithDisclaimer: title: CustomerProfileModelResponseWithDisclaimer type: object properties: prefix: title: Prefix type: string first_name: title: First Name type: string middle_name: title: Middle Name type: string last_name: title: Last Name type: string suffix: title: Suffix type: string ssn: title: Ssn type: string mobile_number: title: Mobile Number type: string mobile_number_verified_status: title: Mobile Number Verified Status type: boolean default: false home_number: title: Home Number type: string home_number_verified_status: title: Home Number Verified Status type: boolean default: false customer_type: title: Customer Type type: string date_of_birth: title: Date Of Birth type: string description: 'format: YYYY-MM-DD' format: date meta_data: title: Meta Data type: object stripe_customer_id: title: Stripe Customer Id type: string preferred_contact: title: Preferred Contact type: string reference_id: title: Reference Id type: string external_id: title: External Id type: string identifier: title: Identifier type: string email: title: Email type: string created_by: title: Created By type: string created_at: title: Created At type: string format: date-time updated_at: title: Updated At type: string format: date-time updated_by: title: Updated By type: string deleted_at: title: Deleted At type: string format: date-time deleted_by: title: Deleted By type: string customer_addresses: title: Customer Addresses type: array items: $ref: '#/components/schemas/CustomerAddressPreResponseModel' income_info: $ref: '#/components/schemas/CustomerEmploymentInfoPreResponseModel' payments_info: title: Payments Info type: array items: $ref: '#/components/schemas/CustomerPaymentInfoResponseModel' license_info: $ref: '#/components/schemas/LicenseInfoCustomerResponseModel' disclaimer_info: title: Disclaimer Info type: array items: $ref: '#/components/schemas/DisclaimerAcceptanceModel' CustomerProfileModelResponseWithID: title: CustomerProfileModelResponseWithID type: object properties: prefix: title: Prefix type: string first_name: title: First Name type: string middle_name: title: Middle Name type: string last_name: title: Last Name type: string suffix: title: Suffix type: string ssn: title: Ssn type: string mobile_number: title: Mobile Number type: string mobile_number_verified_status: title: Mobile Number Verified Status type: boolean default: false home_number: title: Home Number type: string home_number_verified_status: title: Home Number Verified Status type: boolean default: false customer_type: title: Customer Type type: string date_of_birth: title: Date Of Birth type: string description: 'format: YYYY-MM-DD' format: date meta_data: title: Meta Data type: object stripe_customer_id: title: Stripe Customer Id type: string preferred_contact: title: Preferred Contact type: string reference_id: title: Reference Id type: string external_id: title: External Id type: string identifier: title: Identifier type: string email: title: Email type: string created_by: title: Created By type: string created_at: title: Created At type: string format: date-time updated_at: title: Updated At type: string format: date-time updated_by: title: Updated By type: string deleted_at: title: Deleted At type: string format: date-time deleted_by: title: Deleted By type: string id: title: Id type: integer consent: title: Consent CustomerProfilePaginationResponse: title: CustomerProfilePaginationResponse type: object properties: result: title: Result type: array items: $ref: '#/components/schemas/CustomerProfileModelResponse' page_number: title: Page Number type: integer page_size: title: Page Size type: integer total_pages: title: Total Pages type: integer total_results: title: Total Results type: integer CustomerProfileUpdateModel: title: CustomerProfileUpdateModel type: object properties: customer_profile: $ref: '#/components/schemas/CustomerUpdateModel' customer_addresses: title: Customer Addresses type: array items: $ref: '#/components/schemas/CustomerAddressModel' income_info: $ref: '#/components/schemas/CustomerProfileIncomeInfoModel' CustomerProposalDocuments: title: CustomerProposalDocuments type: object properties: customer_reference_id: title: Customer Reference Id type: string external_reference_id: title: External Reference Id type: string document_reference_id: title: Document Reference Id type: string document_type: title: Document Type type: string content_type: title: Content Type type: string comment: title: Comment type: string category: title: Category type: string document: title: Document type: string document_name: title: Document Name type: string document_size: title: Document Size type: string document_url: title: Document Url type: string reason_by_system: title: Reason By System type: string reason_for_customer: title: Reason For Customer type: string document_status: title: Document Status type: string document_upload_indicator: title: Document Upload Indicator type: boolean default: false expires_at: title: Expires At type: string description: 'format: YYYY-MM-DD hh:mm:ss' format: date-time created_at: title: Created At type: string description: 'format: YYYY-MM-DD hh:mm:ss' format: date-time updated_at: title: Updated At type: string description: 'format: YYYY-MM-DD hh:mm:ss' format: date-time deleted_at: title: Deleted At type: string description: 'format: YYYY-MM-DD hh:mm:ss' format: date-time updated_by: title: Updated By type: string created_by: title: Created By type: string deleted_by: title: Deleted By type: string uploaded_by: title: Uploaded By type: string uploaded_at: title: Uploaded At type: string format: date-time is_deleted: title: Is Deleted type: boolean default: false identifier: title: Identifier type: string stipulation_code: title: Stipulation Code type: string is_mandatory: title: Is Mandatory type: boolean default: false CustomerRequiredEmailModel: title: CustomerRequiredEmailModel required: - email - created_by type: object properties: prefix: title: Prefix type: string first_name: title: First Name type: string middle_name: title: Middle Name type: string last_name: title: Last Name type: string suffix: title: Suffix type: string ssn: title: Ssn type: string mobile_number: title: Mobile Number type: string mobile_number_verified_status: title: Mobile Number Verified Status type: boolean default: false home_number: title: Home Number type: string home_number_verified_status: title: Home Number Verified Status type: boolean default: false customer_type: title: Customer Type type: string date_of_birth: title: Date Of Birth type: string description: 'format: YYYY-MM-DD' format: date meta_data: title: Meta Data type: object stripe_customer_id: title: Stripe Customer Id type: string preferred_contact: title: Preferred Contact type: string reference_id: title: Reference Id type: string external_id: title: External Id type: string identifier: title: Identifier minLength: 1 type: string email: title: Email type: string format: email created_by: title: Created By type: string CustomerSignatureModel: title: CustomerSignatureModel type: object properties: signature_image: title: Signature Image type: string initial_image: title: Initial Image type: string ip: title: Ip type: string reference_id: title: Reference Id type: string dealer_id: title: Dealer Id type: integer CustomerSignatureResponseModel: title: CustomerSignatureResponseModel type: object properties: signature_image: title: Signature Image type: string initial_image: title: Initial Image type: string ip: title: Ip type: string reference_id: title: Reference Id type: string dealer_id: title: Dealer Id type: integer created_at: title: Created At type: string format: date-time updated_at: title: Updated At type: string format: date-time updated_by: title: Updated By type: string deleted_at: title: Deleted At type: string format: date-time deleted_by: title: Deleted By type: string CustomerSignatureUpdateModel: title: CustomerSignatureUpdateModel type: object properties: signature_image: title: Signature Image type: string initial_image: title: Initial Image type: string ip: title: Ip type: string updated_by: title: Updated By type: string CustomerStatusFlagModel: title: CustomerStatusFlagModel required: - reference_id - flag_name - category - created_by type: object properties: reference_id: title: Reference Id type: string flag_name: title: Flag Name minLength: 1 type: string category: title: Category minLength: 1 type: string identifier: title: Identifier minLength: 1 type: string created_by: title: Created By type: string CustomerStatusFlagResponseModel: title: CustomerStatusFlagResponseModel type: object properties: reference_id: title: Reference Id type: string flag_name: title: Flag Name type: string category: title: Category type: string identifier: title: Identifier type: string created_by: title: Created By type: string updated_by: title: Updated By type: string is_active: title: Is Active type: boolean is_deleted: title: Is Deleted type: boolean created_at: title: Created At type: string format: date-time updated_at: title: Updated At type: string format: date-time CustomerStipulationPaginationResponse: title: CustomerStipulationPaginationResponse type: object properties: result: title: Result type: array items: $ref: '#/components/schemas/CustomerDocumentWithReviewsResponseModel' page_number: title: Page Number type: integer page_size: title: Page Size type: integer total_pages: title: Total Pages type: integer total_results: title: Total Results type: integer CustomerUpdateAddressModel: title: CustomerUpdateAddressModel required: - address_type type: object properties: address_line_1: title: Address Line 1 type: string description: Address line one address_line_2: title: Address Line 2 type: string description: Address line two state_name: title: State Name type: string description: Address state name zip_code: title: Zip Code type: string description: Zip code county: title: County type: string description: Address county city: title: City type: string description: Address city contact_number: title: Contact Number type: string description: Contact number verified: title: Verified type: boolean description: Is Address verified move_in_date: title: Move In Date type: string description: 'format: YYYY-MM-DD' format: date is_garaging: title: Is Garaging type: boolean description: Garaging flag default: false address_type: $ref: '#/components/schemas/AddressTypes' CustomerUpdateModel: title: CustomerUpdateModel required: - updated_by type: object properties: prefix: title: Prefix type: string first_name: title: First Name type: string middle_name: title: Middle Name type: string last_name: title: Last Name type: string suffix: title: Suffix type: string ssn: title: Ssn type: string mobile_number: title: Mobile Number type: string mobile_number_verified_status: title: Mobile Number Verified Status type: boolean default: false home_number: title: Home Number type: string home_number_verified_status: title: Home Number Verified Status type: boolean default: false customer_type: title: Customer Type type: string date_of_birth: title: Date Of Birth type: string description: 'format: YYYY-MM-DD' format: date meta_data: title: Meta Data type: object stripe_customer_id: title: Stripe Customer Id type: string preferred_contact: title: Preferred Contact type: string updated_by: title: Updated By type: string CustomersParamsModel: title: CustomersParamsModel required: - reference_ids type: object properties: reference_ids: title: Reference Ids type: array items: type: string description: Reference IDs of the customers to be returned DateTimeFormatEnum: title: DateTimeFormatEnum enum: - YYYY/MM/DD - YYYY/MM/DD HH:MM:SS - YYYY-MM-DD - YYYY-MM-DD HH:MM:SS - MM/DD/YYYY - MM/DD/YYYY HH:MM:SS - MM-DD-YYYY - MM-DD-YYYY HH:MM:SS - DD/MM/YYYY - DD/MM/YYYY HH:MM:SS - DD-MM-YYYY - DD-MM-YYYY HH:MM:SS - Month DD, YYYY - Month DD, YYYY HH:MM:SS - Day Month Year - Day Month Year HH:MM:SS type: string description: An enumeration. DealerAddress: title: DealerAddress type: object properties: address1: title: Address1 type: string address2: title: Address2 type: string city: title: City type: string state: title: State type: string zip: title: Zip type: string addressType: title: Addresstype type: string DealerResponse: title: DealerResponse type: object properties: result: title: Result type: array items: $ref: '#/components/schemas/DealerResponseModel' DealerResponseModel: title: DealerResponseModel required: - dealer_name - dealer_id - dealer_code - dealer_address_1 - dealer_address_2 - dealer_city - dealer_county - dealer_state_name - dealer_zip_code - dealer_distance - dealer_active type: object properties: dealer_name: title: Dealer Name type: string description: Dealer Name dealer_id: title: Dealer Id type: string description: Dealer ID dealer_code: title: Dealer Code type: string description: Dealer Code dealer_address_1: title: Dealer Address 1 type: string description: Dealer Address 1 dealer_address_2: title: Dealer Address 2 type: string description: Dealer Address 2 dealer_city: title: Dealer City type: string description: Dealer City dealer_county: title: Dealer County type: string description: Dealer Country dealer_state_name: title: Dealer State Name type: string description: Dealer State Code dealer_zip_code: title: Dealer Zip Code type: string description: Dealer Zip Code dealer_distance: title: Dealer Distance type: number description: Dealer Distance dealer_active: title: Dealer Active type: boolean description: Dealer Active Status DeleteConsentModel: title: DeleteConsentModel required: - consent_id type: object properties: consent_id: title: Consent Id type: integer DeleteRequestModel: title: DeleteRequestModel required: - deleted_by type: object properties: deleted_by: title: Deleted By type: string DisclaimerAcceptanceModel: title: DisclaimerAcceptanceModel type: object properties: order_reference_id: title: Order Reference Id type: string customer_reference_id: title: Customer Reference Id type: string identifier: title: Identifier type: string disclaimer_name: title: Disclaimer Name type: string disclaimer_version: title: Disclaimer Version type: string disclaimer_details: title: Disclaimer Details type: string disclaimer_acceptance_date: title: Disclaimer Acceptance Date type: string format: date-time DisclaimerAcceptanceParamsModel: title: DisclaimerAcceptanceParamsModel type: object properties: order_reference_id: title: Order Reference Id type: string customer_reference_id: title: Customer Reference Id type: string disclaimer_name: title: Disclaimer Name type: string disclaimer_version: title: Disclaimer Version type: number DisclaimerModel: title: DisclaimerModel required: - name - description type: object properties: version: title: Version type: string name: title: Name type: string description: title: Description type: string type: title: Type type: string applicable_for: title: Applicable For type: string required_by: title: Required By type: string status: title: Status type: string change_type: title: Change Type type: string effectiveDate: title: Effectivedate type: string format: date-time meta_data: title: Meta Data type: object updated_by: title: Updated By type: string created_by: title: Created By type: string disclaimer_accord: title: Disclaimer Accord type: boolean DisclaimerResponseModel: title: DisclaimerResponseModel type: object properties: version: title: Version type: string name: title: Name type: string identifier: title: Identifier type: string description: title: Description type: string type: title: Type type: string applicable_for: title: Applicable For type: string required_by: title: Required By type: string status: title: Status type: string change_type: title: Change Type type: string created_at: title: Created At type: string format: date-time created_by: title: Created By type: string updated_at: title: Updated At type: string format: date-time updated_by: title: Updated By type: string effectiveDate: title: Effectivedate type: string format: date-time meta_data: title: Meta Data type: object disclaimer_accord: title: Disclaimer Accord type: boolean DisclaimerUpdateParamsModel: title: DisclaimerUpdateParamsModel type: object properties: status: title: Status type: string description: title: Description type: string meta_data: title: Meta Data type: object updated_by: title: Updated By type: string DocumentGenerationWithSignatoryModel: title: DocumentGenerationWithSignatoryModel required: - company_id - documents type: object properties: company_id: title: Company Id type: integer documents: title: Documents type: array items: $ref: '#/components/schemas/DocumentWithCustomSignatories' DocumentMetaData: title: DocumentMetaData type: object properties: meta_data: title: Meta Data type: object DocumentPackageRequestModel: title: DocumentPackageRequestModel type: object properties: order_id: title: Order Id type: string reference_id: title: Reference Id type: string type: title: Type type: string identifier: title: Identifier minLength: 1 type: string documents: title: Documents type: array items: $ref: '#/components/schemas/DocumentRequestModel' DocumentPackageResponseModel: title: DocumentPackageResponseModel type: object properties: identifier: title: Identifier type: string order_id: title: Order Id type: string reference_id: title: Reference Id type: string type: title: Type type: string status: title: Status type: string created_at: title: Created At type: string format: date-time updated_at: title: Updated At type: string format: date-time documents: title: Documents type: array items: $ref: '#/components/schemas/DocumentsModel' DocumentRequestModel: title: DocumentRequestModel type: object properties: title: title: Title type: string template: title: Template type: string data: title: Data type: object meta_data: title: Meta Data type: object identifier: title: Identifier minLength: 1 type: string signatures: title: Signatures type: array items: $ref: '#/components/schemas/DocumentSignaturesModel' DocumentSignaturesModel: title: DocumentSignaturesModel required: - id - type type: object properties: id: title: Id type: string status: title: Status type: string type: title: Type type: string signer: title: Signer type: string signed_at: title: Signed At type: string x: title: X type: integer 'y': title: 'Y' type: integer x_bound: title: X Bound type: integer y_bound: title: Y Bound type: integer width: title: Width type: integer height: title: Height type: integer page: title: Page type: integer date_field_id: title: Date Field Id type: string DocumentUploadStatus: title: DocumentUploadStatus enum: - Draft - InProgress - Approved - SoftReject - Reject type: string description: An enumeration. DocumentWithCustomSignatories: title: DocumentWithCustomSignatories required: - data - template - signatories type: object properties: data: $ref: '#/components/schemas/GenerateDocumentData' template: title: Template type: string signatories: title: Signatories type: array items: type: string DocumentsModel: title: DocumentsModel type: object properties: identifier: title: Identifier type: string title: title: Title type: string template: title: Template type: string data: title: Data type: object meta_data: title: Meta Data type: object status: title: Status type: string last_viewed_at: title: Last Viewed At type: string format: date-time signatures: title: Signatures type: array items: $ref: '#/components/schemas/DocumentSignaturesModel' created_at: title: Created At type: string format: date-time updated_at: title: Updated At type: string format: date-time generated_document_uri: title: Generated Document Uri type: string DocumentsResponseModel: title: DocumentsResponseModel type: object properties: identifier: title: Identifier type: string pdf: title: Pdf type: string title: title: Title type: string template: title: Template type: string data: title: Data type: object meta_data: title: Meta Data type: object status: title: Status type: string last_viewed_at: title: Last Viewed At type: string format: date-time signatures: title: Signatures type: array items: $ref: '#/components/schemas/DocumentSignaturesModel' created_at: title: Created At type: string format: date-time updated_at: title: Updated At type: string format: date-time generated_document_uri: title: Generated Document Uri type: string DynamicFieldModel: title: DynamicFieldModel enum: - prefix - first_name - middle_name - last_name - full_name - suffix - ssn - identifier - mobile_number - mobile_number_verified_status - home_number - home_number_verified_status - customer_type - date_of_birth - stripe_customer_id - reference_id - email - address_line_1 - address_line_2 - state_name - zip_code - county - city - contact_number - verified - address_type - license_number - order_identifier - order_status - stock_number - vin - dealer_id type: string description: An enumeration. EmailNotificationRequestModel: title: EmailNotificationRequestModel required: - data type: object properties: source_email: title: Source Email type: string email: title: Email type: string email_attachment_keys: title: Email Attachment Keys type: array items: type: string data: $ref: '#/components/schemas/GenerateDocumentData' email_subject: title: Email Subject type: string cc_emails: title: Cc Emails type: array items: type: string bcc_emails: title: Bcc Emails type: array items: type: string EmailSqsModel: title: EmailSqsModel required: - event_name - recipients type: object properties: event_name: $ref: '#/components/schemas/Events' dealer_id: title: Dealer Id type: integer customer_id: title: Customer Id type: integer order_reference: title: Order Reference type: string custom_email: title: Custom Email type: string recipients: title: Recipients type: array items: {} EmploymentInfoCreateModelEmpTypeMendatory: title: EmploymentInfoCreateModelEmpTypeMendatory required: - employment_type - reference_id type: object properties: employment_type: title: Employment Type minLength: 1 type: string description: Employment type name: title: Name type: string description: Name phone: title: Phone type: string description: Phone employed_since: title: Employed Since type: string description: 'format: YYYY-MM-DD' format: date occupation: title: Occupation type: string description: Occupation annual_employment_income: title: Annual Employment Income type: number description: Annual employment income annual_other_income: title: Annual Other Income type: number description: Annual other income source_of_other_income: title: Source Of Other Income type: string description: Annual other income reference_id: title: Reference Id minLength: 1 type: string description: Reference ID for Employment address: $ref: '#/components/schemas/CustomerAddressModel' EmploymentInfoResponseModel: title: EmploymentInfoResponseModel type: object properties: employment_type: title: Employment Type type: string description: Employment type name: title: Name type: string description: Name phone: title: Phone type: string description: Phone employed_since: title: Employed Since type: string description: Employed since format: date occupation: title: Occupation type: string description: Occupation annual_employment_income: title: Annual Employment Income type: number description: Annual employment income annual_other_income: title: Annual Other Income type: number description: Annual other income source_of_other_income: title: Source Of Other Income type: string description: Annual other income created_at: title: Created At type: string format: date-time created_by: title: Created By type: string updated_at: title: Updated At type: string format: date-time updated_by: title: Updated By type: string deleted_at: title: Deleted At type: string format: date-time deleted_by: title: Deleted By type: string reference_id: title: Reference Id type: string address: $ref: '#/components/schemas/AddressResponseModel' EmploymentInfoUpdateModel: title: EmploymentInfoUpdateModel type: object properties: employment_type: title: Employment Type type: string description: Employment type name: title: Name type: string description: Name phone: title: Phone type: string description: Phone employed_since: title: Employed Since type: string description: Employed since format: date occupation: title: Occupation type: string description: Occupation annual_employment_income: title: Annual Employment Income type: number description: Annual employment income annual_other_income: title: Annual Other Income type: number description: Annual other income source_of_other_income: title: Source Of Other Income type: string description: Annual other income address: $ref: '#/components/schemas/CustomerUpdateAddressModel' EntityType: title: EntityType enum: - Dealer - Lender description: An enumeration. ErrorDetailModel: title: ErrorDetailModel required: - detail type: object properties: detail: $ref: '#/components/schemas/ErrorModel' ErrorModel: title: ErrorModel type: object properties: code: title: Error code type: string description: Error code based on the validation, if any validation fail message: title: Error message type: string description: Error code based on the validation, if any validation fail EventStatus: title: EventStatus enum: - Pause - Resume description: An enumeration. Events: title: Events enum: - Customer Verification - Customer Sign up completion - Send Invitation Email - Send Order Link - Credit Application Submission - Credit Application Resubmission - Credit Application Approved - Credit Application Conditioned - Order Cancellation - Order Declined - Order Withdrawn - Payment Successful - Payment Decline - Order Completion - Lead Creation - Asset Inspection Requested - Asset Inspection Completed - Driver License Verification Successful - Driver License Verification Failed - Credit Decision Rejected - Customer Vehicle Pickup/Delivery - Customer Order Created - Customer Order Placed - Car not Available - Lead generation - Order TimeSlots Proposed - Customer Order Availability Confirmed - Generate Compliance Documents - Email Quotation - Email Compliance Documents - Download Quotation - Download Proposal - Email Proposal - Email Proposal to Customer - Customer Order Scheduled - Customer Order Reschedule - Trade in offer rejected - Trade in offer accepted - Trade in offer updated - Availability Confirmed with special price type: string description: An enumeration. ExternalKeys: title: ExternalKeys type: object properties: external_subscription_key: title: External Subscription Key type: string SSO_client_id: title: Sso Client Id type: string ExternalOrder: title: ExternalOrder type: object properties: id: title: Id type: string customerId: title: Customerid type: string type: title: Type type: string quoteId: title: Quoteid type: string downPayment: title: Downpayment type: number downPaymentTax: title: Downpaymenttax type: number taxOnCapCostReduction: title: Taxoncapcostreduction type: number monthlyPayment: title: Monthlypayment type: number monthlyPaymentTax: title: Monthlypaymenttax type: number monthlyPaymentFee: title: Monthlypaymentfee type: number stripeSubscriptionId: title: Stripesubscriptionid type: string contractPackageId: title: Contractpackageid type: string status: title: Status type: string cancellationCode: title: Cancellationcode type: string cancellationReason: title: Cancellationreason type: string cancelledBy: title: Cancelledby type: string cancelledAt: title: Cancelledat type: string hyperionId: title: Hyperionid type: string orderItems: title: Orderitems type: array items: $ref: '#/components/schemas/OrderItem' events: title: Events type: array items: type: string fulfillment: $ref: '#/components/schemas/Fulfillment' lastModifiedOn: title: Lastmodifiedon type: string createdOn: title: Createdon type: string otozInsuranceId: title: Otozinsuranceid type: string otozCustomerId: title: Otozcustomerid type: string ExternalOrderMapper: title: ExternalOrderMapper type: object properties: orders: title: Orders type: array items: $ref: '#/components/schemas/ExternalOrder' totalPages: title: Totalpages type: integer count: title: Count type: integer FNIProductCalculationModel: title: FNIProductCalculationModel type: object properties: price: title: Price type: number name: title: Name type: string monthly_impact: title: Monthly Impact type: number FeeInfo: title: FeeInfo type: object properties: amount: title: Amount type: string description: Fee Amount frequency: title: Frequency type: string description: FeeFfrequency name: title: Name type: string description: Fee Name occurence: title: Occurence type: string description: Fee Occurence FeeRequestModel: title: FeeRequestModel type: object properties: fee_name: title: Fee Name type: string fee_amount: title: Fee Amount type: number fee_handling: title: Fee Handling type: string is_taxable: title: Is Taxable type: boolean tax_in_capital: title: Tax In Capital type: boolean default: true vendor: title: Vendor type: string FilterModel: title: FilterModel required: - field - operator type: object properties: field: $ref: '#/components/schemas/DynamicFieldModel' operator: $ref: '#/components/schemas/Operators' value: title: Value and_or: $ref: '#/components/schemas/AndOr' FinanceAndInsuranceRequestModel: title: FinanceAndInsuranceRequestModel type: object properties: fni_product_name: title: Fni Product Name type: string fni_product_amount: title: Fni Product Amount type: number amount_handling: title: Amount Handling type: string is_taxable: title: Is Taxable type: boolean default: false FinancialInsurance: title: FinancialInsurance type: object properties: applied_price: title: Applied Price type: integer financial_insurance_id: title: Financial Insurance Id type: integer identifier: title: Identifier type: string FinancialStipulationModel: title: FinancialStipulationModel required: - customer_reference_id - external_reference_id - financial_stip_type - condition - stipulation_code type: object properties: customer_reference_id: title: Customer Reference Id type: string external_reference_id: title: External Reference Id type: string financial_stip_type: title: Financial Stip Type type: string condition: title: Condition type: string stipulation_code: title: Stipulation Code maxLength: 5 type: string reason_by_system: title: Reason By System type: string reason_for_customer: title: Reason For Customer type: string fulfilled: title: Fulfilled type: boolean default: false description: title: Description type: string expires_at: title: Expires At type: string description: 'format: YYYY-MM-DD hh:mm:ss' format: date-time identifier: title: Identifier minLength: 1 type: string key_id: title: Key Id type: integer FinancialStipulationsResponseModel: title: FinancialStipulationsResponseModel type: object properties: customer_reference_id: title: Customer Reference Id type: string external_reference_id: title: External Reference Id type: string financial_stip_type: title: Financial Stip Type type: string reason_by_system: title: Reason By System type: string reason_for_customer: title: Reason For Customer type: string fulfilled: title: Fulfilled type: boolean default: false condition: title: Condition type: string description: title: Description type: string stipulation_code: title: Stipulation Code type: string expires_at: title: Expires At type: string description: 'format: YYYY-MM-DD hh:mm:ss' format: date-time created_at: title: Created At type: string description: 'format: YYYY-MM-DD hh:mm:ss' format: date-time created_by: title: Created By type: string updated_at: title: Updated At type: string description: 'format: YYYY-MM-DD hh:mm:ss' format: date-time updated_by: title: Updated By type: string deleted_at: title: Deleted At type: string description: 'format: YYYY-MM-DD hh:mm:ss' format: date-time deleted_by: title: Deleted By type: string is_deleted: title: Is Deleted type: boolean default: false identifier: title: Identifier type: string FraudCheckModel: title: FraudCheckModel required: - user_id - order_reference_number - reference_id - dealer_code type: object properties: user_id: title: User Id type: integer order_reference_number: title: Order Reference Number minLength: 1 type: string description: Order Reference Id reference_id: title: Reference Id minLength: 1 type: string description: Customer Reference Id dealer_code: title: Dealer Code type: string Fulfillment: title: Fulfillment type: object properties: id: title: Id type: string type: title: Type type: string hyperionId: title: Hyperionid type: string dealerName: title: Dealername type: string dealerAddress: $ref: '#/components/schemas/DealerAddress' vehicleAvailableAfter: title: Vehicleavailableafter type: string customerReceivedVehicleAt: title: Customerreceivedvehicleat type: string GenerateDocumentData: title: GenerateDocumentData required: - company_id - reference_number - customer_reference_id type: object properties: company_id: title: Company Id type: integer description: Company id reference_number: title: Reference Number type: string description: Order Reference Number customer_reference_id: title: Customer Reference Id type: string description: Customer Reference Id lender_name: title: Lender Name type: string description: Lender Name name: title: Name type: string description: Quote or Proposal Name comments: title: Comments type: string description: General Comments creation_date: title: Creation Date type: string description: Deal Creation Date asset_type: title: Asset Type type: string description: Asset Type client_type: title: Client Type type: string description: Customer Type customer_name: title: Customer Name type: string description: Customer Name first_name: title: First Name type: string description: First Name last_name: title: Last Name type: string description: Last Name contact_number: title: Contact Number type: string description: Contact Number email_address: title: Email Address type: string description: Email Address id_number: title: Id Number type: string description: ID Number company_name: title: Company Name type: string description: Company Name registration_number: title: Registration Number type: string description: Registration Number trading_as: title: Trading As type: string description: Trading As years_in_business: title: Years In Business type: string description: Years in Business address: title: Address type: string description: Address broker_name: title: Broker Name type: string description: Broker Name introducer_name: title: Introducer Name type: string description: Introducer Name introducer_email: title: Introducer Email type: string description: Introducer Email introducer_contact: title: Introducer Contact type: string description: Introducer Contact asset_cost: title: Asset Cost type: string description: Asset Cost deposit_amount: title: Deposit Amount type: string description: Deposit Amount deposit: title: Deposit type: string description: Deposit finance_amount: title: Finance Amount type: string description: Finance Amount finance_type: title: Finance Type type: string description: Finance Type advance_payments: title: Advance Payments type: string description: Advance Payments regular_payments: title: Regular Payments type: string description: Regular Payments payment_frequency: title: Payment Frequency type: string description: Payment Frequency payment_mode: title: Payment Mode type: string description: Payment Mode total_payable: title: Total Payable type: string description: Total Payable gross_yield: title: Gross Yield type: string description: Gross Yield net_yield: title: Net Yield type: string description: Net Yield apr: title: Apr type: string description: APR commission_amount: title: Commission Amount type: string description: Commission Amount commission_percentage: title: Commission Percentage type: string description: Commission Percentage rate: title: Rate type: string description: Rate rate_type: title: Rate Type type: string description: Rate Type no_of_advance_payment: title: No Of Advance Payment type: string description: No of Advance Payment no_of_regular_payments: title: No Of Regular Payments type: string description: No of Regular Payments flat_rate_excl_commission: title: Flat Rate Excl Commission type: string description: Flat Rate Excl Commission flat_rate_incl_commission: title: Flat Rate Incl Commission type: string description: Flat Rate Incl Commission balloon_payment: title: Balloon Payment type: string description: Ballon Payment ballon_collection: title: Ballon Collection type: string description: Ballon Collection vat_treatment: title: Vat Treatment type: string description: VAT Treatment vat_amount: title: Vat Amount type: string description: VAT Amount vat_number: title: Vat Number type: string description: VAT Number vat_deferred_type: title: Vat Deferred Type type: string description: VAT Deferred Type document_fee: title: Document Fee type: string description: Document Fee annual_admin_fee: title: Annual Admin Fee type: string description: Annual Admin Fee otp_fee: title: Otp Fee type: string description: OTP Fee product_type: title: Product Type type: string description: Product Type sum_of_advance_rentals: title: Sum Of Advance Rentals type: string description: Sum of Advance Rentals sum_of_fees: title: Sum Of Fees type: string description: Sum of Fees sum_of_periodic_interest: title: Sum Of Periodic Interest type: string description: Sum of Periodic Interest sum_of_rentals: title: Sum Of Rentals type: string description: Sum of All Rentals rental: title: Rental type: string description: Rental Amount total_payables: title: Total Payables type: string description: Total Payables term: title: Term type: string description: Contract Terms processing_date: title: Processing Date type: string description: Processing Date fees_info: title: Fees Info type: array items: $ref: '#/components/schemas/FeeInfo' description: Fees List director_details: title: Director Details type: array items: $ref: '#/components/schemas/PartnerInfo' description: Directors List assets: title: Assets type: array items: $ref: '#/components/schemas/AssetInfo' description: Total Assets credit_documents: title: Credit Documents type: array items: $ref: '#/components/schemas/CreditDocuments' description: Credit Documents List payments: title: Payments type: array items: $ref: '#/components/schemas/PaymentDetails' description: Total Payments underwriter_comments: title: Underwriter Comments type: array items: $ref: '#/components/schemas/UnderWriterCommentsModel' contact_person_name: title: Contact Person Name type: string description: Contact Person Name contact_person_email: title: Contact Person Email type: string description: Contact Person Email contact_person_contact: title: Contact Person Contact type: string description: Contact Person Contact contact_person_address: title: Contact Person Address type: string description: Contact Person Address total_rentals_without_balloon: title: Total Rentals Without Balloon type: string description: Total Rentals without Balloon GetConsentModel: title: GetConsentModel required: - email type: object properties: email: title: Email type: string dealer_id: title: Dealer Id type: integer dealer_code: title: Dealer Code type: string GetOrderStatusModel: title: GetOrderStatusModel required: - order_status type: object properties: order_status: title: Order Status type: string HTTPValidationError: title: HTTPValidationError type: object properties: detail: title: Detail type: array items: $ref: '#/components/schemas/ValidationError' HistoryPaginationResponse: title: HistoryPaginationResponse type: object properties: results: title: Results type: array items: $ref: '#/components/schemas/HistoryResponseDetail' page_number: title: Page Number type: integer page_size: title: Page Size type: integer total_pages: title: Total Pages type: integer total_results: title: Total Results type: integer HistoryResponseDetail: title: HistoryResponseDetail type: object properties: identifier: title: Identifier type: string created_at: title: Created At type: string format: date-time created_by: title: Created By type: string updated_at: title: Updated At type: string format: date-time updated_by: title: Updated By type: string deleted_at: title: Deleted At type: string format: date-time deleted_by: title: Deleted By type: string action: title: Action type: string order_reference_id: title: Order Reference Id type: string module_type: title: Module Type type: string InsuranceDetailStatus: title: InsuranceDetailStatus enum: - Verified - Unverified - Expired type: string description: An enumeration. InsuranceDocumentsModel: title: InsuranceDocumentsModel required: - content_type - name - file_size type: object properties: document: title: Document type: string content_type: title: Content Type minLength: 1 type: string description: 'format: application/pdf, image/png ' name: title: Name minLength: 1 type: string file_size: title: File Size minLength: 1 type: string created_by: title: Created By type: string doucment_reference_id: title: Doucment Reference Id type: string InsuranceDocumentsResponseModel: title: InsuranceDocumentsResponseModel type: object properties: document_uri: title: Document Uri type: string content_type: title: Content Type type: string name: title: Name type: string file_size: title: File Size type: string identifier: title: Identifier type: string is_active: title: Is Active type: boolean created_by: title: Created By type: string created_at: title: Created At type: string format: date deleted_at: title: Deleted At type: string format: date deleted_by: title: Deleted By type: string InsuranceInfoPaginationResponse: title: InsuranceInfoPaginationResponse type: object properties: result: title: Result type: array items: $ref: '#/components/schemas/InsuranceInformationResponseModel' page_number: title: Page Number type: integer page_size: title: Page Size type: integer total_pages: title: Total Pages type: integer total_results: title: Total Results type: integer InsuranceInformationResponseModel: title: InsuranceInformationResponseModel type: object properties: order_reference_id: title: Order Reference Id type: string reference_id: title: Reference Id type: string insurer_name: title: Insurer Name type: string agent_phone: title: Agent Phone type: string subscription_id: title: Subscription Id type: string agent_name: title: Agent Name type: string policy_number: title: Policy Number type: string start_date: title: Start Date type: string description: 'format: YYYY-MM-DD' format: date expiration_date: title: Expiration Date type: string description: 'format: YYYY-MM-DD' format: date deductible_comprehensive: title: Deductible Comprehensive type: number deductible_collision: title: Deductible Collision type: number created_by: title: Created By type: string identifier: title: Identifier type: string is_verified: title: Is Verified type: boolean default: false insurance_documents: title: Insurance Documents type: array items: $ref: '#/components/schemas/InsuranceDocumentsResponseModel' insurer_address: $ref: '#/components/schemas/CustomerAddressWithoutAddressTypeModel' status: $ref: '#/components/schemas/InsuranceDetailStatus' is_active: title: Is Active type: boolean is_deleted: title: Is Deleted type: boolean created_at: title: Created At type: string format: date-time updated_at: title: Updated At type: string format: date-time updated_by: title: Updated By type: string deleted_at: title: Deleted At type: string format: date deleted_by: title: Deleted By type: string InsuranceInformationUpdateModel: title: InsuranceInformationUpdateModel required: - updated_by type: object properties: order_reference_id: title: Order Reference Id type: string insurer_name: title: Insurer Name type: string agent_phone: title: Agent Phone type: string subscription_id: title: Subscription Id type: string agent_name: title: Agent Name type: string status: $ref: '#/components/schemas/InsuranceDetailStatus' policy_number: title: Policy Number type: string start_date: title: Start Date type: string description: 'format: YYYY-MM-DD' format: date expiration_date: title: Expiration Date type: string description: 'format: YYYY-MM-DD' format: date deductible_comprehensive: title: Deductible Comprehensive type: number deductible_collision: title: Deductible Collision type: number is_verified: title: Is Verified type: boolean default: false updated_by: title: Updated By type: string insurer_address: $ref: '#/components/schemas/AddressBasicModel' insurance_documents: title: Insurance Documents type: array items: $ref: '#/components/schemas/InsuranceDocumentsModel' InsuranceInformationWithAddressesModel: title: InsuranceInformationWithAddressesModel required: - created_by type: object properties: order_reference_id: title: Order Reference Id type: string reference_id: title: Reference Id type: string insurer_name: title: Insurer Name type: string agent_phone: title: Agent Phone type: string subscription_id: title: Subscription Id type: string agent_name: title: Agent Name type: string policy_number: title: Policy Number type: string start_date: title: Start Date type: string description: 'format: YYYY-MM-DD' format: date expiration_date: title: Expiration Date type: string description: 'format: YYYY-MM-DD' format: date deductible_comprehensive: title: Deductible Comprehensive type: number deductible_collision: title: Deductible Collision type: number created_by: title: Created By type: string identifier: title: Identifier type: string is_verified: title: Is Verified type: boolean default: false insurance_documents: title: Insurance Documents type: array items: $ref: '#/components/schemas/InsuranceDocumentsModel' insurer_address: $ref: '#/components/schemas/CustomerAddressWithoutAddressTypeModel' InsuranceProviderRequest: title: InsuranceProviderRequest type: object properties: order_id: title: Order Id type: string description: Order Reference Id transactionId: title: Transactionid type: string description: Transaction Id carrierName: title: Carriername type: string description: Insurer Name policyExpirationDate: title: Policyexpirationdate type: string description: Expiration Date format: date policyDocumentUrl: title: Policydocumenturl type: string description: Policy Document Url insuranceCardUrl: title: Insurancecardurl type: string description: Insurance Card Url contactNumber: title: Contactnumber type: string description: Contact Number policyNumber: title: Policynumber type: string description: Policy Number InsuranceRequestModel: title: InsuranceRequestModel type: object properties: insurance_name: title: Insurance Name type: string insurance_amount: title: Insurance Amount type: number amount_handling: title: Amount Handling type: string InterestChartResponseModel: title: InterestChartResponseModel type: object properties: chart_id: title: Chart Id type: integer margin: title: Margin type: number maximum_margin: title: Maximum Margin type: number minimum_margin: title: Minimum Margin type: number InternalAppointmentDetails: title: InternalAppointmentDetails required: - created_at - order_id - key_id - updated_at - id - dealer_id - customer_id - appointment_date - appointment_type type: object properties: created_at: title: Created At type: string order_id: title: Order Id type: integer dealer_code: title: Dealer Code tenant_id: title: Tenant Id key_id: title: Key Id type: integer address_id: title: Address Id updated_at: title: Updated At type: string id: title: Id type: integer dealer_id: title: Dealer Id type: integer customer_id: title: Customer Id type: integer appointment_date: title: Appointment Date type: string appointment_type: title: Appointment Type type: string address: title: Address InternalCustomerAddress: title: InternalCustomerAddress required: - address_type - customer_id - state_name - key_id - is_active - is_deleted - created_at - id - identifier - is_garaging - updated_at type: object properties: created_by: title: Created By type: string address_line_2: title: Address Line 2 type: string verified: title: Verified type: boolean updated_by: title: Updated By type: string state_id: title: State Id address_type: title: Address Type type: string customer_id: title: Customer Id type: integer deleted_at: title: Deleted At state_name: title: State Name type: string key_id: title: Key Id type: integer category_identifier: title: Category Identifier deleted_by: title: Deleted By zip_code: title: Zip Code type: string is_active: title: Is Active type: boolean parent_id: title: Parent Id is_deleted: title: Is Deleted type: boolean county: title: County type: string country_id: title: Country Id history_id: title: History Id created_at: title: Created At type: string id: title: Id type: integer city: title: City type: string field5: title: Field5 move_in_date: title: Move In Date type: string identifier: title: Identifier type: string contact_number: title: Contact Number field6: title: Field6 is_garaging: title: Is Garaging type: boolean updated_at: title: Updated At type: string address_line_1: title: Address Line 1 type: string lender_id: title: Lender Id InternalCustomerInfo: title: InternalCustomerInfo required: - last_name - created_at - is_deleted - mobile_number - reference_id - id - identifier - ssn - key_id - updated_at - email - is_active - updated_by - first_name - mobile_number_verified_status - home_number_verified_status - customer_addresses - customer_license type: object properties: deleted_by: title: Deleted By last_name: title: Last Name type: string customer_type: title: Customer Type created_at: title: Created At type: string is_deleted: title: Is Deleted type: boolean mobile_number: title: Mobile Number type: string reference_id: title: Reference Id type: string id: title: Id type: integer home_number: title: Home Number date_of_birth: title: Date Of Birth identifier: title: Identifier type: string ssn: title: Ssn type: string key_id: title: Key Id type: integer updated_at: title: Updated At type: string prefix: title: Prefix email: title: Email type: string created_by: title: Created By suffix: title: Suffix stripe_customer_id: title: Stripe Customer Id is_active: title: Is Active type: boolean updated_by: title: Updated By type: string first_name: title: First Name type: string mobile_number_verified_status: title: Mobile Number Verified Status type: boolean meta_data: title: Meta Data deleted_at: title: Deleted At middle_name: title: Middle Name home_number_verified_status: title: Home Number Verified Status type: boolean parent_id: title: Parent Id customer_addresses: title: Customer Addresses type: array items: $ref: '#/components/schemas/InternalCustomerAddress' customer_license: title: Customer License type: array items: $ref: '#/components/schemas/InternalCustomerLicenseItem' InternalCustomerLicenseItem: title: InternalCustomerLicenseItem required: - id - expiry_date - call_type - identifier - front_image - updated_at - customer_id - first_name - key_id - last_name - is_active - date_of_birth - license_number - is_pdf_417 - created_at - is_deleted - status type: object properties: id: title: Id type: integer expiry_date: title: Expiry Date type: string call_type: title: Call Type type: string identifier: title: Identifier type: string front_image: title: Front Image type: string is_selfie_verified: title: Is Selfie Verified updated_at: title: Updated At type: string customer_id: title: Customer Id type: integer back_image: title: Back Image created_by: title: Created By first_name: title: First Name type: string selfie_image: title: Selfie Image key_id: title: Key Id type: integer updated_by: title: Updated By last_name: title: Last Name type: string cropped_front_image: title: Cropped Front Image is_active: title: Is Active type: boolean deleted_at: title: Deleted At date_of_birth: title: Date Of Birth type: string cropped_back_image: title: Cropped Back Image parent_id: title: Parent Id deleted_by: title: Deleted By license_number: title: License Number type: string cropped_selfie_image: title: Cropped Selfie Image is_pdf_417: title: Is Pdf 417 type: boolean created_at: title: Created At type: string is_deleted: title: Is Deleted type: boolean issue_date: title: Issue Date status: title: Status type: string InternalDocument: title: InternalDocument required: - identifier - document_name - document_raw_url - document_signed_url - is_fni_doc - is_verified type: object properties: identifier: title: Identifier type: string document_name: title: Document Name type: string document_raw_url: title: Document Raw Url type: string document_signed_url: title: Document Signed Url type: string is_fni_doc: title: Is Fni Doc type: boolean is_verified: title: Is Verified type: boolean InternalInsuranceInformation: title: InternalInsuranceInformation required: - order_reference_id - key_id - updated_at - identifier - policy_number - created_by - customer_id - expiration_date - insurer_name - insurance_address - status - created_at - is_deleted - agent_name - is_active - id type: object properties: order_reference_id: title: Order Reference Id type: string subscription_id: title: Subscription Id key_id: title: Key Id type: integer updated_at: title: Updated At type: string identifier: title: Identifier type: string policy_number: title: Policy Number type: string created_by: title: Created By type: string customer_id: title: Customer Id type: integer expiration_date: title: Expiration Date type: string updated_by: title: Updated By insurer_name: title: Insurer Name type: string deductible_comprehensive: title: Deductible Comprehensive deleted_at: title: Deleted At insurance_address: title: Insurance Address type: integer deductible_collision: title: Deductible Collision deleted_by: title: Deleted By status: title: Status type: string insurance_documents: title: Insurance Documents created_at: title: Created At type: string is_deleted: title: Is Deleted type: boolean agent_name: title: Agent Name type: string is_active: title: Is Active type: boolean id: title: Id type: integer agent_phone: title: Agent Phone parent_id: title: Parent Id InternalOrderFee: title: InternalOrderFee required: - lender_id - applied_price - created_at - dealer_fee_id - dealer_id - id - identifier - is_active - is_deleted - order_id - updated_at - fee_name type: object properties: lender_id: title: Lender Id type: integer applied_price: title: Applied Price type: number created_at: title: Created At type: string dealer_fee_id: title: Dealer Fee Id type: integer dealer_id: title: Dealer Id type: integer id: title: Id type: integer identifier: title: Identifier type: string is_active: title: Is Active type: boolean is_deleted: title: Is Deleted type: boolean order_id: title: Order Id type: integer updated_at: title: Updated At type: string fee_name: title: Fee Name type: string InternalOrderModel: title: InternalOrderModel required: - fp_id - annual_usage - vehicle_id - payment_received - schedule_option - dealer_id - due_at_signing - base_rate - rental_frequency - is_deleted - lender_id - selling_price - finance_amount - margin - rental_mode - id - contract_term - down_payment - finance_type - applicable_rate - updated_at - reference_number - allowed_usage - down_payment_lease - customer_id - calculation_method - created_at - order_asset_number - credit_rating - identifier - is_active - application_created_at - apr - rv_balloon_percentage - order_stage - key_id - asset_usage - status - estimated_monthly_payment - rv_balloon_value - order_fees - order_options - order_fnI - order_tradein - customer_info - Vehicle_details - Insurance_Information - appointment_details - documents type: object properties: deleted_at: title: Deleted At fp_id: title: Fp Id type: integer annual_usage: title: Annual Usage type: number vehicle_id: title: Vehicle Id type: integer payment_received: title: Payment Received type: boolean subscription_status: title: Subscription Status meta_data: title: Meta Data schedule_option: title: Schedule Option type: string deleted_by: title: Deleted By dealer_id: title: Dealer Id type: integer due_at_signing: title: Due At Signing type: number msrp: title: Msrp base_rate: title: Base Rate type: integer billing_status: title: Billing Status parent_id: title: Parent Id rental_frequency: title: Rental Frequency type: string is_deleted: title: Is Deleted type: boolean lender_id: title: Lender Id type: integer selling_price: title: Selling Price type: number finance_amount: title: Finance Amount type: number margin: title: Margin type: integer start_date: title: Start Date terms: title: Terms rental_mode: title: Rental Mode type: string id: title: Id type: integer contract_term: title: Contract Term type: integer down_payment: title: Down Payment type: number finance_type: title: Finance Type type: string applicable_rate: title: Applicable Rate type: integer end_date: title: End Date excess_usage_rate: title: Excess Usage Rate final_bill_invoice_id: title: Final Bill Invoice Id updated_at: title: Updated At type: string reference_number: title: Reference Number type: string allowed_usage: title: Allowed Usage type: integer down_payment_lease: title: Down Payment Lease type: number tenant_id: title: Tenant Id customer_id: title: Customer Id type: integer has_draft_invoice: title: Has Draft Invoice invoice_status: title: Invoice Status calculation_method: title: Calculation Method type: string created_at: title: Created At type: string order_asset_number: title: Order Asset Number type: string credit_rating: title: Credit Rating type: string expiry_date: title: Expiry Date identifier: title: Identifier type: string external_subscription_id: title: External Subscription Id is_active: title: Is Active type: boolean reason: title: Reason created_by: title: Created By application_created_at: title: Application Created At type: string apr: title: Apr type: number rv_balloon_percentage: title: Rv Balloon Percentage type: number order_stage: title: Order Stage type: string vendor_subscription_id: title: Vendor Subscription Id key_id: title: Key Id type: integer asset_usage: title: Asset Usage type: string updated_by: title: Updated By status: title: Status type: string estimated_monthly_payment: title: Estimated Monthly Payment type: number rv_balloon_value: title: Rv Balloon Value type: number order_currency: title: Order Currency external_order_id: title: External Order Id order_fees: title: Order Fees type: array items: $ref: '#/components/schemas/InternalOrderFee' order_options: title: Order Options type: array items: {} order_fnI: title: Order Fni type: array items: {} order_tradein: $ref: '#/components/schemas/InternalOrderTradein' customer_info: $ref: '#/components/schemas/InternalCustomerInfo' order_asset: title: Order Asset Vehicle_details: $ref: '#/components/schemas/InternalVehicleDetails' Insurance_Information: $ref: '#/components/schemas/InternalInsuranceInformation' appointment_details: $ref: '#/components/schemas/InternalAppointmentDetails' documents: title: Documents type: array items: $ref: '#/components/schemas/InternalDocument' InternalOrderTradein: title: InternalOrderTradein required: - year - is_customer_titled - asset_image - created_at - make - loan_lease_balance - order_id - model - lender_id - trim - identifier - updated_at - mileage - is_active - vin - is_deleted - condition - id - trade_in_amount - payoff_amount type: object properties: year: title: Year type: integer is_customer_titled: title: Is Customer Titled type: boolean asset_image: title: Asset Image type: array items: type: string created_at: title: Created At type: string make: title: Make type: string loan_lease_balance: title: Loan Lease Balance type: boolean order_id: title: Order Id type: integer model: title: Model type: string lender_contract_number: title: Lender Contract Number lender_id: title: Lender Id type: integer trim: title: Trim type: string lender_name: title: Lender Name identifier: title: Identifier type: string updated_at: title: Updated At type: string mileage: title: Mileage type: integer lender_address: title: Lender Address is_active: title: Is Active type: boolean vin: title: Vin type: string lender_contact_number: title: Lender Contact Number is_deleted: title: Is Deleted type: boolean condition: title: Condition type: string payment_type: title: Payment Type id: title: Id type: integer trade_in_amount: title: Trade In Amount type: integer payoff_amount: title: Payoff Amount type: integer InternalVehicleDetails: title: InternalVehicleDetails required: - model - make - year - trim_description - stock_number - vin type: object properties: model: title: Model type: string make: title: Make type: string year: title: Year type: string vehicle_display_name: title: Vehicle Display Name trim_description: title: Trim Description type: string stock_number: title: Stock Number type: string vin: title: Vin type: string InvoiceStatus: title: InvoiceStatus enum: - Active - Paused - Resumed type: string description: An enumeration. LeadData: title: LeadData type: object properties: vehicle_details: title: Vehicle Details type: object description: Vehicle Details customer_details: title: Customer Details type: object description: Customer Details vehicle_search_criteria: title: Vehicle Search Criteria type: object description: Vehicle Search Criteria LeadModel: title: LeadModel type: object properties: id: title: Id type: integer slug: title: Slug type: string key_id: title: Key Id type: integer dealer_id: title: Dealer Id type: integer data: $ref: '#/components/schemas/LeadData' status: title: Status type: string reference_id: title: Reference Id type: string LicenseInfoCustomerResponseModel: title: LicenseInfoCustomerResponseModel type: object properties: first_name: title: First Name type: string last_name: title: Last Name type: string status: title: Status type: string license_number: title: License Number type: string is_pdf_417: title: Is Pdf 417 type: boolean issue_date: title: Issue Date type: string description: 'format: YYYY-MM-DD' format: date expiry_date: title: Expiry Date type: string description: 'format: YYYY-MM-DD' format: date date_of_birth: title: Date Of Birth type: string description: 'format: YYYY-MM-DD' format: date is_selfie_verified: title: Is Selfie Verified type: boolean LicenseInfoPaginationResponse: title: LicenseInfoPaginationResponse type: object properties: result: title: Result type: array items: $ref: '#/components/schemas/LicenseInfoResponseModel' page_number: title: Page Number type: integer page_size: title: Page Size type: integer total_pages: title: Total Pages type: integer total_results: title: Total Results type: integer LicenseInfoResponseModel: title: LicenseInfoResponseModel type: object properties: first_name: title: First Name type: string description: First name last_name: title: Last Name type: string description: Last name date_of_birth: title: Date Of Birth type: string description: 'format: YYYY-MM-DD' format: date is_pdf_417: title: Is Pdf 417 type: boolean license_number: title: License Number type: string description: license number issue_date: title: Issue Date type: string description: 'format: YYYY-MM-DD' format: date expiry_date: title: Expiry Date type: string description: 'format: YYYY-MM-DD' format: date front_image: title: Front Image type: string description: license front image back_image: title: Back Image type: string description: license back image status: title: Status type: string call_type: $ref: '#/components/schemas/CallType' selfie_image: title: Selfie Image type: string cropped_front_image: title: Cropped Front Image type: string cropped_back_image: title: Cropped Back Image type: string cropped_selfie_image: title: Cropped Selfie Image type: string is_selfie_verified: title: Is Selfie Verified type: boolean created_by: title: Created By type: string reference_id: title: Reference Id type: string is_active: title: Is Active type: boolean identifier: title: Identifier type: string created_at: title: Created At type: string format: date-time updated_at: title: Updated At type: string format: date-time updated_by: title: Updated By type: string deleted_at: title: Deleted At type: string format: date-time deleted_by: title: Deleted By type: string address: $ref: '#/components/schemas/AddressBasicModel' LicenseInfoUpdateResponseModel: title: LicenseInfoUpdateResponseModel type: object properties: first_name: title: First Name type: string description: First name last_name: title: Last Name type: string description: Last name date_of_birth: title: Date Of Birth type: string description: 'format: YYYY-MM-DD' format: date is_pdf_417: title: Is Pdf 417 type: boolean license_number: title: License Number type: string description: license number issue_date: title: Issue Date type: string description: 'format: YYYY-MM-DD' format: date expiry_date: title: Expiry Date type: string description: 'format: YYYY-MM-DD' format: date front_image: title: Front Image type: string description: license front image back_image: title: Back Image type: string description: license back image status: title: Status type: string call_type: $ref: '#/components/schemas/CallType' selfie_image: title: Selfie Image type: string cropped_front_image: title: Cropped Front Image type: string cropped_back_image: title: Cropped Back Image type: string cropped_selfie_image: title: Cropped Selfie Image type: string is_selfie_verified: title: Is Selfie Verified type: boolean created_by: title: Created By type: string is_active: title: Is Active type: boolean identifier: title: Identifier type: string created_at: title: Created At type: string format: date-time updated_at: title: Updated At type: string format: date-time updated_by: title: Updated By type: string deleted_at: title: Deleted At type: string format: date-time deleted_by: title: Deleted By type: string address: $ref: '#/components/schemas/AddressBasicModel' LicenseVerificationModel: title: LicenseVerificationModel required: - front_image - back_image - customer_id type: object properties: front_image: title: Front Image type: string back_image: title: Back Image type: string customer_id: title: Customer Id type: string dealer_code: title: Dealer Code type: string api_version: title: Api Version type: string default: '1.2' LisenceInfoUpdateModel: title: LisenceInfoUpdateModel type: object properties: first_name: title: First Name type: string description: First name last_name: title: Last Name type: string description: Last name date_of_birth: title: Date Of Birth type: string description: 'format: YYYY-MM-DD' format: date is_pdf_417: title: Is Pdf 417 type: boolean license_number: title: License Number type: string description: license number issue_date: title: Issue Date type: string description: 'format: YYYY-MM-DD' format: date expiry_date: title: Expiry Date type: string description: 'format: YYYY-MM-DD' format: date front_image: title: Front Image type: string description: license front image back_image: title: Back Image type: string description: license back image status: title: Status type: string call_type: $ref: '#/components/schemas/CallType' selfie_image: title: Selfie Image type: string cropped_front_image: title: Cropped Front Image type: string cropped_back_image: title: Cropped Back Image type: string cropped_selfie_image: title: Cropped Selfie Image type: string is_selfie_verified: title: Is Selfie Verified type: boolean created_by: title: Created By type: string mitek_response: title: Mitek Response type: string updated_by: title: Updated By type: string address: $ref: '#/components/schemas/CustomerAddressWithoutAddressTypeModel' LisenceInfoWithAdress: title: LisenceInfoWithAdress type: object properties: first_name: title: First Name type: string description: First name last_name: title: Last Name type: string description: Last name date_of_birth: title: Date Of Birth type: string description: 'format: YYYY-MM-DD' format: date is_pdf_417: title: Is Pdf 417 type: boolean license_number: title: License Number type: string description: license number issue_date: title: Issue Date type: string description: 'format: YYYY-MM-DD' format: date expiry_date: title: Expiry Date type: string description: 'format: YYYY-MM-DD' format: date front_image: title: Front Image type: string description: license front image back_image: title: Back Image type: string description: license back image status: title: Status type: string call_type: $ref: '#/components/schemas/CallType' selfie_image: title: Selfie Image type: string cropped_front_image: title: Cropped Front Image type: string cropped_back_image: title: Cropped Back Image type: string cropped_selfie_image: title: Cropped Selfie Image type: string is_selfie_verified: title: Is Selfie Verified type: boolean created_by: title: Created By type: string reference_id: title: Reference Id type: string identifier: title: Identifier minLength: 1 type: string mitek_response: title: Mitek Response type: string address: $ref: '#/components/schemas/CustomerAddressWithoutAddressTypeModel' MonthlyPaymentCalculationModelV2: title: MonthlyPaymentCalculationModelV2 required: - asset_make_name - asset_model_name - asset_trim_name - dealer_id - company_id - rental_mode - financed_amount - terms type: object properties: asset_make_name: title: Asset Make Name type: string asset_model_name: title: Asset Model Name type: string asset_trim_name: title: Asset Trim Name type: string dealer_id: title: Dealer Id type: integer company_id: title: Company Id type: integer rental_mode: title: Rental Mode type: string financed_amount: title: Financed Amount type: number terms: title: Terms type: array items: type: integer NFACalculationParams: title: NFACalculationParams required: - per_unit_selling_price - dealer_id - options - fees - fni_products - taxes - insurance type: object properties: per_unit_selling_price: title: Per Unit Selling Price type: number description: Per Unit Asset Selling Price dealer_id: title: Dealer Id type: integer description: System Generated Dealer Id quantity: title: Quantity type: integer description: Quantity of Financed Equipment/Assets down_payment: title: Down Payment type: number description: Asset Total Down payment options: title: Options type: array items: $ref: '#/components/schemas/OptionsRequestModel' description: Options applied on asset fees: title: Fees type: array items: $ref: '#/components/schemas/FeeRequestModel' description: Fees fni_products: title: Fni Products type: array items: $ref: '#/components/schemas/FinanceAndInsuranceRequestModel' description: F&I Products trade_in_amount: title: Trade In Amount type: number description: Trade-in amount taxes: title: Taxes type: array items: $ref: '#/components/schemas/TaxesRequestModel' description: Taxes insurance: title: Insurance type: array items: $ref: '#/components/schemas/InsuranceRequestModel' description: Insurance Operators: title: Operators enum: - Equals - Not_equals - Less_than - Greater_than - Less_than_and_equal - Greater_than_and_equal - Is_null - Not_null - Contains type: string description: An enumeration. Option: title: Option required: - option_id - applied_price - rv_balloon_percentage - rv_balloon_value type: object properties: option_id: title: Option Id type: integer identifier: title: Identifier type: string applied_price: title: Applied Price type: number rv_balloon_percentage: title: Rv Balloon Percentage type: number rv_balloon_value: title: Rv Balloon Value type: number OptionFilterType: title: OptionFilterType enum: - All - DecodedOnly type: string description: An enumeration. OptionsRequestModel: title: OptionsRequestModel type: object properties: option_name: title: Option Name type: string option_amount: title: Option Amount type: number rv_amount_on_option: title: Rv Amount On Option type: number amount_handling: title: Amount Handling type: string OrderAssetModel: title: OrderAssetModel type: object properties: make: title: Make type: string identifier: title: Identifier type: string model: title: Model type: string trim: title: Trim type: string year_manufacturer: title: Year Manufacturer type: string msrp: title: Msrp type: number mileage: title: Mileage type: integer exterior_color: title: Exterior Color type: string condition: title: Condition type: array items: type: string classification: title: Classification type: string engine_cylinder: title: Engine Cylinder type: string power_type: title: Power Type type: string power_figure: title: Power Figure type: string engine_displacement: title: Engine Displacement type: string fuel_type: title: Fuel Type type: string quantity: title: Quantity type: string unit_price: title: Unit Price type: string unit_tax: title: Unit Tax type: string total: title: Total type: string vin: title: Vin type: string asset_type: title: Asset Type type: string rv_balloon_amount: title: Rv Balloon Amount type: number OrderAssetUpdateModel: title: OrderAssetUpdateModel type: object properties: order_id: title: Order Id type: string description: Order Reference Id mileage: title: Mileage type: number engine_cylinder: title: Engine Cylinder type: string vehicle_uses: title: Vehicle Uses type: string transmission_type: title: Transmission Type type: string odometer_disclaimer: title: Odometer Disclaimer type: string OrderCalculationResponseModel: title: OrderCalculationResponseModel type: object properties: fp_id: title: Fp Id type: integer description: fp_id program_name: title: Program Name type: string description: Program name finance_type: title: Finance Type type: string description: Finance type calculation_method: title: Calculation Method type: string description: Calculation method rental_mode: title: Rental Mode type: string description: Rental mode rv_balloon_override: title: Rv Balloon Override type: boolean description: RV balloon override? interest_rate_override: title: Interest Rate Override type: boolean description: Interest rate override? rate_conversion_method: title: Rate Conversion Method type: string description: Rate conversion method rv_balloon_applicable: title: Rv Balloon Applicable type: boolean description: RV balloon applicable? rv_balloon_type: title: Rv Balloon Type type: string description: RV balloon type rv_calculation_method: title: Rv Calculation Method type: string description: RV calculation method estimated_monthly_payment: title: Estimated Monthly Payment type: number description: Estimated monthly payment rv_amount: title: Rv Amount type: integer description: RV amount due_at_signing: title: Due At Signing type: number description: Due at signing selling_price: title: Selling Price type: integer description: Selling price down_payment: title: Down Payment type: integer description: Down payment taxes: title: Taxes type: array items: $ref: '#/components/schemas/TaxesRequestModel' description: Taxes financed_amount: title: Financed Amount type: integer description: Financed amount rental_frequency: title: Rental Frequency type: array items: type: integer description: Rental frequency rv_chart: title: Rv Chart description: RV chart interest_chart: title: Interest Chart allOf: - $ref: '#/components/schemas/InterestChartResponseModel' description: Interest chart subsidy: title: Subsidy allOf: - $ref: '#/components/schemas/SubsidyResponseModel' description: Subsidy rentals_stream: title: Rentals Stream type: array items: $ref: '#/components/schemas/RentalSreamResponseModel' description: Rentals stream OrderChecklistModel: title: OrderChecklistModel required: - customer_reference_id - order_reference_id - checklist_name - event - question_text - question_type - primary_answer - checklist_identifier - created_by type: object properties: customer_reference_id: title: Customer Reference Id type: string description: Customer reference number order_reference_id: title: Order Reference Id type: string description: Order reference number checklist_name: title: Checklist Name type: string description: Checklist name event: title: Event type: string description: Event question_text: title: Question Text type: string description: Question text question_type: allOf: - $ref: '#/components/schemas/QuestionType' description: Question type [YES_NO or MULTIPLE_OPTIONS] primary_answer: title: Primary Answer type: string description: Primary answer secondary_answer: title: Secondary Answer type: string description: Secondary answer external_order_ref_number: title: External Order Ref Number type: string description: External order reference number checklist_identifier: title: Checklist Identifier type: string description: Checklist identifier description: title: Description type: string description: Checklist description created_by: title: Created By type: string OrderChecklistResponseModel: title: OrderChecklistResponseModel required: - id - customer_id - checklist_name - question_text - question_type - primary_answer - checklist_identifier type: object properties: id: title: Id type: integer customer_id: title: Customer Id type: integer order_reference_id: title: Order Reference Id type: string checklist_name: title: Checklist Name type: string event: title: Event type: string question_text: title: Question Text type: string question_type: $ref: '#/components/schemas/QuestionType' primary_answer: title: Primary Answer type: string secondary_answer: title: Secondary Answer type: string external_order_ref_number: title: External Order Ref Number type: string checklist_identifier: title: Checklist Identifier type: string description: title: Description type: string created_by: title: Created By type: string updated_by: title: Updated By type: string deleted_by: title: Deleted By type: string created_at: title: Created At type: string format: date-time updated_at: title: Updated At type: string format: date-time changed_by: title: Changed By type: string changed_at: title: Changed At type: string format: date-time OrderChecklistUpdateModel: title: OrderChecklistUpdateModel type: object properties: customer_reference_id: title: Customer Reference Id type: string description: Customer reference id checklist_identifier: title: Checklist Identifier type: string description: Checklist identifier checklist_name: title: Checklist Name type: string description: Checklist name event: title: Event type: string description: Event question_text: title: Question Text type: string description: Question text question_type: allOf: - $ref: '#/components/schemas/QuestionType' description: Question type [YES_NO or MULTIPLE_OPTIONS] primary_answer: title: Primary Answer type: string description: Primary answer secondary_answer: title: Secondary Answer type: string description: Secondary answer external_order_ref_number: title: External Order Ref Number type: string description: External order reference number description: title: Description type: string description: Checklist description updated_by: title: Updated By type: string updated_at: title: Updated At type: string changed_by: title: Changed By type: string changed_at: title: Changed At type: string format: date-time OrderCommentsModel: title: OrderCommentsModel type: object properties: identifier: title: Identifier type: string order_reference_id: title: Order Reference Id type: string customer_id: title: Customer Id type: string category: $ref: '#/components/schemas/CommentDiaryCategory' comment: title: Comment type: string created_by: title: Created By type: string created_at: title: Created At type: string format: date-time updated_by: title: Updated By type: string updated_at: title: Updated At type: string format: date-time OrderCreditDecisionModel: title: OrderCreditDecisionModel required: - order_id type: object properties: order_id: title: Order Id type: integer decision_code: title: Decision Code type: string description: title: Description type: string response_code: title: Response Code type: string mapped_code: title: Mapped Code type: string stipulation: title: Stipulation type: array items: type: object OrderCreditDecisionResponseModel: title: OrderCreditDecisionResponseModel required: - order_id type: object properties: order_id: title: Order Id type: integer decision_code: title: Decision Code type: string description: title: Description type: string response_code: title: Response Code type: string mapped_code: title: Mapped Code type: string stipulation: title: Stipulation type: array items: type: object created_at: title: Created At type: string format: date-time updated_at: title: Updated At type: string format: date-time created_by: title: Created By type: string updated_by: title: Updated By type: string OrderFIPResponseModel: title: OrderFIPResponseModel required: - applied_price - dealer_id - financial_insurance_id - order_id - lender_id type: object properties: identifier: title: Identifier type: string applied_price: title: Applied Price type: number dealer_id: title: Dealer Id type: integer financial_insurance_id: title: Financial Insurance Id type: integer order_id: title: Order Id type: integer lender_id: title: Lender Id type: integer OrderFeeCreateModel: title: OrderFeeCreateModel required: - dealer_fee_id - applied_price type: object properties: dealer_fee_id: title: Dealer Fee Id type: integer applied_price: title: Applied Price type: number identifier: title: Identifier type: string vendor: title: Vendor type: string fee_type: title: Fee Type type: string OrderFeeModel: title: OrderFeeModel required: - dealer_fee_id - dealer_id - applied_price - order_id - lender_id type: object properties: identifier: title: Identifier type: string dealer_fee_id: title: Dealer Fee Id type: integer dealer_id: title: Dealer Id type: integer applied_price: title: Applied Price type: number order_id: title: Order Id type: integer lender_id: title: Lender Id type: integer vendor: title: Vendor type: string fee_type: title: Fee Type type: string OrderFinancialInsuranceProductCreateModel: title: OrderFinancialInsuranceProductCreateModel required: - applied_price - financial_insurance_id type: object properties: applied_price: title: Applied Price type: number financial_insurance_id: title: Financial Insurance Id type: integer form_id: title: Form Id type: integer rate_id: title: Rate Id type: integer mileage: title: Mileage type: integer term: title: Term type: integer session_id: title: Session Id type: string identifier: title: Identifier type: string is_msp: title: Is Msp type: boolean OrderFinancialInsuranceProductModel: title: OrderFinancialInsuranceProductModel required: - applied_price - dealer_id - financial_insurance_id - mileage - term - order_id - lender_id - form_id - rate_id type: object properties: applied_price: title: Applied Price type: number dealer_id: title: Dealer Id type: integer financial_insurance_id: title: Financial Insurance Id type: integer mileage: title: Mileage type: integer term: title: Term type: integer order_id: title: Order Id type: integer lender_id: title: Lender Id type: integer is_msp: title: Is Msp type: boolean form_id: title: Form Id type: integer rate_id: title: Rate Id type: integer OrderIndividualizedModel: title: OrderIndividualizedModel required: - reference_number type: object properties: reference_number: title: Reference Number type: string individualized_agreement: title: Individualized Agreement type: string OrderInformationModel: title: OrderInformationModel required: - order_info - customer_info type: object properties: order_info: $ref: '#/components/schemas/OrderQuotationResponseModel' customer_info: $ref: '#/components/schemas/CustomerProfileModelResponse' OrderItem: title: OrderItem type: object properties: id: title: Id type: integer productId: title: Productid type: string type: title: Type type: string metadata: $ref: '#/components/schemas/OrderItemMetadata' OrderItemMetadata: title: OrderItemMetadata type: object properties: vin: title: Vin type: string make: title: Make type: string term: title: Term type: string trim: title: Trim type: string year: title: Year type: string model: title: Model type: string engine: title: Engine type: string bodyType: title: Bodytype type: string fuelType: title: Fueltype type: string stockType: title: Stocktype type: string storeName: title: Storename type: string drivetrain: title: Drivetrain type: string downPayment: title: Downpayment type: string fuelEconomy: title: Fueleconomy type: string stockNumber: title: Stocknumber type: string exteriorColor: title: Exteriorcolor type: string interiorColor: title: Interiorcolor type: string milesPerMonth: title: Milespermonth type: string vehicleImages: title: Vehicleimages type: array items: type: string installedOptions: title: Installedoptions type: array items: type: string transmissionType: title: Transmissiontype type: string odometerAtOrderCreation: title: Odometeratordercreation type: integer OrderOptionCreateModel: title: OrderOptionCreateModel required: - option_id - applied_price - rv_balloon_percentage type: object properties: option_id: title: Option Id type: integer identifier: title: Identifier type: string applied_price: title: Applied Price type: number rv_balloon_percentage: title: Rv Balloon Percentage type: number rv_balloon_value: title: Rv Balloon Value type: number OrderOptionModel: title: OrderOptionModel required: - order_id - option_id - applied_price - dealer_id - lender_id - rv_balloon_percentage - rv_balloon_value type: object properties: identifier: title: Identifier type: string order_id: title: Order Id type: integer option_id: title: Option Id type: integer applied_price: title: Applied Price type: number dealer_id: title: Dealer Id type: integer lender_id: title: Lender Id type: integer rv_balloon_percentage: title: Rv Balloon Percentage type: number rv_balloon_value: title: Rv Balloon Value type: number OrderPaginationResponse: title: OrderPaginationResponse type: object properties: result: title: Result type: array items: $ref: '#/components/schemas/OrderInformationModel' page_number: title: Page Number type: integer page_size: title: Page Size type: integer total_pages: title: Total Pages type: integer total_results: title: Total Results type: integer OrderProposalStatus: title: OrderProposalStatus enum: - Draft - New - Submitted - Approved - Conditioned - Conditional Approval - Additional Info Required - Declined - Withdrawn - Documents Sent - Documents Received - Sent for Payout - Paid Out - Awaiting Compliance - Complied - Awaiting More - Fully Received - Deferred type: string description: An enumeration. OrderQuotationCreateModel: title: OrderQuotationCreateModel required: - reference_id type: object properties: id: title: Id type: integer dealer_id: title: Dealer Id type: integer lender_id: title: Lender Id type: integer broker_id: title: Broker Id type: integer company_id: title: Company Id type: integer name: title: Name type: string contract_term: title: Contract Term type: integer allowed_usage: title: Allowed Usage type: integer credit_rating: title: Credit Rating type: string apr: title: Apr type: number estimated_monthly_payment: title: Estimated Monthly Payment type: number annual_usage: title: Annual Usage type: number default: 0 due_at_signing: title: Due At Signing type: number is_payment_updated: title: Is Payment Updated type: boolean default: false selling_price: title: Selling Price type: number down_payment: title: Down Payment type: number down_payment_lease: title: Down Payment Lease type: number tax_amount: title: Tax Amount type: number tax_amount_number: title: Tax Amount Number type: number deferred_type: title: Deferred Type type: string rv_balloon_percentage: title: Rv Balloon Percentage type: number rv_balloon_value: title: Rv Balloon Value type: number balloon_collection: title: Balloon Collection type: string fp_id: title: Fp Id type: integer vehicle_id: title: Vehicle Id type: integer msrp: title: Msrp type: number schedule_option: title: Schedule Option type: string asset_usage: title: Asset Usage type: string calcuation_method: title: Calcuation Method type: string order_stage: title: Order Stage type: string finance_type: title: Finance Type type: string order_fees: title: Order Fees type: array items: $ref: '#/components/schemas/OrderFeeCreateModel' order_options: title: Order Options type: array items: anyOf: - $ref: '#/components/schemas/OrderOptionCreateModel' - $ref: '#/components/schemas/Option' order_fnI: title: Order Fni type: array items: anyOf: - $ref: '#/components/schemas/OrderFinancialInsuranceProductCreateModel' - $ref: '#/components/schemas/FinancialInsurance' order_tradein: $ref: '#/components/schemas/OrderTradeInCreateModel' appointment_details: $ref: '#/components/schemas/libdms__models__CreateAppointmentModel' finance_amount: title: Finance Amount type: number order_asset: $ref: '#/components/schemas/OrderAssetModel' insurance: $ref: '#/components/schemas/InsuranceInformationWithAddressesModel' payment_recieved: title: Payment Recieved type: boolean base_rate: title: Base Rate type: number rate_type: title: Rate Type type: string commission_type: title: Commission Type type: string margin: title: Margin type: number applicable_rate: title: Applicable Rate type: number invoice_status: $ref: '#/components/schemas/InvoiceStatus' rental_mode: title: Rental Mode type: string rental_frequency: title: Rental Frequency type: string running_id: title: Running Id type: string order_currency: title: Order Currency type: string commission_amount: title: Commission Amount type: number received_security_deposit: title: Received Security Deposit type: integer net_finance_amount: title: Net Finance Amount type: number rebate: title: Rebate type: number capitalized_cost_reduction: title: Capitalized Cost Reduction type: number monthly_deprecation: title: Monthly Deprecation type: number tax_on_capitalized_cost_reduction: title: Tax On Capitalized Cost Reduction type: number monthly_sales_use_tax: title: Monthly Sales Use Tax type: number sum_of_fees: title: Sum Of Fees type: number sum_of_periodic_interest: title: Sum Of Periodic Interest type: number sum_of_rentals: title: Sum Of Rentals type: number total_payables: title: Total Payables type: number non_vatable_amount: title: Non Vatable Amount type: number individualized_agreement: title: Individualized Agreement type: string base_residual_type: title: Base Residual Type type: integer excess_mileage_rate: title: Excess Mileage Rate type: number asset_rv_amount: title: Asset Rv Amount type: number reference_id: title: Reference Id type: string is_payment_estimator: title: Is Payment Estimator type: boolean OrderQuotationModel: title: OrderQuotationModel type: object properties: id: title: Id type: integer dealer_id: title: Dealer Id type: integer lender_id: title: Lender Id type: integer broker_id: title: Broker Id type: integer company_id: title: Company Id type: integer name: title: Name type: string contract_term: title: Contract Term type: integer allowed_usage: title: Allowed Usage type: integer credit_rating: title: Credit Rating type: string apr: title: Apr type: number estimated_monthly_payment: title: Estimated Monthly Payment type: number annual_usage: title: Annual Usage type: number default: 0 due_at_signing: title: Due At Signing type: number is_payment_updated: title: Is Payment Updated type: boolean default: false selling_price: title: Selling Price type: number down_payment: title: Down Payment type: number down_payment_lease: title: Down Payment Lease type: number tax_amount: title: Tax Amount type: number tax_amount_number: title: Tax Amount Number type: number deferred_type: title: Deferred Type type: string rv_balloon_percentage: title: Rv Balloon Percentage type: number rv_balloon_value: title: Rv Balloon Value type: number balloon_collection: title: Balloon Collection type: string fp_id: title: Fp Id type: integer vehicle_id: title: Vehicle Id type: integer msrp: title: Msrp type: number schedule_option: title: Schedule Option type: string asset_usage: title: Asset Usage type: string calcuation_method: title: Calcuation Method type: string order_stage: title: Order Stage type: string finance_type: title: Finance Type type: string order_fees: title: Order Fees type: array items: $ref: '#/components/schemas/OrderFeeCreateModel' order_options: title: Order Options type: array items: anyOf: - $ref: '#/components/schemas/OrderOptionCreateModel' - $ref: '#/components/schemas/Option' order_fnI: title: Order Fni type: array items: anyOf: - $ref: '#/components/schemas/OrderFinancialInsuranceProductCreateModel' - $ref: '#/components/schemas/FinancialInsurance' order_tradein: $ref: '#/components/schemas/OrderTradeInCreateModel' appointment_details: $ref: '#/components/schemas/libdms__models__CreateAppointmentModel' finance_amount: title: Finance Amount type: number order_asset: $ref: '#/components/schemas/OrderAssetModel' insurance: $ref: '#/components/schemas/InsuranceInformationWithAddressesModel' payment_recieved: title: Payment Recieved type: boolean base_rate: title: Base Rate type: number rate_type: title: Rate Type type: string commission_type: title: Commission Type type: string margin: title: Margin type: number applicable_rate: title: Applicable Rate type: number invoice_status: $ref: '#/components/schemas/InvoiceStatus' rental_mode: title: Rental Mode type: string rental_frequency: title: Rental Frequency type: string running_id: title: Running Id type: string order_currency: title: Order Currency type: string commission_amount: title: Commission Amount type: number received_security_deposit: title: Received Security Deposit type: integer net_finance_amount: title: Net Finance Amount type: number rebate: title: Rebate type: number capitalized_cost_reduction: title: Capitalized Cost Reduction type: number monthly_deprecation: title: Monthly Deprecation type: number tax_on_capitalized_cost_reduction: title: Tax On Capitalized Cost Reduction type: number monthly_sales_use_tax: title: Monthly Sales Use Tax type: number sum_of_fees: title: Sum Of Fees type: number sum_of_periodic_interest: title: Sum Of Periodic Interest type: number sum_of_rentals: title: Sum Of Rentals type: number total_payables: title: Total Payables type: number non_vatable_amount: title: Non Vatable Amount type: number individualized_agreement: title: Individualized Agreement type: string base_residual_type: title: Base Residual Type type: integer excess_mileage_rate: title: Excess Mileage Rate type: number asset_rv_amount: title: Asset Rv Amount type: number OrderQuotationResponseModel: title: OrderQuotationResponseModel required: - status - reference_number - order_asset_number - identifier type: object properties: id: title: Id type: integer dealer_id: title: Dealer Id type: integer lender_id: title: Lender Id type: integer broker_id: title: Broker Id type: integer company_id: title: Company Id type: integer name: title: Name type: string contract_term: title: Contract Term type: integer allowed_usage: title: Allowed Usage type: integer credit_rating: title: Credit Rating type: string apr: title: Apr type: number estimated_monthly_payment: title: Estimated Monthly Payment type: number annual_usage: title: Annual Usage type: number default: 0 due_at_signing: title: Due At Signing type: number is_payment_updated: title: Is Payment Updated type: boolean default: false selling_price: title: Selling Price type: number down_payment: title: Down Payment type: number down_payment_lease: title: Down Payment Lease type: number tax_amount: title: Tax Amount type: number tax_amount_number: title: Tax Amount Number type: number deferred_type: title: Deferred Type type: string rv_balloon_percentage: title: Rv Balloon Percentage type: number rv_balloon_value: title: Rv Balloon Value type: number balloon_collection: title: Balloon Collection type: string fp_id: title: Fp Id type: integer vehicle_id: title: Vehicle Id type: integer msrp: title: Msrp type: number schedule_option: title: Schedule Option type: string asset_usage: title: Asset Usage type: string calcuation_method: title: Calcuation Method type: string order_stage: title: Order Stage type: string finance_type: title: Finance Type type: string order_fees: title: Order Fees type: array items: $ref: '#/components/schemas/OrderFeeCreateModel' order_options: title: Order Options type: array items: anyOf: - $ref: '#/components/schemas/OrderOptionCreateModel' - $ref: '#/components/schemas/Option' order_fnI: title: Order Fni type: array items: anyOf: - $ref: '#/components/schemas/OrderFinancialInsuranceProductCreateModel' - $ref: '#/components/schemas/FinancialInsurance' order_tradein: $ref: '#/components/schemas/OrderTradeInCreateModel' appointment_details: $ref: '#/components/schemas/libdms__models__CreateAppointmentModel' finance_amount: title: Finance Amount type: number order_asset: $ref: '#/components/schemas/OrderAssetModel' insurance: $ref: '#/components/schemas/InsuranceInformationWithAddressesModel' payment_recieved: title: Payment Recieved type: boolean base_rate: title: Base Rate type: number rate_type: title: Rate Type type: string commission_type: title: Commission Type type: string margin: title: Margin type: number applicable_rate: title: Applicable Rate type: number invoice_status: $ref: '#/components/schemas/InvoiceStatus' rental_mode: title: Rental Mode type: string rental_frequency: title: Rental Frequency type: string running_id: title: Running Id type: string order_currency: title: Order Currency type: string commission_amount: title: Commission Amount type: number received_security_deposit: title: Received Security Deposit type: integer net_finance_amount: title: Net Finance Amount type: number rebate: title: Rebate type: number capitalized_cost_reduction: title: Capitalized Cost Reduction type: number monthly_deprecation: title: Monthly Deprecation type: number tax_on_capitalized_cost_reduction: title: Tax On Capitalized Cost Reduction type: number monthly_sales_use_tax: title: Monthly Sales Use Tax type: number sum_of_fees: title: Sum Of Fees type: number sum_of_periodic_interest: title: Sum Of Periodic Interest type: number sum_of_rentals: title: Sum Of Rentals type: number total_payables: title: Total Payables type: number non_vatable_amount: title: Non Vatable Amount type: number individualized_agreement: title: Individualized Agreement type: string base_residual_type: title: Base Residual Type type: integer excess_mileage_rate: title: Excess Mileage Rate type: number asset_rv_amount: title: Asset Rv Amount type: number customer_id: title: Customer Id type: integer status: title: Status type: string reference_number: title: Reference Number type: string order_asset_number: title: Order Asset Number type: string identifier: title: Identifier type: string OrderQuotationUpdateModel: title: OrderQuotationUpdateModel required: - identifier type: object properties: id: title: Id type: integer dealer_id: title: Dealer Id type: integer lender_id: title: Lender Id type: integer broker_id: title: Broker Id type: integer company_id: title: Company Id type: integer name: title: Name type: string contract_term: title: Contract Term type: integer allowed_usage: title: Allowed Usage type: integer credit_rating: title: Credit Rating type: string apr: title: Apr type: number estimated_monthly_payment: title: Estimated Monthly Payment type: number annual_usage: title: Annual Usage type: number default: 0 due_at_signing: title: Due At Signing type: number is_payment_updated: title: Is Payment Updated type: boolean default: false selling_price: title: Selling Price type: number down_payment: title: Down Payment type: number down_payment_lease: title: Down Payment Lease type: number tax_amount: title: Tax Amount type: number tax_amount_number: title: Tax Amount Number type: number deferred_type: title: Deferred Type type: string rv_balloon_percentage: title: Rv Balloon Percentage type: number rv_balloon_value: title: Rv Balloon Value type: number balloon_collection: title: Balloon Collection type: string fp_id: title: Fp Id type: integer vehicle_id: title: Vehicle Id type: integer msrp: title: Msrp type: number schedule_option: title: Schedule Option type: string asset_usage: title: Asset Usage type: string calcuation_method: title: Calcuation Method type: string order_stage: title: Order Stage type: string finance_type: title: Finance Type type: string order_fees: title: Order Fees type: array items: $ref: '#/components/schemas/OrderFeeCreateModel' order_options: title: Order Options type: array items: anyOf: - $ref: '#/components/schemas/OrderOptionCreateModel' - $ref: '#/components/schemas/Option' order_fnI: title: Order Fni type: array items: anyOf: - $ref: '#/components/schemas/OrderFinancialInsuranceProductCreateModel' - $ref: '#/components/schemas/FinancialInsurance' order_tradein: $ref: '#/components/schemas/OrderTradeInCreateModel' appointment_details: $ref: '#/components/schemas/libdms__models__CreateAppointmentModel' finance_amount: title: Finance Amount type: number order_asset: $ref: '#/components/schemas/OrderAssetModel' insurance: $ref: '#/components/schemas/InsuranceInformationWithAddressesModel' payment_recieved: title: Payment Recieved type: boolean base_rate: title: Base Rate type: number rate_type: title: Rate Type type: string commission_type: title: Commission Type type: string margin: title: Margin type: number applicable_rate: title: Applicable Rate type: number invoice_status: $ref: '#/components/schemas/InvoiceStatus' rental_mode: title: Rental Mode type: string rental_frequency: title: Rental Frequency type: string running_id: title: Running Id type: string order_currency: title: Order Currency type: string commission_amount: title: Commission Amount type: number received_security_deposit: title: Received Security Deposit type: integer net_finance_amount: title: Net Finance Amount type: number rebate: title: Rebate type: number capitalized_cost_reduction: title: Capitalized Cost Reduction type: number monthly_deprecation: title: Monthly Deprecation type: number tax_on_capitalized_cost_reduction: title: Tax On Capitalized Cost Reduction type: number monthly_sales_use_tax: title: Monthly Sales Use Tax type: number sum_of_fees: title: Sum Of Fees type: number sum_of_periodic_interest: title: Sum Of Periodic Interest type: number sum_of_rentals: title: Sum Of Rentals type: number total_payables: title: Total Payables type: number non_vatable_amount: title: Non Vatable Amount type: number individualized_agreement: title: Individualized Agreement type: string base_residual_type: title: Base Residual Type type: integer excess_mileage_rate: title: Excess Mileage Rate type: number asset_rv_amount: title: Asset Rv Amount type: number identifier: title: Identifier type: string changeVehicleStatus: title: Changevehiclestatus type: boolean default: true OrderStageTypes: title: OrderStageTypes enum: - Quotation - Application type: string description: An enumeration. OrderStakeholderAddressModel: title: OrderStakeholderAddressModel type: object properties: address_line_1: title: Address Line 1 type: string description: Address line one address_line_2: title: Address Line 2 type: string description: Address line two state_name: title: State Name type: string description: Address state name zip_code: title: Zip Code type: string description: Zip code county: title: County type: string description: Address county city: title: City type: string description: Address city contact_number: title: Contact Number type: string description: Contact number verified: title: Verified type: boolean description: Is Address verified move_in_date: title: Move In Date type: string description: 'format: YYYY-MM-DD' format: date is_garaging: title: Is Garaging type: boolean description: Garaging flag default: false identifier: title: Identifier type: string address_type: $ref: '#/components/schemas/AddressTypes' OrderStakeholderBaseModel: title: OrderStakeholderBaseModel type: object properties: identifier: title: Identifier type: string order_identifier: title: Order Identifier type: string stakeholder_reference_id: title: Stakeholder Reference Id type: string name: title: Name type: string email: title: Email type: string role: title: Role type: string position: title: Position type: string contact_number: title: Contact Number type: string address_id: title: Address Id type: string OrderStakeholderValidationModel: title: OrderStakeholderValidationModel type: object properties: identifier: title: Identifier type: string order_identifier: title: Order Identifier type: string stakeholder_reference_id: title: Stakeholder Reference Id type: string name: title: Name type: string email: title: Email type: string role: title: Role type: string position: title: Position type: string contact_number: title: Contact Number type: string address_id: title: Address Id type: string stakeholder_address: $ref: '#/components/schemas/OrderStakeholderAddressModel' OrderStatusHistoryModel: title: OrderStatusHistoryModel required: - order_reference_number type: object properties: order_reference_number: title: Order Reference Number type: string OrderStatusRequestModel: title: OrderStatusRequestModel required: - status - user_id type: object properties: status: title: Status type: string user_id: title: User Id type: integer reason: title: Reason type: string OrderTradeInCreateModel: title: OrderTradeInCreateModel type: object properties: year: title: Year type: integer make: title: Make type: string model: title: Model type: string trim: title: Trim type: string mileage: title: Mileage type: integer vin: title: Vin type: string identifier: title: Identifier type: string condition: $ref: '#/components/schemas/VehicleCondition' trade_in_amount: title: Trade In Amount type: number is_customer_titled: title: Is Customer Titled type: boolean loan_lease_balance: title: Loan Lease Balance type: boolean lender_contract_number: title: Lender Contract Number type: string lender_name: title: Lender Name type: string lender_address: title: Lender Address type: string lender_contact_number: title: Lender Contact Number type: string payment_type: $ref: '#/components/schemas/PaymentType' payoff_amount: title: Payoff Amount type: number lender_id: title: Lender Id type: integer description: DealerTradeIn lender id asset_image: title: Asset Image type: array items: type: string trade_in_type: $ref: '#/components/schemas/TradeInType' question_answers: title: Question Answers type: array items: $ref: '#/components/schemas/TradeInCheckList' OrderTradeInModel: title: OrderTradeInModel type: object properties: year: title: Year type: integer make: title: Make type: string model: title: Model type: string trim: title: Trim type: string mileage: title: Mileage type: integer vin: title: Vin type: string condition: $ref: '#/components/schemas/VehicleCondition' trade_in_amount: title: Trade In Amount type: number is_customer_titled: title: Is Customer Titled type: boolean loan_lease_balance: title: Loan Lease Balance type: boolean lender_contract_number: title: Lender Contract Number type: string lender_name: title: Lender Name type: string lender_address: title: Lender Address type: string lender_contact_number: title: Lender Contact Number type: string payment_type: $ref: '#/components/schemas/PaymentType' payoff_amount: title: Payoff Amount type: number order_id: title: Order Id type: integer lender_id: title: Lender Id type: integer asset_image: title: Asset Image type: array items: type: string OrderTradeInResponseModel: title: OrderTradeInResponseModel type: object properties: identifier: title: Identifier type: string year: title: Year type: integer make: title: Make type: string model: title: Model type: string trim: title: Trim type: string mileage: title: Mileage type: integer vin: title: Vin type: string condition: $ref: '#/components/schemas/VehicleCondition' trade_in_amount: title: Trade In Amount type: number is_customer_titled: title: Is Customer Titled type: boolean loan_lease_balance: title: Loan Lease Balance type: boolean lender_contract_number: title: Lender Contract Number type: string lender_name: title: Lender Name type: string lender_address: title: Lender Address type: string lender_contact_number: title: Lender Contact Number type: string payment_type: $ref: '#/components/schemas/PaymentType' payoff_amount: title: Payoff Amount type: number order_id: title: Order Id type: integer lender_id: title: Lender Id type: integer asset_image: title: Asset Image type: array items: type: string OrderWorkqueueModel: title: OrderWorkqueueModel type: object properties: identifier: title: Identifier type: string reference_number: title: Reference Number type: string name: title: Name type: string created_by: title: Created By type: string updated_at: title: Updated At type: string format: date created_at: title: Created At type: string format: date date_submitted: title: Date Submitted type: string format: date start_date: title: Start Date type: string format: date end_date: title: End Date type: string format: date status: title: Status type: string external_order_id: title: External Order Id type: string selling_price: title: Selling Price type: number down_payment: title: Down Payment type: number calculations_type: title: Calculations Type type: string introducer_identifier: title: Introducer Identifier type: string introducer_name: title: Introducer Name type: string lender_name: title: Lender Name type: string dealer_name: title: Dealer Name type: string customer_name: title: Customer Name type: string finance_type: title: Finance Type type: string product_type: title: Product Type type: string finance_amount: title: Finance Amount type: number running_id: title: Running Id type: string customer_type: title: Customer Type type: string OrderWorkqueueResponseModel: title: OrderWorkqueueResponseModel required: - results - total_results type: object properties: results: title: Results type: array items: $ref: '#/components/schemas/OrderWorkqueueModel' total_results: title: Total Results type: integer PartnerInfo: title: PartnerInfo type: object properties: full_name: title: Full Name type: string description: Partner Full Name email: title: Email type: string description: Partner Email contact_number: title: Contact Number type: string description: Partner Contact Number address: title: Address type: string description: Partner Address PaymentDetails: title: PaymentDetails type: object properties: payment_from: title: Payment From type: string description: Payment From payment_to: title: Payment To type: string description: Payment To amount: title: Amount type: string description: Payment Amount payment_type: title: Payment Type type: string description: Rate Type PaymentMethodType: title: PaymentMethodType enum: - card - ach_debit - cheque type: string description: An enumeration. PaymentOption: title: PaymentOption type: object properties: redirect_url: title: Redirect Url type: string payment_method: title: Payment Method type: string card: title: Card type: object PaymentType: title: PaymentType enum: - Lease - Finance type: string description: An enumeration. PersonalFinanceModel: title: PersonalFinanceModel required: - reference_id type: object properties: residence: title: Residence type: string description: Residence monthly_payment: title: Monthly Payment type: number description: Monthly Payment bankruptcy: title: Bankruptcy type: boolean description: Bankruptcy asset_usage: title: Asset Usage type: boolean description: Asset Usage reference_id: title: Reference Id minLength: 1 type: string description: Reference Id PersonalFinanceUpdateModel: title: PersonalFinanceUpdateModel type: object properties: residence: title: Residence minLength: 1 type: string description: Residence monthly_payment: title: Monthly Payment type: number description: Monthly Payment bankruptcy: title: Bankruptcy type: boolean description: Bankruptcy asset_usage: title: Asset Usage type: boolean description: Asset Usage PlaidLinkTokenResponseModel: title: PlaidLinkTokenResponseModel required: - link_token - expiration - request_id type: object properties: link_token: title: Link Token type: string description: Link Token expiration: title: Expiration type: string description: Expiration request_id: title: Request Id type: string description: Request Id PlateformVehicleType: title: PlateformVehicleType enum: - Car - NewCar - UsedCar - MotorBike type: string description: An enumeration. ProgramEvaluationForCalculationModel: title: ProgramEvaluationForCalculationModel required: - terms - per_unit_selling_price - dealer_id type: object properties: terms: title: Terms type: string description: Terms per_unit_selling_price: title: Per Unit Selling Price type: number description: Per Unit Asset Selling Price dealer_id: title: Dealer Id type: integer description: Dealer Id quantity: title: Quantity type: integer description: Quantity of Financed Equipment/Assets asset_make_name: title: Asset Make Name type: string description: Asset make name asset_model_name: title: Asset Model Name type: string description: Asset model name asset_trim_name: title: Asset Trim Name type: string description: Asset trim name make_name: title: Make Name type: string description: Make Name model_name: title: Model Name type: string description: Model Name trim_name: title: Trim Name type: string description: Trim Name asset_condition: title: Asset Condition type: string description: Asset Condition credit_rating_id: title: Credit Rating Id type: string description: System Generated Credit Rating Id finance_type: title: Finance Type type: string description: Finance Type asset_classification: title: Asset Classification type: string description: Asset Classification (e.g. Vehicle, Equipment etc.) annual_usage: title: Annual Usage type: integer description: Annual Usage is_rv_guaranteed: title: Is Rv Guaranteed type: string description: Is RV Guaranteed down_payment: title: Down Payment type: number description: Asset Total Down payment down_payment_paid_by_dealer: title: Down Payment Paid By Dealer type: number description: Asset Down payment paid by Dealer down_payment_paid_by_oem: title: Down Payment Paid By Oem type: number description: Asset Down payment paid by OEM options: title: Options type: array items: $ref: '#/components/schemas/OptionsRequestModel' description: Options applied on asset fees: title: Fees type: array items: $ref: '#/components/schemas/FeeRequestModel' description: Fees fni_products: title: Fni Products type: array items: $ref: '#/components/schemas/FinanceAndInsuranceRequestModel' description: F&I Products trade_in_amount: title: Trade In Amount type: number description: Trade-in amount taxes: title: Taxes type: array items: $ref: '#/components/schemas/TaxesRequestModel' description: Trade-in amount insurance: title: Insurance type: array items: $ref: '#/components/schemas/InsuranceRequestModel' description: Taxes rental_frequency: title: Rental Frequency type: string description: Rental Frequency subsidy: title: Subsidy allOf: - $ref: '#/components/schemas/SubsidyRequestModel' description: Subsidy Parameters interest_rate: title: Interest Rate type: number description: Interest Rate rental_mode: title: Rental Mode type: string description: Payment Mode residual_value: title: Residual Value type: number description: RV Value start_term: title: Start Term type: integer description: Start Term end_term: title: End Term type: integer description: End Term rental_amount: title: Rental Amount type: number description: Payment Amount is_renewal: title: Is Renewal type: boolean description: If Quotation for Renewal or New Quotation program_id: title: Program Id type: integer description: Previous Program ID structure_rentals: title: Structure Rentals type: array items: $ref: '#/components/schemas/StructureRentalModel' description: Array of Structured Rentals ProgramEvaluationParamsModel: title: ProgramEvaluationParamsModel required: - terms - per_unit_selling_price type: object properties: terms: title: Terms type: integer description: Terms per_unit_selling_price: title: Per Unit Selling Price type: number description: Per Unit Asset Selling Price dealer_id: title: Dealer Id type: integer description: System Generated Dealer Id quantity: title: Quantity type: integer description: Quantity of Financed Equipment/Assets asset_make_id: title: Asset Make Id type: integer description: System Generated Asset Make Id asset_model_id: title: Asset Model Id type: integer description: System Generated Asset Model Id asset_trim_id: title: Asset Trim Id type: integer description: System Generated Asset Trim Id make_name: title: Make Name type: string description: Make Name model_name: title: Model Name type: string description: Model Name trim_name: title: Trim Name type: string description: Trim Name asset_condition: title: Asset Condition type: string description: Asset Condition credit_rating_id: title: Credit Rating Id type: string description: System Generated Credit Rating Id finance_type: title: Finance Type type: string description: Finance Type asset_classification: title: Asset Classification type: string description: Asset Classification (e.g. Vehicle, Equipment etc.) annual_usage: title: Annual Usage type: integer description: Annual Usage is_rv_guaranteed: title: Is Rv Guaranteed type: string description: Is RV Guaranteed down_payment: title: Down Payment type: number description: Asset Total Down payment down_payment_paid_by_dealer: title: Down Payment Paid By Dealer type: number description: Asset Down payment paid by Dealer down_payment_paid_by_oem: title: Down Payment Paid By Oem type: number description: Asset Down payment paid by OEM options: title: Options type: array items: $ref: '#/components/schemas/OptionsRequestModel' description: Options applied on asset fees: title: Fees type: array items: $ref: '#/components/schemas/FeeRequestModel' description: Fees fni_products: title: Fni Products type: array items: $ref: '#/components/schemas/FinanceAndInsuranceRequestModel' description: F&I Products trade_in_amount: title: Trade In Amount type: number description: Trade-in amount taxes: title: Taxes type: array items: $ref: '#/components/schemas/TaxesRequestModel' description: Trade-in amount insurance: title: Insurance type: array items: $ref: '#/components/schemas/InsuranceRequestModel' description: Taxes rental_frequency: title: Rental Frequency type: string description: Rental Frequency subsidy: title: Subsidy allOf: - $ref: '#/components/schemas/SubsidyRequestModel' description: Subsidy Parameters interest_rate: title: Interest Rate type: number description: Interest Rate rental_mode: title: Rental Mode type: string description: Payment Mode residual_value: title: Residual Value type: number description: RV Value start_term: title: Start Term type: integer description: Start Term end_term: title: End Term type: integer description: End Term rental_amount: title: Rental Amount type: number description: Payment Amount is_renewal: title: Is Renewal type: boolean description: If Quotation for Renewal or New Quotation program_id: title: Program Id type: integer description: Previous Program ID structure_rentals: title: Structure Rentals type: array items: $ref: '#/components/schemas/StructureRentalModel' description: Array of Structured Rentals ProgramParamsModel: title: ProgramParamsModel type: object properties: terms: title: Terms type: integer description: Terms dealer_code: title: Dealer Code type: string description: Dealer Code lender_code: title: Lender Code type: string description: Lender Code company_code: title: Company Code type: string description: Company Code customer_type: title: Customer Type type: string description: Customer Type for Chart product_type: title: Product Type type: string description: Product Type For Chart asset_category: title: Asset Category type: string description: Asset Category For Chart asset_type: title: Asset Type type: string description: Asset Type For Chart business_trading_age: title: Business Trading Age type: string description: Business Trading Age For Chart make_name: title: Make Name type: string description: Make Name model_code: title: Model Code type: string description: Model Code model_name: title: Model Name type: string description: Model Name model_detail_name: title: Model Detail Name type: string description: Trim Name asset_condition: title: Asset Condition type: string description: Asset Condition credit_rating: title: Credit Rating type: string description: Credit rating finance_type: title: Finance Type type: string description: Finance Type asset_classification: title: Asset Classification type: string description: Asset Classification (e.g. Vehicle, Equipment etc.) annual_usage: title: Annual Usage type: integer description: Annual Usage is_rv_guaranteed: title: Is Rv Guaranteed type: string description: Is RV Guaranteed rental_mode: title: Rental Mode type: string description: Payment Mode rental_frequency: title: Rental Frequency type: string description: Rental Frequency available with Program retrieve_all_programs: title: Retrieve All Programs type: boolean description: Retrieve all program financed_amount: title: Financed Amount type: string description: Financed Amount vin: title: Vin type: string description: Vin Number odometer: title: Odometer type: integer description: Odometer selling_price: title: Selling Price type: integer description: Selling Price msrp: title: Msrp type: integer description: MSRF is_new: title: Is New type: boolean description: Is it new total_score: title: Total Score type: integer description: Total Score is_payment_estimator: title: Is Payment Estimator type: boolean description: Is Payment Estimator tier: title: Tier type: string description: tier ProposalAssetsModel: title: ProposalAssetsModel type: object properties: id: title: Id type: integer identifier: title: Identifier type: string category: title: Category type: string asset_type: title: Asset Type type: string asset_sub_type: title: Asset Sub Type type: string supplier_name: title: Supplier Name type: string description: title: Description type: string unit_price: title: Unit Price type: string quantity: title: Quantity type: string total: title: Total type: string age: title: Age type: number condition: title: Condition type: array items: type: string rv_balloon_amount: title: Rv Balloon Amount type: number ProposalCustomerAddressModel: title: ProposalCustomerAddressModel type: object properties: identifier: title: Identifier type: string address_line_1: title: Address Line 1 type: string address_line_2: title: Address Line 2 type: string city: title: City type: string zip_code: title: Zip Code type: string county: title: County type: string move_in_date: title: Move In Date type: string format: date-time ProposalCustomerDetails: title: ProposalCustomerDetails type: object properties: identifier: title: Identifier type: string reference_id: title: Reference Id type: string customer_type: title: Customer Type type: string first_name: title: First Name type: string last_name: title: Last Name type: string email: title: Email type: string mobile_number: title: Mobile Number type: string company_registration_number: title: Company Registration Number type: string company_name: title: Company Name type: string trading_as: title: Trading As type: string year_business_established: title: Year Business Established type: string nature_of_business: title: Nature Of Business type: string sic_code: title: Sic Code type: string id_number: title: Id Number type: string address: $ref: '#/components/schemas/ProposalCustomerAddressModel' partners: title: Partners type: array items: $ref: '#/components/schemas/CustomerPartnerDetails' customer_documents: title: Customer Documents type: array items: $ref: '#/components/schemas/CustomerProposalDocuments' ProposalDashboardAnalyticsModel: title: ProposalDashboardAnalyticsModel type: object properties: identifier: title: Identifier type: string updated_at: title: Updated At type: string format: date status: title: Status type: string name: title: Name type: string product_type: title: Product Type type: string finance_type: title: Finance Type type: string customer_name: title: Customer Name type: string introducer_name: title: Introducer Name type: string lender_name: title: Lender Name type: string dealer_name: title: Dealer Name type: string date_submitted: title: Date Submitted type: string format: date finance_amount: title: Finance Amount type: string start_date: title: Start Date type: string format: date end_date: title: End Date type: string format: date age_in_seconds: title: Age In Seconds type: string company_name: title: Company Name type: string first_name: title: First Name type: string middle_name: title: Middle Name type: string last_name: title: Last Name type: string customer_type: title: Customer Type type: string running_id: title: Running Id type: string ProposalRequestModel: title: ProposalRequestModel type: object properties: name: title: Name type: string introducer_identifier: title: Introducer Identifier type: string introducer_name: title: Introducer Name type: string dealer_id: title: Dealer Id type: integer lender_id: title: Lender Id type: integer broker_id: title: Broker Id type: integer start_date: title: Start Date type: string format: date end_date: title: End Date type: string format: date status: title: Status type: string created_by: title: Created By type: string selling_price: title: Selling Price type: number down_payment: title: Down Payment type: number estimated_monthly_payment: title: Estimated Monthly Payment type: number sum_of_advance_rentals: title: Sum Of Advance Rentals type: number no_of_advance_payments: title: No Of Advance Payments type: integer no_of_regular_payments: title: No Of Regular Payments type: integer rental_frequency: title: Rental Frequency type: string deferral_amount: title: Deferral Amount type: number rv_balloon_value: title: Rv Balloon Value type: number balloon_collection: title: Balloon Collection type: string calculations_type: title: Calculations Type type: string program_type: title: Program Type type: string product_type: title: Product Type type: string finance_type: title: Finance Type type: string finance_amount: title: Finance Amount type: number gross_profit: title: Gross Profit type: number due_at_signing: title: Due At Signing type: number comments: title: Comments type: string meta_data: title: Meta Data type: object commission_amount: title: Commission Amount type: number vat_treatment: title: Vat Treatment type: string tax_amount: title: Tax Amount type: number tax_amount_number: title: Tax Amount Number type: integer deferred_type: title: Deferred Type type: string reference_number: title: Reference Number type: string rental_mode: title: Rental Mode type: string rate_type: title: Rate Type type: string margin: title: Margin type: number commission_type: title: Commission Type type: string running_id: title: Running Id type: string non_vatable_amount: title: Non Vatable Amount type: number customer: $ref: '#/components/schemas/ProposalCustomerDetails' order_assets: title: Order Assets type: array items: $ref: '#/components/schemas/ProposalAssetsModel' order_fees: title: Order Fees type: array items: $ref: '#/components/schemas/QuickQuoteFeeModel' order_payments: title: Order Payments type: array items: $ref: '#/components/schemas/QuickQuotePaymentModel' order_stakeholders: title: Order Stakeholders type: array items: $ref: '#/components/schemas/OrderStakeholderBaseModel' order_comments: title: Order Comments type: array items: $ref: '#/components/schemas/OrderCommentsModel' ProposalResponseModel: title: ProposalResponseModel type: object properties: name: title: Name type: string introducer_identifier: title: Introducer Identifier type: string introducer_name: title: Introducer Name type: string dealer_id: title: Dealer Id type: integer lender_id: title: Lender Id type: integer broker_id: title: Broker Id type: integer start_date: title: Start Date type: string format: date end_date: title: End Date type: string format: date status: title: Status type: string created_by: title: Created By type: string selling_price: title: Selling Price type: number down_payment: title: Down Payment type: number estimated_monthly_payment: title: Estimated Monthly Payment type: number sum_of_advance_rentals: title: Sum Of Advance Rentals type: number no_of_advance_payments: title: No Of Advance Payments type: integer no_of_regular_payments: title: No Of Regular Payments type: integer rental_frequency: title: Rental Frequency type: string deferral_amount: title: Deferral Amount type: number rv_balloon_value: title: Rv Balloon Value type: number balloon_collection: title: Balloon Collection type: string calculations_type: title: Calculations Type type: string program_type: title: Program Type type: string product_type: title: Product Type type: string finance_type: title: Finance Type type: string finance_amount: title: Finance Amount type: number gross_profit: title: Gross Profit type: number due_at_signing: title: Due At Signing type: number comments: title: Comments type: string meta_data: title: Meta Data type: object commission_amount: title: Commission Amount type: number vat_treatment: title: Vat Treatment type: string tax_amount: title: Tax Amount type: number tax_amount_number: title: Tax Amount Number type: integer deferred_type: title: Deferred Type type: string reference_number: title: Reference Number type: string rental_mode: title: Rental Mode type: string rate_type: title: Rate Type type: string margin: title: Margin type: number commission_type: title: Commission Type type: string running_id: title: Running Id type: string non_vatable_amount: title: Non Vatable Amount type: number identifier: title: Identifier type: string customer: $ref: '#/components/schemas/ProposalCustomerDetails' order_assets: title: Order Assets type: array items: $ref: '#/components/schemas/ProposalAssetsModel' order_fees: title: Order Fees type: array items: $ref: '#/components/schemas/QuickQuoteFeeModel' order_payments: title: Order Payments type: array items: $ref: '#/components/schemas/QuickQuotePaymentModel' order_stakeholders: title: Order Stakeholders type: array items: $ref: '#/components/schemas/OrderStakeholderBaseModel' order_comments: title: Order Comments type: array items: $ref: '#/components/schemas/OrderCommentsModel' QuestionType: title: QuestionType enum: - YES_NO - MULTIPLE_OPTIONS description: An enumeration. QuickAssetModel: title: QuickAssetModel type: object properties: id: title: Id type: integer identifier: title: Identifier type: string vin: title: Vin type: string make: title: Make type: string model: title: Model type: string trim: title: Trim type: string year: title: Year type: string stock_number: title: Stock Number type: string asset_image: title: Asset Image type: array items: type: string asset_type: title: Asset Type type: string rv_balloon_amount: title: Rv Balloon Amount type: number QuickOrderModel: title: QuickOrderModel type: object properties: name: title: Name type: string identifier: title: Identifier type: string start_date: title: Start Date type: string format: date end_date: title: End Date type: string format: date customer_reference_id: title: Customer Reference Id type: string external_order_id: title: External Order Id type: string order_status: title: Order Status type: string created_by: title: Created By type: string selling_price: title: Selling Price type: number down_payment: title: Down Payment type: number estimated_monthly_payment: title: Estimated Monthly Payment type: number sum_of_advance_rentals: title: Sum Of Advance Rentals type: number calculations_type: title: Calculations Type type: string no_of_advance_payments: title: No Of Advance Payments type: integer no_of_regular_payments: title: No Of Regular Payments type: integer introducer_identifier: title: Introducer Identifier type: string introducer_name: title: Introducer Name type: string rental_frequency: title: Rental Frequency type: string deferral_amount: title: Deferral Amount type: number rv_balloon_value: title: Rv Balloon Value type: number balloon_collection: title: Balloon Collection type: string finance_type: title: Finance Type type: string product_type: title: Product Type type: string program_type: title: Program Type type: string finance_amount: title: Finance Amount type: number gross_profit: title: Gross Profit type: number commission_amount: title: Commission Amount type: number due_at_signing: title: Due At Signing type: number meta_data: title: Meta Data type: object comments: title: Comments type: string dealer_id: title: Dealer Id type: string broker_id: title: Broker Id type: string vat_treatment: title: Vat Treatment type: string tax_amount: title: Tax Amount type: number tax_amount_number: title: Tax Amount Number type: integer deferred_type: title: Deferred Type type: string reference_number: title: Reference Number type: string rental_mode: title: Rental Mode type: string rate_type: title: Rate Type type: string margin: title: Margin type: number commission_type: title: Commission Type type: string sum_of_fees: title: Sum Of Fees type: number sum_of_periodic_interest: title: Sum Of Periodic Interest type: number sum_of_rentals: title: Sum Of Rentals type: number total_payables: title: Total Payables type: number running_id: title: Running Id type: string non_vatable_amount: title: Non Vatable Amount type: number order_fees: title: Order Fees type: array items: $ref: '#/components/schemas/QuickQuoteFeeModel' order_payments: title: Order Payments type: array items: $ref: '#/components/schemas/QuickQuotePaymentModel' assets: title: Assets type: array items: $ref: '#/components/schemas/QuickAssetModel' QuickQuotationModel: title: QuickQuotationModel type: object properties: quote_identifiers: $ref: '#/components/schemas/QuickQuoteCustomerModel' quote_details: $ref: '#/components/schemas/QuickOrderModel' QuickQuotationResponseModel: title: QuickQuotationResponseModel type: object properties: identifier: title: Identifier type: string name: title: Name type: string start_date: title: Start Date type: string format: date end_date: title: End Date type: string format: date updated_at: title: Updated At type: string format: date external_order_id: title: External Order Id type: string status: title: Status type: string created_by: title: Created By type: string selling_price: title: Selling Price type: number down_payment: title: Down Payment type: number estimated_monthly_payment: title: Estimated Monthly Payment type: string calculations_type: title: Calculations Type type: string sum_of_advance_rentals: title: Sum Of Advance Rentals type: number no_of_advance_payments: title: No Of Advance Payments type: integer no_of_regular_payments: title: No Of Regular Payments type: integer introducer_identifier: title: Introducer Identifier type: string introducer_name: title: Introducer Name type: string rental_frequency: title: Rental Frequency type: string deferral_amount: title: Deferral Amount type: number rv_balloon_value: title: Rv Balloon Value type: number balloon_collection: title: Balloon Collection type: string finance_type: title: Finance Type type: string product_type: title: Product Type type: string finance_amount: title: Finance Amount type: number gross_profit: title: Gross Profit type: number commission_type: title: Commission Type type: string commission_amount: title: Commission Amount type: number due_at_signing: title: Due At Signing type: number meta_data: title: Meta Data type: object comments: title: Comments type: string vat_treatment: title: Vat Treatment type: string tax_amount: title: Tax Amount type: number tax_amount_number: title: Tax Amount Number type: integer deferred_type: title: Deferred Type type: string reference_number: title: Reference Number type: string rate_type: title: Rate Type type: string margin: title: Margin type: number rental_mode: title: Rental Mode type: string sum_of_fees: title: Sum Of Fees type: number sum_of_periodic_interest: title: Sum Of Periodic Interest type: number sum_of_rentals: title: Sum Of Rentals type: number total_payables: title: Total Payables type: number running_id: title: Running Id type: string broker_id: title: Broker Id type: integer non_vatable_amount: title: Non Vatable Amount type: number order_fees: title: Order Fees type: array items: $ref: '#/components/schemas/QuickQuoteFeeModel' order_payments: title: Order Payments type: array items: $ref: '#/components/schemas/QuickQuotePaymentModel' assets: title: Assets type: array items: $ref: '#/components/schemas/QuickAssetModel' order_stakeholders: title: Order Stakeholders type: array items: $ref: '#/components/schemas/OrderStakeholderBaseModel' created_at: title: Created At type: string format: date date_submitted: title: Date Submitted type: string format: date customer: $ref: '#/components/schemas/QuickQuoteCustomerModel' QuickQuoteCustomerModel: title: QuickQuoteCustomerModel type: object properties: company_name: title: Company Name type: string first_name: title: First Name type: string last_name: title: Last Name type: string mobile_number: title: Mobile Number type: string customer_type: title: Customer Type type: string identifier: title: Identifier minLength: 1 type: string email: title: Email type: string format: email reference_id: title: Reference Id type: string QuickQuoteFeeModel: title: QuickQuoteFeeModel type: object properties: id: title: Id type: integer identifier: title: Identifier type: string dealer_fee_name: title: Dealer Fee Name type: string applied_price: title: Applied Price type: number order_id: title: Order Id type: integer fee_frequency: title: Fee Frequency type: string fee_occurance: title: Fee Occurance type: string fee_first_due_date: title: Fee First Due Date type: string QuickQuotePaymentModel: title: QuickQuotePaymentModel type: object properties: identifier: title: Identifier type: string payment_number_from: title: Payment Number From type: integer payment_number_to: title: Payment Number To type: integer amount: title: Amount type: number payment_type: title: Payment Type type: string order_id: title: Order Id type: integer RebateModel: title: RebateModel required: - price type: object properties: name: title: Name type: string description: Description of the rebate price: title: Price type: number description: Price of the rebate RentalMode: title: RentalMode enum: - Advance - Arrear description: An enumeration. RentalSreamResponseModel: title: RentalSreamResponseModel type: object properties: startTerm: title: Startterm type: integer description: Start term endTerm: title: Endterm type: integer description: End term rentalAmount: title: Rentalamount type: number description: Rental amount rentalType: title: Rentaltype type: string description: Rental type total_subsidy: title: Total Subsidy type: number description: Total subsidy RequestModel: title: RequestModel type: object properties: request_type: title: Request Type type: string order_reference_number: title: Order Reference Number type: string request_status: title: Request Status type: string lender_id: title: Lender Id type: integer dealer_id: title: Dealer Id type: integer last_action_date: title: Last Action Date type: string format: date-time RequestResponseModel: title: RequestResponseModel type: object properties: request_type: title: Request Type type: string order_reference_number: title: Order Reference Number type: string request_status: title: Request Status type: string lender_id: title: Lender Id type: integer dealer_id: title: Dealer Id type: integer last_action_date: title: Last Action Date type: string format: date-time created_at: title: Created At type: string format: date-time updated_at: title: Updated At type: string format: date-time created_by: title: Created By type: string updated_by: title: Updated By type: string ResponseModel: title: ResponseModel required: - success type: object properties: success: title: Success type: boolean SendCustomerEmailModel: title: SendCustomerEmailModel required: - subject - email - email_type - dealership_name type: object properties: subject: title: Subject type: string description: Subject of Email email: title: Email type: string description: Recipient Email format: email full_name: title: Full Name type: string description: Customer full name email_type: allOf: - $ref: '#/components/schemas/SendEMailCallType' description: allowed values create_customer or create_order reference_number: title: Reference Number type: string description: Reference number dealership_name: title: Dealership Name type: string description: Dealership name SendEMailCallType: title: SendEMailCallType enum: - create_customer - create_order type: string description: An enumeration. SignatureCustomerDocument: title: SignatureCustomerDocument required: - document_url - document_name - customer_id - identifier type: object properties: document_url: title: Document Url type: string document_name: title: Document Name type: string customer_id: title: Customer Id type: string identifier: title: Identifier type: string SignerRole: title: SignerRole enum: - Dealer Admin - Applicant type: string description: An enumeration. SortByEnum: title: SortByEnum enum: - updated_at - created_at - full_name - first_name - email - date_of_birth - mobile_number - state - reference_id - license_no - identifier - order_identifier - order_status - vin - dealer_id - order_updated_at type: string description: An enumeration. SortByOrderStakeholder: title: SortByOrderStakeholder enum: - name - email - role - position type: string description: An enumeration. SortByQuickQuotation: title: SortByQuickQuotation enum: - customer_name - lender_name - dealer_name - introducer_name - name - finance_type - product_type - finance_amount - updated_at - date_submitted - start_date - end_date - statuses type: string description: An enumeration. SortEnum: title: SortEnum enum: - asc - desc type: string description: An enumeration. StatusResponseModel: title: StatusResponseModel type: object properties: dealer_id: title: Dealer Id type: integer status: title: Status type: string StipulationCategory: title: StipulationCategory enum: - STIP - NON_STIP type: string description: An enumeration. StipulationFulfillmentModel: title: StipulationFulfillmentModel type: object properties: stipulation_id: title: Stipulation Id type: string stipulation_code: title: Stipulation Code type: string document_upload: title: Document Upload type: string stipulation_type: title: Stipulation Type type: string verification_indicator: title: Verification Indicator type: boolean applied_on: title: Applied On type: string StipulationFulfillmentResponseModel: title: StipulationFulfillmentResponseModel type: object properties: stipulation_id: title: Stipulation Id type: string stipulation_code: title: Stipulation Code type: string document_upload: title: Document Upload type: string stipulation_type: title: Stipulation Type type: string verification_indicator: title: Verification Indicator type: boolean applied_on: title: Applied On type: string created_at: title: Created At type: string format: date-time updated_at: title: Updated At type: string format: date-time created_by: title: Created By type: string updated_by: title: Updated By type: string StipulationResponseModel: title: StipulationResponseModel type: object properties: stipulation_code: title: Stipulation Code type: string stipulation_type: title: Stipulation Type type: string parameter: title: Parameter type: string description: title: Description type: string document_code: title: Document Code type: string assignee: title: Assignee type: string lender_id: title: Lender Id type: integer StructureRentalModel: title: StructureRentalModel type: object properties: start_term: title: Start Term type: string end_term: title: End Term type: string rental_type: title: Rental Type type: string amount: title: Amount type: string SubsidyRequestModel: title: SubsidyRequestModel type: object properties: subsidy_calculation_method: title: Subsidy Calculation Method type: string financier_rate: title: Financier Rate type: number manufacturer_subsidy_rate: title: Manufacturer Subsidy Rate type: number dealer_subsidy_rate: title: Dealer Subsidy Rate type: number SubsidyResponseModel: title: SubsidyResponseModel type: object properties: dealer_subsidy: title: Dealer Subsidy type: number manufacturer_subsidy: title: Manufacturer Subsidy type: number total_subsidy: title: Total Subsidy type: number TagsAnlyticModel: title: TagsAnlyticModel required: - session type: object properties: session: title: Session type: string format: uuid user_id: title: User Id type: integer slug: title: Slug type: string tenant_id: title: Tenant Id type: integer dealer_name: title: Dealer Name type: string dealer_id: title: Dealer Id type: integer deal_type: title: Deal Type type: string vin: title: Vin type: string vehicle_make: title: Vehicle Make type: string vehicle_model: title: Vehicle Model type: string vehicle_status: title: Vehicle Status type: string vehicle_year: title: Vehicle Year type: string event_name: title: Event Name type: string page_type: title: Page Type type: string data: title: Data anyOf: - type: string - {} TaxesRequestModel: title: TaxesRequestModel type: object properties: tax_name: title: Tax Name type: string tax_amount: title: Tax Amount type: number amount_handling: title: Amount Handling type: string ThemeBuilderModel: title: ThemeBuilderModel required: - user_email type: object properties: id: title: Id type: integer description: Primary ID of Theme Builder stylesheet: title: Stylesheet type: string description: Stylesheet of Theme Builder Class darkmode_stylesheet: title: Darkmode Stylesheet type: string description: Darkmode Stylesheet of Theme Builder favicon: title: Favicon type: string description: favicon of Theme Builder logo: title: Logo type: string description: logo of Theme Builder user_email: title: User Email type: string description: Email of logged in user format: email ThemeBuilderPatchModel: title: ThemeBuilderPatchModel type: object properties: id: title: Id type: integer description: Primary ID of Theme Builder stylesheet: title: Stylesheet type: string description: Stylesheet of Theme Builder Class darkmode_stylesheet: title: Darkmode Stylesheet type: string description: Darkmode Stylesheet of Theme Builder favicon: title: Favicon type: string description: favicon of Theme Builder logo: title: Logo type: string description: logo of Theme Builder TradeIn: title: TradeIn type: object properties: trade_in_type: title: Trade In Type type: string description: Trade In Type vin: title: Vin type: string description: VIN offer_amount: title: Offer Amount type: number description: Offer Amount pay_off_amount: title: Pay Off Amount type: number description: Pay Off Amount allowance_amount: title: Allowance Amount type: number description: Actual Cash Value TradeInCheckList: title: TradeInCheckList type: object properties: question: title: Question type: string answer: title: Answer type: string trade_in_id: title: Trade In Id type: integer TradeInDecodeVin: title: TradeInDecodeVin type: object properties: platform_vehicle_type: $ref: '#/components/schemas/PlateformVehicleType' vin: title: Vin type: string default: '' option_filter: $ref: '#/components/schemas/OptionFilterType' TradeInInspectionStatus: title: TradeInInspectionStatus enum: - Pending - Completed description: An enumeration. TradeInMake: title: TradeInMake type: object properties: make_id: title: Make Id type: integer default: 0 year_id: title: Year Id type: integer default: 0 start_year: title: Start Year type: integer default: 0 end_year: title: End Year type: integer default: 0 category_id: title: Category Id type: integer default: 0 platform_vehicle_type: $ref: '#/components/schemas/PlateformVehicleType' TradeInModel: title: TradeInModel type: object properties: make_id: title: Make Id type: integer default: 0 year_id: title: Year Id type: integer default: 0 start_year: title: Start Year type: integer default: 0 end_year: title: End Year type: integer default: 0 category_id: title: Category Id type: integer default: 0 model_id: title: Model Id type: integer default: 0 make_name: title: Make Name type: string default: '' platform_vehicle_type: $ref: '#/components/schemas/PlateformVehicleType' TradeInOptions: title: TradeInOptions required: - platform_vehicle_type type: object properties: platform_vehicle_type: title: Platform Vehicle Type type: string options_filter: $ref: '#/components/schemas/TradeInOptionsFilter' TradeInOptionsFilter: title: TradeInOptionsFilter type: object properties: vehicleId: title: Vehicleid type: integer default: 0 yearId: title: Yearid type: integer default: 0 makeId: title: Makeid type: integer default: 0 modelId: title: Modelid type: integer default: 0 trimId: title: Trimid type: integer default: 0 TradeInTrim: title: TradeInTrim type: object properties: trim_id: title: Trim Id type: integer default: 0 year_id: title: Year Id type: integer default: 0 make_id: title: Make Id type: integer default: 0 model_id: title: Model Id type: integer default: 0 model_year_id: title: Model Year Id type: string default: '' platform_vehicle_type: $ref: '#/components/schemas/PlateformVehicleType' TradeInType: title: TradeInType enum: - Manual Estimate - Make Model - Vin - License Plate type: string description: An enumeration. TradeInVehicleDetail: title: TradeInVehicleDetail type: object properties: platform_vehicle_type: $ref: '#/components/schemas/PlateformVehicleType' vehicle_id: title: Vehicle Id type: integer default: 0 year_id: title: Year Id type: integer default: 0 make_id: title: Make Id type: integer default: 0 model_year_id: title: Model Year Id type: integer default: 0 model_id: title: Model Id type: integer default: 0 trim_id: title: Trim Id type: integer default: 0 make_name: title: Make Name type: string default: '' model_name: title: Model Name type: string default: '' TradeInVehicleValue: title: TradeInVehicleValue type: object properties: vehicle_id: title: Vehicle Id type: integer default: 0 odometer: title: Odometer type: integer default: 0 zip_code: title: Zip Code type: string default: '' vehicle_option_id: title: Vehicle Option Id type: array items: $ref: '#/components/schemas/VehicleOption' default: [] start_year: title: Start Year type: integer default: 0 end_year: title: End Year type: integer default: 0 model_id: title: Model Id type: integer default: 0 TradeInYear: title: TradeInYear type: object properties: make_id: title: Make Id type: integer default: 0 make_name: title: Make Name type: string default: '' model_id: title: Model Id type: integer default: 0 model_name: title: Model Name type: string default: '' platform_vehicle_type: $ref: '#/components/schemas/PlateformVehicleType' UnderWriterCommentsModel: title: UnderWriterCommentsModel type: object properties: category: $ref: '#/components/schemas/CommentDiaryCategory' comment: title: Comment type: string created_by: title: Created By type: string UpdateAppointmentModel: title: UpdateAppointmentModel required: - id - appointment_date type: object properties: id: title: Id type: integer order_id: title: Order Id type: integer dealer_id: title: Dealer Id type: integer customer_id: title: Customer Id type: integer appointment_date: title: Appointment Date type: string format: date-time time_zone: title: Time Zone type: string appointment_type: title: Appointment Type type: string appointment_status: title: Appointment Status type: string comments: title: Comments type: string address_id: title: Address Id type: integer dealer_code: title: Dealer Code type: string address_data: $ref: '#/components/schemas/CustomerAddressWithId' created_by: title: Created By type: string updated_by: title: Updated By type: string UpdateProposalStatusRequestModel: title: UpdateProposalStatusRequestModel required: - identifier - current_status - next_status type: object properties: identifier: title: Identifier type: string current_status: $ref: '#/components/schemas/OrderProposalStatus' next_status: $ref: '#/components/schemas/OrderProposalStatus' created_by: title: Created By type: string created_at: title: Created At type: string updated_at: title: Updated At type: string comment_data: $ref: '#/components/schemas/OrderCommentsModel' UpdateQuickOrderModel: title: UpdateQuickOrderModel type: object properties: name: title: Name type: string identifier: title: Identifier type: string start_date: title: Start Date type: string format: date end_date: title: End Date type: string format: date customer_reference_id: title: Customer Reference Id type: string external_order_id: title: External Order Id type: string order_status: title: Order Status type: string created_by: title: Created By type: string selling_price: title: Selling Price type: number down_payment: title: Down Payment type: number estimated_monthly_payment: title: Estimated Monthly Payment type: number sum_of_advance_rentals: title: Sum Of Advance Rentals type: number calculations_type: title: Calculations Type type: string no_of_advance_payments: title: No Of Advance Payments type: integer no_of_regular_payments: title: No Of Regular Payments type: integer introducer_identifier: title: Introducer Identifier type: string introducer_name: title: Introducer Name type: string rental_frequency: title: Rental Frequency type: string deferral_amount: title: Deferral Amount type: number rv_balloon_value: title: Rv Balloon Value type: number balloon_collection: title: Balloon Collection type: string finance_type: title: Finance Type type: string product_type: title: Product Type type: string program_type: title: Program Type type: string finance_amount: title: Finance Amount type: number gross_profit: title: Gross Profit type: number commission_amount: title: Commission Amount type: number due_at_signing: title: Due At Signing type: number meta_data: title: Meta Data type: object comments: title: Comments type: string dealer_id: title: Dealer Id type: string broker_id: title: Broker Id type: string vat_treatment: title: Vat Treatment type: string tax_amount: title: Tax Amount type: number tax_amount_number: title: Tax Amount Number type: integer deferred_type: title: Deferred Type type: string reference_number: title: Reference Number type: string rental_mode: title: Rental Mode type: string rate_type: title: Rate Type type: string margin: title: Margin type: number commission_type: title: Commission Type type: string sum_of_fees: title: Sum Of Fees type: number sum_of_periodic_interest: title: Sum Of Periodic Interest type: number sum_of_rentals: title: Sum Of Rentals type: number total_payables: title: Total Payables type: number running_id: title: Running Id type: string non_vatable_amount: title: Non Vatable Amount type: number order_fees: title: Order Fees type: array items: $ref: '#/components/schemas/QuickQuoteFeeModel' order_payments: title: Order Payments type: array items: $ref: '#/components/schemas/QuickQuotePaymentModel' assets: title: Assets type: array items: $ref: '#/components/schemas/QuickAssetModel' updated_by: title: Updated By type: string customer: $ref: '#/components/schemas/QuickQuoteCustomerModel' UploadFile: title: UploadFile required: - file - file_name - content_type type: object properties: file: title: File type: string file_name: title: File Name type: string content_type: title: Content Type type: string ValidationError: title: ValidationError required: - loc - msg - type type: object properties: loc: title: Location type: array items: anyOf: - type: string - type: integer msg: title: Message type: string type: title: Error Type type: string Vehicle: title: Vehicle required: - vin - odometer_mileage - msrp type: object properties: vin: title: Vin type: string description: VIN is_new: title: Is New type: boolean description: Is New odometer_mileage: title: Odometer Mileage type: integer description: Odometer msrp: title: Msrp type: number description: MSRP year: title: Year type: integer description: Year transmission_type: title: Transmission Type type: string description: Transmission Type VehicleCondition: title: VehicleCondition enum: - Fair - Good - Very Good - Excellent type: string description: An enumeration. VehicleOption: title: VehicleOption required: - vehicleOptionId type: object properties: vehicleOptionId: title: Vehicleoptionid type: integer VehicleValuationProviders: title: VehicleValuationProviders enum: - KBB - JDPower type: string description: An enumeration. WorkqueueModel: title: WorkqueueModel required: - order_id - dealer_id - request_type type: object properties: order_id: title: Order Id type: integer dealer_id: title: Dealer Id type: integer request_type: title: Request Type type: string expired_at: title: Expired At type: string format: date-time libdms__appointment_models__CreateAppointmentModel: title: CreateAppointmentModel required: - appointment_date type: object properties: order_id: title: Order Id type: integer dealer_id: title: Dealer Id type: integer customer_id: title: Customer Id type: integer appointment_date: title: Appointment Date type: string format: date-time time_zone: title: Time Zone type: string appointment_type: title: Appointment Type type: string appointment_status: title: Appointment Status type: string comments: title: Comments type: string address_id: title: Address Id type: integer dealer_code: title: Dealer Code type: string address_data: $ref: '#/components/schemas/CustomerAddressWithId' created_by: title: Created By type: string updated_by: title: Updated By type: string libdms__models__CreateAppointmentModel: title: CreateAppointmentModel type: object properties: id: title: Id type: integer order_id: title: Order Id type: integer dealer_id: title: Dealer Id type: integer customer_id: title: Customer Id type: integer appointment_date: title: Appointment Date type: string format: date-time appointment_type: title: Appointment Type type: string appointment_status: title: Appointment Status type: string comments: title: Comments type: string address_id: title: Address Id type: integer dealer_code: title: Dealer Code type: string address_data: $ref: '#/components/schemas/CustomerAddressWithId' created_by: title: Created By type: string updated_by: title: Updated By type: string time_zone: title: Time Zone type: string submitOrderRequest: title: submitOrderRequest required: - lender_ids type: object properties: lender_ids: title: Lender Ids type: array items: type: integer description: list of lender ids the order will be submitted to securitySchemes: APIKeyHeader: type: apiKey in: header name: X-Api-Key OAuth2PasswordBearer: type: oauth2 flows: password: scopes: {} tokenUrl: /signup/verify-otp