API Doc Version 1.3.45

What's New

GET /config/sentry-debug

Trigger Error

GET /config/health

Health

GET /config/version

Version

POST /config/asset-list-import/{tenant_id}

Imports Asset Catalogue Files data into database

GET /config/asset-make/filter

Get asset make paginated data

GET /config/asset-make

Get all asset make records

POST /config/asset-make

Creates Asset Make

GET /config/asset-make/{make_id}

Get Asset Make Record

DELETE /config/asset-make/{make_id}

Delete Asset Make

PATCH /config/asset-make/{make_id}

Updates Asset Make

GET /config/asset-make/make_code/{make_code}

Check Asset Make Record

GET /config/asset-model

Get all asset model records

POST /config/asset-model

Creates Asset Model

GET /config/asset-model/{asset_model_id}

Get asset model Record

DELETE /config/asset-model/{asset_model_id}

Delete Asset Model

GET /config/asset-model/by-name/{model_name}

Get asset model Record

PATCH /config/asset-model/{model_id}

Updates Asset Model

GET /config/asset-model/model_code/{model_code}

Check Asset Model Record

GET /config/asset-trim

Get all asset trim records

POST /config/asset-trim

Creates Asset Trim

GET /config/asset-trim/{trim_id}

Get Asset Trim Record

DELETE /config/asset-trim/{trim_id}

Delete Asset Trim

PATCH /config/asset-trim/{trim_id}

Updates Asset Trim

GET /config/asset-model-trim

Get all asset models along with trim records

GET /config/asset-trim/trim_code/{trim_code}

Check Asset Trim Record

GET /config/asset-condition-test/filter

Get asset condition data

GET /config/asset-conditions

Get all asset condition records

POST /config/asset-conditions

Creates Asset Condition

GET /config/asset-conditions/{asset_condition_id}

Get Asset Condition Record

DELETE /config/asset-conditions/{asset_condition_id}

Delete Asset Condition

PATCH /config/asset-conditions/{asset_condition_id}

Updates Asset Condition

GET /config/asset-condition/active

Get active asset condition records

GET /config/asset-conditions/code/{code}

Asset Condition Code Duplicate Exist

GET /config/asset-data/filter

Get asset data

GET /config/asset-usage/filter

Get asset usage data

GET /config/asset-usages

Get all asset usage records

POST /config/asset-usages

Creates Asset Usage

GET /config/asset-usages/{asset_usage_id}

Get Asset usage Record

DELETE /config/asset-usages/{asset_usage_id}

Delete Asset usage

PATCH /config/asset-usages/{asset_usage_id}

Updates Asset usage

GET /config/asset-usage/active

Get active asset usage records

GET /config/asset-usages/code/{code}

Check Asset usage Code Exist

GET /config/get_asset/by_name

Get Asset Make Record

POST /config/lender/create-lender

Creates a lender record

GET /config/lender

Get all lender records

GET /config/lender/{lender_id}

Get a lender record by Id

DELETE /config/lender/{lender_id}

Deletes a lender record

PATCH /config/lender/update-lender/{lender_id}

Updates a lender record

GET /config/configured_lenders

Get all configured lenders records

GET /config/all-lenders/filter

Get Lenders paginated records

GET /config/default/lender

Get default lender record

POST /config/import/dealer-lenders/

Get default lender record

GET /config/lender/dealer-lenders/{dealer_code}

Get all lender records

GET /config/company-lender

Get company lender record

GET /config/all-company-lenders

Get company lender record

POST /config/lender/default-configurations

Create default configurations for third-party lenders

GET /config/lender/default-configurations/{provider_id}/{dealer_code}

Retrieve default configurations for third-party lenders

PATCH /config/lender/default-configurations/{default_lender_config_id}

Update default configurations for third-party lenders

GET /config/check-s3-credentials/{tenant_id}

Check Tenant has added S3 credential

POST /config/company/create-company

Creates a company record

GET /config/company

Get all company records

POST /config/company

Creates a company with tenant id

GET /config/company_by_api_key

Get a company record

GET /config/company/{company_id}

Get a company record by Id

DELETE /config/company/{company_id}

Deletes a company record

PATCH /config/company/{company_id}

Updates a company record

GET /config/company/by-tenant-id/{tenant_id}

Get a company record by Tenant id

GET /config/company/by-tenant-slug/{slug}

Get a company record by company Slug

PATCH /config/company/update-company/{company_id}

Updates a company record

GET /config/currencies

Get currencies records

DELETE /config/address/{address_id}

Deletes company address record

PATCH /config/get-api-key-by-token/{token}

Get Api Key By Token

GET /config/documents

Get all documents of a company

GET /config/check-slug/slug

check unique slug

PATCH /config/company/update-company-pricing/{company_id}

Updates a company pricing record

POST /config/finance-customer-setup

Create initial FinanceType and CustomerType data

GET /config/company/by-tenant-domain/{domain}

Get a company record by company domain name

PATCH /config/company/update/email-status

Update company's correspondence email status

GET /config/company/lender-selection-rules/

Get all Company Lender Selection Rules

POST /config/company/lender-selection-rules

Add Lender Selection Rule

PATCH /config/company/update/lender-selection-rules

Update Lender Selection Rule

DELETE /config/company/lender-selection-rules/{rule_id}

Delete Lender Selection Rule

POST /config/company/lender-selection-rules/evaluate

Evaluate Lender Selection Rule

GET /config/charts

Get all charts

POST /config/charts

Creates a chart record

GET /config/interest-chart/filter

Get all pagination interest-chart records

GET /config/charts/{chart_id}

Get chart by Id

DELETE /config/charts/{chart_id}

Deletes a chart record

PATCH /config/charts/{chart_id}

Updates a chart record

GET /config/interest-chart

Get all interest rate charts

POST /config/interest-chart

Creates a interest rate chart record

GET /config/interest-chart/{interest_chart_id}

Get interest rate chart record by Id

DELETE /config/interest-chart/{interest_chart_id}

Deletes a interest chart record

PATCH /config/interest-chart/{interest_chart_id}

Updates a interest chart record

GET /config/rv-chart

Get all RV chart records

POST /config/rv-chart

Creates a RV chart record

GET /config/rv-chart/filter

Get paginated charts records

GET /config/rv-chart/{rv_chart_id}

Get a single RV Chart record

DELETE /config/rv-chart/{rv_chart_id}

Deletes a RV chart record

PATCH /config/rv-chart/{rv_chart_id}

Updates a RV chart record

POST /config/rv-evaluate

RV chart evaluation

POST /config/interest-chart-evaluate

Interest rate chart evaluation

POST /config/subsidy-chart-evaluate

Subsidy chart evaluation

POST /config/base-rate-chart-evaluate

Base chart evaluation

POST /config/interest-chart/criteria

Creates a interest rate chart criteria

POST /config/rv-chart/criteria

Creates a RV chart criteria

POST /config/down-payment/criteria

Creates a Down Payment chart criteria

POST /config/commissions/criteria

Creates a Commission chart criteria

POST /config/subsidy/criteria

Creates a Subsidy chart criteria

GET /config/interest-charts/name

This method returns name of Chart if duplication of name exists

GET /config/rv-charts/name

This method returns name of Chart if duplication of name exists

GET /config/chart/name

This method returns name of Chart if duplication of name exists

GET /config/chart/type

Checks criteria attached to subsidy chart

GET /config/down-payment/filter

Get all pagination down payment records

GET /config/down-payment

Get all down payment charts

POST /config/down-payment

Creates a down payment chart record

GET /config/down-payment/{down_payment_id}

Get down payment chart record by Id

DELETE /config/down-payment/{down_payment_id}

