API Doc Version 1.0.15

What's New

POST /config/charts/base_rate/

Creates a chart record

POST /config/programs/permutation/

Create permutation in case of multiple criteria

POST /config/programs/multi-quote/

Retrieve all evaluated programs into a single response

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/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

DELETE /config/charts/base_rate/{base_rate_chart_id}

Deletes a chart record

What's Deleted

GET /config/asset-make/test/{lender_id}

Get all asset make records

GET /config/all-asset-make

Get all asset make records

POST /config/charts/base-rate/

Creates a chart record

DELETE /config/chart/base_rate/{base_rate_chart_id}

Deletes a chart record

GET /config/financial-product

Get financial product management records

POST /config/financial-product

Creates financial product

GET /config/financial-parameter/

GetFinancial parameter records

POST /config/financial-parameter/

Creates a financial parameter

GET /config/financial-parameter/{financial_parameter_id}

Get financial parameter by Id

DELETE /config/financial-parameter/{financial_parameter_id}

Deletes a financial parameter record

PATCH /config/financial-parameter/{financial_parameter_id}

Updates a financial parameter record

POST /config/dealerships

Creates a dealership

GET /config/dealerships/active

Get all the dealership records

GET /config/dealerships/dealer_id/{dealer_id}

Get all the dealership records

GET /config/dealerships/filter

Get paginated dealership records

GET /config/dealerships/{dealership_id}

Get dealership record provided by Id

PUT /config/dealerships/{dealership_id}

Updates a dealership record

DELETE /config/dealerships/{dealership_id}

Deletes a dealership record

GET /config/dealerships/find/by-tenant

Get dealership record provided by Id

DELETE /config/dealer/{dealer_id}

Deletes a dealer by dealer Id

GET /config/dealer/by-dealer-id/{dealer_id}

Get dealer by dealer Id

DELETE /config/financial-product/{financial_product_id}

Deletes a financial product management record

POST /config/dealer

Creates new dealer

What's Changed

POST /config/asset-model

Request:

Changed content type : application/json

• Deleted property asset_trims (array)

PATCH /config/asset-model/{model_id}

Request:

Changed content type : application/json

• Deleted property asset_trims (array)

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

Asset Condition Code Duplicate Exist

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

POST /config/lender/create-lender

Request:

Changed content type : application/json

• Changed property lender_profile (object)

  New required properties:

  • email

  • Changed property url (string)

  • Changed property email (string -> string)

  • Changed property tax_id (string)

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  New required properties:

  • email

  • Changed property url (string)

  • Changed property email (string -> string)

  • Changed property tax_id (string)

GET /config/lender

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  Changed items (object):

  New required properties:

  • email

  • Changed property url (string)

  • Changed property email (string -> string)

    Email of the Lender

  • Changed property tax_id (string)

GET /config/lender/{lender_id}

Parameters:

Changed: lender_id in path

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  New required properties:

  • email

  • Changed property url (string)

  • Changed property email (string -> string)

    Email of the Lender

  • Changed property tax_id (string)

DELETE /config/lender/{lender_id}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  New required properties:

  • email

  • Changed property url (string)

  • Changed property email (string -> string)

    Email of the Lender

  • Changed property tax_id (string)

PATCH /config/lender/{lender_id}

Request:

Changed content type : application/json

• Changed property lender_profile (object)

  New required properties:

  • email

  • Changed property url (string)

  • Changed property email (string -> string)

  • Changed property tax_id (string)

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  New required properties:

  • email

  • Changed property url (string)

  • Changed property email (string -> string)

    Email of the Lender

  • Changed property tax_id (string)

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

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  New required properties:

  • email

  • Changed property url (string)

  • Changed property email (string -> string)

    Email of the Lender

  • Changed property tax_id (string)

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

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  New required properties:

  • email

  • Changed property url (string)

  • Changed property email (string -> string)

    Email of the Lender

  • Changed property tax_id (string)

DELETE /config/address/{address_id}

Parameters:

Changed: address_id in path

POST /config/base-rate-chart-evaluate

Parameters:

Added: api_key_id in query

POST /config/subsidy/criteria

Request:

Changed content type : application/json

• Changed property criteria (object)

  • Added property rate (number)

    Rate upto 4 decimal places for Subsidy Chart Criteria

GET /config/subsidy/filter

Parameters:

Added: rate in query

GET /config/subsidy

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  Changed items (object):

  • Added property rate (number)

    Rate upto 4 decimal places for Subsidy Chart Criteria

POST /config/subsidy

Request:

Changed content type : application/json

• Added property rate (number)

  Rate upto 4 decimal places for Subsidy Chart Criteria

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property rate (number)

    Rate upto 4 decimal places for Subsidy Chart Criteria

GET /config/subsidy/{subsidy_id}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property rate (number)

    Rate upto 4 decimal places for Subsidy Chart Criteria

DELETE /config/subsidy/{subsidy_id}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property rate (number)

    Rate upto 4 decimal places for Subsidy Chart Criteria

PATCH /config/subsidy/{subsidy_id}

Request:

