API Doc Version 1.0.27

What's New

GET /config/lender_by_api_key

Get a lender record

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

Get Api Key By Token

POST /config/stipulation-reason

Creates a stipulation Reason

GET /config/stipulation-reason/{stipulation_name}/{reason_status}

Get Stipulation by Reason Status

DELETE /config/stipulation-reason/{stipulation_reason_id}

Delete Stipulation Reason

GET /config/dealer/tradein/{tradein_id}

Get dealer trade in record provided by trade in Id

GET /config/dealer/listing_type/provider/

Get provider by dealer code and listing type

GET /config/integration/mitek-integration/{provider_name}

Get Product Onboarding

GET /config/business-partner/

Get Business Partner

POST /config/business-partner/

Create Business Partner

PATCH /config/business-partner/

Update Business Partner

What's Deleted

GET /config/allowed-mileage

Get all allowed mileage records

GET /config/allowed-mileage/{mileage_id}

Get allowed mileage record by Id

GET /config/dealer/tradein/{trade_id}

Get dealer trade in record provided by trade Id

What's Changed

GET /config/vehicle

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  Changed items (object):

  • Changed property photo_urls (object -> array)

    List of vehicle photo urls

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

Parameters:

Changed: lender_id in header

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

Parameters:

Changed: lender_id in header

GET /config/asset-model

Parameters:

Changed: lender_id in header

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  Changed items (object):

  • Changed property asset_trims (array)

    Changed items (object):

    • Changed property trim_code (string)

GET /config/asset-model/{asset_model_id}

Parameters:

Changed: lender_id in header

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property asset_trims (array)

    Changed items (object):

    • Changed property trim_code (string)

DELETE /config/asset-model/{asset_model_id}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property asset_trims (array)

    Changed items (object):

    • Changed property trim_code (string)

PATCH /config/asset-model/{model_id}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property asset_trims (array)

    Changed items (object):

    • Changed property trim_code (string)

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

Parameters:

Changed: lender_id in header

GET /config/asset-trim

Parameters:

Changed: lender_id in header

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  Changed items (object):

  • Changed property trim_code (string)

POST /config/asset-trim

Request:

Changed content type : application/json

• Changed property trim_code (string)

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property trim_code (string)

GET /config/asset-trim/{trim_id}

Parameters:

Changed: lender_id in header

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property trim_code (string)

DELETE /config/asset-trim/{trim_id}

Parameters:

Changed: lender_id in header

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property trim_code (string)

PATCH /config/asset-trim/{trim_id}

Request:

Changed content type : application/json

New required properties:

• lender_id

• Changed property trim_code (string)

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  New required properties:

  • lender_id

  • Changed property trim_code (string)

GET /config/asset-model-trim

Parameters:

Changed: lender_id in header

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  Changed items (object):

  • Changed property asset_trims (array)

    Changed items (object):

    • Changed property trim_code (string)

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

Parameters:

Changed: lender_id in header

GET /config/asset-condition-test/filter

Parameters:

Changed: lender_id in header

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property result (array)

    Changed items (object):

    New required properties:

    • lender_id

GET /config/asset-conditions

Parameters:

Changed: lender_id in header

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  Changed items (object):

  New required properties:

  • lender_id

POST /config/asset-conditions

Parameters:

Added: lender_id in header

Request:

Changed content type : application/json

• Deleted property lender_id (integer)

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  New required properties:

  • lender_id

GET /config/asset-conditions/{asset_condition_id}

Parameters:

Changed: asset_condition_id in path

Changed: lender_id in header

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  New required properties:

  • lender_id

DELETE /config/asset-conditions/{asset_condition_id}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  New required properties:

  • lender_id

PATCH /config/asset-conditions/{asset_condition_id}

Parameters:

Added: lender_id in header

Request:

Changed content type : application/json

• Deleted property lender_id (integer)

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  New required properties:

  • lender_id

GET /config/asset-condition/active

Parameters:

Changed: lender_id in header

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  Changed items (object):

  New required properties:

  • lender_id

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

Parameters:

Changed: lender_id in header

GET /config/asset-usage/filter

Parameters:

Changed: lender_id in header

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property result (array)

    Changed items (object):

    New required properties:

    • lender_id

GET /config/asset-usages

Parameters:

Changed: lender_id in header

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  Changed items (object):

  New required properties:

  • lender_id

POST /config/asset-usages

Parameters:

Added: lender_id in header

Request:

Changed content type : application/json

• Deleted property lender_id (integer)

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  New required properties:

  • lender_id

GET /config/asset-usages/{asset_usage_id}

Parameters:

Changed: asset_usage_id in path

Changed: lender_id in header

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  New required properties:

  • lender_id

DELETE /config/asset-usages/{asset_usage_id}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  New required properties:

  • lender_id

PATCH /config/asset-usages/{asset_usage_id}

Request:

Changed content type : application/json

• Deleted property lender_id (integer)

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  New required properties:

  • lender_id

GET /config/asset-usage/active

Parameters:

Changed: lender_id in header

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  Changed items (object):

  New required properties:

  • lender_id

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

Check Asset usage Code Exist

Parameters:

Changed: lender_id in header

POST /config/lender/create-lender

Request:

Changed content type : application/json

• Changed property lender_profile (object)

  • Added property existing_customer_check (string)

    Existing Customer Check of the Lender

• Changed property lender_addresses (array)

  Changed items (object):

  • Changed property id (integer)

    Primary id of Dealer Address

  • Changed property address_line_1 (string)

    Address 1 of Dealer

  • Changed property address_line_2 (string)

    Address 2 of Dealer

  • Changed property state_id (integer)

    State of Dealer

  • Changed property state_name (string)

    State Name of Dealer

  • Changed property zip_code (string)

    Zip code of Dealer

  • Changed property county (string)

    County Name of Dealer

  • Changed property city (string)

    City of Dealer

  • Changed property contact_number (string)

    Contact Number of Dealer

  • Changed property verified (boolean)

    Verification Status of Dealer

  • Changed property address_type (string)

    Address type of Dealer

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property existing_customer_check (string)

    Existing Customer Check of the Lender

GET /config/lender

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  Changed items (object):

  • Added property existing_customer_check (string)

    Existing Customer Check of the Lender

  • Changed property addresses (array)

    Associate Lender Addresses

    Changed items (object):

    • Changed property id (integer)

      Primary id of Dealer Address

    • Changed property address_line_1 (string)

      Address 1 of Dealer

    • Changed property address_line_2 (string)

      Address 2 of Dealer

    • Changed property state_id (integer)

      State of Dealer

    • Changed property state_name (string)

      State Name of Dealer

    • Changed property zip_code (string)

      Zip code of Dealer

    • Changed property county (string)

      County Name of Dealer

    • Changed property city (string)

      City of Dealer

    • Changed property contact_number (string)

      Contact Number of Dealer

    • Changed property verified (boolean)

      Verification Status of Dealer

    • Changed property address_type (string)

      Address type of Dealer

GET /config/lender/{lender_id}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property existing_customer_check (string)

    Existing Customer Check of the Lender

  • Changed property addresses (array)

    Associate Lender Addresses

    Changed items (object):

    • Changed property id (integer)

      Primary id of Dealer Address

    • Changed property address_line_1 (string)

      Address 1 of Dealer

    • Changed property address_line_2 (string)

      Address 2 of Dealer

    • Changed property state_id (integer)

      State of Dealer

    • Changed property state_name (string)

      State Name of Dealer

    • Changed property zip_code (string)

      Zip code of Dealer

    • Changed property county (string)

      County Name of Dealer

    • Changed property city (string)

      City of Dealer

    • Changed property contact_number (string)

      Contact Number of Dealer

    • Changed property verified (boolean)

      Verification Status of Dealer

    • Changed property address_type (string)

      Address type of Dealer

DELETE /config/lender/{lender_id}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property existing_customer_check (string)

    Existing Customer Check of the Lender

  • Changed property addresses (array)

    Associate Lender Addresses

    Changed items (object):

    • Changed property id (integer)

      Primary id of Dealer Address

    • Changed property address_line_1 (string)

      Address 1 of Dealer

    • Changed property address_line_2 (string)

      Address 2 of Dealer

    • Changed property state_id (integer)

      State of Dealer

    • Changed property state_name (string)

      State Name of Dealer

    • Changed property zip_code (string)

      Zip code of Dealer

    • Changed property county (string)

      County Name of Dealer

    • Changed property city (string)

      City of Dealer

    • Changed property contact_number (string)

      Contact Number of Dealer

    • Changed property verified (boolean)

      Verification Status of Dealer

    • Changed property address_type (string)

      Address type of Dealer

PATCH /config/lender/{lender_id}

Request:

Changed content type : application/json

• Changed property lender_profile (object)

  • Added property existing_customer_check (string)

    Existing Customer Check of the Lender