Deletes a down payment chart record

PATCH /config/down-payment/{down_payment_id}

Updates a down payment chart record

GET /config/commissions/filter

Get all pagination commission records

GET /config/commissions

Get all commission charts

POST /config/commissions

Creates a commission chart record

GET /config/commissions/{commission_id}

Get commission chart record by Id

DELETE /config/commissions/{commission_id}

Deletes a commission chart record

PATCH /config/commissions/{commission_id}

Updates a commission chart record

GET /config/subsidy/filter

Get all pagination subsidy records

GET /config/subsidy

Get all subsidy charts

POST /config/subsidy

Creates a subsidy chart record

GET /config/subsidy/{subsidy_id}

Get subsidy chart record by Id

DELETE /config/subsidy/{subsidy_id}

Deletes a subsidy chart record

PATCH /config/subsidy/{subsidy_id}

Updates a subsidy chart record

POST /config/charts/base_rate/

Creates a chart record

GET /config/charts/filter/

Get all charts

DELETE /config/charts/base_rate/{base_rate_chart_id}

Deletes a chart record

PATCH /config/charts/base_rate/{base_rate_chart_id}

Updates a chart record

POST /config/down-payment-chart-evaluate

Down Payment chart evaluation

POST /config/commission-chart-evaluate

Commission chart evaluation

POST /config/fees-chart/criteria

Creates a Fees chart criteria

GET /config/fees-chart/name

This method returns name of Chart if duplication of name exists

GET /config/fees-chart

Get all Fees Chart Criteria

POST /config/fees-chart

Add a Fees Chart Criteiria

GET /config/fees-chart/{fees_chart_id}

Get a Fees Chart Criteria by id

DELETE /config/fees-chart/{fees_chart_id}

Deletes a Fees Chart Criteria

PATCH /config/fees-chart/{fees_chart_id}

Updates a Fees Chart Criteria

GET /config/fees-chart/paginated/filter

Get all pagination fees records

POST /config/fee-chart-evaluate

Fee chart evaluation

GET /config/financial-product/filter

Get paginated financial product management records

GET /config/financial-product/{financial_product_id}

Get financial product management by Id

PATCH /config/financial-product/{financial_product_id}

Updates a financial product management record

POST /config/financial-product/create-fp

Creates a custom financial product

PATCH /config/financial-product/update-fp/{custom_financial_product_id}

Updates a custom financial product record

GET /config/financial-product/name/{name}

Get duplicate name records

GET /config/financial-product/code/{code}

Get duplicate code records

GET /config/document-type

Gets a document type

POST /config/document-type

Creates a document type

GET /config/document-type/{is_stipulation}

Gets a document type

GET /config/document-type/filter/

Get paginated document type records

GET /config/document-type/{document_type_id}

Get document type by Id

DELETE /config/document-type/{document_type_id}

Deletes a document type record

PATCH /config/document-type/{document_type_id}

Updates a document type record

GET /config/business-units

Gets a business units

POST /config/business-units

Creates a business units

GET /config/business-units/filter

Get paginated business units records

GET /config/business-units/{business_units_id}

Get business units by Id

DELETE /config/business-units/{business_units_id}

Deletes a business units record

PATCH /config/business-units/{business_units_id}

Updates a business units record

GET /config/other-costs

Gets other costs

POST /config/other-costs

Creates other costs

GET /config/other-costs/filter

Get paginated other costs records

GET /config/other-costs/{other_costs_id}

Get other costs by Id

DELETE /config/other-costs/{other_costs_id}

Deletes a other costs record

PATCH /config/other-costs/{other_costs_id}

Updates a other costs record

GET /config/terms

Get terms record

POST /config/terms

Creates a term record

GET /config/term/active

Get terms record

GET /config/terms/{term_id}

Get terms by Id

DELETE /config/terms/{term_id}

Deletes a terms record

PATCH /config/terms/{term_id}

Updates a terms record

GET /config/term/filter

Get paginated terms record

GET /config/state

Get all states

GET /config/credit-ratings

Get all credit ratings record

POST /config/credit-ratings

Creates a credit rating record

GET /config/credit-ratings/filter

Get paginated credit rating records

GET /config/credit-rating/active

Get all credit ratings record

GET /config/credit-ratings/{credit_rating_id}

Get credit ratings by Id

DELETE /config/credit-ratings/{credit_rating_id}

Deletes a credit rating record

PATCH /config/credit-ratings/{credit_rating_id}

Updates credit rating record

GET /config/annual-mileage

Get annual mileage records

POST /config/annual-mileage

Creates annual mileage record

GET /config/annual-mileage/filter

Get paginated annual mileage records

GET /config/annual-mileage/active

Get annual mileage records

GET /config/annual-mileage/{annual_mileage_id}

Get annual mileage by Id

DELETE /config/annual-mileage/{annual_mileage_id}

Deletes annual mileage record

PATCH /config/annual-mileage/{annual_mileage_id}

Updates annual mileage record

GET /config/Financed-Amount

Get financed amount records

POST /config/Financed-Amount

Creates financed amount record

GET /config/Financed-Amount/filter

Get paginated financed amount records

GET /config/Financed-Amount/active

Get annual mileage records

GET /config/Financed-Amount/{financed_amount_id}

Get financed amount by Id

DELETE /config/Financed-Amount/{financed_amount_id}

Deletes financed amount record

PATCH /config/Financed-Amount/{financed_amount_id}

Updates financed amount record

GET /config/fee-names

Get Fee Name records

POST /config/fee-names

Creates Fee Name record

GET /config/fee-names/{fee_name_id}

Get fee name by Id

DELETE /config/fee-names/{fee_name_id}

Deletes a fee name record

PATCH /config/fee-names/{fee_name_id}

Updates a fee name record

GET /config/fee-name/filter

Get paginated fee names

GET /config/master-list-accessories

Get master list accessory records

POST /config/master-list-accessories

Creates master list accessory record

GET /config/master-list-accessorie/filter

Get paginated master list accessory records

GET /config/master-list-accessories/{masteraccessory_id}

Get master list accessory record by Id

DELETE /config/master-list-accessories/{masteraccessory_id}

Deletes a master list accessory record

PATCH /config/master-list-accessories/{masteraccessory_id}

Updates a master list accessory record

POST /config/contract-term/create-contract-term

Creates a contract term record

GET /config/contract-term/{contract_term_id}

Get a contract term record by Id

DELETE /config/contract-term/{contract_term_id}

Deletes a contract term record

PATCH /config/contract-term/{contract_term_id}

Updates a contract term record

GET /config/contract-term/filter

Get paginated contract term records

GET /config/contract-term/active

Get all active contract term records

GET /config/contract-term

Get all contract term records

GET /config/option-category

Get option category records

POST /config/option-category

Creates an option category record

GET /config/option-category/active

Get option category records

GET /config/option-category/{option_category_id}

Get option category by Id

DELETE /config/option-category/{option_category_id}

Deletes an option category record

PATCH /config/option-category/{option_category_id}

Updates an option category record

GET /config/option-category/filter/

Get paginated option category records

GET /config/contract-allowed-annum-mileage/filter

Get paginated contract allowed annum mileage records

GET /config/contract-allowed-annum-mileage

Get contract allowed annum mileage records

POST /config/contract-allowed-annum-mileage

Creates a contract allowed annum mileage record

GET /config/contract-allowed-annum-mileage/{contract_allowed_annum_mileage_id}

Get contract allowed annum mileage by Id

DELETE /config/contract-allowed-annum-mileage/{contract_allowed_annum_mileage_id}

Deletes a contract allowed annum mileage record

