Developer Docs
Index
Version 1.0.34

API Doc Version 1.0.34

What's New

GET /config/business-trading-age

Get Business Trading Age records

POST /config/business-trading-age

Creates a business trading age record

GET /config/business-trading-age/filter

Get paginated business trading age records

GET /config/business-trading-age/active

Get all active trading age records

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

Get trading age by Id

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

Deletes trading age record

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

Updates trading age record

GET /config/pre-qualification

Get Pre Qualification records

POST /config/pre-qualification

Creates a Pre-Qualification setup record

GET /config/pre-qualification/filter

Get paginated pre-qualification setup records

GET /config/pre-qualification/active

Get all active pre-qualification records

GET /config/pre-qualification/{pre_qualification_id}

Get Pre Qualification by Id

DELETE /config/pre-qualification/{pre_qualification_id}

Deletes pre-qualification record

PATCH /config/pre-qualification/{pre_qualification_id}

Updates trading age record

GET /config/asset_sub_type/{asset_subtype_id}

Get an asset subtype by Id

DELETE /config/asset_sub_type/{asset_subtype_id}

Deletes a asset subtype record

PATCH /config/asset_sub_type/{asset_subtype_id}

Updates a asset subtype record

PATCH /config/product_type/{product_type_id}

Updates a product type

PATCH /config/finance_type/{finance_type_id}

Updates a finance type

What's Deleted

GET /configasset_sub_type/{asset_subtype_id}

Get an asset subtype by Id

DELETE /configasset_sub_type/{asset_subtype_id}

Deletes a asset subtype record

PATCH /configasset_sub_type/{asset_subtype_id}

Updates a asset subtype record

POST /config/stipulation/

Creates a stipulation record

PUT /config/product_type/{product_type_id}

Updates a product type

PUT /config/finance_type/{finance_type_id}

Updates a finance type

What's Changed

GET /config/customer-type

Parameters:

Added: company_id in header

Return Type:

New response : 422 Unprocessable Entity

Validation Error

POST /config/customer-type

Parameters:

Added: company_id in header

GET /config/customer-type/{customer_type_id}

Parameters:

Added: company_id in header

DELETE /config/customer-type/{customer_type_id}

Parameters:

Added: company_id in header

PATCH /config/customer-type/{customer_type_id}

Parameters:

Added: company_id in header

GET /config/stipulation/

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    Changed items (object):

    • Changed property stipulation_type (string)

      Stipulation Type i.e., either financial or non-financial or General

GET /config/stipulation/filter

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Changed property result (array)

      Changed items (object):

      • Changed property stipulation_type (string)

        Stipulation Type i.e., either financial or non-financial or General

GET /config/stipulation/{stipulation_id}

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Changed property stipulation_type (string)

      Stipulation Type i.e., either financial or non-financial or General

DELETE /config/stipulation/{stipulation_id}

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Changed property stipulation_type (string)

      Stipulation Type i.e., either financial or non-financial or General

PATCH /config/stipulation/{stipulation_id}

Request:

Changed content type : application/json

  • Changed property stipulation_type (string)

    Stipulation Type i.e., either financial or non-financial or General

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Changed property stipulation_type (string)

      Stipulation Type i.e., either financial or non-financial or General

GET /config/dealer/profile

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    Changed items (object):

    • Added property trading_as (string)

      Trading as

    • Added property contact_person_email (string)

      Contact Person Email Address

    • Added property contact_person_phone_number (string)

      Contact Person Phone Number

POST /config/dealer/profile

Request:

Changed content type : application/json

  • Added property trading_as (string)

    Trading as

  • Added property contact_person_email (string)

    Contact Person Email Address

  • Added property contact_person_phone_number (string)

    Contact Person Phone Number

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Added property trading_as (string)

      Trading as

    • Added property contact_person_email (string)

      Contact Person Email Address

    • Added property contact_person_phone_number (string)

      Contact Person Phone Number

DELETE /config/dealer/profile/{dealer_profile_id}

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Added property trading_as (string)

      Trading as

    • Added property contact_person_email (string)

      Contact Person Email Address

    • Added property contact_person_phone_number (string)

      Contact Person Phone Number

PATCH /config/dealer/profile/{dealer_profile_id}

Request:

Changed content type : application/json

  • Added property trading_as (string)

    Trading as

  • Added property contact_person_email (string)

    Contact Person Email Address

  • Added property contact_person_phone_number (string)

    Contact Person Phone Number

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Added property trading_as (string)

      Trading as

    • Added property contact_person_email (string)

      Contact Person Email Address

    • Added property contact_person_phone_number (string)

      Contact Person Phone Number

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 trading_as (string)

      Trading as

    • Added property contact_person_email (string)

      Contact Person Email Address

    • Added property contact_person_phone_number (string)

      Contact Person Phone Number