• Changed property lender_addresses (array)

  Changed items (object):

  • Changed property id (integer)

    Primary id of Dealer Address

  • Changed property address_line_1 (string)

    Address 1 of Dealer

  • Changed property address_line_2 (string)

    Address 2 of Dealer

  • Changed property state_id (integer)

    State of Dealer

  • Changed property state_name (string)

    State Name of Dealer

  • Changed property zip_code (string)

    Zip code of Dealer

  • Changed property county (string)

    County Name of Dealer

  • Changed property city (string)

    City of Dealer

  • Changed property contact_number (string)

    Contact Number of Dealer

  • Changed property verified (boolean)

    Verification Status of Dealer

  • Changed property address_type (string)

    Address type of Dealer

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property existing_customer_check (string)

    Existing Customer Check of the Lender

  • Changed property addresses (array)

    Associate Lender Addresses

    Changed items (object):

    • Changed property id (integer)

      Primary id of Dealer Address

    • Changed property address_line_1 (string)

      Address 1 of Dealer

    • Changed property address_line_2 (string)

      Address 2 of Dealer

    • Changed property state_id (integer)

      State of Dealer

    • Changed property state_name (string)

      State Name of Dealer

    • Changed property zip_code (string)

      Zip code of Dealer

    • Changed property county (string)

      County Name of Dealer

    • Changed property city (string)

      City of Dealer

    • Changed property contact_number (string)

      Contact Number of Dealer

    • Changed property verified (boolean)

      Verification Status of Dealer

    • Changed property address_type (string)

      Address type of Dealer

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

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property existing_customer_check (string)

    Existing Customer Check of the Lender

  • Changed property addresses (array)

    Associate Lender Addresses

    Changed items (object):

    • Changed property id (integer)

      Primary id of Dealer Address

    • Changed property address_line_1 (string)

      Address 1 of Dealer

    • Changed property address_line_2 (string)

      Address 2 of Dealer

    • Changed property state_id (integer)

      State of Dealer

    • Changed property state_name (string)

      State Name of Dealer

    • Changed property zip_code (string)

      Zip code of Dealer

    • Changed property county (string)

      County Name of Dealer

    • Changed property city (string)

      City of Dealer

    • Changed property contact_number (string)

      Contact Number of Dealer

    • Changed property verified (boolean)

      Verification Status of Dealer

    • Changed property address_type (string)

      Address type of Dealer

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

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property existing_customer_check (string)

    Existing Customer Check of the Lender

  • Changed property addresses (array)

    Associate Lender Addresses

    Changed items (object):

    • Changed property id (integer)

      Primary id of Dealer Address

    • Changed property address_line_1 (string)

      Address 1 of Dealer

    • Changed property address_line_2 (string)

      Address 2 of Dealer

    • Changed property state_id (integer)

      State of Dealer

    • Changed property state_name (string)

      State Name of Dealer

    • Changed property zip_code (string)

      Zip code of Dealer

    • Changed property county (string)

      County Name of Dealer

    • Changed property city (string)

      City of Dealer

    • Changed property contact_number (string)

      Contact Number of Dealer

    • Changed property verified (boolean)

      Verification Status of Dealer

    • Changed property address_type (string)

      Address type of Dealer

DELETE /config/address/{address_id}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property address_type (string)

    An enumeration.

    Added enum value:

    • Employment GET /config/charts

Parameters:

Changed: lender_id in header

POST /config/charts

Parameters:

Added: lender_id in header

Request:

Changed content type : application/json

• Deleted property lender_id (integer)

  Lender id for Charts

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Deleted property lender_id (integer)

    Lender id for Charts

GET /config/interest-chart/filter

Parameters:

Changed: output_parameter_type in query

Changed: lender_id in header

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property result (array)

    Changed items (object):

    • Deleted property lender_id (integer)

      Lender id for Charts

GET /config/charts/{chart_id}

Parameters:

Changed: lender_id in header

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Deleted property lender_id (integer)

    Lender id for Charts

DELETE /config/charts/{chart_id}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Deleted property lender_id (integer)

    Lender id for Charts

PATCH /config/charts/{chart_id}

Parameters:

Added: lender_id in header

Request:

Changed content type : application/json

• Deleted property lender_id (integer)

  Lender id for Charts

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Deleted property lender_id (integer)

    Lender id for Charts

GET /config/interest-chart

Parameters:

Changed: lender_id in header

GET /config/interest-chart/{interest_chart_id}

Parameters:

Changed: interest_chart_id in path

Changed: lender_id in header

DELETE /config/interest-chart/{interest_chart_id}

Parameters:

Changed: interest_chart_id in path

GET /config/rv-chart

Parameters:

Changed: lender_id in header

GET /config/rv-chart/filter

Parameters:

Changed: lender_id in header

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property result (array)

    Changed items (object):

    • Deleted property lender_id (integer)

      Lender id for Charts

GET /config/rv-chart/{rv_chart_id}

Parameters:

Changed: lender_id in header

POST /config/rv-evaluate

Request:

Changed content type : application/json

• Added property financed_amount (string)

POST /config/interest-chart-evaluate

Request:

Changed content type : application/json

• Changed property late_charge_inclusive_adder (string -> boolean)

• Changed property property_tax_inclusive_adder (string -> boolean)

• Changed property origination_fee_inclusive_adder (string -> boolean)

POST /config/subsidy-chart-evaluate

Request:

Changed content type : application/json

• Added property financed_amount (string)

POST /config/interest-chart/criteria

Parameters:

Added: lender_id in header

Request:

Changed content type : application/json

• Changed property chart (object)

  • Deleted property lender_id (integer)

    Lender id for Charts

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Deleted property lender_id (integer)

    Lender id for Charts

POST /config/rv-chart/criteria

Parameters:

Added: lender_id in header

Request:

Changed content type : application/json

• Changed property chart (object)

  • Deleted property lender_id (integer)

    Lender id for Charts

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Deleted property lender_id (integer)

    Lender id for Charts

POST /config/down-payment/criteria

Parameters:

Added: lender_id in header

Request:

Changed content type : application/json

• Changed property chart (object)

  • Deleted property lender_id (integer)

    Lender id for Charts

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Deleted property lender_id (integer)

    Lender id for Charts

POST /config/commissions/criteria

Parameters:

Added: lender_id in header

Request:

Changed content type : application/json

• Changed property chart (object)

  • Deleted property lender_id (integer)

    Lender id for Charts

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Deleted property lender_id (integer)

    Lender id for Charts

POST /config/subsidy/criteria

Parameters:

Added: lender_id in header

Request:

Changed content type : application/json

• Changed property chart (object)

  • Deleted property lender_id (integer)

    Lender id for Charts

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Deleted property lender_id (integer)

    Lender id for Charts

GET /config/interest-charts/name

Parameters:

Changed: lender_id in header

GET /config/rv-charts/name

Parameters:

Changed: lender_id in header

GET /config/chart/name

Parameters:

Changed: lender_id in header

GET /config/chart/type

Parameters:

Changed: lender_id in header

GET /config/down-payment/filter

Parameters:

Changed: lender_id in header

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property result (array)

    Changed items (object):

    • Deleted property lender_id (integer)

      Lender id for Charts

GET /config/down-payment

Parameters:

Changed: lender_id in header

GET /config/down-payment/{down_payment_id}

Parameters:

Changed: lender_id in header

GET /config/commissions/filter

Parameters:

Changed: lender_id in header

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property result (array)

    Changed items (object):

    • Deleted property lender_id (integer)

      Lender id for Charts

GET /config/commissions

Parameters:

Changed: lender_id in header

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  Changed items (object):

  New optional properties:

  • output_parameter_type

GET /config/commissions/{commission_id}

Parameters:

Changed: lender_id in header

GET /config/subsidy/filter

Parameters:

Changed: lender_id in header

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property result (array)

    Changed items (object):

    • Deleted property lender_id (integer)

      Lender id for Charts

GET /config/subsidy

Parameters:

Changed: lender_id in header

GET /config/subsidy/{subsidy_id}

Parameters:

Changed: lender_id in header

GET /config/charts/filter/

Parameters:

Changed: lender_id in header

POST /config/down-payment-chart-evaluate

Request:

Changed content type : application/json

• Added property financed_amount (string)

POST /config/commission-chart-evaluate

Request:

Changed content type : application/json

• Added property financed_amount (string)

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

Parameters:

Changed: lender_id in header

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

Parameters:

Changed: lender_id in header

GET /config/document-type

Parameters:

Changed: lender_id in header

GET /config/document-type/filter

Parameters:

Changed: lender_id in header

GET /config/document-type/{document_type_id}

Parameters:

Changed: lender_id in header

DELETE /config/document-type/{document_type_id}

Parameters:

Changed: document_type_id in path

GET /config/business-units

Parameters:

Changed: lender_id in header

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  Changed items (object):

  New required properties:

  • lender_id

  • Changed property lender_id (integer)

POST /config/business-units

Parameters:

Added: lender_id in header

Request:

Changed content type : application/json

• Deleted property lender_id (integer)

  Lender id that supports Business type mode

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  New required properties:

  • lender_id

  • Changed property lender_id (integer)

GET /config/business-units/filter

Parameters:

Changed: lender_id in header

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property result (array)

    Changed items (object):

    New required properties:

    • lender_id

    • Changed property lender_id (integer)

GET /config/business-units/{business_units_id}

Parameters:

Changed: lender_id in header

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  New required properties:

  • lender_id

  • Changed property lender_id (integer)

DELETE /config/business-units/{business_units_id}

Parameters:

Changed: business_units_id in path

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  New required properties:

  • lender_id

  • Changed property lender_id (integer)

PATCH /config/business-units/{business_units_id}

Parameters:

Added: lender_id in header

Request:

Changed content type : application/json

• Deleted property lender_id (integer)

  Lender id that supports Business type mode

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  New required properties:

  • lender_id

  • Changed property lender_id (integer)

GET /config/other-costs

Parameters:

Changed: lender_id in header

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  Changed items (object):

  New required properties:

  • lender_id

  • Changed property lender_id (integer)

POST /config/other-costs