PATCH /config/contract-allowed-annum-mileage/{contract_allowed_annum_mileage_id}

Updates contract allowed annum mileage record

GET /config/contract-allowed-annum-mileage/active

Get all active contract allowed annum mileage records

GET /config/decision_status

Get decision status records

POST /config/decision_status

Creates a decision status record

GET /config/decision_status/{decision_status_id}

Get decision status by Id

DELETE /config/decision_status/{decision_status_id}

Deletes a decision status record

PATCH /config/decision_status/{decision_status_id}

Updates a decision status record

GET /config/decision_statuses/filter

Get paginated decision status records

GET /config/status-flags/{status_flag_id}

Get status flag by Id

GET /config/status-flags

Gets all status flag

POST /config/status-flags

Creates a status flag

DELETE /config/status-flags/{status_flags_id}

Deletes a status flag record

PATCH /config/status-flags/{status_flags_id}

Updates a status flag record

GET /config/dairy-category/{dairy_category_id}

Get Diary Category by Id

DELETE /config/dairy-category/{dairy_category_id}

Deletes a Diary Category record

PATCH /config/dairy-category/{dairy_category_id}

Updates a Diary Category record

GET /config/dairy-category

Gets all Diary Category

POST /config/dairy-category

Creates a Diary Category

GET /config/prefix

Gets all prefix

POST /config/prefix

Creates a prefix

GET /config/prefix/{prefix_identifier}

Get prefix by Identifier

DELETE /config/prefix/{prefix_identifier}

Deletes a prefix record

PATCH /config/prefix/{prefix_identifier}

Updates a prefix record

GET /config/address-category

Gets all address category

GET /config/address_category/{address_category_identifier}

Get address category by Identifier

DELETE /config/address_category/{address_category_identifier}

Deletes a address category record

PATCH /config/address_category/{address_category_identifier}

Updates a address category record

POST /config/address_category

Creates a address category

GET /config/event

Gets all events

POST /config/event

Creates an event record

GET /config/event/{event_id}

Get event type by Id

DELETE /config/event/{event_id}

Deletes an event record

PATCH /config/event/{event_id}

Updates an event record

GET /config/reason

Gets all reasons

POST /config/reason

Creates a reason

GET /config/reason/filter

Get all reasons by type

GET /config/reason/{reason_id}

Get reason by Id

DELETE /config/reason/{reason_id}

Deletes a reason

PATCH /config/reason/{reason_id}

Updates a reason

GET /config/odometer

Get odometer variance threshold value by Id

GET /config/get-all-languages

Get all Languages

GET /config/get-active-languages

Get active Languages

GET /config/get-tenant-languages

Get all Languages

GET /config/get-tenant-languages/{slug}

This method returns tenant languages by slug

GET /config/get-lender-languages-and-translations/filter

Get filtered lender languages and translations

GET /config/get-lender-languages-and-translations

Get lender languages and translations

PATCH /config/lender-language

Add or Update Tenant Language

POST /config/lender-placeholder-add-new-tenant-translations

Add Translations For New Tenant

PATCH /config/lender-placeholder-and-translations

Add or Update Translations

DELETE /config/lender-placeholder/{placeholder_id}

Deletes a placeholder record

DELETE /config/lender-language/{language_id}

Delete lender language

POST /config/radius/create-radius

Creates a radius record

GET /config/radius/{radius_id}

Get a radius record by Id

DELETE /config/radius/{radius_id}

Deletes a radius record

PATCH /config/radius/{radius_id}

Updates a radius record

GET /config/radius

Get all radius records

GET /config/stationery

Get stationery records

POST /config/stationery

Creates a new stationery record

GET /config/stationery/type/{stationery_type}/{stationery_event}

Get stationery records by type & event

GET /config/stationery/{stationery_id}

Get stationery by Id

DELETE /config/stationery/{stationery_id}

Deletes a stationery record

PATCH /config/stationery/{stationery_id}

Updates a stationery record

GET /config/stationery/filter/

Get paginated stationery records

GET /config/stationery/get_documents/

Get paginated stationery records

GET /config/comments-categories

Get all comments categories records

POST /config/comments-categories

Creates Comments Categories

GET /config/comments-categories/{comments_categories_id}

Get Comments Categories Record

PATCH /config/comments-categories/{comments_categories_id}

Updates Comments Categories

DELETE /config/comments-categories/{comments_categorie_id}

Delete Comments Categories

GET /config/customer-type

Get all customer type records

POST /config/customer-type

Creates Customer Type setup

GET /config/customer-type/{customer_type_id}

Get Customer Type Setup Record

DELETE /config/customer-type/{customer_type_id}

Delete Customer Type Setup Record

PATCH /config/customer-type/{customer_type_id}

Updates Customer Type Setup

GET /config/base-rate-source

Get base rate source setup records

POST /config/base-rate-source

Create new base rate source setup

GET /config/base-rate-source/{base_rate_source_id}

Get Base Rate Source setup by Id

DELETE /config/base-rate-source/{base_rate_source_id}

Deletes a BaseRateSource setup record

PATCH /config/base-rate-source/{base_rate_source_id}

Update the baseratesource setup

GET /config/business-trading-age

Get Business Trading Age records

POST /config/business-trading-age

Creates a business trading age record

GET /config/business-trading-age/filter

Get paginated business trading age records

GET /config/business-trading-age/active

Get all active trading age records

GET /config/business-trading-age/{trading_age_id}

Get trading age by Id

DELETE /config/business-trading-age/{trading_age_id}

Deletes trading age record

PATCH /config/business-trading-age/{trading_age_id}

Updates trading age record

GET /config/pre-qualification

Get Pre Qualification records

POST /config/pre-qualification

Creates a Pre-Qualification setup record

GET /config/pre-qualification/filter

Get paginated pre-qualification setup records

GET /config/pre-qualification/active

Get all active pre-qualification records

GET /config/pre-qualification/{pre_qualification_id}

Get Pre Qualification by Id

DELETE /config/pre-qualification/{pre_qualification_id}

Deletes pre-qualification record

PATCH /config/pre-qualification/{pre_qualification_id}

Updates trading age record

GET /config/insurance-companies

Get All Insurance Companies records

POST /config/insurance-companies

Creates a Insurance Companies record

GET /config/insurance-companies/active

Get all active Insurance Companies records

DELETE /config/insurance-companies/{insurance_companies_id}

Deletes Insurance Companies record

PATCH /config/insurance-companies/{insurance_companies_id}

Updates Insurance Companies record

GET /config/appointment-type

Get all appointment Type records

POST /config/appointment-type

Creates a appointment type

DELETE /config/appointment-type/{appointment_type_id}

Deletes a appointment Type

PATCH /config/appointment-type/{appointment_type_id}

Update appointment Type record

GET /config/time-slot-interval

Get all TimeSlot interval records

POST /config/time-slot-interval

Creates a TimeSlot interval

DELETE /config/time-slot-interval/{time_slot_interval_id}

Deletes a TimeSlot interval record

PATCH /config/time-slot-interval/{time_slot_interval_id}

Update TimeSlot interval record

POST /config/default-language

Get active Languages

DELETE /config/default-language/{language_name}

Get active Languages

POST /config/stipulation

Creates a stipulation record

GET /config/stipulation/

Get all stipulation records

GET /config/stipulation/filter

Get all pagination stipulation records

GET /config/stipulation/{stipulation_id}

Get stipulation record by its Id

DELETE /config/stipulation/{stipulation_id}

Deletes a stipulation record

PATCH /config/stipulation/{stipulation_id}

Updates a stipulation record

POST /config/stipulation-reason

Creates a stipulation Reason

GET /config/stipulation-reason/{document_type_name}/{review_status}

