API Doc Version 1.0.36

What's New

GET /config/company-lender

Get company lender 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

POST /config/company/update_email-status/{email_status}

Update company's correspondence email status

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

This method returns tenant languages by slug

GET /config/dealer/option-model-name

Get dealer option accessory record provided by dealer code

GET /config/users/dealer_association

Get all the dealer records

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

POST /config/fees_codes/providers

Codes of fees mappings based on the list of providers

POST /config/option_codes/providers

Codes of option mappings based on the list of providers

POST /config/fp_category_codes/providers

Codes of fp category mappings based on the list of providers

What's Deleted

GET /config/dealer/option-trim-code

Get dealer option accessory record provided by dealer code

What's Changed

GET /config/vehicle

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  Changed items (object):

  • Changed property vehicle_url (object -> object)

    List of vehicle URLs

  • Changed property photo_urls (array)

    List of vehicle photo urls

    Changed items (object -> object):

POST /config/lender/create-lender

Request:

Changed content type : application/json

• Added property lease_rate_type (string)

  Lease Rate type base on Finance type as Lease

• Added property down_payment (string)

  Down Payment of Lender

• Changed property configured_rates (array)

  List of Standard Rates

  Changed items (object):

  • Added property min_down_payment_rate (number)

    Minimum down payment Rate of rate configuration

  • Added property max_down_payment_rate (number)

    Maximum down payment Rate of rate configuration

GET /config/lender

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  Changed items (object):

  • Added property lease_rate_type (string)

    Lease Rate type base on Finance type as Lease

  • Added property down_payment (string)

    Down Payment of Lender

  • Changed property configured_rates (array)

    List of Standard Rates

    Changed items (object):

    • Added property min_down_payment_rate (number)

      Minimum down payment Rate of rate configuration

    • Added property max_down_payment_rate (number)

      Maximum down payment Rate of rate configuration

GET /config/lender/{lender_id}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property lease_rate_type (string)

    Lease Rate type base on Finance type as Lease

  • Added property down_payment (string)

    Down Payment of Lender

  • Changed property configured_rates (array)

    List of Standard Rates

    Changed items (object):

    • Added property min_down_payment_rate (number)

      Minimum down payment Rate of rate configuration

    • Added property max_down_payment_rate (number)

      Maximum down payment Rate of rate configuration

DELETE /config/lender/{lender_id}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property lease_rate_type (string)

    Lease Rate type base on Finance type as Lease

  • Added property down_payment (string)

    Down Payment of Lender

  • Changed property configured_rates (array)

    List of Standard Rates

    Changed items (object):

    • Added property min_down_payment_rate (number)

      Minimum down payment Rate of rate configuration

    • Added property max_down_payment_rate (number)

      Maximum down payment Rate of rate configuration

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

Request:

Changed content type : application/json

• Added property lease_rate_type (string)

  Lease Rate type base on Finance type as Lease

• Added property down_payment (string)

  Down Payment of Lender

• Changed property configured_rates (array)

  List of Standard Rates

  Changed items (object):

  • Added property min_down_payment_rate (number)

    Minimum down payment Rate of rate configuration

  • Added property max_down_payment_rate (number)

    Maximum down payment Rate of rate configuration

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property lease_rate_type (string)

    Lease Rate type base on Finance type as Lease

  • Added property down_payment (string)

    Down Payment of Lender

  • Changed property configured_rates (array)

    List of Standard Rates

    Changed items (object):

    • Added property min_down_payment_rate (number)

      Minimum down payment Rate of rate configuration

    • Added property max_down_payment_rate (number)

      Maximum down payment Rate of rate configuration

GET /config/configured_lenders

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  Changed items (object):

  • Added property lease_rate_type (string)

    Lease Rate type base on Finance type as Lease

  • Added property down_payment (string)

    Down Payment of Lender

  • Changed property configured_rates (array)

    List of Standard Rates

    Changed items (object):

    • Added property min_down_payment_rate (number)

      Minimum down payment Rate of rate configuration

    • Added property max_down_payment_rate (number)

      Maximum down payment Rate of rate configuration

GET /config/all-lenders/filter

Parameters:

Added: lease_rate_type in query

Added: down_payment in query

GET /config/default/lender

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property lease_rate_type (string)

    Lease Rate type base on Finance type as Lease

  • Added property down_payment (string)

    Down Payment of Lender

  • Changed property configured_rates (array)

    List of Standard Rates

    Changed items (object):

    • Added property min_down_payment_rate (number)

      Minimum down payment Rate of rate configuration

    • Added property max_down_payment_rate (number)

      Maximum down payment Rate of rate configuration

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

Parameters:

Added: finance_type in query

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  Changed items (object):

  • Added property lease_rate_type (string)

    Lease Rate type base on Finance type as Lease

  • Added property down_payment (string)

    Down Payment of Lender

  • Changed property configured_rates (array)

    List of Standard Rates

    Changed items (object):

    • Added property min_down_payment_rate (number)

      Minimum down payment Rate of rate configuration

    • Added property max_down_payment_rate (number)

      Maximum down payment Rate of rate configuration