Parameters:

Added: lender_id in header

Request:

Changed content type : application/json

• Deleted property lender_id (integer)

  Lender id that supports Other Cost mode

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  New required properties:

  • lender_id

  • Changed property lender_id (integer)

GET /config/other-costs/filter

Parameters:

Changed: lender_id in header

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property result (array)

    Changed items (object):

    New required properties:

    • lender_id

    • Changed property lender_id (integer)

GET /config/other-costs/{other_costs_id}

Parameters:

Changed: lender_id in header

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  New required properties:

  • lender_id

  • Changed property lender_id (integer)

DELETE /config/other-costs/{other_costs_id}

Parameters:

Changed: other_costs_id in path

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  New required properties:

  • lender_id

  • Changed property lender_id (integer)

PATCH /config/other-costs/{other_costs_id}

Parameters:

Added: lender_id in header

Request:

Changed content type : application/json

• Deleted property lender_id (integer)

  Lender id that supports Other Cost mode

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  New required properties:

  • lender_id

  • Changed property lender_id (integer)

GET /config/terms

Parameters:

Changed: lender_id in header

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  Changed items (object):

  • Changed property lender_id (integer)

POST /config/terms

Parameters:

Added: lender_id in header

Request:

Changed content type : application/json

New optional properties:

• lender_id

• Deleted property lender_id (integer)

  Lender id that supports terms mode

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property lender_id (integer)

GET /config/term/active

Parameters:

Changed: lender_id in header

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  Changed items (object):

  • Changed property lender_id (integer)

GET /config/terms/{term_id}

Parameters:

Changed: term_id in path

Changed: lender_id in header

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property lender_id (integer)

DELETE /config/terms/{term_id}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property lender_id (integer)

PATCH /config/terms/{term_id}

Parameters:

Added: lender_id in header

Request:

Changed content type : application/json

New optional properties:

• lender_id

• Deleted property lender_id (integer)

  Lender id that supports terms mode

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property lender_id (integer)

GET /config/term/filter

Parameters:

Changed: lender_id in header

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property result (array)

    Changed items (object):

    • Changed property lender_id (integer)

GET /config/credit-ratings

Parameters:

Changed: lender_id in header

GET /config/credit-ratings/filter

Parameters:

Changed: lender_id in header

GET /config/credit-rating/active

Parameters:

Changed: lender_id in header

GET /config/credit-ratings/{credit_rating_id}

Parameters:

Changed: lender_id in header

PATCH /config/credit-ratings/{credit_rating_id}

Parameters:

Changed: lender_id in header

GET /config/annual-mileage

Parameters:

Changed: lender_id in header

GET /config/annual-mileage/filter

Parameters:

Changed: lender_id in header

GET /config/annual-mileage/active

Parameters:

Changed: lender_id in header

GET /config/annual-mileage/{annual_mileage_id}

Parameters:

Changed: lender_id in header

GET /config/Financed-Amount

Parameters:

Changed: lender_id in header

GET /config/Financed-Amount/filter

Parameters:

Changed: lender_id in header

GET /config/Financed-Amount/active

Parameters:

Changed: lender_id in header

GET /config/Financed-Amount/{financed_amount_id}

Parameters:

Changed: lender_id in header

GET /config/fee-names

Parameters:

Changed: lender_id in header

GET /config/fee-names/{fee_name_id}

Parameters:

Changed: lender_id in header

GET /config/fee-name/filter

Parameters:

Changed: lender_id in header

GET /config/master-list-accessories

Parameters:

Changed: lender_id in header

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

    • Changed property trim_code (string)

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

    • Changed property trim_code (string)

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

Parameters:

Changed: lender_id in header

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

    • Changed property trim_code (string)

GET /config/contract-term/{contract_term_id}

Parameters:

Changed: lender_id in header

GET /config/contract-term/filter

Parameters:

Changed: lender_id in header

GET /config/contract-term/active

Parameters:

Changed: lender_id in header

GET /config/contract-term

Parameters:

Changed: lender_id in header

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

Parameters:

Changed: lender_id in header

GET /config/option-category

Parameters:

Changed: lender_id in header

GET /config/option-category/active

Parameters:

Changed: lender_id in header

GET /config/option-category/{option_category_id}

Parameters:

Changed: lender_id in header

GET /config/option-category/filter/

Parameters:

Changed: lender_id in header

GET /config/contract-allowed-annum-mileage

Parameters:

Changed: lender_id in header

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

Parameters:

Changed: lender_id in header

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

Parameters:

Changed: lender_id in header

GET /config/decision_status

Parameters:

Changed: lender_id in header

GET /config/decision_status/{decision_status_id}

Parameters:

Changed: lender_id in header

GET /config/decision_statuses/filter

Parameters:

Changed: lender_id in header

GET /config/event

Parameters:

Changed: lender_id in header

GET /config/event/{event_id}

Parameters:

Changed: lender_id in header

GET /config/reason

Parameters:

Changed: lender_id in header

GET /config/reason/{reason_id}

Parameters:

Changed: lender_id in header

GET /config/odometer/{lender_id}

Parameters:

Changed: lender_id in path

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property existing_customer_check (string)

    Existing Customer Check of the Lender

GET /config/stipulation/

Parameters:

Changed: lender_id in header

GET /config/stipulation/filter

Parameters:

Changed: lender_id in header

GET /config/stipulation/{stipulation_id}

Parameters:

Changed: lender_id in header

POST /config/programs/all/

Request:

Changed content type : application/json

• Added property financed_amount (string)

  Financed Amount

POST /config/programs/permutation/

Request:

Changed content type : application/json

• Added property financed_amount (array)

  Financed Amount

  Items (integer):

POST /config/programs/multi-quote/

Request:

Changed content type : application/json

• Added property financed_amount (array)

  Financed Amount

GET /config/dealer/option

Parameters:

Changed: lender_id in header

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  Changed items (object):

  • Changed property is_active (boolean)

    Addon is_active

  • Changed property id (integer)

    Addon Id

  • Changed property offered_by (string -> string)

    An enumeration.

  • Changed property description (string)

    Addon description

  • Changed property product_name (string)

    Addon product_name

  • Changed property vehicle_type (integer)

    Addon asset condition

  • Changed property part_no (string)

    Addon part_no

  • Changed property supplier (string)

    Addon supplier

  • Changed property installation_mode (string -> string)

    An enumeration.

  • Changed property specific_category (string)

    Addon specific_category

  • Changed property price (number)

    Addon price

  • Changed property is_price_inclusive (boolean)

    Addon is_price_inclusive

  • Changed property rv_adder (number)

    Addon rv_adder

  • Changed property image (array)

    Addon image

  • Changed property video_url (string)

    Addon video_url

  • Changed property brochure_url (string)

    Addon brochure_url

  • Changed property category_id (integer)

    Addon categoty_id

  • Changed property lender_id (integer)

    Addon lender_id

  • Changed property dealer_code (string)

    Addon dealer code

  • Changed property compatible_models (array)

    Addon compatible_models

    Changed items (object):

    • Changed property trim_code (string)

POST /config/dealer/option

Request:

Changed content type : application/json

New required properties:

• dealer_code

• Changed property is_active (boolean)

  Addon is_active

• Changed property id (integer)

  Addon Id

• Changed property compatible_models (array)

  Addon compatible_models

• Changed property offered_by (string -> string)

  An enumeration.

• Changed property description (string)

  Addon description

• Changed property product_name (string)

  Addon product_name

• Changed property vehicle_type (integer)

  Addon asset condition

• Changed property part_no (string)

  Addon part_no

• Changed property supplier (string)

  Addon supplier

• Changed property installation_mode (string -> string)

  An enumeration.

• Changed property specific_category (string)

  Addon specific_category

• Changed property price (number)

  Addon price

• Changed property is_price_inclusive (boolean)

  Addon is_price_inclusive

• Changed property rv_adder (number)

  Addon rv_adder

• Changed property image (array)

  Addon image

• Changed property video_url (string)

  Addon video_url

• Changed property brochure_url (string)

  Addon brochure_url

• Changed property category_id (integer)

  Addon categoty_id

• Changed property lender_id (integer)

  Addon lender_id

• Changed property dealer_id (integer)

  Addon dealer_id

• Changed property dealer_code (string)

  Addon dealer code

Return Type:

Changed response : 201 Created

Successful Response

• Changed content type : application/json

  • Changed property is_active (boolean)

    Addon is_active

  • Changed property id (integer)

    Addon Id

  • Changed property offered_by (string -> string)

    An enumeration.

  • Changed property description (string)

    Addon description

  • Changed property product_name (string)

    Addon product_name

  • Changed property vehicle_type (integer)

    Addon asset condition

  • Changed property part_no (string)

    Addon part_no

  • Changed property supplier (string)

    Addon supplier

  • Changed property installation_mode (string -> string)

    An enumeration.

  • Changed property specific_category (string)

    Addon specific_category

  • Changed property price (number)

    Addon price

  • Changed property is_price_inclusive (boolean)

    Addon is_price_inclusive

  • Changed property rv_adder (number)

    Addon rv_adder

  • Changed property image (array)

    Addon image

  • Changed property video_url (string)

    Addon video_url

  • Changed property brochure_url (string)

    Addon brochure_url

  • Changed property category_id (integer)

    Addon categoty_id

  • Changed property lender_id (integer)

    Addon lender_id

  • Changed property dealer_code (string)

    Addon dealer code

  • Changed property compatible_models (array)

    Addon compatible_models

    Changed items (object):

    • Changed property trim_code (string)