Get Stipulation by Reason Status

DELETE /config/stipulation-reason/{stipulation_reason_id}

Delete Stipulation Reason

POST /config/programs/all/

Program evaluation response

POST /config/programs/permutation/

Create permutation in case of multiple criteria

POST /config/programs/multi-quote/

Retrieve all evaluated programs into a single response

GET /config/dealer/option

Get all the dealer option accessory records

POST /config/dealer/option

Creates dealer option accessory

GET /config/dealer/option/filter

Get dealer option accessory records

GET /config/dealers/preferred/accessories

Get the count of dealer preferred accessories

GET /config/dealer/option-model-name

Get dealer option accessory record provided by dealer code

GET /config/dealer/option/{option_id}

Get dealer option accessory record provided by dealer option accessory Id

DELETE /config/dealer/option/{option_id}

Deletes dealer option accessory record

PATCH /config/dealer/option/{option_id}

Updates dealer option category record

GET /config/dealer/fee

Get all the dealer fee records

POST /config/dealer/fee

Creates a dealer fee

GET /config/dealer/fee/dealer-code/{dealer_code}

Get dealer fee record provided by dealer Code

GET /config/dealer/{dealer_code}/fees

Get fees by dealer

GET /config/dealer/fee/{fee_id}

Get dealer fee record provided by fee Id

DELETE /config/dealer/fee/{fee_id}

Deletes a dealer fee record

PATCH /config/dealer/fee/{fee_id}

Updates a dealer fee record

GET /config/dealer/profile

Get all the dealer profile records

POST /config/dealer/profile

Creates a dealer profile

DELETE /config/dealer/profile/{dealer_profile_id}

Deletes a dealer profile record

PATCH /config/dealer/profile/{dealer_profile_id}

Updates a dealer profile record by dealer profile Id

PATCH /config/dealer/profile/pen-dealer-id/{dealer_code}/{pen_dealer_id}

Updates dealer profile record by pen dealer Id

GET /config/dealer/profile/{dealer_code}

Get dealer profile record provided by dealer code

GET /config/dealer/preference

Get all the dealer preference records

POST /config/dealer/preference

Creates a dealer preference

DELETE /config/dealer/preference/{dealerpreference_id}

Deletes a dealer preference record

PATCH /config/dealer/preference/{dealer_preference_id}

Updates a dealer preference record by Id

GET /config/dealer/preference-by-dealer-code/{dealer_code}

Get dealer preference record provided by Code

GET /config/dealer/payment-detail

Get all the dealer payment detail records

POST /config/dealer/payment-detail

Creates a dealer payment detail

GET /config/dealer/payment-detail/{payment_id}

Get a dealer payment detail record provided by payment Id

DELETE /config/dealer/payment-detail/{payment_id}

Deletes a dealer payment detail record

GET /config/dealer/payment-detail_by_dealer_code/{dealer_code}

Get dealer payment detail record provided by dealer code

PATCH /config/dealer/payment-detail/{payment_detail_id}

Updates a dealer payment detail record by id

GET /config/dealer/tradein

Get all the dealer trade in records

POST /config/dealer/tradein

Creates a dealer trade in

GET /config/dealer/tradein-by-dealer-code/{dealer_code}

Get dealer trade in record provided by dealer code

GET /config/dealer/tradein/{tradein_id}

Get dealer trade in record provided by trade in Id

DELETE /config/dealer/tradein/{trade_id}

Deletes a dealer trade in record

PATCH /config/dealer/tradein/{trade_in_id}

Updates a dealer trade in record by Id

POST /config/dealers

Creates a dealer

GET /config/dealers/active

Get all the dealer records

GET /config/dealers/filter

Get paginated dealer records

GET /config/users/dealer_association

Get all the dealer records

GET /config/dealers/{dealer_id}

Get dealer by dealer Id

PUT /config/dealers/{dealer_id}

Updates a dealer record

DELETE /config/dealers/{dealer_id}

Deletes a dealer record

GET /config/dealer

Get all dealer

GET /config/dealer/{dealer_code}

Get dealer by dealer code

GET /config/dealer/find/by-tenant

Get dealer by Tenant ID and Email

PATCH /config/dealer/profile/shift-digital-dealer-id/{dealer_code}/{shift_digital_dealer_id}

Updates a dealer code by dealer Id

GET /config/dealer/fees/filter

Get dealer fee

PATCH /config/dealer/profile/unregister-pen-dealer/{dealer_code}

Updates dealer profile record by pen dealer Id

PATCH /config/dealer/profile/stripe-dealer-id/{dealer_code}/{stripe_dealer_id}

Updates dealer profile record by stripe dealer Id

GET /config/dealer/get_dealer_fees_sum/by_dealer_id/

Get sum of all associated dealer fees

GET /config/dealer/get_dealer/by_company_id/

Get All Dealer By Company Id

POST /config/dealer/individualized_agreement

Creates a dealer individualize agreement

GET /config/dealer/{dealer_code}/individualized_agreement

Gets all dealer individualize agreements by dealer code

GET /config/dealer/individualized_agreement/{agreement_id}

Get a dealer individualize agreement by id

DELETE /config/dealer/individualized_agreement/{agreement_id}

Deletes a dealer individualize agreement by id

PATCH /config/dealer/individualized_agreement/{agreement_id}

Updates a dealer individualize agreement by id

POST /config/dealer/custom_link

Creates a dealer custom link

PATCH /config/dealer/custom_link/{custom_link_id}

Updates a dealer custom link

DELETE /config/dealer/custom_link/{dealer_code}/{custom_link_id}

Deletes a dealer custom link

POST /config/dealer/compatible-options

Get options compatible with all provided trim codes

POST /config/dealers-chat

Creates a dealers chat

PATCH /config/dealers-chat/{chat_id}

Updates a dealer chat

GET /config/dealers-chat/{dealer_code}

Get all dealers chat records

GET /config/dealers-association/{dealer_id}

Check dealer associations with other setups by dealer_id

POST /config/reservation-deposit

Create a new reservation and deposit record

PATCH /config/reservation-deposit

Update an existing reservation or deposit record

GET /config/reservation-deposit/{dealer_code}

Retrieve reservation and deposit records for a dealer

POST /config/dealer-markups

Create or update a Dealer's Markup

DELETE /config/dealer-markups/{dealer_markup_id}

Delete Dealer Markup and Related Data

PATCH /config/dealer-markups/{dealer_markup_id}

Update existing Dealer's Markups (Selective Update)

DELETE /config/lender-dealer-markups/{lender_markup_id}

Delete Dealer Markup and Related Data

PATCH /config/update-lender-markup-status/{dealer_id}/{score_range_id}/{lender_id}

Update Lender Markup Status

GET /config/dealer-markup/{dealer_code}

Get Dealer's Markup Information

GET /config/dealer-markups/filter

Filter Dealer Markups

POST /config/create-dealer-appointment

Add New Dealer Appointment Record

GET /config/dealer-appointment/filter

Get paginated Dealer Appointment records

GET /config/dealer-appointment/{appointment_id}

Get Appointment Configuration by ID

DELETE /config/dealer-appointment/{appointment_id}

Delete Dealer Appointment by ID

PATCH /config/dealer-appointment/{appointment_id}

Update Dealer Appointment record by ID

GET /config/dealer/{dealer_code}/workday

Get dealer workdays

PATCH /config/dealer/{dealer_code}/workday

Updates a dealer workdays

GET /config/vehicle

Get all vehicles

GET /config/vehicle_by_vin/{vehicle_id}

Get a specific vehicle by Id

GET /config/vehicle/{vin}

Get a specific vehicle by VIN