GET /config/company

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  Changed items (object):

  • Added property time_zone (string)

    Time zone for company

  • Added property day_light_saving (boolean)

  • Added property shift_inventory_file_time (string)

    Shift Digital Inventory File Time in UTC

  • Added property domain (string)

    Domain of a Company

  • Added property contact_person_name (string)

    Contact Person Name

  • Added property contact_person_email (string)

    Contact Person Email

  • Added property contact_person_phone_number (string)

    Contact Person Phone Number

  • Added property correspondence_email (string)

    Correspondence Email of a Company

  • Deleted property theme (object)

    Theme of a company

  • Changed property configured_rates (array)

    List of Standard Rates

    Changed items (object):

    • Added property min_down_payment_rate (number)

      Minimum down payment Rate of rate configuration

    • Added property max_down_payment_rate (number)

      Maximum down payment Rate of rate configuration

GET /config/company_by_api_key

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property time_zone (string)

    Time zone for company

  • Added property day_light_saving (boolean)

  • Added property shift_inventory_file_time (string)

    Shift Digital Inventory File Time in UTC

  • Added property domain (string)

    Domain of a Company

  • Added property contact_person_name (string)

    Contact Person Name

  • Added property contact_person_email (string)

    Contact Person Email

  • Added property contact_person_phone_number (string)

    Contact Person Phone Number

  • Added property correspondence_email (string)

    Correspondence Email of a Company

  • Deleted property theme (object)

    Theme of a company

  • Changed property configured_rates (array)

    List of Standard Rates

    Changed items (object):

    • Added property min_down_payment_rate (number)

      Minimum down payment Rate of rate configuration

    • Added property max_down_payment_rate (number)

      Maximum down payment Rate of rate configuration

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

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property time_zone (string)

    Time zone for company

  • Added property day_light_saving (boolean)

  • Added property shift_inventory_file_time (string)

    Shift Digital Inventory File Time in UTC

  • Added property domain (string)

    Domain of a Company

  • Added property contact_person_name (string)

    Contact Person Name

  • Added property contact_person_email (string)

    Contact Person Email

  • Added property contact_person_phone_number (string)

    Contact Person Phone Number

  • Added property correspondence_email (string)

    Correspondence Email of a Company

  • Deleted property theme (object)

    Theme of a company

  • Changed property configured_rates (array)

    List of Standard Rates

    Changed items (object):

    • Added property min_down_payment_rate (number)

      Minimum down payment Rate of rate configuration

    • Added property max_down_payment_rate (number)

      Maximum down payment Rate of rate configuration

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

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property time_zone (string)

    Time zone for company

  • Added property day_light_saving (boolean)

  • Added property shift_inventory_file_time (string)

    Shift Digital Inventory File Time in UTC

  • Added property domain (string)

    Domain of a Company

  • Added property contact_person_name (string)

    Contact Person Name

  • Added property contact_person_email (string)

    Contact Person Email

  • Added property contact_person_phone_number (string)

    Contact Person Phone Number

  • Added property correspondence_email (string)

    Correspondence Email of a Company

  • Deleted property theme (object)

    Theme of a company

  • Changed property configured_rates (array)

    List of Standard Rates

    Changed items (object):

    • Added property min_down_payment_rate (number)

      Minimum down payment Rate of rate configuration

    • Added property max_down_payment_rate (number)

      Maximum down payment Rate of rate configuration

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

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property time_zone (string)

    Time zone for company

  • Added property day_light_saving (boolean)

  • Added property shift_inventory_file_time (string)

    Shift Digital Inventory File Time in UTC

  • Added property domain (string)

    Domain of a Company

  • Added property contact_person_name (string)

    Contact Person Name

  • Added property contact_person_email (string)

    Contact Person Email

  • Added property contact_person_phone_number (string)

    Contact Person Phone Number

  • Added property correspondence_email (string)

    Correspondence Email of a Company

  • Deleted property theme (object)

    Theme of a company

  • Changed property configured_rates (array)

    List of Standard Rates

    Changed items (object):

    • Added property min_down_payment_rate (number)

      Minimum down payment Rate of rate configuration

    • Added property max_down_payment_rate (number)

      Maximum down payment Rate of rate configuration

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

Request:

Changed content type : application/json

• Changed property configured_rates (array)

  List of Standard Rates

  Changed items (object):

  • Added property min_down_payment_rate (number)

    Minimum down payment Rate of rate configuration

  • Added property max_down_payment_rate (number)

    Maximum down payment Rate of rate configuration

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property configured_rates (array)

    List of Standard Rates

    Changed items (object):

    • Added property min_down_payment_rate (number)

      Minimum down payment Rate of rate configuration

    • Added property max_down_payment_rate (number)

      Maximum down payment Rate of rate configuration

GET /config/interest-chart/filter

Parameters:

Deleted: rate_type in query