GET /config/dealer/option-trim-code

Get dealer option accessory record provided by dealer code

Parameters:

Added: trim_code in query

Deleted: trim_desc in query

Changed: dealer_code in query

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

    • Changed property trim_code (string)

GET /config/dealer/option/{option_id}

Parameters:

Changed: lender_id in header

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  New required properties:

  • dealer_code

  • Changed property is_active (boolean)

    Addon is_active

  • Changed property id (integer)

    Addon Id

  • Changed property compatible_models (array)

    Addon compatible_models

  • Changed property offered_by (string -> string)

    An enumeration.

  • Changed property description (string)

    Addon description

  • Changed property product_name (string)

    Addon product_name

  • Changed property vehicle_type (integer)

    Addon asset condition

  • Changed property part_no (string)

    Addon part_no

  • Changed property supplier (string)

    Addon supplier

  • Changed property installation_mode (string -> string)

    An enumeration.

  • Changed property specific_category (string)

    Addon specific_category

  • Changed property price (number)

    Addon price

  • Changed property is_price_inclusive (boolean)

    Addon is_price_inclusive

  • Changed property rv_adder (number)

    Addon rv_adder

  • Changed property image (array)

    Addon image

  • Changed property video_url (string)

    Addon video_url

  • Changed property brochure_url (string)

    Addon brochure_url

  • Changed property category_id (integer)

    Addon categoty_id

  • Changed property lender_id (integer)

    Addon lender_id

  • Changed property dealer_id (integer)

    Addon dealer_id

  • Changed property dealer_code (string)

    Addon dealer code

DELETE /config/dealer/option/{option_id}

Parameters:

Changed: option_id in path

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  New required properties:

  • dealer_code

  • Changed property is_active (boolean)

    Addon is_active

  • Changed property id (integer)

    Addon Id

  • Changed property compatible_models (array)

    Addon compatible_models

  • Changed property offered_by (string -> string)

    An enumeration.

  • Changed property description (string)

    Addon description

  • Changed property product_name (string)

    Addon product_name

  • Changed property vehicle_type (integer)

    Addon asset condition

  • Changed property part_no (string)

    Addon part_no

  • Changed property supplier (string)

    Addon supplier

  • Changed property installation_mode (string -> string)

    An enumeration.

  • Changed property specific_category (string)

    Addon specific_category

  • Changed property price (number)

    Addon price

  • Changed property is_price_inclusive (boolean)

    Addon is_price_inclusive

  • Changed property rv_adder (number)

    Addon rv_adder

  • Changed property image (array)

    Addon image

  • Changed property video_url (string)

    Addon video_url

  • Changed property brochure_url (string)

    Addon brochure_url

  • Changed property category_id (integer)

    Addon categoty_id

  • Changed property lender_id (integer)

    Addon lender_id

  • Changed property dealer_id (integer)

    Addon dealer_id

  • Changed property dealer_code (string)

    Addon dealer code

PATCH /config/dealer/option/{option_id}

Request:

Changed content type : application/json

New required properties:

• dealer_code

• Changed property is_active (boolean)

  Addon is_active

• Changed property id (integer)

  Addon Id

• Changed property compatible_models (array)

  Addon compatible_models

• Changed property offered_by (string -> string)

  An enumeration.

• Changed property description (string)

  Addon description

• Changed property product_name (string)

  Addon product_name

• Changed property vehicle_type (integer)

  Addon asset condition

• Changed property part_no (string)

  Addon part_no

• Changed property supplier (string)

  Addon supplier

• Changed property installation_mode (string -> string)

  An enumeration.

• Changed property specific_category (string)

  Addon specific_category

• Changed property price (number)

  Addon price

• Changed property is_price_inclusive (boolean)

  Addon is_price_inclusive

• Changed property rv_adder (number)

  Addon rv_adder

• Changed property image (array)

  Addon image

• Changed property video_url (string)

  Addon video_url

• Changed property brochure_url (string)

  Addon brochure_url

• Changed property category_id (integer)

  Addon categoty_id

• Changed property lender_id (integer)

  Addon lender_id

• Changed property dealer_id (integer)

  Addon dealer_id

• Changed property dealer_code (string)

  Addon dealer code

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property is_active (boolean)

    Addon is_active

  • Changed property id (integer)

    Addon Id

  • Changed property offered_by (string -> string)

    An enumeration.

  • Changed property description (string)

    Addon description

  • Changed property product_name (string)

    Addon product_name

  • Changed property vehicle_type (integer)

    Addon asset condition

  • Changed property part_no (string)

    Addon part_no

  • Changed property supplier (string)

    Addon supplier

  • Changed property installation_mode (string -> string)

    An enumeration.

  • Changed property specific_category (string)

    Addon specific_category

  • Changed property price (number)

    Addon price

  • Changed property is_price_inclusive (boolean)

    Addon is_price_inclusive

  • Changed property rv_adder (number)

    Addon rv_adder

  • Changed property image (array)

    Addon image

  • Changed property video_url (string)

    Addon video_url

  • Changed property brochure_url (string)

    Addon brochure_url

  • Changed property category_id (integer)

    Addon categoty_id

  • Changed property lender_id (integer)

    Addon lender_id

  • Changed property dealer_code (string)

    Addon dealer code

  • Changed property compatible_models (array)

    Addon compatible_models

    Changed items (object):

    • Changed property trim_code (string)

GET /config/dealer/fee

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  Changed items (object):

  New required properties:

  • fee_handling

  • Added property fee_handling (string)

    fee handling

POST /config/dealer/fee

Request:

Changed content type : application/json

New required properties:

• fee_handling

• Added property fee_handling (string)

  fee handling

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  New required properties:

  • fee_handling

  • Added property fee_handling (string)

    fee handling

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

Parameters:

Added: state_code in query

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

GET /config/dealer/{dealer_code}/fees

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

GET /config/dealer/fee/{fee_id}

Parameters:

Changed: fee_id in path

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  New required properties:

  • fee_handling

  • Added property fee_handling (string)

    fee handling

DELETE /config/dealer/fee/{fee_id}

Parameters:

Changed: fee_id in path

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  New required properties:

  • fee_handling

  • Added property fee_handling (string)

    fee handling

PATCH /config/dealer/fee/{fee_id}

Request:

Changed content type : application/json

New required properties:

• fee_handling

• Added property fee_handling (string)

  fee handling

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  New required properties:

  • fee_handling

  • Added property fee_handling (string)

    fee handling

GET /config/dealer/profile

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  Changed items (object):

  • Deleted property dealer_id (integer)

    DealerProfileModel dealer id

  • Changed property id (integer)

    Id

  • Changed property contact_number (string)

    contact number

  • Changed property customer_support_number (string)

    customer support number

  • Changed property time_zone (string)

    time zone

  • Changed property fax_number (string)

    fax number

  • Changed property email (string -> string)

  • Changed property website (string)

  • Changed property contact_person_name (string)

    contact person name

  • Changed property day_light_saving (boolean)

    day light saving

  • Changed property initials (string)

    initials

  • Changed property dealer_address (object)

    dealer address

    • Changed property id (integer)

      Primary id of Dealer Address

    • Changed property address_line_1 (string)

      Address 1 of Dealer

    • Changed property address_line_2 (string)

      Address 2 of Dealer

    • Changed property state_id (integer)

      State of Dealer

    • Changed property state_name (string)

      State Name of Dealer

    • Changed property zip_code (string)

      Zip code of Dealer

    • Changed property county (string)

      County Name of Dealer

    • Changed property city (string)

      City of Dealer

    • Changed property contact_number (string)

      Contact Number of Dealer

    • Changed property verified (boolean)

      Verification Status of Dealer

    • Changed property address_type (string)

      Address type of Dealer

  • Changed property market_scan_number (string)

    market scan number

  • Changed property dealer_code (string)

    dealer_code

  • Changed property pen_dealer_id (string)

    pen dealer id

  • Changed property stripe_dealer_id (string)

    stripe dealer id

  • Changed property shift_digital_dealer_id (string)

    Shift Digital Dealer Id

  • Changed property available_finance_types (array)

    available finance types

    Changed items (string):

    An enumeration.

    Added enum value:

    • `` Removed enum value:

    • Finance&Lease

  • Changed property schedule_option (array)

    schedule option

POST /config/dealer/profile

Request:

Changed content type : application/json

• Deleted property dealer_id (integer)

  DealerProfileModel dealer id

• Changed property id (integer)

  Id

• Changed property contact_number (string)

  contact number

• Changed property customer_support_number (string)

  customer support number

• Changed property time_zone (string)

  time zone

• Changed property fax_number (string)

  fax number

• Changed property email (string -> string)

• Changed property website (string)

• Changed property contact_person_name (string)

  contact person name

• Changed property day_light_saving (boolean)

  day light saving

• Changed property initials (string)

  initials

• Changed property dealer_address (object)

  dealer address

  • Changed property id (integer)

    Primary id of Dealer Address

  • Changed property address_line_1 (string)

    Address 1 of Dealer

  • Changed property address_line_2 (string)

    Address 2 of Dealer

  • Changed property state_id (integer)

    State of Dealer

  • Changed property state_name (string)

    State Name of Dealer

  • Changed property zip_code (string)

    Zip code of Dealer

  • Changed property county (string)

    County Name of Dealer

  • Changed property city (string)

    City of Dealer

  • Changed property contact_number (string)

    Contact Number of Dealer

  • Changed property verified (boolean)

    Verification Status of Dealer

  • Changed property address_type (string)

    Address type of Dealer