Changed content type : application/json

• Added property rate (number)

  Rate upto 4 decimal places for Subsidy Chart Criteria

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property rate (number)

    Rate upto 4 decimal places for Subsidy Chart Criteria

GET /config/financial-product/{financial_product_id}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property program_state (string)

  • Added property dealers (array)

    Associated dealers with a program

    Items (object):

    • Property id (integer)

      Dealer Id

    • Property dealer_name (string)

      Dealer Name for Dealer Creation

    • Property dealer_code (string)

      Dealer Code For the Dealer

    • Property email (string)

      Email address of Dealer

    • Property contact_person (string)

      Contact Person for Dealer

    • Property contact_person_first_name (string)

      DealerModel contact person first name

    • Property contact_person_last_name (string)

      DealerModel contact person last name

    • Property contact_person_email (string)

      DealerModel contact person email

    • Property password (string)

      Password for created Dealer

    • Property contact_number (string)

      Contact Number of Dealer

    • Property contact_person_role (string)

      DealerModel contact person role

    • Property is_active (boolean)

      DealerModel is active

    • Property digital_retail (boolean)

      Digital Retail required or not for Dealer

    • Property website (string)

      Website of Dealer

    • Property zip_code (string)

      Zip Code of Dealer City

    • Property is_default_password_changed (boolean)

      IsDefault Password changed or not after dealer creation

    • Property lender_id (integer)

      lender Id against which dealer is created

    • Property user_id (integer)

      DealerModel dealer id

  • Deleted property is_draft (boolean)

  • Deleted property dealerships (array)

    Associated dealers with a program

PATCH /config/financial-product/{financial_product_id}

Request:

Changed content type : application/json

New required properties:

• program_state

• Added property program_state (object)

  Program State

  Enum values:

  • Expired
  • Published
  • Draft
  • ReadytoPublish

• Added property dealers (array)

  Associated dealers with a program

  Items (integer):

• Deleted property dealerships (array)

  Associated dealers with a program

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property program_state (string)

  • Added property dealers (array)

    Associated dealers with a program

  • Deleted property is_draft (boolean)

  • Deleted property dealerships (array)

    Associated dealers with a program

POST /config/financial-product/create-fp

Request:

Changed content type : application/json

• Changed property financial_product_general (object)

  New required properties:

  • program_state

  • Added property program_state (object)

    Program State

  • Added property dealers (array)

    Associated dealers with a program

  • Deleted property dealerships (array)

    Associated dealers with a program

Return Type:

Changed response : 201 Created

Successful Response

• Changed content type : application/json

  • Added property program_state (string)

  • Added property dealers (array)

    Associated dealers with a program

  • Deleted property is_draft (boolean)

  • Deleted property dealerships (array)

    Associated dealers with a program

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

Request:

Changed content type : application/json

• Changed property financial_product_general (object)

  New required properties:

  • program_state

  • Added property program_state (object)

    Program State

  • Added property dealers (array)

    Associated dealers with a program

  • Deleted property dealerships (array)

    Associated dealers with a program

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property program_state (string)

  • Added property dealers (array)

    Associated dealers with a program

  • Deleted property is_draft (boolean)

  • Deleted property dealerships (array)

    Associated dealers with a program

GET /config/document-type

Parameters:

Changed: lender_id in header

GET /config/other-costs

Gets other costs

POST /config/other-costs

Creates other costs

GET /config/odometer/{lender_id}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  New required properties:

  • email

  • Changed property url (string)

  • Changed property email (string -> string)

  • Changed property tax_id (string)

POST /config/programs/all/

Request:

Changed content type : application/json

• Added property retrieve_all_programs (boolean)

  Retrieve all program

GET /config/dealer/profile

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  Changed items (object):

  • Added property dealer_address (object)

    DealerProfileModel dealer address

    • Property is_active (boolean)

    • Property is_deleted (boolean)

    • Property id (integer)

      Primary id of Lender Address

    • Property address_line_1 (string)

      Address 1 of lender

    • Property address_line_2 (string)

      Address 2 of lender

    • Property state_id (integer)

      State of Lender

    • Property state_name (string)

      State Name of Lender

    • Property zip_code (string)

      Zip code of Lender

    • Property county (string)

      County Name of Lender

    • Property city (string)

      City of Lender

    • Property country_id (integer)

      country id of Countries

    • Property field5 (string)

      generic field for address

    • Property field6 (string)

      generic field for address

    • Property contact_number (string)

      Contact Number of Lender

    • Property verified (boolean)

      Verification Status of Lender

    • Property address_type (string)

      Address type of Lender

  • Deleted property dealership_address (object)

    DealerProfileModel dealership address

POST /config/dealer/profile

Request:

Changed content type : application/json

• Added property dealer_address (object)

  DealerProfileModel dealer address

• Deleted property dealership_address (object)

  DealerProfileModel dealership address

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property dealer_address (object)

    DealerProfileModel dealer address

  • Deleted property dealership_address (object)

    DealerProfileModel dealership address