GET /config/interest-chart

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  Changed items (object):

  • Deleted property rate_type (string)

    Rate type for Interest Rate Chart Criteria

POST /config/interest-chart

Request:

Changed content type : application/json

• Deleted property rate_type (string)

  Rate type for Interest Rate Chart Criteria

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Deleted property rate_type (string)

    Rate type for Interest Rate Chart Criteria

GET /config/interest-chart/{interest_chart_id}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Deleted property rate_type (string)

    Rate type for Interest Rate Chart Criteria

DELETE /config/interest-chart/{interest_chart_id}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Deleted property rate_type (string)

    Rate type for Interest Rate Chart Criteria

PATCH /config/interest-chart/{interest_chart_id}

Request:

Changed content type : application/json

• Deleted property rate_type (string)

  Rate type for Interest Rate Chart Criteria

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Deleted property rate_type (string)

    Rate type for Interest Rate Chart Criteria

POST /config/interest-chart-evaluate

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  Changed items (object):

  • Deleted property rate_type (string)

    Rate type for Interest Rate Chart Criteria

POST /config/interest-chart/criteria

Request:

Changed content type : application/json

• Changed property interestCriteria (object)

  • Deleted property rate_type (string)

    Rate type for Interest Rate Chart Criteria

POST /config/fees-chart/criteria

Request:

Changed content type : application/json

• Changed property criteria (object)

  • Changed property chart_id (integer)

    Chart id for Fees Chart Criteria

GET /config/fees-chart

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  Changed items (object):

  • Changed property chart_id (integer)

    Chart id for Fees Chart Criteria

POST /config/fees-chart

Request:

Changed content type : application/json

• Changed property chart_id (integer)

  Chart id for Fees Chart Criteria

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property chart_id (integer)

    Chart id for Fees Chart Criteria

GET /config/fees-chart/{fees_chart_id}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property chart_id (integer)

    Chart id for Fees Chart Criteria

DELETE /config/fees-chart/{fees_chart_id}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property chart_id (integer)

    Chart id for Fees Chart Criteria

PATCH /config/fees-chart/{fees_chart_id}

Request:

Changed content type : application/json

• Changed property chart_id (integer)

  Chart id for Fees Chart Criteria

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property chart_id (integer)

    Chart id for Fees Chart Criteria

GET /config/fees-chart/paginated/filter

Parameters:

Added: fee_name in query

GET /config/master-list-accessories

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  Changed items (object):

  • Changed property compatible_models (array)

    Compatible models of Master List Accessory

    Changed items (object):

    New required properties:

    • make_id
    • model_code
    • model_name

    New optional properties:

    • model_id

    • trim_code

    • trim_name

    • Added property model_name (string)

    • Added property model_code (string)

    • Added property description (string)

    • Added property make_id (integer)

    • Deleted property trim_name (string)

    • Deleted property trim_description (string)

    • Deleted property trim_code (string)

    • Deleted property trim_image (array)

    • Deleted property model_id (integer)

POST /config/master-list-accessories

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property compatible_models (array)

    Compatible models of Master List Accessory

    Changed items (object):

    New required properties:

    • make_id
    • model_code
    • model_name

    New optional properties:

    • model_id

    • trim_code

    • trim_name

    • Added property model_name (string)

    • Added property model_code (string)

    • Added property description (string)

    • Added property make_id (integer)

    • Deleted property trim_name (string)

    • Deleted property trim_description (string)

    • Deleted property trim_code (string)

    • Deleted property trim_image (array)

    • Deleted property model_id (integer)

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

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property compatible_models (array)

    Compatible models of Master List Accessory

    Changed items (object):

    New required properties:

    • make_id
    • model_code
    • model_name

    New optional properties:

    • model_id

    • trim_code

    • trim_name

    • Added property model_name (string)

    • Added property model_code (string)

    • Added property description (string)

    • Added property make_id (integer)

    • Deleted property trim_name (string)

    • Deleted property trim_description (string)

    • Deleted property trim_code (string)

    • Deleted property trim_image (array)

    • Deleted property model_id (integer)

GET /config/odometer/{company_id}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property time_zone (string)

    Time zone for company

  • Added property day_light_saving (boolean)

    Daylight saving applicable

  • Added property shift_inventory_file_time (string)

    Shift Digital Inventory File Time in UTC

  • Added property domain (string)

    Domain of a Company

  • Added property correspondence_email (string)

    Correspondence Email of a Company

GET /config/stipulation/

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  Changed items (object):

  • Changed property stipulation_code (string)

    Stipulation Code that will be unique with maximum 50 alphanumeric characters

POST /config/stipulation/

Request:

Changed content type : application/json

• Changed property stipulation_code (string)

  Stipulation Code that will be unique with maximum 50 alphanumeric characters

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property stipulation_code (string)

    Stipulation Code that will be unique with maximum 50 alphanumeric characters

GET /config/stipulation/filter

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property result (array)

    Changed items (object):

    • Changed property stipulation_code (string)

      Stipulation Code that will be unique with maximum 50 alphanumeric characters