• Changed property market_scan_number (string)

  market scan number

• Changed property dealer_code (string)

  dealer_code

• Changed property pen_dealer_id (string)

  pen dealer id

• Changed property stripe_dealer_id (string)

  stripe dealer id

• Changed property shift_digital_dealer_id (string)

  Shift Digital Dealer Id

• Changed property available_finance_types (array)

  available finance types

  Changed items (string):

  An enumeration.

  Added enum value:

  • `` Removed enum value:

  • Finance&Lease

• Changed property schedule_option (array)

  schedule option

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Deleted property dealer_id (integer)

    DealerProfileModel dealer id

  • Changed property id (integer)

    Id

  • Changed property contact_number (string)

    contact number

  • Changed property customer_support_number (string)

    customer support number

  • Changed property time_zone (string)

    time zone

  • Changed property fax_number (string)

    fax number

  • Changed property email (string -> string)

  • Changed property website (string)

  • Changed property contact_person_name (string)

    contact person name

  • Changed property day_light_saving (boolean)

    day light saving

  • Changed property initials (string)

    initials

  • Changed property dealer_address (object)

    dealer address

    • Changed property id (integer)

      Primary id of Dealer Address

    • Changed property address_line_1 (string)

      Address 1 of Dealer

    • Changed property address_line_2 (string)

      Address 2 of Dealer

    • Changed property state_id (integer)

      State of Dealer

    • Changed property state_name (string)

      State Name of Dealer

    • Changed property zip_code (string)

      Zip code of Dealer

    • Changed property county (string)

      County Name of Dealer

    • Changed property city (string)

      City of Dealer

    • Changed property contact_number (string)

      Contact Number of Dealer

    • Changed property verified (boolean)

      Verification Status of Dealer

    • Changed property address_type (string)

      Address type of Dealer

  • Changed property market_scan_number (string)

    market scan number

  • Changed property dealer_code (string)

    dealer_code

  • Changed property pen_dealer_id (string)

    pen dealer id

  • Changed property stripe_dealer_id (string)

    stripe dealer id

  • Changed property shift_digital_dealer_id (string)

    Shift Digital Dealer Id

  • Changed property available_finance_types (array)

    available finance types

    Changed items (string):

    An enumeration.

    Added enum value:

    • `` Removed enum value:

    • Finance&Lease

  • Changed property schedule_option (array)

    schedule option

DELETE /config/dealer/profile/{dealer_profile_id}

Parameters:

Changed: dealer_profile_id in path

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Deleted property dealer_id (integer)

    DealerProfileModel dealer id

  • Changed property id (integer)

    Id

  • Changed property contact_number (string)

    contact number

  • Changed property customer_support_number (string)

    customer support number

  • Changed property time_zone (string)

    time zone

  • Changed property fax_number (string)

    fax number

  • Changed property email (string -> string)

  • Changed property website (string)

  • Changed property contact_person_name (string)

    contact person name

  • Changed property day_light_saving (boolean)

    day light saving

  • Changed property initials (string)

    initials

  • Changed property dealer_address (object)

    dealer address

    • Changed property id (integer)

      Primary id of Dealer Address

    • Changed property address_line_1 (string)

      Address 1 of Dealer

    • Changed property address_line_2 (string)

      Address 2 of Dealer

    • Changed property state_id (integer)

      State of Dealer

    • Changed property state_name (string)

      State Name of Dealer

    • Changed property zip_code (string)

      Zip code of Dealer

    • Changed property county (string)

      County Name of Dealer

    • Changed property city (string)

      City of Dealer

    • Changed property contact_number (string)

      Contact Number of Dealer

    • Changed property verified (boolean)

      Verification Status of Dealer

    • Changed property address_type (string)

      Address type of Dealer

  • Changed property market_scan_number (string)

    market scan number

  • Changed property dealer_code (string)

    dealer_code

  • Changed property pen_dealer_id (string)

    pen dealer id

  • Changed property stripe_dealer_id (string)

    stripe dealer id

  • Changed property shift_digital_dealer_id (string)

    Shift Digital Dealer Id

  • Changed property available_finance_types (array)

    available finance types

    Changed items (string):

    An enumeration.

    Added enum value:

    • `` Removed enum value:

    • Finance&Lease

  • Changed property schedule_option (array)

    schedule option

PATCH /config/dealer/profile/{dealer_profile_id}

Parameters:

Changed: dealer_profile_id in path

Request:

Changed content type : application/json

• Deleted property dealer_id (integer)

  DealerProfileModel dealer id

• Changed property id (integer)

  Id

• Changed property contact_number (string)

  contact number

• Changed property customer_support_number (string)

  customer support number

• Changed property time_zone (string)

  time zone

• Changed property fax_number (string)

  fax number

• Changed property email (string -> string)

• Changed property website (string)

• Changed property contact_person_name (string)

  contact person name

• Changed property day_light_saving (boolean)

  day light saving

• Changed property initials (string)

  initials

• Changed property dealer_address (object)

  dealer address

  • Changed property id (integer)

    Primary id of Dealer Address

  • Changed property address_line_1 (string)

    Address 1 of Dealer

  • Changed property address_line_2 (string)

    Address 2 of Dealer

  • Changed property state_id (integer)

    State of Dealer

  • Changed property state_name (string)

    State Name of Dealer

  • Changed property zip_code (string)

    Zip code of Dealer

  • Changed property county (string)

    County Name of Dealer

  • Changed property city (string)

    City of Dealer

  • Changed property contact_number (string)

    Contact Number of Dealer

  • Changed property verified (boolean)

    Verification Status of Dealer

  • Changed property address_type (string)

    Address type of Dealer

• Changed property market_scan_number (string)

  market scan number

• Changed property dealer_code (string)

  dealer_code

• Changed property pen_dealer_id (string)

  pen dealer id

• Changed property stripe_dealer_id (string)

  stripe dealer id

• Changed property shift_digital_dealer_id (string)

  Shift Digital Dealer Id

• Changed property available_finance_types (array)

  available finance types

  Changed items (string):

  An enumeration.

  Added enum value:

  • `` Removed enum value:

  • Finance&Lease

• Changed property schedule_option (array)

  schedule option

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Deleted property dealer_id (integer)

    DealerProfileModel dealer id

  • Changed property id (integer)

    Id

  • Changed property contact_number (string)

    contact number

  • Changed property customer_support_number (string)

    customer support number

  • Changed property time_zone (string)

    time zone

  • Changed property fax_number (string)

    fax number

  • Changed property email (string -> string)

  • Changed property website (string)

  • Changed property contact_person_name (string)

    contact person name

  • Changed property day_light_saving (boolean)

    day light saving

  • Changed property initials (string)

    initials

  • Changed property dealer_address (object)

    dealer address

    • Changed property id (integer)

      Primary id of Dealer Address

    • Changed property address_line_1 (string)

      Address 1 of Dealer

    • Changed property address_line_2 (string)

      Address 2 of Dealer

    • Changed property state_id (integer)

      State of Dealer

    • Changed property state_name (string)

      State Name of Dealer

    • Changed property zip_code (string)

      Zip code of Dealer

    • Changed property county (string)

      County Name of Dealer

    • Changed property city (string)

      City of Dealer

    • Changed property contact_number (string)

      Contact Number of Dealer

    • Changed property verified (boolean)

      Verification Status of Dealer

    • Changed property address_type (string)

      Address type of Dealer

  • Changed property market_scan_number (string)

    market scan number

  • Changed property dealer_code (string)

    dealer_code

  • Changed property pen_dealer_id (string)

    pen dealer id

  • Changed property stripe_dealer_id (string)

    stripe dealer id

  • Changed property shift_digital_dealer_id (string)

    Shift Digital Dealer Id

  • Changed property available_finance_types (array)

    available finance types

    Changed items (string):

    An enumeration.

    Added enum value:

    • `` Removed enum value:

    • Finance&Lease

  • Changed property schedule_option (array)

    schedule option

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

  • Deleted property dealer_id (integer)

    DealerProfileModel dealer id

  • Changed property id (integer)

    Id

  • Changed property contact_number (string)

    contact number

  • Changed property customer_support_number (string)

    customer support number

  • Changed property time_zone (string)

    time zone

  • Changed property fax_number (string)

    fax number

  • Changed property email (string -> string)

  • Changed property website (string)

  • Changed property contact_person_name (string)

    contact person name

  • Changed property day_light_saving (boolean)

    day light saving

  • Changed property initials (string)

    initials

  • Changed property dealer_address (object)

    dealer address

    • Changed property id (integer)

      Primary id of Dealer Address

    • Changed property address_line_1 (string)

      Address 1 of Dealer

    • Changed property address_line_2 (string)

      Address 2 of Dealer

    • Changed property state_id (integer)

      State of Dealer

    • Changed property state_name (string)

      State Name of Dealer

    • Changed property zip_code (string)

      Zip code of Dealer

    • Changed property county (string)

      County Name of Dealer

    • Changed property city (string)

      City of Dealer

    • Changed property contact_number (string)

      Contact Number of Dealer

    • Changed property verified (boolean)

      Verification Status of Dealer

    • Changed property address_type (string)

      Address type of Dealer

  • Changed property market_scan_number (string)

    market scan number

  • Changed property dealer_code (string)

    dealer_code

  • Changed property pen_dealer_id (string)

    pen dealer id

  • Changed property stripe_dealer_id (string)

    stripe dealer id

  • Changed property shift_digital_dealer_id (string)

    Shift Digital Dealer Id

  • Changed property available_finance_types (array)

    available finance types

    Changed items (string):

    An enumeration.

    Added enum value:

    • `` Removed enum value:

    • Finance&Lease

  • Changed property schedule_option (array)

    schedule option

