Developer Docs
Index
Version 1.0.12

API Doc Version 1.0.12

What's New

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

Imports Asset Catalogue Files data into database

POST /config/down-payment/criteria

Creates a Down Payment chart criteria

POST /config/commissions/criteria

Creates a Commission chart criteria

POST /config/subsidy/criteria

Creates a Subsidy chart criteria

GET /config/chart/name

This method returns name of Chart if duplication of name exists

GET /config/chart/type

Checks criteria attached to subsidy chart

GET /config/down-payment/filter

Get all pagination down payment records

GET /config/down-payment

Get all down payment charts

POST /config/down-payment

Creates a down payment chart record

GET /config/down-payment/{down_payment_id}

Get down payment chart record by Id

DELETE /config/down-payment/{down_payment_id}

Deletes a down payment chart record

PATCH /config/down-payment/{down_payment_id}

Updates a down payment chart record

GET /config/commissions/filter

Get all pagination commission records

GET /config/commissions

Get all commission charts

POST /config/commissions

Creates a commission chart record

GET /config/commissions/{commission_id}

Get commission chart record by Id

DELETE /config/commissions/{commission_id}

Deletes a commission chart record

PATCH /config/commissions/{commission_id}

Updates a commission chart record

GET /config/subsidy/filter

Get all pagination subsidy records

GET /config/subsidy

Get all subsidy charts

POST /config/subsidy

Creates a subsidy chart record

GET /config/subsidy/{subsidy_id}

Get subsidy chart record by Id

DELETE /config/subsidy/{subsidy_id}

Deletes a subsidy chart record

PATCH /config/subsidy/{subsidy_id}

Updates a subsidy chart record

POST /config/charts/base-rate/

Creates a chart record

GET /config/charts/filter/

Get all charts

DELETE /config/chart/base_rate/{base_rate_chart_id}

Deletes a chart record

PATCH /config/charts/base_rate/{base_rate_chart_id}

Updates a chart record

POST /config/inventory-list-import/{dealer_id}/{tenant_id}

Imports Inventory Files data into database

PATCH /config/vehicle-detail/update-status-by-vin/

Update Inventory Record Status

POST /config/get_event_associated_checklist/

This API helps to evaluate given criteria and retrive configured checklist(s)

What's Deleted

POST /config/asset-list-import/

Imports Asset Catalogue Files data into database

POST /config/inventory-list-import/{dealer_id}

Imports Inventory Files data into database

GET /config/get_event_associated_checklist/

This API helps to evaluate given criteria and retrive configured checklist(s)

What's Changed

DELETE /config/lender/{id}

Parameters:

Added: id in path

Deleted: lender_id in query

GET /config/charts

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    Changed items (object):

    New optional properties:

    • chart_name

    • is_active

    • Added property output_parameter_type (string)

      Output parameter type i.e., for subsidy & commission

    • Added property base_rate (number)

      Base Rate of a Chart

    • Added property effective_date (string)

      Effective Date of a Base Chart

    • Added property tenure (string)

      Tenure of a Base Rate Chart

POST /config/charts

Request:

Changed content type : application/json

  • Added property output_parameter_type (string)

    Output parameter type i.e., for subsidy & commission

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Added property output_parameter_type (string)

      Output parameter type i.e., for subsidy & commission

GET /config/interest-chart/filter

Parameters:

Added: output_parameter_type in query

Added: financed_amount_range in query

Added: purchase_option in query

Added: manufacturer in query

Added: business_units in query

Added: cost_name in query

Added: late_charge_inclusive_adder in query

Added: property_tax_inclusive_adder in query

Added: origination_fee_inclusive_adder in query

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Changed property result (array)

      Changed items (object):

      • Added property output_parameter_type (string)

        Output parameter type i.e., for subsidy & commission

GET /config/charts/{chart_id}

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Added property output_parameter_type (string)

      Output parameter type i.e., for subsidy & commission

DELETE /config/charts/{chart_id}

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Added property output_parameter_type (string)

      Output parameter type i.e., for subsidy & commission

PATCH /config/charts/{chart_id}

Request:

Changed content type : application/json

  • Added property output_parameter_type (string)

    Output parameter type i.e., for subsidy & commission

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Added property output_parameter_type (string)

      Output parameter type i.e., for subsidy & commission