GET /config/stipulation/{stipulation_id}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property stipulation_code (string)

    Stipulation Code that will be unique with maximum 50 alphanumeric characters

DELETE /config/stipulation/{stipulation_id}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property stipulation_code (string)

    Stipulation Code that will be unique with maximum 50 alphanumeric characters

PATCH /config/stipulation/{stipulation_id}

Request:

Changed content type : application/json

• Changed property stipulation_code (string)

  Stipulation Code that will be unique with maximum 50 alphanumeric characters

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property stipulation_code (string)

    Stipulation Code that will be unique with maximum 50 alphanumeric characters

POST /config/programs/all/

Request:

Changed content type : application/json

• Added property tier (string)

  Tier

GET /config/dealer/option

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  Changed items (object):

  • Changed property compatible_models (array)

    Addon compatible_models

    Changed items (object):

    New required properties:

    • make_id
    • model_code
    • model_name

    New optional properties:

    • model_id

    • trim_code

    • trim_name

    • Added property model_name (string)

    • Added property model_code (string)

    • Added property description (string)

    • Added property make_id (integer)

    • Deleted property trim_name (string)

    • Deleted property trim_description (string)

    • Deleted property trim_code (string)

    • Deleted property trim_image (array)

    • Deleted property model_id (integer)

POST /config/dealer/option

Return Type:

Changed response : 201 Created

Successful Response

• Changed content type : application/json

  • Changed property compatible_models (array)

    Addon compatible_models

    Changed items (object):

    New required properties:

    • make_id
    • model_code
    • model_name

    New optional properties:

    • model_id

    • trim_code

    • trim_name

    • Added property model_name (string)

    • Added property model_code (string)

    • Added property description (string)

    • Added property make_id (integer)

    • Deleted property trim_name (string)

    • Deleted property trim_description (string)

    • Deleted property trim_code (string)

    • Deleted property trim_image (array)

    • Deleted property model_id (integer)

GET /config/dealer/option/{option_id}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property compatible_models (array)

    Addon compatible_models

    Changed items (object):

    New required properties:

    • make_id
    • model_code
    • model_name

    New optional properties:

    • model_id

    • trim_code

    • trim_name

    • Added property model_name (string)

    • Added property model_code (string)

    • Added property description (string)

    • Added property make_id (integer)

    • Deleted property trim_name (string)

    • Deleted property trim_description (string)

    • Deleted property trim_code (string)

    • Deleted property trim_image (array)

    • Deleted property model_id (integer)

PATCH /config/dealer/option/{option_id}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property compatible_models (array)

    Addon compatible_models

    Changed items (object):

    New required properties:

    • make_id
    • model_code
    • model_name

    New optional properties:

    • model_id

    • trim_code

    • trim_name

    • Added property model_name (string)

    • Added property model_code (string)

    • Added property description (string)

    • Added property make_id (integer)

    • Deleted property trim_name (string)

    • Deleted property trim_description (string)

    • Deleted property trim_code (string)

    • Deleted property trim_image (array)

    • Deleted property model_id (integer)

GET /config/dealer/fee

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  Changed items (object):

  • Deleted property external_code (string)

    external_code

POST /config/dealer/fee

Request:

Changed content type : application/json

• Deleted property external_code (string)

  external_code

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Deleted property external_code (string)

    external_code

GET /config/dealer/{dealer_code}/fees

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  Changed items (object):

  • Deleted property external_code (string)

    external_code

GET /config/dealer/fee/{fee_id}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Deleted property external_code (string)

    external_code

DELETE /config/dealer/fee/{fee_id}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Deleted property external_code (string)

    external_code

PATCH /config/dealer/fee/{fee_id}

Request:

Changed content type : application/json

• Deleted property external_code (string)

  external_code

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Deleted property external_code (string)

    external_code

GET /config/dealer/profile

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  Changed items (object):

  • Added property time_zone_difference (string)

    time zone Difference

  • Added property sub_domain (string)

    Sub Domain

  • Changed property available_finance_types (array)

    available finance types

    Changed items (string):

    Removed enum values:

    • Finance
    • Lease
    • `` POST /config/dealer/profile

Request:

Changed content type : application/json

• Added property time_zone_difference (string)

  time zone Difference

• Added property sub_domain (string)

  Sub Domain

• Changed property available_finance_types (array)

  available finance types

  Changed items (string):

  Removed enum values:

  • Finance
  • Lease
  • `` Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property time_zone_difference (string)

    time zone Difference

  • Added property sub_domain (string)

    Sub Domain

  • Changed property available_finance_types (array)

    available finance types

    Changed items (string):

    Removed enum values:

    • Finance
    • Lease
    • `` DELETE /config/dealer/profile/{dealer_profile_id}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property time_zone_difference (string)

    time zone Difference

  • Added property sub_domain (string)

    Sub Domain

  • Changed property available_finance_types (array)

    available finance types

    Changed items (string):

    Removed enum values:

    • Finance
    • Lease
    • `` PATCH /config/dealer/profile/{dealer_profile_id}

