API Doc Version 1.0.39

What's New

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

Get asset model Record

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

Check if financial insurance exist

GET /config/deal-type

Fetch Deal Tags

POST /config/deal-type

Create Deal Tags

DELETE /config/deal-type/{deal_type_id}

Delete Deal Tag

PATCH /config/deal-type/{deal_type_id}

Update Deal Tag

What's Changed

GET /config/state

Parameters:

Added: company_id in query

Return Type:

New response : 422 Unprocessable Entity

Validation Error

GET /config/vehicle

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  Changed items (object):

  • Added property asset_category (string)

    Asset category of vehicle

  • Added property asset_type (string)

    Asset type of vehicle

  • Added property asset_subtype (string)

    Asset subtype of vehicle

  • Added property asset_description (string)

    Asset description of Vehicle

GET /config/for-error}`

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property deal_type (string)

    Deal Type of the Rebate

  • Added property eligibility_requirements (string)

    Eligibility Requirements of the Rebate

  • Deleted property payment_term (array)

    Payment Term of Rebate

GET /config/for-exception}`

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property deal_type (string)

    Deal Type of the Rebate

  • Added property eligibility_requirements (string)

    Eligibility Requirements of the Rebate

  • Deleted property payment_term (array)

    Payment Term of Rebate

GET /config/company

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  Changed items (object):

  • Added property credit_response_cushion_time (integer)

    credit response cushion time against tenant

  • Added property session_unlock (boolean)

    Session Unlock

  • Deleted property credit_decision_expiry_in_days (integer)

    Credit Decision valid days

GET /config/company_by_api_key

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property credit_response_cushion_time (integer)

    credit response cushion time against tenant

  • Added property session_unlock (boolean)

    Session Unlock

  • Deleted property credit_decision_expiry_in_days (integer)

    Credit Decision valid days

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

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property credit_response_cushion_time (integer)

    credit response cushion time against tenant

  • Added property session_unlock (boolean)

    Session Unlock

  • Deleted property credit_decision_expiry_in_days (integer)

    Credit Decision valid days

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

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property credit_response_cushion_time (integer)

    credit response cushion time against tenant

  • Added property session_unlock (boolean)

    Session Unlock

  • Deleted property credit_decision_expiry_in_days (integer)

    Credit Decision valid days

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

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property credit_response_cushion_time (integer)

    credit response cushion time against tenant

  • Added property session_unlock (boolean)

    Session Unlock

  • Deleted property credit_decision_expiry_in_days (integer)

    Credit Decision valid days

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

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property credit_response_cushion_time (integer)

    credit response cushion time against tenant

  • Added property session_unlock (boolean)

    Session Unlock

  • Deleted property credit_decision_expiry_in_days (integer)

    Credit Decision valid days

GET /config/odometer

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property credit_response_cushion_time (integer)

    credit response cushion time against tenant

  • Added property session_unlock (boolean)

    Session Unlock

  • Deleted property credit_decision_expiry_in_days (integer)

    Credit Decision valid days

POST /config/stationery

Request:

Changed content type : application/json

New required properties:

• deal_type

• Added property deal_type (string)

  deal type of Stationery Model

• Changed property co_applicant (boolean -> string)

  co_applicant of Stationery Model

• Changed property auto_include (boolean -> string)

  To check if document will automatically be added in deal or not

PATCH /config/stationery/{stationery_id}

Request:

Changed content type : application/json

New required properties:

• deal_type

• Added property deal_type (string)

  deal type of Stationery Model

• Changed property co_applicant (boolean -> string)

  co_applicant of Stationery Model

• Changed property auto_include (boolean -> string)

  To check if document will automatically be added in deal or not

GET /config/stationery/filter/

Parameters:

Added: finance_type in query

Added: customer_type in query

GET /config/dealer/fee

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  Changed items (object):

  New required properties:

  • deal_type

  • Added property deal_type (string)

    deal type

POST /config/dealer/fee

Request:

Changed content type : application/json

New required properties:

• deal_type

• Added property deal_type (string)

  deal type

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  New required properties:

  • deal_type

  • Added property deal_type (string)

    deal type

GET /config/dealer/{dealer_code}/fees

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  Changed items (object):

  New required properties:

  • deal_type

  • Added property deal_type (string)

    deal type

GET /config/dealer/fee/{fee_id}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  New required properties:

  • deal_type

  • Added property deal_type (string)

    deal type

DELETE /config/dealer/fee/{fee_id}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  New required properties:

  • deal_type

  • Added property deal_type (string)

    deal type