GET /config/interest-chart

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    Changed items (object):

    • Added property financed_amount_range (array)

      Multiple Financed Amount in array format for Interest Rate Chart Criteria

      Items (string):

    • Added property purchase_option (array)

      Multiple Purchase Option in array format for Interest Rate Chart Criteria

      Items (string):

    • Added property manufacturer (array)

      Multiple Manfacturers in array format for Interest Rate Chart Criteria

      Items (string):

    • Added property business_units (array)

      Multiple Business units in array format for Interest Rate Chart Criteria

      Items (string):

    • Added property cost_name (array)

      Multiple cost name in array format for Interest Rate Chart Criteria

      Items (string):

    • Added property late_charge_inclusive_adder (boolean)

      Is late charge inclusive adder applicable in Interest Rate Chart Criteria?

    • Added property property_tax_inclusive_adder (boolean)

      Is property tax inclusive adder applicable in Interest Rate Chart Criteria?

    • Added property origination_fee_inclusive_adder (boolean)

      Is q fee inclusive adder applicable in Interest Rate Chart Criteria?

POST /config/interest-chart

Request:

Changed content type : application/json

  • Added property financed_amount_range (array)

    Multiple Financed Amount in array format for Interest Rate Chart Criteria

  • Added property purchase_option (array)

    Multiple Purchase Option in array format for Interest Rate Chart Criteria

  • Added property manufacturer (array)

    Multiple Manfacturers in array format for Interest Rate Chart Criteria

  • Added property business_units (array)

    Multiple Business units in array format for Interest Rate Chart Criteria

  • Added property cost_name (array)

    Multiple cost name in array format for Interest Rate Chart Criteria

  • Added property late_charge_inclusive_adder (boolean)

    Is late charge inclusive adder applicable in Interest Rate Chart Criteria?

  • Added property property_tax_inclusive_adder (boolean)

    Is property tax inclusive adder applicable in Interest Rate Chart Criteria?

  • Added property origination_fee_inclusive_adder (boolean)

    Is q fee inclusive adder applicable in Interest Rate Chart Criteria?

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Added property financed_amount_range (array)

      Multiple Financed Amount in array format for Interest Rate Chart Criteria

    • Added property purchase_option (array)

      Multiple Purchase Option in array format for Interest Rate Chart Criteria

    • Added property manufacturer (array)

      Multiple Manfacturers in array format for Interest Rate Chart Criteria

    • Added property business_units (array)

      Multiple Business units in array format for Interest Rate Chart Criteria

    • Added property cost_name (array)

      Multiple cost name in array format for Interest Rate Chart Criteria

    • Added property late_charge_inclusive_adder (boolean)

      Is late charge inclusive adder applicable in Interest Rate Chart Criteria?

    • Added property property_tax_inclusive_adder (boolean)

      Is property tax inclusive adder applicable in Interest Rate Chart Criteria?

    • Added property origination_fee_inclusive_adder (boolean)

      Is q fee inclusive adder applicable in Interest Rate Chart Criteria?

GET /config/interest-chart/{interest_chart_id}

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Added property financed_amount_range (array)

      Multiple Financed Amount in array format for Interest Rate Chart Criteria

    • Added property purchase_option (array)

      Multiple Purchase Option in array format for Interest Rate Chart Criteria

    • Added property manufacturer (array)

      Multiple Manfacturers in array format for Interest Rate Chart Criteria

    • Added property business_units (array)

      Multiple Business units in array format for Interest Rate Chart Criteria

    • Added property cost_name (array)

      Multiple cost name in array format for Interest Rate Chart Criteria

    • Added property late_charge_inclusive_adder (boolean)

      Is late charge inclusive adder applicable in Interest Rate Chart Criteria?

    • Added property property_tax_inclusive_adder (boolean)

      Is property tax inclusive adder applicable in Interest Rate Chart Criteria?

    • Added property origination_fee_inclusive_adder (boolean)

      Is q fee inclusive adder applicable in Interest Rate Chart Criteria?