Request:

Changed content type : application/json

• Added property time_zone_difference (string)

  time zone Difference

• Added property sub_domain (string)

  Sub Domain

• Changed property available_finance_types (array)

  available finance types

  Changed items (string):

  Removed enum values:

  • Finance
  • Lease
  • `` Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property time_zone_difference (string)

    time zone Difference

  • Added property sub_domain (string)

    Sub Domain

  • Changed property available_finance_types (array)

    available finance types

    Changed items (string):

    Removed enum values:

    • Finance
    • Lease
    • `` PATCH /config/dealer/profile/pen-dealer-id/{dealer_code}/{pen_dealer_id}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property time_zone_difference (string)

    time zone Difference

  • Added property sub_domain (string)

    Sub Domain

  • Changed property available_finance_types (array)

    available finance types

    Changed items (string):

    Removed enum values:

    • Finance
    • Lease
    • `` GET /config/dealer/profile/{dealer_code}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property time_zone_difference (string)

    time zone Difference

  • Added property sub_domain (string)

    Sub Domain

  • Changed property available_finance_types (array)

    available finance types

    Changed items (string):

    Removed enum values:

    • Finance
    • Lease
    • `` GET /config/dealer/preference

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  Changed items (object):

  • Changed property standard_lease_rates (object)

    Standard Lease rates for dealer

    • Added property min_down_payment_rate (number)

      Minimum down payment Rate of rate configuration

    • Added property max_down_payment_rate (number)

      Maximum down payment Rate of rate configuration

  • Changed property standard_finance_rates (object)

    Standard Finance rates for dealer

    • Added property min_down_payment_rate (number)

      Minimum down payment Rate of rate configuration

    • Added property max_down_payment_rate (number)

      Maximum down payment Rate of rate configuration

POST /config/dealer/preference

Request:

Changed content type : application/json

• Changed property standard_lease_rates (object)

  Standard Lease rates for dealer

  • Added property min_down_payment_rate (number)

    Minimum down payment Rate of rate configuration

  • Added property max_down_payment_rate (number)

    Maximum down payment Rate of rate configuration

• Changed property standard_finance_rates (object)

  Standard Finance rates for dealer

  • Added property min_down_payment_rate (number)

    Minimum down payment Rate of rate configuration

  • Added property max_down_payment_rate (number)

    Maximum down payment Rate of rate configuration

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property standard_lease_rates (object)

    Standard Lease rates for dealer

    • Added property min_down_payment_rate (number)

      Minimum down payment Rate of rate configuration

    • Added property max_down_payment_rate (number)

      Maximum down payment Rate of rate configuration

  • Changed property standard_finance_rates (object)

    Standard Finance rates for dealer

    • Added property min_down_payment_rate (number)

      Minimum down payment Rate of rate configuration

    • Added property max_down_payment_rate (number)

      Maximum down payment Rate of rate configuration

DELETE /config/dealer/preference/{dealerpreference_id}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property standard_lease_rates (object)

    Standard Lease rates for dealer

    • Added property min_down_payment_rate (number)

      Minimum down payment Rate of rate configuration

    • Added property max_down_payment_rate (number)

      Maximum down payment Rate of rate configuration

  • Changed property standard_finance_rates (object)

    Standard Finance rates for dealer

    • Added property min_down_payment_rate (number)

      Minimum down payment Rate of rate configuration

    • Added property max_down_payment_rate (number)

      Maximum down payment Rate of rate configuration

PATCH /config/dealer/preference/{dealer_preference_id}

Request:

Changed content type : application/json

• Changed property standard_lease_rates (object)

  Standard Lease rates for dealer

  • Added property min_down_payment_rate (number)

    Minimum down payment Rate of rate configuration

  • Added property max_down_payment_rate (number)

    Maximum down payment Rate of rate configuration

• Changed property standard_finance_rates (object)

  Standard Finance rates for dealer

  • Added property min_down_payment_rate (number)

    Minimum down payment Rate of rate configuration

  • Added property max_down_payment_rate (number)

    Maximum down payment Rate of rate configuration

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property standard_lease_rates (object)

    Standard Lease rates for dealer

    • Added property min_down_payment_rate (number)

      Minimum down payment Rate of rate configuration

    • Added property max_down_payment_rate (number)

      Maximum down payment Rate of rate configuration

  • Changed property standard_finance_rates (object)

    Standard Finance rates for dealer

    • Added property min_down_payment_rate (number)

      Minimum down payment Rate of rate configuration

    • Added property max_down_payment_rate (number)

      Maximum down payment Rate of rate configuration

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

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property standard_lease_rates (object)

    Standard Lease rates for dealer

    • Added property min_down_payment_rate (number)

      Minimum down payment Rate of rate configuration

    • Added property max_down_payment_rate (number)

      Maximum down payment Rate of rate configuration

  • Changed property standard_finance_rates (object)

    Standard Finance rates for dealer

    • Added property min_down_payment_rate (number)

      Minimum down payment Rate of rate configuration

    • Added property max_down_payment_rate (number)

      Maximum down payment Rate of rate configuration