PATCH /config/dealer/fee/{fee_id}

Request:

Changed content type : application/json

New required properties:

• deal_type

• Added property deal_type (string)

  deal type

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  New required properties:

  • deal_type

  • Added property deal_type (string)

    deal type

GET /config/dealer/profile

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  Changed items (object):

  • Added property taxable_deal_types (array)

    List of Taxable deal types

    Items (string):

  • Added property routeone_contracts_dealership_id (string)

    Routeone Contracts dealer ID

POST /config/dealer/profile

Request:

Changed content type : application/json

• Added property taxable_deal_types (array)

  List of Taxable deal types

• Added property routeone_contracts_dealership_id (string)

  Routeone Contracts dealer ID

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property taxable_deal_types (array)

    List of Taxable deal types

  • Added property routeone_contracts_dealership_id (string)

    Routeone Contracts dealer ID

DELETE /config/dealer/profile/{dealer_profile_id}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property taxable_deal_types (array)

    List of Taxable deal types

  • Added property routeone_contracts_dealership_id (string)

    Routeone Contracts dealer ID

PATCH /config/dealer/profile/{dealer_profile_id}

Request:

Changed content type : application/json

• Added property taxable_deal_types (array)

  List of Taxable deal types

• Added property routeone_contracts_dealership_id (string)

  Routeone Contracts dealer ID

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property taxable_deal_types (array)

    List of Taxable deal types

  • Added property routeone_contracts_dealership_id (string)

    Routeone Contracts dealer ID

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

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property taxable_deal_types (array)

    List of Taxable deal types

  • Added property routeone_contracts_dealership_id (string)

    Routeone Contracts dealer ID

GET /config/dealer/profile/{dealer_code}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property taxable_deal_types (array)

    List of Taxable deal types

  • Added property routeone_contracts_dealership_id (string)

    Routeone Contracts dealer ID

POST /config/dealers

Request:

Changed content type : application/json

• Added property associated_broker_id (integer)

  Associated Broker of Dealer

Return Type:

Changed response : 201 Created

Successful Response

• Changed content type : application/json

  • Added property associated_broker_id (integer)

    Associated Broker of Dealer

GET /config/dealers/filter

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property result (array)

    Changed items (object):

    • Added property associated_broker_id (integer)

      Associated Broker of Dealer

GET /config/dealers/{dealer_id}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property associated_broker_id (integer)

    Associated Broker of Dealer

PUT /config/dealers/{dealer_id}

Request:

Changed content type : application/json

• Added property associated_broker_id (integer)

  Associated Broker of Dealer

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property associated_broker_id (integer)

    Associated Broker of Dealer

DELETE /config/dealers/{dealer_id}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property associated_broker_id (integer)

    Associated Broker of Dealer

GET /config/dealer

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  Changed items (object):

  • Added property associated_broker_id (integer)

    Associated Broker of Dealer

GET /config/dealer/{dealer_code}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property associated_broker_id (integer)

    Associated Broker of Dealer

GET /config/dealer/find/by-tenant

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property associated_broker_id (integer)

    Associated Broker of Dealer

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

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property taxable_deal_types (array)

    List of Taxable deal types

  • Added property routeone_contracts_dealership_id (string)

    Routeone Contracts dealer ID

GET /config/dealer/fees/filter

Parameters:

Added: deal_type 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:

    • deal_type

    • Added property deal_type (string)

      deal type

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

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property taxable_deal_types (array)

    List of Taxable deal types

  • Added property routeone_contracts_dealership_id (string)

    Routeone Contracts dealer ID

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

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property taxable_deal_types (array)

    List of Taxable deal types

  • Added property routeone_contracts_dealership_id (string)

    Routeone Contracts dealer ID

GET /config/vehicle_by_vin/{vehicle_id}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property asset_category (string)

    Asset category of vehicle

  • Added property asset_type (string)

    Asset type of vehicle

  • Added property asset_subtype (string)

    Asset subtype of vehicle

  • Added property asset_description (string)

    Asset description of Vehicle

GET /config/vehicle/{vin}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property asset_category (string)

    Asset category of vehicle

  • Added property asset_type (string)

    Asset type of vehicle

  • Added property asset_subtype (string)

    Asset subtype of vehicle

  • Added property asset_description (string)

    Asset description of Vehicle

PATCH /config/vehicle/{vin}

Request:

Changed content type : application/json

• Added property asset_category (string)

  Asset category of vehicle

• Added property asset_type (string)

  Asset type of vehicle

• Added property asset_subtype (string)

  Asset subtype of vehicle