PATCH /config/vehicle/{vin}

Updates a vehicle

DELETE /config/vehicle/{vehicle_id}

Deletes a vehicle

GET /config/vehicle-detail

Get all vehicle details records

GET /config/vehicle-detail/{dealer_code}/{vin}

Get a specific vehicle details

GET /config/vehicle-detail/{dealer_code}

Get all vehicle details by vins

GET /config/inventory/filter

Get all vehicle details records

POST /config/vehicle-detail/

Create a vehicle detail record

PATCH /config/vehicle-detail/{vin}

Updates a vehicle detail record

DELETE /config/vehicle-detail/{vehicle_id}

Deletes a vehicle detail record

GET /config/inventory/reference-data-by-dealer-code/{dealer_code}

Get reference data

GET /config/inventory/attached-option

Get all attached option accessories

GET /config/inventory/attached-option/filter

Get all attached option accessories

POST /config/inventory-list-import/{dealer_code}/{tenant_id}

Imports Inventory Files data into database

PATCH /config/vehicle-detail/update-status-by-vin/

Update Inventory Record Status

POST /config/vehicle/

Creates a vehicle

PUT /config/vehicle/update-bulk

Update vehicle records in bulk

GET /config/get-inventory-models

Get all asset models from asset makes

GET /config/get-inventory-trims

Get all asset trims from asset models

GET /config/financial-insurance

Get all financial insurance

POST /config/financial-insurance

Creates a financial insurance product

GET /config/financial-insurance-by-finance_type/{dealer_code}

Get all financial insurance

POST /config/financial-insurance-material

Get all financial insurance

GET /config/financial-insurance/{financial_insurance_id}

Get financial insurance product

DELETE /config/financial-insurance/{financial_insurance_id}

Deletes a financial insurance record

PATCH /config/financial-insurance/{financial_insurance_id}

Updates a financial insurance product

GET /config/financial-insurances/filter

Get all financial and insurance products

DELETE /config/financial-insurance/delete-all/{dealer_code}

Deletes all financial insurance records of a specific dealer

GET /config/dealers/preferred/fni-products/{dealer_code}

Get the count of dealer preferred financial insurance products

POST /config/financial-insurance-bundle

Creates a financial insurance product bundle

GET /config/financial-insurance-bundle/{dealer_code}

Get financial insurance product bundle by dealer code

DELETE /config/financial-insurance-bundle/{bundle_id}

Deletes financial insurance product bundle

PATCH /config/financial-insurance-bundle/{bundle_id}

Updates financial insurance product bundle

GET /config/financial-insurance-bundle-by-id/{bundle_id}

Get financial insurance product bundle by Id

GET /config/financial-insurances-bundle/filter

Get all financial insurance product bundles

DELETE /config/financial-insurance-bundle-product/{bundle_id}/{product_id}

Deletes individual product from bundle

PATCH /config/update-bundle-product-status/{bundle_id}/{product_id}

Update status of individual product bundle

GET /config/check-duplicate-bundle-name/{dealer_code}/{bundle_name}

Update status of individual product bundle

PATCH /config/update-bundle-status/{bundle_id}

Update status of individual product bundle

GET /config/check/financial-insurance/{dealer_code}

Check if financial insurance exist

GET /config/integrations/dealer/check-dealer-pen-registration/{dealer_code}

Check if dealer is registered with pen

GET /config/integrations/dealer/check-dealer-stripe-registration/{dealer_code}

Get count of dealers who are registered with stripe integration

GET /config/integration/company

Get integration records

POST /config/integration/company

Creates integration

PATCH /config/integration/company

Updates integration

GET /config/integration/dealer/active/{dealer_code}

Get all dealer integration records where dealer input required

GET /config/integrations/filter

Get integration records

DELETE /config/integration/company/{integration_id}

Delete integration and all of its providers

PATCH /config/integration/status/{integration_id}

Updates integration and all its associated providers status

DELETE /config/integration/provider/{provider_id}

Delete integration and all of its providers

GET /config/integration/integration-type/{dealer_code}/{integration_type}

Get single dealer integration record by integration type

GET /config/integration/integration-type-company/{integration_type}

Get single dealer integration record by integration type

PATCH /config/integration/dealer/provider

Updates integration

GET /config/integration/dealer/provider/{dealer_code}

Updates integration

POST /config/tenant/integration/configuration

Create Tenant Configuration

GET /config/tenant/configuration/{tenant_id}

Get Tenant Configuration

POST /config/bucket/upload-view-file/{tenant_id}

Uploads object to AWS S3 Bucket

POST /config/bucket/upload-file/{tenant_id}

Uploads object to AWS S3 Bucket

DELETE /config/bucket/delete-file/{key_name}/{tenant_id}

Removes object from s3 Bucket

POST /config/get/pre-signed/urls/

Uploads object to AWS S3 Bucket

POST /configbucket/upload/css/file/{tenant_id}

Uploads object to AWS S3 Bucket

POST /configbucket/upload/providers/{provider_name}

Uploads Service Provider Logo to AWS S3 Bucket

GET /configbucket/providers/{provider_name}

Get Presigned URL for logo

GET /config/countries

Get all countries

POST /config/checklist_response_verification/

This API helps to verify checklist responses.

POST /config/get_event_associated_checklist/

This API helps to evaluate given criteria and retrieve configured checklist(s)

POST /config/create_event_criteria_association/

This API helps us to associate an event and criteria with checklist.

DELETE /config/delete_event_criteria_association/{criteria_identifier}

This API helps to delete existing criteria based on identifier.

PATCH /config/update_checklist/

This API helps in to update checklist details like question and answers.

DELETE /config/delete_checklist_by_name/{checklist_name}

This API helps to remove all details of the specified checklist and all its associations

GET /config/get_all_checklist

This API helps to retrieve active checklist and event criteria associated with them.

GET /config/get_checklist_by_name/{checklist_name}

This API helps to retreive active checklist and event criteria associated with it.

POST /config/create_checklist/

This API helps to create new checklist. We can create multiple checklists in one iteration.

GET /config/theme-builder

Get theme by user email

POST /config/theme-builder

Post Theme Builder Record

PATCH /config/theme-builder/{user_email}

Updates a theme builder record

POST /config/upsert-theme

Update or Create Theme for a Company

GET /config/product_type

Get all product types

POST /config/product_type

Creates a product type

GET /config/product_type/{product_type_id}

Get a product type by product id

DELETE /config/product_type/{product_type_id}

Deletes a product type

PATCH /config/product_type/{product_type_id}

Updates a product type

GET /config/finance_type

Get all finance types

POST /config/finance_type

Creates a finance type

GET /config/finance_type/{finance_type_id}

Get finance type by finance id

DELETE /config/finance_type/{finance_type_id}

Deletes a finance type

PATCH /config/finance_type/{finance_type_id}

Updates a finance type

GET /config/asset_category

Gets an asset category

POST /config/asset_category

Creates an asset category

GET /config/asset_category/{asset_category_id}

Get an asset category by Id

DELETE /config/asset_category/{asset_category_id}

Deletes a asset category record

PATCH /config/asset_category/{asset_category_id}

Updates a asset category record

GET /config/asset_type

Gets an asset type

POST /config/asset_type

Creates an asset type

GET /config/asset_type/{asset_type_id}

Get an asset type by Id

DELETE /config/asset_type/{asset_type_id}

Deletes a asset type record

PATCH /config/asset_type/{asset_type_id}

Updates a asset type record

GET /config/asset_sub_type

Gets an asset subtype

POST /config/asset_sub_type

Creates an asset subtype

GET /config/asset_sub_type/{asset_subtype_id}

Get an asset subtype by Id