POST /config/dealers

Request:

Changed content type : application/json

• Added property chat (boolean)

  Dealer chat status

• Added property user_is_active (boolean)

  Dealer User Status

• Deleted property external_code (string)

  Lender Code

Return Type:

Changed response : 201 Created

Successful Response

• Changed content type : application/json

  • Added property chat (boolean)

    Dealer chat status

  • Added property user_is_active (boolean)

    Dealer User Status

  • Deleted property external_code (string)

    Lender Code

GET /config/dealers/active

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  Changed items (object):

  • Added property user_is_active (boolean)

    Dealer User Status

GET /config/dealers/filter

Parameters:

Added: chat in query

Added: user_is_active in query

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property result (array)

    Changed items (object):

    • Added property chat (boolean)

      Dealer chat status

    • Added property user_is_active (boolean)

      Dealer User Status

    • Deleted property external_code (string)

      Lender Code

GET /config/dealers/{dealer_id}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property chat (boolean)

    Dealer chat status

  • Added property user_is_active (boolean)

    Dealer User Status

  • Deleted property external_code (string)

    Lender Code

PUT /config/dealers/{dealer_id}

Request:

Changed content type : application/json

• Added property chat (boolean)

  Dealers chat status

• Added property user_is_active (boolean)

  Dealer User Status

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property chat (boolean)

    Dealers chat status

  • Added property user_is_active (boolean)

    Dealer User Status

DELETE /config/dealers/{dealer_id}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property chat (boolean)

    Dealer chat status

  • Added property user_is_active (boolean)

    Dealer User Status

  • Deleted property external_code (string)

    Lender Code

GET /config/dealer

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  Changed items (object):

  • Added property chat (boolean)

    Dealer chat status

  • Added property user_is_active (boolean)

    Dealer User Status

  • Deleted property external_code (string)

    Lender Code

GET /config/dealer/{dealer_code}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property chat (boolean)

    Dealer chat status

  • Added property user_is_active (boolean)

    Dealer User Status

  • Deleted property external_code (string)

    Lender Code

GET /config/dealer/find/by-tenant

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property chat (boolean)

    Dealer chat status

  • Added property user_is_active (boolean)

    Dealer User Status

  • Deleted property external_code (string)

    Lender Code

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

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property time_zone_difference (string)

    time zone Difference

  • Added property sub_domain (string)

    Sub Domain

  • Changed property available_finance_types (array)

    available finance types

    Changed items (string):

    Removed enum values:

    • Finance
    • Lease
    • `` GET /config/dealer/fees/filter

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property result (array)

    Changed items (object):

    • Deleted property external_code (string)

      external_code

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

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property time_zone_difference (string)

    time zone Difference

  • Added property sub_domain (string)

    Sub Domain

  • Changed property available_finance_types (array)

    available finance types

    Changed items (string):

    Removed enum values:

    • Finance
    • Lease
    • `` PATCH /config/dealer/profile/stripe-dealer-id/{dealer_code}/{stripe_dealer_id}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property time_zone_difference (string)

    time zone Difference

  • Added property sub_domain (string)

    Sub Domain

  • Changed property available_finance_types (array)

    available finance types

    Changed items (string):

    Removed enum values:

    • Finance
    • Lease
    • `` POST /config/dealer/compatible-options

Request:

Changed content type : application/json

New required properties:

• model_names

New optional properties:

• trim_codes

• Added property model_names (array)

  Items (string):

• Deleted property trim_codes (array)

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  Changed items (object):

  • Changed property compatible_models (array)

    AddonModel compatible_models

    Changed items (object):

    New required properties:

    • make_id
    • model_code
    • model_name

    New optional properties:

    • model_id

    • trim_code

    • trim_name

    • Added property model_name (string)

    • Added property model_code (string)

    • Added property description (string)

    • Added property make_id (integer)

    • Deleted property trim_name (string)

    • Deleted property trim_description (string)

    • Deleted property trim_code (string)

    • Deleted property trim_image (array)

    • Deleted property model_id (integer)

GET /config/vehicle_by_vin/{vehicle_id}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property vehicle_url (object -> object)

    List of vehicle URLs

  • Changed property photo_urls (array)

    List of vehicle photo urls

    Changed items (object -> object):

GET /config/vehicle/{vin}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property vehicle_url (object -> object)

    List of vehicle URLs

  • Changed property photo_urls (array)

    List of vehicle photo urls

    Changed items (object -> object):

DELETE /config/vehicle/{vehicle_id}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property vehicle_url (object -> object)

    List of vehicle URLs

  • Changed property photo_urls (array)

    List of vehicle photo urls

    Changed items (object -> object):

PATCH /config/vehicle/{vehicle_id}

Request:

Changed content type : application/json

• Changed property vehicle_url (object -> object)

  List of vehicle URLs