• Added property asset_description (string)

  Asset description of Vehicle

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property asset_category (string)

    Asset category of vehicle

  • Added property asset_type (string)

    Asset type of vehicle

  • Added property asset_subtype (string)

    Asset subtype of vehicle

  • Added property asset_description (string)

    Asset description of Vehicle

DELETE /config/vehicle/{vehicle_id}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property asset_category (string)

    Asset category of vehicle

  • Added property asset_type (string)

    Asset type of vehicle

  • Added property asset_subtype (string)

    Asset subtype of vehicle

  • Added property asset_description (string)

    Asset description of Vehicle

POST /config/vehicle/

Request:

Changed content type : application/json

• Added property asset_category (string)

  Asset category of vehicle

• Added property asset_type (string)

  Asset type of vehicle

• Added property asset_subtype (string)

  Asset subtype of vehicle

• Added property asset_description (string)

  Asset description of Vehicle

GET /config/financial-insurance

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  Changed items (object):

  • Added property taxable_deal_types (array)

    List of taxable deal types

    Items (string):

POST /config/financial-insurance

Request:

Changed content type : application/json

• Added property taxable_deal_types (array)

  List of taxable deal types

Return Type:

Changed response : 201 Created

Successful Response

• Changed content type : application/json

  • Added property taxable_deal_types (array)

    List of taxable deal types

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

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  Changed items (object):

  • Added property taxable_deal_types (array)

    List of taxable deal types

POST /config/financial-insurance-material

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property taxable_deal_types (array)

    List of taxable deal types

GET /config/financial-insurance/{financial_insurance_id}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property taxable_deal_types (array)

    List of taxable deal types

DELETE /config/financial-insurance/{financial_insurance_id}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property taxable_deal_types (array)

    List of taxable deal types

PATCH /config/financial-insurance/{financial_insurance_id}

Request:

Changed content type : application/json

• Added property taxable_deal_types (array)

  List of taxable deal types

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property taxable_deal_types (array)

    List of taxable deal types

GET /config/financial-insurances/filter

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property result (array)

    Changed items (object):

    • Added property taxable_deal_types (array)

      List of taxable deal types

PATCH /config/integration/dealer/provider

Request:

Changed content type : application/json

• Added property routeone_contracts_dealership_id (string)

  Routeone Contracts dealer ID for contracting

POST /config/create-rebate

Request:

Changed content type : application/json

• Added property deal_type (string)

  Deal Type of the Rebate

• Added property eligibility_requirements (string)

  Eligibility Requirements of the Rebate

• Deleted property payment_term (array)

  Payment Term of Rebate

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property deal_type (string)

    Deal Type of the Rebate

  • Added property eligibility_requirements (string)

    Eligibility Requirements of the Rebate

  • Deleted property payment_term (array)

    Payment Term of Rebate

GET /config/rebates/{rebate_id}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property deal_type (string)

    Deal Type of the Rebate

  • Added property eligibility_requirements (string)

    Eligibility Requirements of the Rebate

  • Deleted property payment_term (array)

    Payment Term of Rebate

DELETE /config/rebates/{rebate_id}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property deal_type (string)

    Deal Type of the Rebate

  • Added property eligibility_requirements (string)

    Eligibility Requirements of the Rebate

  • Deleted property payment_term (array)

    Payment Term of Rebate

PATCH /config/rebate/{rebate_id}

Request:

Changed content type : application/json

• Added property deal_type (string)

  Deal Type of the Rebate

• Added property eligibility_requirements (string)

  Eligibility Requirements of the Rebate

• Deleted property payment_term (array)

  Payment Term of Rebate

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property deal_type (string)

    Deal Type of the Rebate

  • Added property eligibility_requirements (string)

    Eligibility Requirements of the Rebate

  • Deleted property payment_term (array)

    Payment Term of Rebate

GET /config/rebate/filter

Parameters:

Added: deal_type in query

Added: is_deleted in query

Added: finance_type in query

Added: applicable_states in query

Added: module in query

Deleted: company_id in query

Deleted: company_id in header

POST /config/company/create-company

Request:

Changed content type : application/json

• Changed property company_profile (object)

  • Added property credit_response_cushion_time (integer)

    credit response cushion time against tenant

  • Added property session_unlock (boolean)

    Session Unlock

  • Deleted property credit_decision_expiry_in_days (integer)

    Credit Decision valid days

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property credit_response_cushion_time (integer)

    credit response cushion time against tenant

  • Added property session_unlock (boolean)

    Session Unlock

  • Deleted property credit_decision_expiry_in_days (integer)

    Credit Decision valid days