DELETE /config/asset_sub_type/{asset_subtype_id}

Deletes a asset subtype record

PATCH /config/asset_sub_type/{asset_subtype_id}

Updates a asset subtype record

GET /config/fees-mapping

Get all Fees Mapping

POST /config/fees-mapping

Creates Fees Mapping

GET /config/fees_mapping/{fees_mapping_id}

Get a Fees Mapping by id

DELETE /config/fees_mapping/{fees_mapping_id}

Delete Fees Mapping

POST /config/fees_codes/providers

Codes of fees mappings based on the list of providers

GET /config/option-mapping

Get all Option Mapping

POST /config/option-mapping

Creates a Option Mapping

GET /config/option_mapping/{option_mapping_id}

Get a Option Mapping by id

DELETE /config/option_mapping/{option_mapping_id}

Delete Option Mapping

POST /config/option_codes/providers

Codes of option mappings based on the list of providers

GET /config/fp-category-mapping

Get all Financial insurance product's category mapping

POST /config/fp-category-mapping

Creates Financial insurance product's category mapping

GET /config/fp-category-mapping/{fp_category_mapping_id}

Get a Financial insurance product's category mapping by id

DELETE /config/fp-category-mapping/{fp_category_mapping_id}

Delete Financial insurance product's category mapping

POST /config/fp_category_codes/providers

Codes of fp category mappings based on the list of providers

GET /config/finance-type-mapping

Get all Option Mapping

POST /config/finance-type-mapping

Creates a Option Mapping

GET /config/finance-type-mapping/{finance_mapping_id}

Get a Option Mapping by id

DELETE /config/finance-type-mapping/{finance_mapping_id}

Delete Option Mapping

POST /config/save-configuration

Creates a finance type

GET /config/get-configuration

Creates a finance type

POST /config/create-rebate

Creates a company Rebate

GET /config/rebates/{rebate_id}

Get Rebate by Id

DELETE /config/rebates/{rebate_id}

Deletes a rebate setup record

PATCH /config/rebate/{rebate_id}

Update the rebate setup

GET /config/rebate/filter

Get paginated Rebate records

GET /config/for-error}`

Get Rebate by Id

GET /config/for-exception}`

Get Rebate by Id

POST /config/dealer/holiday

Bulk create, update and delete dealer holidays

GET /config/dealer/holiday/dealer-code/{dealer_code}

Get all dealer holidays

GET /config/deal-type

Fetch Deal Tags

POST /config/deal-type

Create Deal Tags

DELETE /config/deal-type/{deal_type_id}

Delete Deal Tag

PATCH /config/deal-type/{deal_type_id}

Update Deal Tag

POST /config/business-partner

Creates a business Partner

PUT /config/business-partner/{id}

Updates a dealer record

GET /config/busines-partner/active

Get all the dealer records

GET /config/busines-partner/filter

Get paginated dealer records

GET /config/business-partner-types

Business Partner Types

GET /config/busines-partner/{id}

Get business_partne record provided by Id

DELETE /config/busines-partner/{id}

Deletes a dealer record

GET /config/business-partner/profile

Get all the business partner profile records

POST /config/business-partner/profile

Creates a business partner profile

GET /config/business-partner/profile/{business_partner_id}

Get dealer profile record provided by dealer code

PATCH /config/business-partner/profile/{business_partner_id}

Updates a business partner record by Id

DELETE /config/business-partner/profile/{bussiness_partner_id}

Deletes a business partner profile record

What's Deleted

GET /dms/sentry-debug

Trigger Error

GET /dms/external-scripts/{script_name}

External Scripts for dealers(Payment Estimator)

GET /dms/health

Health

GET /dms/version

Version

POST /dms/customer/

Creates customer

POST /dms/customer/send-email-to-customer

send email to customer

GET /dms/customer/all-customers

Get all customer records

POST /dms/customer/all-customers-dynamic-search

Get all customer records dynamic search

GET /dms/customer/customer-history

Get all customers records history

PATCH /dms/check-customer-by-email

Check customer, create if does not exist

PATCH /dms/update-dms-customer

Update Dms Customer

GET /dms/customer

Get customer record

DELETE /dms/customer

Deprecate customer delete enpoint. Use [delete-customer] instead

PATCH /dms/customer

Updates customer

GET /dms/check-dms-customer

Get customer record

GET /dms/customer-by-email

Get Customer Record by email

PATCH /dms/delete-customer

Delete customer

GET /dms/customer/license-info

Get license info record by reference id

POST /dms/customer/license-info

Creates license information

DELETE /dms/customer/license-info

Delete single license information record

PATCH /dms/customer/license-info

Updates License Info Record

GET /dms/customers

Gets customer names by customer reference ids

POST /dms/customers

Gets customer names by customer reference ids

GET /dms/customer/license-info-history

Get all customer license information history

GET /dms/customer/third-party-response-history

Get third party response history

GET /dms/customer/employment-info

Get single employment information record

POST /dms/customer/employment-info

Creates employment information

DELETE /dms/customer/employment-info

Delete single employment information record

PATCH /dms/customer/employment-info

Updates employment information

GET /dms/customer/personal-finance

Get single personal finance information record

POST /dms/customer/personal-finance

Creates personal finance information

DELETE /dms/customer/personal-finance

Delete single personal finance information record

PATCH /dms/customer/personal-finance

Updates personal finance information

GET /dms/customer/payment-information

Get customer payment information

POST /dms/customer/payment-information

Create customer payment information

DELETE /dms/customer/payment-information

Delete customer payment information

PATCH /dms/customer/payment-information

Update customer payment information

GET /dms/customer/signature

Gets a customer signature record by customer signature id

POST /dms/customer/signature

Creates customer signature

DELETE /dms/customer/signature

Deprecate signature delete enpoint. Use [delete-signature] instead

PATCH /dms/customer/signature

Updates customer signature

PATCH /dms/customer/delete-signature

Delete single customer signature record

GET /dms/customer/signature/by-dealer-id

Gets a customer signature record by dealer id

GET /dms/address

Get existing record of address

POST /dms/address

Create an address

DELETE /dms/address

Delete existing record of address

PATCH /dms/address

Update an address

GET /dms/address/history

Delete existing record of address

GET /dms/customer/insurance-information

Get customer insurance information by customer reference id and order reference number

POST /dms/customer/insurance-information

Create customer insurance information

DELETE /dms/customer/insurance-information

Delete single customer insurance information

PATCH /dms/customer/insurance-information

Updates customer insurance information

PATCH /dms/customer/update-insurance-information

Updates customer insurance information

GET /dms/customer/insurance-information-history

Get customer insurance information history

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

Get customer insurance information by customer reference id

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

Get customer insurance information by order reference number

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

Get customer insurance information document history

PATCH /dms/customer/delete-insurance-information

Delete single customer insurance information

POST /dms/customer/insurance-information/add-document

Add insurance document

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

Delete insurance document

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

Delete insurance document

GET /dms/customer/status-flag

Get all customer status flag

POST /dms/customer/status-flag

Create customer status flag

DELETE /dms/customer/status-flag

Remove customer status flag

PATCH /dms/customer/remove-status-flag

Remove customer status flag

POST /dms/customer/comment

Create customer comment diary

PATCH /dms/customer/comment

Update customer comment diary

GET /dms/customer/comments

Get customer comment diary

POST /dms/customer/license-verification

License verification through MiTek

GET /dms/customer/fraud-check

Get Fraud Check Report

POST /dms/customer/fraud-check

Creates personal finance information

POST /dms/customer/all-customers-orders-dynamic-search

Get all customer records along with its orders dynamic search

GET /dms/customer/prequalification_check