• Changed property photo_urls (array)

  List of vehicle photo urls

  Changed items (object -> object):

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property vehicle_url (object -> object)

    List of vehicle URLs

  • Changed property photo_urls (array)

    List of vehicle photo urls

    Changed items (object -> object):

GET /config/inventory/attached-option

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  Changed items (object):

  • Changed property compatible_models (array)

    AddonModel compatible_models

    Changed items (object):

    New required properties:

    • make_id
    • model_code
    • model_name

    New optional properties:

    • model_id

    • trim_code

    • trim_name

    • Added property model_name (string)

    • Added property model_code (string)

    • Added property description (string)

    • Added property make_id (integer)

    • Deleted property trim_name (string)

    • Deleted property trim_description (string)

    • Deleted property trim_code (string)

    • Deleted property trim_image (array)

    • Deleted property model_id (integer)

POST /config/vehicle/

Parameters:

Added: company_id in header

Request:

Changed content type : application/json

New required properties:

• trim_code

• Added property trim_code (string)

  Model code of vehicle

• Changed property photo_urls (array)

  List of vehicle photo urls

  Changed items (object -> object):

• Changed property vehicle_url (object -> object)

  List of vehicle URLs

Return Type:

Changed response : 201 Created

Successful Response

• Changed content type : application/json

  New required properties:

  • trim_code

  • Added property trim_code (string)

    Model code of vehicle

  • Changed property photo_urls (array)

    List of vehicle photo urls

    Changed items (object -> object):

  • Changed property vehicle_url (object -> object)

    List of vehicle URLs

PUT /config/vehicle/update-bulk

Parameters:

Added: option in query

GET /config/financial-insurance

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  Changed items (object):

  • Added property category_code (string)

    Category Code for Financial Insurance Product

POST /config/financial-insurance

Request:

Changed content type : application/json

• Added property category_code (string)

  Category Code for Financial Insurance Product

Return Type:

Changed response : 201 Created

Successful Response

• Changed content type : application/json

  • Added property category_code (string)

    Category Code for Financial Insurance Product

GET /config/financial-insurance/{financial_insurance_id}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property category_code (string)

    Category Code for Financial Insurance Product

DELETE /config/financial-insurance/{financial_insurance_id}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property category_code (string)

    Category Code for Financial Insurance Product

PATCH /config/financial-insurance/{financial_insurance_id}

Request:

Changed content type : application/json

• Added property category_code (string)

  Category Code for Financial Insurance Product

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property category_code (string)

    Category Code for Financial Insurance Product

GET /config/finance_type

Parameters:

Deleted: company_id in header

Return Type:

Deleted response : 422 Unprocessable Entity

Validation Error

GET /config/fp-category-mapping

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  Changed items (object):

  • Added property category_code (string)

    Category Code for Financial Insurance

POST /config/fp-category-mapping

Request:

Changed content type : application/json

Changed items (object):

• Added property category_code (string)

  Category Code for Financial Insurance

Return Type:

Changed response : 201 Created

Successful Response

• Changed content type : application/json

  Changed items (object):

  • Added property category_code (string)

    Category Code for Financial Insurance

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

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property category_code (string)

    Category Code for Financial Insurance

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

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property category_code (string)

    Category Code for Financial Insurance

POST /config/company/create-company

Request:

Changed content type : application/json

• Changed property company_profile (object)

  • Added property time_zone (string)

    Time zone for company

  • Added property day_light_saving (boolean)

    Daylight saving applicable

  • Added property shift_inventory_file_time (string)

    Shift Digital Inventory File Time in UTC

  • Added property domain (string)

    Domain of a Company

  • Added property correspondence_email (string)

    Correspondence Email of a Company

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property time_zone (string)

    Time zone for company

  • Added property day_light_saving (boolean)

    Daylight saving applicable

  • Added property shift_inventory_file_time (string)

    Shift Digital Inventory File Time in UTC

  • Added property domain (string)

    Domain of a Company

  • Added property correspondence_email (string)

    Correspondence Email of a Company

GET /config/company/{company_id}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property time_zone (string)

    Time zone for company

  • Added property day_light_saving (boolean)

  • Added property shift_inventory_file_time (string)

    Shift Digital Inventory File Time in UTC

  • Added property domain (string)

    Domain of a Company

  • Added property contact_person_name (string)

    Contact Person Name

  • Added property contact_person_email (string)

    Contact Person Email

  • Added property contact_person_phone_number (string)

    Contact Person Phone Number

  • Added property correspondence_email (string)

    Correspondence Email of a Company

  • Deleted property theme (object)

    Theme of a company

  • Changed property configured_rates (array)

    List of Standard Rates

    Changed items (object):

    • Added property min_down_payment_rate (number)

      Minimum down payment Rate of rate configuration

    • Added property max_down_payment_rate (number)

      Maximum down payment Rate of rate configuration