GET /config/company/{company_id}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property credit_response_cushion_time (integer)

    credit response cushion time against tenant

  • Added property session_unlock (boolean)

    Session Unlock

  • Deleted property credit_decision_expiry_in_days (integer)

    Credit Decision valid days

DELETE /config/company/{company_id}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property credit_response_cushion_time (integer)

    credit response cushion time against tenant

  • Added property session_unlock (boolean)

    Session Unlock

  • Deleted property credit_decision_expiry_in_days (integer)

    Credit Decision valid days

PATCH /config/company/{company_id}

Request:

Changed content type : application/json

• Changed property company_profile (object)

  • Added property credit_response_cushion_time (integer)

    credit response cushion time against tenant

  • Added property session_unlock (boolean)

    Session Unlock

  • Deleted property credit_decision_expiry_in_days (integer)

    Credit Decision valid days

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Added property credit_response_cushion_time (integer)

    credit response cushion time against tenant

  • Added property session_unlock (boolean)

    Session Unlock

  • Deleted property credit_decision_expiry_in_days (integer)

    Credit Decision valid days

GET /config/financial-product/{financial_product_id}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property dealers (array)

    Associated dealers with a program

    Changed items (object):

    • Added property associated_broker_id (integer)

      Associated Broker of Dealer

PATCH /config/financial-product/{financial_product_id}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property dealers (array)

    Associated dealers with a program

    Changed items (object):

    • Added property associated_broker_id (integer)

      Associated Broker of Dealer

POST /config/financial-product/create-fp

Return Type:

Changed response : 201 Created

Successful Response

• Changed content type : application/json

  • Changed property dealers (array)

    Associated dealers with a program

    Changed items (object):

    • Added property associated_broker_id (integer)

      Associated Broker of Dealer

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

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property dealers (array)

    Associated dealers with a program

    Changed items (object):

    • Added property associated_broker_id (integer)

      Associated Broker of Dealer

GET /config/financial-insurances-bundle/filter

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property results (array)

    Changed items (object):

    • Changed property financial_products (array)

      List of Financial Product

      Changed items (object):

      • Added property taxable_deal_types (array)

        List of taxable deal types

GET /config/integration/company

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  Changed items (object):

  • Changed property providers (array)

    Associated Providers

    Changed items (object):

    • Added property routeone_contracts_dealership_id (string)

      Routeone Contracts dealer ID for contracting

POST /config/integration/company

Request:

Changed content type : application/json

• Changed property providers (array)

  Associated Providers

  Changed items (object):

  • Added property routeone_contracts_dealership_id (string)

    Routeone Contracts dealer ID for contracting

Return Type:

Changed response : 201 Created

Successful Response

• Changed content type : application/json

  • Changed property providers (array)

    Associated Providers

    Changed items (object):

    • Added property routeone_contracts_dealership_id (string)

      Routeone Contracts dealer ID for contracting

PATCH /config/integration/company

Request:

Changed content type : application/json

• Changed property providers (array)

  Associated Providers

  Changed items (object):

  • Added property routeone_contracts_dealership_id (string)

    Routeone Contracts dealer ID for contracting

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property providers (array)

    Associated Providers

    Changed items (object):

    • Added property routeone_contracts_dealership_id (string)

      Routeone Contracts dealer ID for contracting

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

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  Changed items (object):

  • Changed property providers (array)

    Associated Providers

    Changed items (object):

    • Added property routeone_contracts_dealership_id (string)

      Routeone Contracts dealer ID for contracting

DELETE /config/integration/company/{integration_id}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property providers (array)

    Associated Providers

    Changed items (object):

    • Added property routeone_contracts_dealership_id (string)

      Routeone Contracts dealer ID for contracting

PATCH /config/integration/status/{integration_id}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property providers (array)

    Associated Providers

    Changed items (object):

    • Added property routeone_contracts_dealership_id (string)

      Routeone Contracts dealer ID for contracting

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

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property providers (array)

    Associated Providers

    Changed items (object):

    • Added property routeone_contracts_dealership_id (string)

      Routeone Contracts dealer ID for contracting

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

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property providers (array)

    Associated Providers

    Changed items (object):

    • Added property routeone_contracts_dealership_id (string)

      Routeone Contracts dealer ID for contracting

GET /config/financial-product/filter

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property result (array)

    Changed items (object):

    • Changed property dealers (array)

      Associated dealers with a program

      Changed items (object):

      • Added property associated_broker_id (integer)

        Associated Broker of Dealer