GET /config/dealer/profile/{dealer_code}

Get dealer profile record provided by dealer code

Parameters:

Changed: dealer_code in path

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Deleted property dealer_id (integer)

    DealerProfileModel dealer id

  • Changed property id (integer)

    Id

  • Changed property contact_number (string)

    contact number

  • Changed property customer_support_number (string)

    customer support number

  • Changed property time_zone (string)

    time zone

  • Changed property fax_number (string)

    fax number

  • Changed property email (string -> string)

  • Changed property website (string)

  • Changed property contact_person_name (string)

    contact person name

  • Changed property day_light_saving (boolean)

    day light saving

  • Changed property initials (string)

    initials

  • Changed property dealer_address (object)

    dealer address

    • Changed property id (integer)

      Primary id of Dealer Address

    • Changed property address_line_1 (string)

      Address 1 of Dealer

    • Changed property address_line_2 (string)

      Address 2 of Dealer

    • Changed property state_id (integer)

      State of Dealer

    • Changed property state_name (string)

      State Name of Dealer

    • Changed property zip_code (string)

      Zip code of Dealer

    • Changed property county (string)

      County Name of Dealer

    • Changed property city (string)

      City of Dealer

    • Changed property contact_number (string)

      Contact Number of Dealer

    • Changed property verified (boolean)

      Verification Status of Dealer

    • Changed property address_type (string)

      Address type of Dealer

  • Changed property market_scan_number (string)

    market scan number

  • Changed property dealer_code (string)

    dealer_code

  • Changed property pen_dealer_id (string)

    pen dealer id

  • Changed property stripe_dealer_id (string)

    stripe dealer id

  • Changed property shift_digital_dealer_id (string)

    Shift Digital Dealer Id

  • Changed property available_finance_types (array)

    available finance types

    Changed items (string):

    An enumeration.

    Added enum value:

    • `` Removed enum value:

    • Finance&Lease

  • Changed property schedule_option (array)

    schedule option

GET /config/dealer/preference

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  Changed items (object):

  New optional properties:

  • dealer_code

  • Deleted property dealer_code (string)

    DealerPreferenceModel dealer code

  • Changed property id (integer)

    Id

  • Changed property default_mileage_id (integer)

    Default mileage id

  • Changed property default_term_id (integer)

    Default term id

  • Changed property minimum_down_payment_id (number)

    Minimum down payment id

  • Changed property maximum_down_payment_id (number)

    Maximum down payment id

  • Changed property default_down_payment_id (number)

    Default down payment id

  • Changed property quotation_expiry_days (integer)

    Quotation expiry days

  • Changed property application_expiry_days (integer)

    Application expiry days

  • Changed property dealer_id (integer)

    Dealer Id

POST /config/dealer/preference

Request:

Changed content type : application/json

• Changed property id (integer)

  Id

• Changed property default_mileage_id (integer)

  Default mileage id

• Changed property default_term_id (integer)

  Default term id

• Changed property minimum_down_payment_id (number)

  Minimum down payment id

• Changed property maximum_down_payment_id (number)

  Maximum down payment id

• Changed property default_down_payment_id (number)

  Default down payment id

• Changed property quotation_expiry_days (integer)

  Quotation expiry days

• Changed property application_expiry_days (integer)

  Application expiry days

• Changed property dealer_id (integer)

  Dealer Id

• Changed property dealer_code (string)

  Dealer code

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  New optional properties:

  • dealer_code

  • Deleted property dealer_code (string)

    DealerPreferenceModel dealer code

  • Changed property id (integer)

    Id

  • Changed property default_mileage_id (integer)

    Default mileage id

  • Changed property default_term_id (integer)

    Default term id

  • Changed property minimum_down_payment_id (number)

    Minimum down payment id

  • Changed property maximum_down_payment_id (number)

    Maximum down payment id

  • Changed property default_down_payment_id (number)

    Default down payment id

  • Changed property quotation_expiry_days (integer)

    Quotation expiry days

  • Changed property application_expiry_days (integer)

    Application expiry days

  • Changed property dealer_id (integer)

    Dealer Id

DELETE /config/dealer/preference/{dealerpreference_id}

Parameters:

Changed: dealerpreference_id in path

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  New optional properties:

  • dealer_code

  • Deleted property dealer_code (string)

    DealerPreferenceModel dealer code

  • Changed property id (integer)

    Id

  • Changed property default_mileage_id (integer)

    Default mileage id

  • Changed property default_term_id (integer)

    Default term id

  • Changed property minimum_down_payment_id (number)

    Minimum down payment id

  • Changed property maximum_down_payment_id (number)

    Maximum down payment id

  • Changed property default_down_payment_id (number)

    Default down payment id

  • Changed property quotation_expiry_days (integer)

    Quotation expiry days

  • Changed property application_expiry_days (integer)

    Application expiry days

  • Changed property dealer_id (integer)

    Dealer Id

PATCH /config/dealer/preference/{dealer_preference_id}

Request:

Changed content type : application/json

• Changed property id (integer)

  Id

• Changed property default_mileage_id (integer)

  Default mileage id

• Changed property default_term_id (integer)

  Default term id

• Changed property minimum_down_payment_id (number)

  Minimum down payment id

• Changed property maximum_down_payment_id (number)

  Maximum down payment id

• Changed property default_down_payment_id (number)

  Default down payment id

• Changed property quotation_expiry_days (integer)

  Quotation expiry days

• Changed property application_expiry_days (integer)

  Application expiry days

• Changed property dealer_id (integer)

  Dealer Id

• Changed property dealer_code (string)

  Dealer code

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  New optional properties:

  • dealer_code

  • Deleted property dealer_code (string)

    DealerPreferenceModel dealer code

  • Changed property id (integer)

    Id

  • Changed property default_mileage_id (integer)

    Default mileage id

  • Changed property default_term_id (integer)

    Default term id

  • Changed property minimum_down_payment_id (number)

    Minimum down payment id

  • Changed property maximum_down_payment_id (number)

    Maximum down payment id

  • Changed property default_down_payment_id (number)

    Default down payment id

  • Changed property quotation_expiry_days (integer)

    Quotation expiry days

  • Changed property application_expiry_days (integer)

    Application expiry days

  • Changed property dealer_id (integer)

    Dealer Id

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

Parameters:

Changed: dealer_code in path

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  New optional properties:

  • dealer_code

  • Deleted property dealer_code (string)

    DealerPreferenceModel dealer code

  • Changed property id (integer)

    Id

  • Changed property default_mileage_id (integer)

    Default mileage id

  • Changed property default_term_id (integer)

    Default term id

  • Changed property minimum_down_payment_id (number)

    Minimum down payment id

  • Changed property maximum_down_payment_id (number)

    Maximum down payment id

  • Changed property default_down_payment_id (number)

    Default down payment id

  • Changed property quotation_expiry_days (integer)

    Quotation expiry days

  • Changed property application_expiry_days (integer)

    Application expiry days

  • Changed property dealer_id (integer)

    Dealer Id

GET /config/dealer/payment-detail

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  Changed items (object):

  New required properties:

  • dealer_code

  • Changed property id (integer)

    Id

  • Changed property account_number (number -> string)

    Account number

  • Changed property aba_number (number -> string)

    ABA number

  • Changed property account_title (string)

    Account title

  • Changed property bank_name (string)

    Bank name

  • Changed property bank_account_limit (number)

    Bank account limit

  • Changed property debit_card_limit (number)

    Debit card limit

  • Changed property credit_card_limit (number)

    Credit card limit

  • Changed property stripe_registered_email (string)

    Stripe registered email

  • Changed property dealer_id (integer)

    Dealer id

  • Changed property dealer_code (string)

    Dealer code

POST /config/dealer/payment-detail

Request:

Changed content type : application/json

New required properties:

• dealer_code

• Deleted property dealer_id (integer)

  PaymentDetailModel dealer id

• Changed property id (integer)

  Id

• Changed property account_number (number -> string)

  Account number

• Changed property aba_number (number -> string)

  ABA number

• Changed property account_title (string)

  Account title

• Changed property bank_name (string)

  Bank name

• Changed property bank_account_limit (number)

  Bank account limit

• Changed property debit_card_limit (number)

  Debit card limit

• Changed property credit_card_limit (number)

  Credit card limit

• Changed property stripe_registered_email (string)

  Stripe registered email

• Changed property dealer_code (string)

  Dealer code

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  New required properties:

  • dealer_code

  • Changed property id (integer)

    Id

  • Changed property account_number (number -> string)

    Account number

  • Changed property aba_number (number -> string)

    ABA number

  • Changed property account_title (string)

    Account title

  • Changed property bank_name (string)

    Bank name

  • Changed property bank_account_limit (number)

    Bank account limit

  • Changed property debit_card_limit (number)

    Debit card limit

  • Changed property credit_card_limit (number)

    Credit card limit

  • Changed property stripe_registered_email (string)

    Stripe registered email

  • Changed property dealer_id (integer)

    Dealer id

  • Changed property dealer_code (string)

    Dealer code

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

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  New required properties:

  • dealer_code

  • Changed property id (integer)

    Id

  • Changed property account_number (number -> string)

    Account number

  • Changed property aba_number (number -> string)

    ABA number

  • Changed property account_title (string)

    Account title

  • Changed property bank_name (string)

    Bank name

  • Changed property bank_account_limit (number)

    Bank account limit

  • Changed property debit_card_limit (number)

    Debit card limit

  • Changed property credit_card_limit (number)

    Credit card limit

  • Changed property stripe_registered_email (string)

    Stripe registered email

  • Changed property dealer_id (integer)

    Dealer id

  • Changed property dealer_code (string)

    Dealer code

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