DELETE /config/company/{company_id}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property time_zone (string)

    Time zone for company

  • Added property day_light_saving (boolean)

  • Added property shift_inventory_file_time (string)

    Shift Digital Inventory File Time in UTC

  • Added property domain (string)

    Domain of a Company

  • Added property contact_person_name (string)

    Contact Person Name

  • Added property contact_person_email (string)

    Contact Person Email

  • Added property contact_person_phone_number (string)

    Contact Person Phone Number

  • Added property correspondence_email (string)

    Correspondence Email of a Company

  • Deleted property theme (object)

    Theme of a company

  • Changed property configured_rates (array)

    List of Standard Rates

    Changed items (object):

    • Added property min_down_payment_rate (number)

      Minimum down payment Rate of rate configuration

    • Added property max_down_payment_rate (number)

      Maximum down payment Rate of rate configuration

PATCH /config/company/{company_id}

Request:

Changed content type : application/json

• Changed property company_profile (object)

  • Added property time_zone (string)

    Time zone for company

  • Added property day_light_saving (boolean)

    Daylight saving applicable

  • Added property shift_inventory_file_time (string)

    Shift Digital Inventory File Time in UTC

  • Added property domain (string)

    Domain of a Company

  • Added property correspondence_email (string)

    Correspondence Email of a Company

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property time_zone (string)

    Time zone for company

  • Added property day_light_saving (boolean)

  • Added property shift_inventory_file_time (string)

    Shift Digital Inventory File Time in UTC

  • Added property domain (string)

    Domain of a Company

  • Added property contact_person_name (string)

    Contact Person Name

  • Added property contact_person_email (string)

    Contact Person Email

  • Added property contact_person_phone_number (string)

    Contact Person Phone Number

  • Added property correspondence_email (string)

    Correspondence Email of a Company

  • Deleted property theme (object)

    Theme of a company

  • Changed property configured_rates (array)

    List of Standard Rates

    Changed items (object):

    • Added property min_down_payment_rate (number)

      Minimum down payment Rate of rate configuration

    • Added property max_down_payment_rate (number)

      Maximum down payment Rate of rate configuration

GET /config/financial-product/{financial_product_id}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property dealers (array)

    Associated dealers with a program

    Changed items (object):

    • Added property chat (boolean)

      Dealer chat status

    • Added property user_is_active (boolean)

      Dealer User Status

    • Deleted property external_code (string)

      Lender Code

PATCH /config/financial-product/{financial_product_id}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property dealers (array)

    Associated dealers with a program

    Changed items (object):

    • Added property chat (boolean)

      Dealer chat status

    • Added property user_is_active (boolean)

      Dealer User Status

    • Deleted property external_code (string)

      Lender Code

POST /config/financial-product/create-fp

Return Type:

Changed response : 201 Created

Successful Response

• Changed content type : application/json

  • Changed property dealers (array)

    Associated dealers with a program

    Changed items (object):

    • Added property chat (boolean)

      Dealer chat status

    • Added property user_is_active (boolean)

      Dealer User Status

    • Deleted property external_code (string)

      Lender Code

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

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property dealers (array)

    Associated dealers with a program

    Changed items (object):

    • Added property chat (boolean)

      Dealer chat status

    • Added property user_is_active (boolean)

      Dealer User Status

    • Deleted property external_code (string)

      Lender Code

GET /config/master-list-accessorie/filter

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property result (array)

    Changed items (object):

    • Changed property compatible_models (array)

      Compatible models of Master List Accessory

      Changed items (object):

      New required properties:

      • make_id
      • model_code
      • model_name

      New optional properties:

      • model_id

      • trim_code

      • trim_name

      • Added property model_name (string)

      • Added property model_code (string)

      • Added property description (string)

      • Added property make_id (integer)

      • Deleted property trim_name (string)

      • Deleted property trim_description (string)

      • Deleted property trim_code (string)

      • Deleted property trim_image (array)

      • Deleted property model_id (integer)

GET /config/dealer/option/filter

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property result (array)

    Changed items (object):

    • Changed property compatible_models (array)

      Addon compatible_models

      Changed items (object):

      New required properties:

      • make_id
      • model_code
      • model_name

      New optional properties:

      • model_id

      • trim_code

      • trim_name

      • Added property model_name (string)

      • Added property model_code (string)

      • Added property description (string)

      • Added property make_id (integer)

      • Deleted property trim_name (string)

      • Deleted property trim_description (string)

      • Deleted property trim_code (string)

      • Deleted property trim_image (array)

      • Deleted property model_id (integer)

GET /config/financial-insurances/filter

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property result (array)

    Changed items (object):

    • Added property category_code (string)

      Category Code for Financial Insurance Product

POST /config/checklist_response_verification/

GET /config/financial-product/filter

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property result (array)

    Changed items (object):

    • Changed property dealers (array)

      Associated dealers with a program

      Changed items (object):

      • Added property chat (boolean)

        Dealer chat status

      • Added property user_is_active (boolean)

        Dealer User Status

      • Deleted property external_code (string)

        Lender Code