Get Pre-Qualification check for the customer email

POST /dms/customer/prequalification_check

Get Pre-Qualification check for the customer email

GET /dms/customer/prequalification_customer

Get Pre-Qualification check for the customer email

POST /dms/customer/send-order-link

send order link

GET /dms/customers/reference-id

Get reference id by email

POST /dms/send-notification-email-sqs

Send Email Notification Through SQS

POST /dms/send-notification-email

Send Email Notification

POST /dms/customer/license-info/by-pass

Creates license Info by pass

POST /dms/customer/credit-check

Assess customer creditworthiness by retrieving credit scores and financial details

GET /dms/order/expiry/{order_stage}/{dealer_id}

Order expiry date

GET /dms/configure/quotation

Get Specific quotation

GET /dms/configure/all-quotation/{reference_number}

Get Specific quotation

GET /dms/configure/all-quotations

Get Specific quotation

PATCH /dms/configure/quotation/{identifier}

Update an configured quotation

POST /dms/configure/save-quotation

Save a new order quotation

POST /dms/configure/order-fees

Creates fee record for order

GET /dms/configure/order-fees/{identifier}

Get all order fees for order

DELETE /dms/configure/order-fees/{identifier}

Delete all orders fees filtered on identifier

PATCH /dms/configure/order-fees/{identifier}

Update fee record for order

POST /dms/configure/order-options

Create a new order option record

GET /dms/configure/order-options/{identifier}

Get order option details

DELETE /dms/configure/order-options/{identifier}

Delete order option record

PATCH /dms/configure/order-options/{identifier}

Update an order option record

POST /dms/configure/order-fni

Create finance insurance product record for order

GET /dms/configure/order-fni/{identifier}

Get orders finance insurance product filtered on identifier

DELETE /dms/configure/order-fni/{identifier}

Delete all orders finance insurance product filtered on identifier

PATCH /dms/configure/order-fni/{identifier}

Update finance insurance product record for order

POST /dms/configure/order/tradein

Creates an order tradein info setup record

GET /dms/configure/order/tradein/{identifier}

Get a order tradein info setup record

DELETE /dms/configure/order/tradein/{identifier}

Delete order tradein info setup record

PATCH /dms/configure/order/tradein/{identifier}

Updates a order tradei info setup record

GET /dms/configure/orders

Get all order record

GET /dms/configure/order/filter

Search orders based on filters

POST /dms/configure/order-status/

Get orders record filtered on order status

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

Update order status record by order reference number

PATCH /dms/configure/order-to-quotation/{identifier}/{reference_number}

Convert specific Order to Quotation

POST /dms/configure/order/status/

Update order status history record by order reference number

GET /dms/configure/assets-by-trim-code/{trim_code}

Get assets by trim code

GET /dms/configure/order/status-by-dealer

Get order status by dealer

GET /dms/order/order_information_for_submitted_order

Get order by order status

GET /dms/order/order_information/{reference_number}

Get order by order status

GET /dms/order/order_insurance_documents/{reference_number}

Get order insurance documents by order ID

GET /dms/order/credit-decision

Get credit decision

POST /dms/order/credit-decision

Add credit decision

GET /dms/order/order-checklist

Get Order checklist

POST /dms/order/order-checklist

Add Order checklist

DELETE /dms/order/order-checklist

Delete Order checklist

PATCH /dms/order/order-checklist

Update Order checklist

GET /dms/order/order-checklist-update-history

Get Order Checklist Update History

PATCH /dms/order/update-credit-approver-decision/{reference_number}

Update decision status after receiving decision from credit approver

PATCH /dms/order/update-payment-status/{reference_number}

Update Payment Status

POST /dms/order/order-verify-document/{identifier}

Verify Order Documents

POST /dms/order/upload-signed-document/{identifier}

Upload Signed Document

PATCH /dms/configure/quotation-to-order/{identifier}

Convert specific Quotation to Application

POST /dms/configure/insurance

Add insurance

GET /dms/configure/quotation-by-customers

Get all orders of a customer

GET /dms/all-quotation-by-reference-number/

Get all quotations based on reference number

POST /dms/order/quick_quotation

Save Single Quotation

PATCH /dms/order/quick_quotation

Update Quotation

GET /dms/configure/quick-quotation-by-identifier/{identifier}

Get Specific quotation

GET /dms/configure/quick-quotation-by-vendor

Get all orders of a customer

GET /dms/order/workqueue

Get all orders for workqueue.

GET /dms/get-reference-data/{dealer_code}

Get Reference Data By Dealer Code

GET /dms/get-inventory

Get Filtered Inventory

GET /dms/get-setup-data

Setup Data

GET /dms/an-order-statuses

Get AN Order Statuses

PATCH /dms/order/asset/{reference_number}

Updates an order asset record

POST /dms/update-order-submission

Update Order Submission Status

PATCH /dms/order/approve-order-by-lender/{reference_number}/{lender_id}

Update Order Status and Lender Id

POST /dms/order/get-customer-order-submissions/{customer_reference_id}/{submission_status}

Get order lender submissions of customer by status and Lender ids

GET /dms/order/get-order-submission-by-id/{submission_id}

Get single order submission by primary key

PATCH /dms/order/re-submit/{identifier}

Update order and re-send deal to lender

PATCH /dms/configure/individualized-agreement

Creates an order individualized agreement info setup record

PATCH /dms/configure/update-financial-indicator/{reference_number}/{is_payment_updated}

Update Financial Indicator

GET /dms/order/get-order-status/{reference_number}

Get order Status

POST /dms/order/proposal

Create new order proposal for broker

PATCH /dms/order/proposal

Update order proposal for broker

PATCH /dms/order/change-proposal-status

Update order proposal status

GET /dms/order/proposal-dashboard-analytics

Get order proposal analytics for broker dashboard

POST /dms/order/generate-document/{event_name}

Generate Document for respective event

POST /dms/order/download_document_by_event/{event_name}

Get generated document(s) key(s) against specific event

POST /dms/order/send-email/{event_name}

send Email notification

POST /dms/order/proposal/submit

Submit Proposal for Broker

GET /dms/order/stakeholder/

Get order stakeholder

POST /dms/order/stakeholder/

Create new order stakeholder

DELETE /dms/order/stakeholder/

Update order stakeholder

PATCH /dms/order/stakeholder/

Update order stakeholder

GET /dms/configure/disclaimer

Get Disclaimer Details by Disclaimer Name and Disclaimer Version

POST /dms/configure/disclaimer

Create disclaimer

GET /dms/configure/disclaimer-by-name/{name}

Get Disclaimer by Name

GET /dms/configure/customer-mandatory-disclaimers

Get customer mandatory Disclaimers

GET /dms/configure/all-disclaimer

Get all Disclaimers

PATCH /dms/configure/disclaimer-status

Update Disclaimer status

PATCH /dms/configure/disclaimer-accord

Update Disclaimer accord

PATCH /dms/configure/disclaimer/{name}

Update Disclaimer details

GET /dms/configure/disclaimer-agreement

Get Saved Disclaimer Agreement

POST /dms/configure/disclaimer-agreement

Create Disclaimer Agreement

DELETE /dms/configure/disclaimer-agreement

Delete Disclaimer Agreement

GET /dms/configure/disclaimer-agreement-datetime

Get Disclaimer Agreement Date Time by Customer ID/Order ID

POST /dms/configure/multiple-disclaimers

Create multiple disclaimers

POST /dms/configure/workqueue

Creates workqueue after Order creation

GET /dms/configure/workqueue/search

Search workqueue based on filters

PATCH /dms/configure/workqueue/create_application/{workqueue_id}