Parameters:

Changed: payment_id in path

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  New required properties:

  • dealer_code

  • Changed property id (integer)

    Id

  • Changed property account_number (number -> string)

    Account number

  • Changed property aba_number (number -> string)

    ABA number

  • Changed property account_title (string)

    Account title

  • Changed property bank_name (string)

    Bank name

  • Changed property bank_account_limit (number)

    Bank account limit

  • Changed property debit_card_limit (number)

    Debit card limit

  • Changed property credit_card_limit (number)

    Credit card limit

  • Changed property stripe_registered_email (string)

    Stripe registered email

  • Changed property dealer_id (integer)

    Dealer id

  • Changed property dealer_code (string)

    Dealer code

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

Get dealer payment detail record provided by dealer code

Parameters:

Changed: dealer_code in path

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  New required properties:

  • dealer_code

  • Changed property id (integer)

    Id

  • Changed property account_number (number -> string)

    Account number

  • Changed property aba_number (number -> string)

    ABA number

  • Changed property account_title (string)

    Account title

  • Changed property bank_name (string)

    Bank name

  • Changed property bank_account_limit (number)

    Bank account limit

  • Changed property debit_card_limit (number)

    Debit card limit

  • Changed property credit_card_limit (number)

    Credit card limit

  • Changed property stripe_registered_email (string)

    Stripe registered email

  • Changed property dealer_id (integer)

    Dealer id

  • Changed property dealer_code (string)

    Dealer code

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

Request:

Changed content type : application/json

New required properties:

• dealer_code

• Deleted property dealer_id (integer)

  PaymentDetailModel dealer id

• Changed property id (integer)

  Id

• Changed property account_number (number -> string)

  Account number

• Changed property aba_number (number -> string)

  ABA number

• Changed property account_title (string)

  Account title

• Changed property bank_name (string)

  Bank name

• Changed property bank_account_limit (number)

  Bank account limit

• Changed property debit_card_limit (number)

  Debit card limit

• Changed property credit_card_limit (number)

  Credit card limit

• Changed property stripe_registered_email (string)

  Stripe registered email

• Changed property dealer_code (string)

  Dealer code

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  New required properties:

  • dealer_code

  • Changed property id (integer)

    Id

  • Changed property account_number (number -> string)

    Account number

  • Changed property aba_number (number -> string)

    ABA number

  • Changed property account_title (string)

    Account title

  • Changed property bank_name (string)

    Bank name

  • Changed property bank_account_limit (number)

    Bank account limit

  • Changed property debit_card_limit (number)

    Debit card limit

  • Changed property credit_card_limit (number)

    Credit card limit

  • Changed property stripe_registered_email (string)

    Stripe registered email

  • Changed property dealer_id (integer)

    Dealer id

  • Changed property dealer_code (string)

    Dealer code

GET /config/dealer/tradein

Parameters:

Changed: lender_id in header

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  Changed items (object):

  New required properties:

  • dealer_code

  • lender_id

  • Deleted property dealer_id (integer)

    DealerTradeInModel dealer id

  • Changed property id (integer)

    Id

  • Changed property partner_name (string)

    partner name

  • Changed property percentage (number)

    percentage

  • Changed property lender_id (integer)

    lender Id

  • Changed property dealer_code (string)

    dealer code

POST /config/dealer/tradein

Request:

Changed content type : application/json

New required properties:

• dealer_code
• lender_id

• Deleted property dealer_id (integer)

  DealerTradeInModel dealer id

• Changed property id (integer)

  Id

• Changed property partner_name (string)

  partner name

• Changed property percentage (number)

  percentage

• Changed property lender_id (integer)

  lender Id

• Changed property dealer_code (string)

  dealer code

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  New required properties:

  • dealer_code

  • lender_id

  • Deleted property dealer_id (integer)

    DealerTradeInModel dealer id

  • Changed property id (integer)

    Id

  • Changed property partner_name (string)

    partner name

  • Changed property percentage (number)

    percentage

  • Changed property lender_id (integer)

    lender Id

  • Changed property dealer_code (string)

    dealer code

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

Get dealer trade in record provided by dealer code

Parameters:

Changed: lender_id in header

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  New required properties:

  • dealer_code

  • lender_id

  • Deleted property dealer_id (integer)

    DealerTradeInModel dealer id

  • Changed property id (integer)

    Id

  • Changed property partner_name (string)

    partner name

  • Changed property percentage (number)

    percentage

  • Changed property lender_id (integer)

    lender Id

  • Changed property dealer_code (string)

    dealer code

DELETE /config/dealer/tradein/{trade_id}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  New required properties:

  • dealer_code

  • lender_id

  • Deleted property dealer_id (integer)

    DealerTradeInModel dealer id

  • Changed property id (integer)

    Id

  • Changed property partner_name (string)

    partner name

  • Changed property percentage (number)

    percentage

  • Changed property lender_id (integer)

    lender Id

  • Changed property dealer_code (string)

    dealer code

PATCH /config/dealer/tradein/{trade_in_id}

Request:

Changed content type : application/json

New required properties:

• dealer_code
• lender_id

• Deleted property dealer_id (integer)

  DealerTradeInModel dealer id

• Changed property id (integer)

  Id

• Changed property partner_name (string)

  partner name

• Changed property percentage (number)

  percentage

• Changed property lender_id (integer)

  lender Id

• Changed property dealer_code (string)

  dealer code

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  New required properties:

  • dealer_code

  • lender_id

  • Deleted property dealer_id (integer)

    DealerTradeInModel dealer id

  • Changed property id (integer)

    Id

  • Changed property partner_name (string)

    partner name

  • Changed property percentage (number)

    percentage

  • Changed property lender_id (integer)

    lender Id

  • Changed property dealer_code (string)

    dealer code

POST /config/dealers

Request:

Changed content type : application/json

New required properties:

• contact_person_email
• contact_person_first_name

• Deleted property password (string)

  Password for created Dealer

• Deleted property contact_number (string)

  Contact Number of Dealer

• Deleted property digital_retail (boolean)

  Digital Retail required or not for Dealer

• Deleted property website (string)

  Website of Dealer

• Deleted property zip_code (string)

  Zip Code of Dealer City

• Deleted property is_default_password_changed (boolean)

  IsDefault Password changed or not after dealer creation

• Changed property email (string -> string)

• Changed property contact_person_first_name (string)

  Contact person first name

• Changed property contact_person_last_name (string)

  Contact person last name

• Changed property contact_person_email (string -> string)

• Changed property contact_person_role (string)

  Contact person role

• Changed property is_active (boolean)

  Dealer Status

• Changed property user_id (integer)

  Dealer admin user ID

Return Type:

Changed response : 201 Created

Successful Response

• Changed content type : application/json

  New required properties:

  • contact_person_email

  • contact_person_first_name

  • Deleted property password (string)

    Password for created Dealer

  • Deleted property contact_number (string)

    Contact Number of Dealer

  • Deleted property digital_retail (boolean)

    Digital Retail required or not for Dealer

  • Deleted property website (string)

    Website of Dealer

  • Deleted property zip_code (string)

    Zip Code of Dealer City

  • Deleted property is_default_password_changed (boolean)

    IsDefault Password changed or not after dealer creation

  • Changed property email (string -> string)

  • Changed property contact_person_first_name (string)

    Contact person first name

  • Changed property contact_person_last_name (string)

    Contact person last name

  • Changed property contact_person_email (string -> string)

  • Changed property contact_person_role (string)

    Contact person role

  • Changed property is_active (boolean)

    Dealer Status

  • Changed property user_id (integer)

    Dealer admin user ID

GET /config/dealers/active

Parameters:

Changed: lender_id in header

GET /config/dealers/filter

Parameters:

Deleted: updated_at in query

Changed: lender_id in header

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property result (array)

    Changed items (object):

    New required properties:

    • contact_person_email

    • contact_person_first_name

    • Deleted property password (string)

      Password for created Dealer

    • Deleted property contact_number (string)

      Contact Number of Dealer

    • Deleted property digital_retail (boolean)

      Digital Retail required or not for Dealer

    • Deleted property website (string)

      Website of Dealer

    • Deleted property zip_code (string)

      Zip Code of Dealer City

    • Deleted property is_default_password_changed (boolean)

      IsDefault Password changed or not after dealer creation

    • Changed property email (string -> string)

    • Changed property contact_person_first_name (string)

      Contact person first name

    • Changed property contact_person_last_name (string)

      Contact person last name

    • Changed property contact_person_email (string -> string)

    • Changed property contact_person_role (string)

      Contact person role

    • Changed property is_active (boolean)

      Dealer Status

    • Changed property user_id (integer)

      Dealer admin user ID

GET /config/dealers/{dealer_id}

Parameters:

Changed: dealer_id in path