GET /config/dealer/profile/{dealer_code}

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Added property trading_as (string)

      Trading as

    • Added property contact_person_email (string)

      Contact Person Email Address

    • Added property contact_person_phone_number (string)

      Contact Person Phone Number

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 trading_as (string)

      Trading as

    • Added property contact_person_email (string)

      Contact Person Email Address

    • Added property contact_person_phone_number (string)

      Contact Person Phone Number

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

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Added property trading_as (string)

      Trading as

    • Added property contact_person_email (string)

      Contact Person Email Address

    • Added property contact_person_phone_number (string)

      Contact Person Phone Number

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 trading_as (string)

      Trading as

    • Added property contact_person_email (string)

      Contact Person Email Address

    • Added property contact_person_phone_number (string)

      Contact Person Phone Number

GET /config/product_type

Parameters:

Added: company_id in header

Return Type:

New response : 422 Unprocessable Entity

Validation Error

POST /config/product_type

Parameters:

Added: company_id in header

GET /config/product_type/{product_type_id}

Parameters:

Added: company_id in header

DELETE /config/product_type/{product_type_id}

Parameters:

Added: company_id in header

GET /config/finance_type

Parameters:

Added: company_id in header

Return Type:

New response : 422 Unprocessable Entity

Validation Error

POST /config/finance_type

Parameters:

Added: company_id in header

GET /config/finance_type/{finance_type_id}

Parameters:

Added: company_id in header

DELETE /config/finance_type/{finance_type_id}

Parameters:

Added: company_id in header

GET /config/asset_category

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    Changed items (object):

    • Added property company_id (integer)

      Company id that supports Asset category model

    • Deleted property lender_id (integer)

      Lender id that supports Asset category model

POST /config/asset_category

Request:

Changed content type : application/json

  • Added property company_id (integer)

    Company id that supports Asset category model

  • Deleted property lender_id (integer)

    Lender id that supports Asset category model

Return Type:

Changed response : 201 Created

Successful Response

  • Changed content type : application/json

    • Added property company_id (integer)

      Company id that supports Asset category model

    • Deleted property lender_id (integer)

      Lender id that supports Asset category model

GET /config/asset_category/{asset_category_id}

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Added property company_id (integer)

      Company id that supports Asset category model

    • Deleted property lender_id (integer)

      Lender id that supports Asset category model

DELETE /config/asset_category/{asset_category_id}

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Added property company_id (integer)

      Company id that supports Asset category model

    • Deleted property lender_id (integer)

      Lender id that supports Asset category model

PATCH /config/asset_category/{asset_category_id}

Request:

Changed content type : application/json

  • Added property company_id (integer)

    Company id that supports Asset category model

  • Deleted property lender_id (integer)

    Lender id that supports Asset category model

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Added property company_id (integer)

      Company id that supports Asset category model

    • Deleted property lender_id (integer)

      Lender id that supports Asset category model

GET /config/asset_type

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    Changed items (object):

    • Added property company_id (integer)

      Company id that supports Asset category model

    • Deleted property lender_id (integer)

      Lender id that supports Asset category model

POST /config/asset_type

Request:

Changed content type : application/json

  • Added property company_id (integer)

    Company id that supports Asset category model

  • Deleted property lender_id (integer)

    Lender id that supports Asset category model

Return Type:

Changed response : 201 Created

Successful Response

  • Changed content type : application/json

    • Added property company_id (integer)

      Company id that supports Asset category model

    • Deleted property lender_id (integer)

      Lender id that supports Asset category model

GET /config/asset_type/{asset_type_id}

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Added property company_id (integer)

      Company id that supports Asset category model

    • Deleted property lender_id (integer)

      Lender id that supports Asset category model

DELETE /config/asset_type/{asset_type_id}

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Added property company_id (integer)

      Company id that supports Asset category model

    • Deleted property lender_id (integer)

      Lender id that supports Asset category model

PATCH /config/asset_type/{asset_type_id}

Request:

Changed content type : application/json

  • Added property company_id (integer)

    Company id that supports Asset category model

  • Deleted property lender_id (integer)

    Lender id that supports Asset category model

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Added property company_id (integer)

      Company id that supports Asset category model

    • Deleted property lender_id (integer)

      Lender id that supports Asset category model

GET /config/asset_sub_type

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    Changed items (object):

    • Added property company_id (integer)

      Company id that supports Asset category model

    • Deleted property lender_id (integer)

      Lender id that supports Asset category model

POST /config/asset_sub_type

Request:

Changed content type : application/json

  • Added property company_id (integer)

    Company id that supports Asset category model

  • Deleted property lender_id (integer)

    Lender id that supports Asset category model

Return Type:

Changed response : 201 Created

Successful Response

  • Changed content type : application/json

    • Added property company_id (integer)

      Company id that supports Asset category model

    • Deleted property lender_id (integer)

      Lender id that supports Asset category model

GET /config/get-configuration

Parameters:

Changed: finance_type in query

List of finance types