Creates workqueue after Order stage change to application

POST /dms/quote/calculation

Calculate Quotation

POST /dms/quote/calculate-order

Calculate Quotation

POST /dms/quote/calculate-nfa

Calculate NFA [Net Financed Amount]

POST /dms/quote/calculation/V2

Calculate Rental

POST /dms/quote/create

Create Quote

GET /dms/an-dealers

Get Dealers

POST /dms/quote/calculation/multi-assets

Calculate Quotation for Multiple Assets

POST /dms/quote/calculation/quantity

Calculate Quotation

POST /dms/quote/calculation/monthlyImpact

Calculate Monthly Impact

POST /dms/configure/appointment

Creates Appointment after Order Confirmation

PATCH /dms/configure/appointment

Update an created appointment

GET /dms/configure/appointment/{appointment_id}

Get Appointment by id

PATCH /dms/configure/appointment/{appointment_id}

Delete created appointment

POST /dms/configure/appointments

Get paginated list of Appointments

POST /dms/email/

Get customer record

POST /dms/consents

Create consents

GET /dms/consents/

Get all consents records

POST /dms/consents/

Delete consents

GET /dms/consents/{consents_id}

Get consents record

PATCH /dms/consents/{consents_id}

Update consents

GET /dms/customer/document

Get customer documents

POST /dms/customer/document

Creates customer document

DELETE /dms/customer/document

Delete customer document by identifier

PATCH /dms/customer/document

Update customer document by identifier

GET /dms/customer/document/status

Get customer document by identifier

PATCH /dms/customer/document/status

Update customer document status

GET /dms/customer/document-history

Get customer document history

PATCH /dms/customer/documents/{customer_reference_id}

Update customer document by identifier

PATCH /dms/customer/delete-document

Delete customer document by identifier

GET /dms/customer/document/review

Get customer document reviews

POST /dms/customer/document/review

Add customer document review

GET /dms/customer/document/uploading-status

Get customer document upload status

PATCH /dms/customer/document/uploading-status

Update customer document upload status

GET /dms/customer/document/download

Get customer document url by artifect_id

GET /dms/customer/document/download-stream

Get customer document stream by artifect_id

POST /dms/customer/document/signature-document

Customer Document Signature

POST /dms/customer/additional-document

Creates customer document

GET /dms/get-an-signed-url

Get AN Signed URL to Upload

GET /dms/configure/document-package

Get document package by identifier

POST /dms/configure/document-package

Create document package

DELETE /dms/configure/document-package

Cancel document package and document by identifier

GET /dms/configure/document-package-by-reference-id

Get document package by reference_id

GET /dms/configure/all-document-packages-by-reference-id

Get document package by reference_id

GET /dms/configure/document-package/document

Get document from document package by identifier

POST /dms/configure/{document_package_id}/{document_id}/{signature_id}

Sign document

POST /dms/configure/by-role/{document_package_identifier}/{document_identifier}/{signature_id}/{signer_role}

Sign document

GET /dms/configure/document-pre-signed-url/{key}

Get document package by identifier

GET /dms/configure/document-base64/{key}

Get document package by identifier

PATCH /dms/configure/metadata

Add Meta Data

GET /dms/configure/document-notification-bookmarks

Get bookmarks of documents and notifications

POST /dms/submit-order

Mock Credit Approver API & Fraud Check

POST /dms/credit-request

Mock Credit Approver Request

POST /dms/contract-document

Handle contract document

GET /dms/contract

Get active contract

POST /dms/contract

Create contract

PATCH /dms/contract

Update contract

PATCH /dms/contract/past-due-webhook

Past due webhook

GET /dms/contract/all

Get all contract records

GET /dms/contracts

Get contracts by external order ids

GET /dms/contracts/search

Get contracts by external order ids

GET /dms/stipulation/fulfillment

Get All Stipulation Fulfillments

POST /dms/stipulation/fulfillment

Create Stipulation Fulfillment

DELETE /dms/stipulation/fulfillment

Delete Stipulation Fulfillments

PATCH /dms/stipulation/fulfillment

Delete Stipulation Fulfillments

GET /dms/stipulation/fulfillment/

Get Stipulation Fulfillments

GET /dms/history

Get all customers records history

GET /dms/history-details

Get history detail

GET /dms/request

Get Request

POST /dms/request

Create Request

DELETE /dms/request

Delete Request

PATCH /dms/request

Update Request

GET /dms/requests

Get All Requests

GET /dms/stipulation/financial

Get Financial Stipulation

POST /dms/stipulation/financial

Create Financial Stipulation

GET /dms/stipulation/stipulation-by-lender

Get Financial Stipulation

GET /dms/external-orders/all

Get External Orders

GET /dms/external-keys/all

Get Keys

POST /dms/external-orders/push-deal

Push Deal to Third Party

POST /dms/theme-builder

Post Theme Builder Record

GET /dms/theme-builder/{user_email}

Get theme by user email

PATCH /dms/theme-builder/{user_email}

Updates a theme builder record

POST /dms/affordability-check/

Affordability Check

POST /dms/affordability-check/monthly-payment-calculation/V2/

Monthly Payment Calculation V2

GET /dms/integration/by_provider_name/{dealer_code}/{integration_type}/{provider_name}

Get Integration By Provider Name

GET /dms/integration/configuration/{dealer_code}/{integration_type}/{provider_name}

Get Hubex Configuration By Provider Name

GET /dms/get-payment-methods/{reference_number}

Get Payment Methods & Get Paid Amount

POST /dms/plaid-link-token/

Create Link Token

POST /dms/create-payment/

Create payment for new Order

POST /dms/update-payment/

Update Order Payment

POST /dms/add-payment-details/

Add Payment Details from dealer side

PUT /dms/remove-payment-details/{order_payment_detail_id}

Remove the order payment detail

GET /dms/dealer/all-dealer-distance

Get All Dealer Distance

GET /dms/dealer/get-associated-dealers

Get All Dealer Distance

GET /dms/dealer/check-actively-order

Check Dealer actively order

POST /dms/get-trade-in-year/

Get all the year from KBB

POST /dms/get-trade-in-make/

Get all the make from KBB

POST /dms/get-trade-in-model/

Get all the models from KBB

POST /dms/get-trade-in-trim/

Get all the trims from KBB

POST /dms/get-trade-in-vehicle_value/

Get vehicle estimation from KBB

POST /dms/get-trade-in-vehicle_detail/

Get vehicle details from KBB

POST /dms/get-vehicle-detail-by-vin/

Get vehicle details through VIN

PATCH /dms/set-trade-in-inspection-status/{order_id}

Set Trade-in inspection status

GET /dms/get-trade_in_history/{order_id}

Get trade in history

POST /dms/get-tradein-options/

Get trade in options linked with vehicles

POST /dms/event_analytic

Create Event

POST /dms/get_event_associated_checklist/

This API helps to evaluate given criteria and retrieve configured checklist(s)

GET /dms/lead

Get dealer's lead

PATCH /dms/lead

Update exisitng Draft/Active lead otherwise create new Lead

PATCH /dms/lead/change-status/{lead_id}

Update exisitng lead status

POST /dms/insurance/add-insurance

Add Insurance

GET /dms/visitors

Get All Visitors

POST /dms/watch_url

Get Visitor Url

POST /dms/payments/contexts

Get Payment Context

GET /dms/payments/contexts/{context_id}/options

Get Payment Options

POST /dms/payments/contexts/{context_id}/authorizations

Get Payment Options

POST /dms/payments/contexts/{context_id}/validate-payment-result

Get Payment Options

GET /for-error

Get Rebate Error

GET /for-exception

Get Rebate Exception