DELETE /config/interest-chart/{interest_chart_id}

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Added property financed_amount_range (array)

      Multiple Financed Amount in array format for Interest Rate Chart Criteria

    • Added property purchase_option (array)

      Multiple Purchase Option in array format for Interest Rate Chart Criteria

    • Added property manufacturer (array)

      Multiple Manfacturers in array format for Interest Rate Chart Criteria

    • Added property business_units (array)

      Multiple Business units in array format for Interest Rate Chart Criteria

    • Added property cost_name (array)

      Multiple cost name in array format for Interest Rate Chart Criteria

    • Added property late_charge_inclusive_adder (boolean)

      Is late charge inclusive adder applicable in Interest Rate Chart Criteria?

    • Added property property_tax_inclusive_adder (boolean)

      Is property tax inclusive adder applicable in Interest Rate Chart Criteria?

    • Added property origination_fee_inclusive_adder (boolean)

      Is q fee inclusive adder applicable in Interest Rate Chart Criteria?

PATCH /config/interest-chart/{interest_chart_id}

Request:

Changed content type : application/json

  • Added property financed_amount_range (array)

    Multiple Financed Amount in array format for Interest Rate Chart Criteria

  • Added property purchase_option (array)

    Multiple Purchase Option in array format for Interest Rate Chart Criteria

  • Added property manufacturer (array)

    Multiple Manfacturers in array format for Interest Rate Chart Criteria

  • Added property business_units (array)

    Multiple Business units in array format for Interest Rate Chart Criteria

  • Added property cost_name (array)

    Multiple cost name in array format for Interest Rate Chart Criteria

  • Added property late_charge_inclusive_adder (boolean)

    Is late charge inclusive adder applicable in Interest Rate Chart Criteria?

  • Added property property_tax_inclusive_adder (boolean)

    Is property tax inclusive adder applicable in Interest Rate Chart Criteria?

  • Added property origination_fee_inclusive_adder (boolean)

    Is q fee inclusive adder applicable in Interest Rate Chart Criteria?

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Added property financed_amount_range (array)

      Multiple Financed Amount in array format for Interest Rate Chart Criteria

    • Added property purchase_option (array)

      Multiple Purchase Option in array format for Interest Rate Chart Criteria

    • Added property manufacturer (array)

      Multiple Manfacturers in array format for Interest Rate Chart Criteria

    • Added property business_units (array)

      Multiple Business units in array format for Interest Rate Chart Criteria

    • Added property cost_name (array)

      Multiple cost name in array format for Interest Rate Chart Criteria

    • Added property late_charge_inclusive_adder (boolean)

      Is late charge inclusive adder applicable in Interest Rate Chart Criteria?

    • Added property property_tax_inclusive_adder (boolean)

      Is property tax inclusive adder applicable in Interest Rate Chart Criteria?

    • Added property origination_fee_inclusive_adder (boolean)

      Is q fee inclusive adder applicable in Interest Rate Chart Criteria?

GET /config/rv-chart/filter

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Changed property result (array)

      Changed items (object):

      • Added property output_parameter_type (string)

        Output parameter type i.e., for subsidy & commission

POST /config/rv-evaluate

Request:

Changed content type : application/json

  • Added property asset_make_name (string)

  • Added property asset_model_name (string)

  • Added property asset_trim_name (string)

  • Deleted property asset_make_id (integer)

  • Deleted property asset_model_id (integer)

  • Deleted property asset_trim_id (integer)

  • Changed property asset_condition (integer -> string)

  • Changed property terms (integer -> string)

POST /config/interest-chart-evaluate

Request:

Changed content type : application/json

  • Added property asset_make_name (string)

  • Added property asset_model_name (string)

  • Added property asset_trim_name (string)

  • Added property credit_rating (string)

  • Deleted property asset_make_id (integer)

  • Deleted property asset_model_id (integer)

  • Deleted property asset_trim_id (integer)

  • Deleted property credit_rating_id (integer)

  • Changed property asset_condition (integer -> string)

  • Changed property terms (integer -> string)

POST /config/interest-chart/criteria

Request:

Changed content type : application/json

  • Changed property chart (object)

    • Added property output_parameter_type (string)

      Output parameter type i.e., for subsidy & commission

  • Changed property interestCriteria (object)

    • Added property financed_amount_range (array)

      Multiple Financed Amount in array format for Interest Rate Chart Criteria

    • Added property purchase_option (array)

      Multiple Purchase Option in array format for Interest Rate Chart Criteria

    • Added property manufacturer (array)

      Multiple Manfacturers in array format for Interest Rate Chart Criteria

    • Added property business_units (array)

      Multiple Business units in array format for Interest Rate Chart Criteria

    • Added property cost_name (array)

      Multiple cost name in array format for Interest Rate Chart Criteria

    • Added property late_charge_inclusive_adder (boolean)

      Is late charge inclusive adder applicable in Interest Rate Chart Criteria?

    • Added property property_tax_inclusive_adder (boolean)

      Is property tax inclusive adder applicable in Interest Rate Chart Criteria?

    • Added property origination_fee_inclusive_adder (boolean)

      Is q fee inclusive adder applicable in Interest Rate Chart Criteria?

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Added property output_parameter_type (string)

      Output parameter type i.e., for subsidy & commission

POST /config/rv-chart/criteria

Request:

Changed content type : application/json

  • Changed property chart (object)

    • Added property output_parameter_type (string)

      Output parameter type i.e., for subsidy & commission

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Added property output_parameter_type (string)

      Output parameter type i.e., for subsidy & commission

GET /config/financial-product

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    Changed items (object):

    • Added property program_commission (object)

      • Property is_active (boolean)

      • Property is_deleted (boolean)

      • Property id (integer)

        Program Commission id

      • Property commission_type (string)

        Program Commission Type

      • Property amortization_method (string)

        Program Commission Amortization Method

      • Property commission_override (string)

        Program Commission Override

      • Property lender_id (string)

        Program Commission Lender id

    • Added property program_subsidy (object)

      • Property is_active (boolean)

      • Property is_deleted (boolean)

      • Property id (integer)

        Program Subsidy id

      • Property calculation_method (string)

        Program Subsidy Calculation Method

      • Property amortization_method (string)

        Program Subsidy Amortization Method

      • Property tax_amortization (string)

        Program Subsidy Tax Amortization

      • Property subsidy_override (string)

        Program Subsidy Override

      • Property lender_id (string)

        Program Subsidy Lender id

GET /config/financial-product/{financial_product_id}

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Added property program_commission (object)

    • Added property program_subsidy (object)

DELETE /config/financial-product/{financial_product_id}

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Added property program_commission (object)

    • Added property program_subsidy (object)

PATCH /config/financial-product/{financial_product_id}

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Added property program_commission (object)

    • Added property program_subsidy (object)

POST /config/financial-product/create-fp

Request:

Changed content type : application/json

  • Added property program_commission (object)

  • Added property program_subsidy (object)

Return Type:

Changed response : 201 Created

Successful Response

  • Changed content type : application/json

    • Added property program_commission (object)

    • Added property program_subsidy (object)

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

Request:

Changed content type : application/json

  • Added property program_commission (object)

  • Added property program_subsidy (object)

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Added property program_commission (object)

    • Added property program_subsidy (object)

POST /config/programs/all/

Request:

Changed content type : application/json

  • Added property asset_model_detail_id (integer)

    System Generated Asset Trim Id

  • Added property model_detail_name (string)

    Trim Name

  • Added property subsidy_calculation_method (string)

    Subsidy Calculation Method

  • Added property amortization_method (string)

    Amortization Method

  • Added property subsidy_tax_amortization (string)

    Subsidy Tax Amortization

  • Added property commission_type (string)

    Commission Type

  • Added property commission_amortization_method (string)

    Commission Amortization Method

  • Added property commission_override (string)

    Commission Override

  • Added property cost_name (string)

    Cost Name

  • Added property late_charge_inclusive_adder (boolean)

    Late Charge Inclusive Adder

  • Added property property_tax_inclusive_adder (boolean)

    Property Tax inclusive adder

  • Added property origination_fee_inclusive_adder (boolean)

    Origination Fee Inclusive adder

  • Added property request_id (string)

    Request Id

  • Added property rv_applicable (boolean)

    rv_applicable

  • Added property rv_type (string)

    rv_type

  • Added property rv_calculation_method (string)

    rv_calculation_method

  • Added property rv_override (string)

    rv_override

  • Deleted property asset_trim_id (integer)

    System Generated Asset Trim Id

  • Deleted property trim_name (string)

    Trim Name

GET /config/financial-product/filter

Return Type:

Changed response : 201 Created

Successful Response

  • Changed content type : application/json

    • Changed property result (array)

      Changed items (object):

      • Added property program_commission (object)

      • Added property program_subsidy (object)