DELETE /config/dealer/profile/{dealer_profile_id}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property dealer_address (object)

    DealerProfileModel dealer address

  • Deleted property dealership_address (object)

    DealerProfileModel dealership address

PATCH /config/dealer/profile/{dealer_profile_id}

Request:

Changed content type : application/json

• Added property dealer_address (object)

  DealerProfileModel dealer address

• Deleted property dealership_address (object)

  DealerProfileModel dealership address

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property dealer_address (object)

    DealerProfileModel dealer address

  • Deleted property dealership_address (object)

    DealerProfileModel dealership address

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

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property dealer_address (object)

    DealerProfileModel dealer address

  • Deleted property dealership_address (object)

    DealerProfileModel dealership address

GET /config/dealer/profile/{dealer_id}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property dealer_address (object)

    DealerProfileModel dealer address

  • Deleted property dealership_address (object)

    DealerProfileModel dealership address

GET /config/dealer

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  Changed items (object):

  New required properties:

  • is_active

  New optional properties:

  • contact_person

  • digital_retail

  • email

  • is_default_password_changed

  • Added property contact_person_first_name (string)

    DealerModel contact person first name

  • Added property contact_person_last_name (string)

    DealerModel contact person last name

  • Added property contact_person_email (string)

    DealerModel contact person email

  • Added property contact_person_role (string)

    DealerModel contact person role

  • Added property is_active (boolean)

    DealerModel is active

  • Added property user_id (integer)

    DealerModel dealer id

  • Deleted property dealership_id (integer)

    dealership_id

GET /config/dealer/{dealer_code}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  New required properties:

  • is_active

  New optional properties:

  • contact_person

  • digital_retail

  • email

  • is_default_password_changed

  • Added property contact_person_first_name (string)

    DealerModel contact person first name

  • Added property contact_person_last_name (string)

    DealerModel contact person last name

  • Added property contact_person_email (string)

    DealerModel contact person email

  • Added property contact_person_role (string)

    DealerModel contact person role

  • Added property is_active (boolean)

    DealerModel is active

  • Added property user_id (integer)

    DealerModel dealer id

  • Deleted property dealership_id (integer)

    dealership_id

GET /config/dealer/find/by-tenant

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  New required properties:

  • is_active

  New optional properties:

  • contact_person

  • digital_retail

  • email

  • is_default_password_changed

  • Added property contact_person_first_name (string)

    DealerModel contact person first name

  • Added property contact_person_last_name (string)

    DealerModel contact person last name

  • Added property contact_person_email (string)

    DealerModel contact person email

  • Added property contact_person_role (string)

    DealerModel contact person role

  • Added property is_active (boolean)

    DealerModel is active

  • Added property user_id (integer)

    DealerModel dealer id

  • Deleted property dealership_id (integer)

    dealership_id

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

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property dealer_address (object)

    DealerProfileModel dealer address

  • Deleted property dealership_address (object)

    DealerProfileModel dealership address

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

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property dealer_address (object)

    DealerProfileModel dealer address

  • Deleted property dealership_address (object)

    DealerProfileModel dealership address

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

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property dealer_address (object)

    DealerProfileModel dealer address

  • Deleted property dealership_address (object)

    DealerProfileModel dealership address

POST /config/asset-make

Request:

Changed content type : application/json

• Deleted property asset_models (array)

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property name (string)

  • Added property external_code (string)

  • Added property asset_models (array)

    Items (object):

    • Property is_active (boolean)

    • Property is_deleted (boolean)

    • Property id (integer)

    • Property model_name (string)

    • Property model_code (string)

    • Property description (string)

    • Property make_id (integer)

    • Property lender_id (integer)

    • Property asset_trims (array)

      Items (object):

      • Property is_active (boolean)

      • Property is_deleted (boolean)

      • Property id (integer)

      • Property trim_name (string)

      • Property trim_description (string)

      • Property trim_code (string)

      • Property trim_image (array)

        Items (object):

      • Property model_id (integer)

      • Property lender_id (integer)

  • Deleted property model_name (string)

  • Deleted property model_code (string)

  • Deleted property make_id (integer)

  • Deleted property asset_trims (array)

PATCH /config/asset-make/{make_id}

Request:

Changed content type : application/json

• Deleted property asset_models (array)

GET /config/financial-product/filter

Parameters:

Added: program_state in query

Deleted: is_draft in query

Return Type:

Changed response : 201 Created

Successful Response

• Changed content type : application/json

  • Changed property result (array)

    Changed items (object):

    • Added property program_state (string)

    • Added property dealers (array)

      Associated dealers with a program

    • Deleted property is_draft (boolean)

    • Deleted property dealerships (array)

      Associated dealers with a program

POST /config/dealer/configurations

Request:

Changed content type : application/json

• Changed property profile (object)

  • Added property dealer_address (object)

    DealerProfileModel dealer address

  • Deleted property dealership_address (object)

    DealerProfileModel dealership address

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property profile (object)

    • Added property dealer_address (object)

      DealerProfileModel dealer address

    • Deleted property dealership_address (object)

      DealerProfileModel dealership address