Changed: lender_id in header

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  New required properties:

  • contact_person_email

  • contact_person_first_name

  • Deleted property password (string)

    Password for created Dealer

  • Deleted property contact_number (string)

    Contact Number of Dealer

  • Deleted property digital_retail (boolean)

    Digital Retail required or not for Dealer

  • Deleted property website (string)

    Website of Dealer

  • Deleted property zip_code (string)

    Zip Code of Dealer City

  • Deleted property is_default_password_changed (boolean)

    IsDefault Password changed or not after dealer creation

  • Changed property email (string -> string)

  • Changed property contact_person_first_name (string)

    Contact person first name

  • Changed property contact_person_last_name (string)

    Contact person last name

  • Changed property contact_person_email (string -> string)

  • Changed property contact_person_role (string)

    Contact person role

  • Changed property is_active (boolean)

    Dealer Status

  • Changed property user_id (integer)

    Dealer admin user ID

PUT /config/dealers/{dealer_id}

Request:

Changed content type : application/json

New required properties:

• contact_person_email
• contact_person_first_name
• email

• Changed property email (string -> string)

  Email address of Dealer

• Changed property contact_person_first_name (string)

  contact person first name

• Changed property contact_person_last_name (string)

  contact person last name

• Changed property contact_person_email (string -> string)

  Contact person Email

• Changed property contact_person_role (string)

  contact person role

• Changed property is_active (boolean)

  is active

• Changed property user_id (integer)

  dealer id

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  New required properties:

  • contact_person_email

  • contact_person_first_name

  • email

  • Changed property email (string -> string)

    Email address of Dealer

  • Changed property contact_person_first_name (string)

    contact person first name

  • Changed property contact_person_last_name (string)

    contact person last name

  • Changed property contact_person_email (string -> string)

    Contact person Email

  • Changed property contact_person_role (string)

    contact person role

  • Changed property is_active (boolean)

    is active

  • Changed property user_id (integer)

    dealer id

DELETE /config/dealers/{dealer_id}

Parameters:

Changed: lender_id in header

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  New required properties:

  • contact_person_email

  • contact_person_first_name

  • Deleted property password (string)

    Password for created Dealer

  • Deleted property contact_number (string)

    Contact Number of Dealer

  • Deleted property digital_retail (boolean)

    Digital Retail required or not for Dealer

  • Deleted property website (string)

    Website of Dealer

  • Deleted property zip_code (string)

    Zip Code of Dealer City

  • Deleted property is_default_password_changed (boolean)

    IsDefault Password changed or not after dealer creation

  • Changed property email (string -> string)

  • Changed property contact_person_first_name (string)

    Contact person first name

  • Changed property contact_person_last_name (string)

    Contact person last name

  • Changed property contact_person_email (string -> string)

  • Changed property contact_person_role (string)

    Contact person role

  • Changed property is_active (boolean)

    Dealer Status

  • Changed property user_id (integer)

    Dealer admin user ID

GET /config/dealer

Parameters:

Changed: lender_id in header

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  Changed items (object):

  New required properties:

  • contact_person_email

  • contact_person_first_name

  • Deleted property password (string)

    Password for created Dealer

  • Deleted property contact_number (string)

    Contact Number of Dealer

  • Deleted property digital_retail (boolean)

    Digital Retail required or not for Dealer

  • Deleted property website (string)

    Website of Dealer

  • Deleted property zip_code (string)

    Zip Code of Dealer City

  • Deleted property is_default_password_changed (boolean)

    IsDefault Password changed or not after dealer creation

  • Changed property email (string -> string)

  • Changed property contact_person_first_name (string)

    Contact person first name

  • Changed property contact_person_last_name (string)

    Contact person last name

  • Changed property contact_person_email (string -> string)

  • Changed property contact_person_role (string)

    Contact person role

  • Changed property is_active (boolean)

    Dealer Status

  • Changed property user_id (integer)

    Dealer admin user ID

GET /config/dealer/{dealer_code}

Parameters:

Changed: lender_id in header

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  New required properties:

  • contact_person_email

  • contact_person_first_name

  • Deleted property password (string)

    Password for created Dealer

  • Deleted property contact_number (string)

    Contact Number of Dealer

  • Deleted property digital_retail (boolean)

    Digital Retail required or not for Dealer

  • Deleted property website (string)

    Website of Dealer

  • Deleted property zip_code (string)

    Zip Code of Dealer City

  • Deleted property is_default_password_changed (boolean)

    IsDefault Password changed or not after dealer creation

  • Changed property email (string -> string)

  • Changed property contact_person_first_name (string)

    Contact person first name

  • Changed property contact_person_last_name (string)

    Contact person last name

  • Changed property contact_person_email (string -> string)

  • Changed property contact_person_role (string)

    Contact person role

  • Changed property is_active (boolean)

    Dealer Status

  • Changed property user_id (integer)

    Dealer admin user ID

GET /config/dealer/find/by-tenant

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  New required properties:

  • contact_person_email

  • contact_person_first_name

  • Deleted property password (string)

    Password for created Dealer

  • Deleted property contact_number (string)

    Contact Number of Dealer

  • Deleted property digital_retail (boolean)

    Digital Retail required or not for Dealer

  • Deleted property website (string)

    Website of Dealer

  • Deleted property zip_code (string)

    Zip Code of Dealer City

  • Deleted property is_default_password_changed (boolean)

    IsDefault Password changed or not after dealer creation

  • Changed property email (string -> string)

  • Changed property contact_person_first_name (string)

    Contact person first name

  • Changed property contact_person_last_name (string)

    Contact person last name

  • Changed property contact_person_email (string -> string)

  • Changed property contact_person_role (string)

    Contact person role

  • Changed property is_active (boolean)

    Dealer Status

  • Changed property user_id (integer)

    Dealer admin user ID

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

  • Deleted property dealer_id (integer)

    DealerProfileModel dealer id

  • Changed property id (integer)

    Id

  • Changed property contact_number (string)

    contact number

  • Changed property customer_support_number (string)

    customer support number

  • Changed property time_zone (string)

    time zone

  • Changed property fax_number (string)

    fax number

  • Changed property email (string -> string)

  • Changed property website (string)

  • Changed property contact_person_name (string)

    contact person name

  • Changed property day_light_saving (boolean)

    day light saving

  • Changed property initials (string)

    initials

  • Changed property dealer_address (object)

    dealer address

    • Changed property id (integer)

      Primary id of Dealer Address

    • Changed property address_line_1 (string)

      Address 1 of Dealer

    • Changed property address_line_2 (string)

      Address 2 of Dealer

    • Changed property state_id (integer)

      State of Dealer

    • Changed property state_name (string)

      State Name of Dealer

    • Changed property zip_code (string)

      Zip code of Dealer

    • Changed property county (string)

      County Name of Dealer

    • Changed property city (string)

      City of Dealer

    • Changed property contact_number (string)

      Contact Number of Dealer

    • Changed property verified (boolean)

      Verification Status of Dealer

    • Changed property address_type (string)

      Address type of Dealer

  • Changed property market_scan_number (string)

    market scan number

  • Changed property dealer_code (string)

    dealer_code

  • Changed property pen_dealer_id (string)

    pen dealer id

  • Changed property stripe_dealer_id (string)

    stripe dealer id

  • Changed property shift_digital_dealer_id (string)

    Shift Digital Dealer Id

  • Changed property available_finance_types (array)

    available finance types

    Changed items (string):

    An enumeration.

    Added enum value:

    • `` Removed enum value:

    • Finance&Lease

  • Changed property schedule_option (array)

    schedule option

GET /config/dealer/fees/filter

Parameters:

Added: fee_handling in query

Changed: dealer_code in query

Changed: is_active in query

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property result (array)

    Changed items (object):

    New required properties:

    • fee_handling

    • Added property fee_handling (string)

      fee handling

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

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Deleted property dealer_id (integer)

    DealerProfileModel dealer id

  • Changed property id (integer)

    Id

  • Changed property contact_number (string)

    contact number

  • Changed property customer_support_number (string)

    customer support number

  • Changed property time_zone (string)

    time zone

  • Changed property fax_number (string)

    fax number

  • Changed property email (string -> string)

  • Changed property website (string)

  • Changed property contact_person_name (string)

    contact person name

  • Changed property day_light_saving (boolean)

    day light saving

  • Changed property initials (string)

    initials

  • Changed property dealer_address (object)

    dealer address

    • Changed property id (integer)

      Primary id of Dealer Address

    • Changed property address_line_1 (string)

      Address 1 of Dealer

    • Changed property address_line_2 (string)

      Address 2 of Dealer

    • Changed property state_id (integer)

      State of Dealer

    • Changed property state_name (string)

      State Name of Dealer

    • Changed property zip_code (string)

      Zip code of Dealer

    • Changed property county (string)

      County Name of Dealer

    • Changed property city (string)

      City of Dealer

    • Changed property contact_number (string)

      Contact Number of Dealer

    • Changed property verified (boolean)

      Verification Status of Dealer

    • Changed property address_type (string)

      Address type of Dealer

  • Changed property market_scan_number (string)

    market scan number

  • Changed property dealer_code (string)

    dealer_code

  • Changed property pen_dealer_id (string)

    pen dealer id

  • Changed property stripe_dealer_id (string)

    stripe dealer id

  • Changed property shift_digital_dealer_id (string)

    Shift Digital Dealer Id

  • Changed property available_finance_types (array)

    available finance types

    Changed items (string):

    An enumeration.

    Added enum value:

    • `` Removed enum value:

    • Finance&Lease

  • Changed property schedule_option (array)

    schedule option