Developer Docs
Index
Technical Changelog
Version 1.0.13

API Doc Version 1.0.13

What's New

POST /config/subsidy-chart-evaluate

Subsidy chart evaluation

POST /config/base-rate-chart-evaluate

Base chart evaluation

POST /config/down-payment-chart-evaluate

Down Payment chart evaluation

POST /config/commission-chart-evaluate

Commission chart evaluation

GET /config/business-units

Gets a business units

POST /config/business-units

Creates a business units

GET /config/business-units/filter

Get paginated business units records

GET /config/business-units/{business_units_id}

Get business units by Id

DELETE /config/business-units/{business_units_id}

Deletes a business units record

PATCH /config/business-units/{business_units_id}

Updates a business units record

GET /config/other-costs

Gets a business units

POST /config/other-costs

Creates a other costs

GET /config/other-costs/filter

Get paginated other costs records

GET /config/other-costs/{other_costs_id}

Get other costs by Id

DELETE /config/other-costs/{other_costs_id}

Deletes a other costs record

PATCH /config/other-costs/{other_costs_id}

Updates a other costs record

GET /config/Financed-Amount

Get financed amount records

POST /config/Financed-Amount

Creates financed amount record

GET /config/Financed-Amount/filter

Get paginated financed amount records

GET /config/Financed-Amount/active

Get annual mileage records

GET /config/Financed-Amount/{financed_amount_id}

Get financed amount by Id

DELETE /config/Financed-Amount/{financed_amount_id}

Deletes financed amount record

PATCH /config/Financed-Amount/{financed_amount_id}

Updates financed amount record

DELETE /config/lender/{lender_id}

Deletes a lender record

What's Deleted

DELETE /config/lender/{id}

Deletes a lender record

What's Changed

GET /config/interest-chart/filter

Parameters:

Added: financed_amount in query

Deleted: financed_amount_range in query

GET /config/interest-chart

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    Changed items (object):

    • Added property financed_amount (array)

      Multiple Financed Amount in array format for Interest Rate Chart Criteria

      Items (string):

    • Deleted property financed_amount_range (array)

      Multiple Financed Amount in array format for Interest Rate Chart Criteria

POST /config/interest-chart

Return Type:

Changed content type : application/json

  • Added property financed_amount (array)

    Multiple Financed Amount in array format for Interest Rate Chart Criteria

  • Deleted property financed_amount_range (array)

    Multiple Financed Amount in array format for Interest Rate Chart Criteria

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Added property financed_amount (array)

      Multiple Financed Amount in array format for Interest Rate Chart Criteria

    • Deleted property financed_amount_range (array)

      Multiple Financed Amount in array format for Interest Rate Chart Criteria

GET /config/interest-chart/{interest_chart_id}

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Added property financed_amount (array)

      Multiple Financed Amount in array format for Interest Rate Chart Criteria

    • Deleted property financed_amount_range (array)

      Multiple Financed Amount in array format for Interest Rate Chart Criteria

DELETE /config/interest-chart/{interest_chart_id}

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Added property financed_amount (array)

      Multiple Financed Amount in array format for Interest Rate Chart Criteria

    • Deleted property financed_amount_range (array)

      Multiple Financed Amount in array format for Interest Rate Chart Criteria

PATCH /config/interest-chart/{interest_chart_id}

Return Type:

Changed content type : application/json

  • Added property financed_amount (array)

    Multiple Financed Amount in array format for Interest Rate Chart Criteria

  • Deleted property financed_amount_range (array)

    Multiple Financed Amount in array format for Interest Rate Chart Criteria

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Added property financed_amount (array)

      Multiple Financed Amount in array format for Interest Rate Chart Criteria

    • Deleted property financed_amount_range (array)

      Multiple Financed Amount in array format for Interest Rate Chart Criteria

GET /config/rv-chart

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    Changed items (object):

    • Added property financed_amount (array)

      Multiple Financed Amount in array format for RV Chart Criteria

      Items (string):

    • Added property purchase_option (array)

      Multiple Purchase Option in array format for Commission Chart Criteria

      Items (string):

POST /config/rv-chart

Return Type:

Changed content type : application/json

  • Added property financed_amount (array)

    Multiple Financed Amount in array format for RV Chart Criteria

  • Added property purchase_option (array)

    Multiple Purchase Option in array format for Commission Chart Criteria

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Added property financed_amount (array)

      Multiple Financed Amount in array format for RV Chart Criteria

    • Added property purchase_option (array)

      Multiple Purchase Option in array format for Commission Chart Criteria

GET /config/rv-chart/filter

Parameters:

Added: financed_amount in query

Added: purchase_option in query

GET /config/rv-chart/{rv_chart_id}

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Added property financed_amount (array)

      Multiple Financed Amount in array format for RV Chart Criteria

    • Added property purchase_option (array)

      Multiple Purchase Option in array format for Commission Chart Criteria

DELETE /config/rv-chart/{rv_chart_id}

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Added property financed_amount (array)

      Multiple Financed Amount in array format for RV Chart Criteria

    • Added property purchase_option (array)

      Multiple Purchase Option in array format for Commission Chart Criteria

PATCH /config/rv-chart/{rv_chart_id}

Return Type:

Changed content type : application/json

  • Added property financed_amount (array)

    Multiple Financed Amount in array format for RV Chart Criteria

  • Added property purchase_option (array)

    Multiple Purchase Option in array format for Commission Chart Criteria

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Added property financed_amount (array)

      Multiple Financed Amount in array format for RV Chart Criteria

    • Added property purchase_option (array)

      Multiple Purchase Option in array format for Commission Chart Criteria

POST /config/rv-evaluate

Return Type:

Changed content type : application/json

  • Added property purchase_option (string)

  • Changed property annual_usage (integer -> string)

POST /config/interest-chart-evaluate

Return Type:

Changed content type : application/json

  • Added property financed_amount (string)

  • Added property purchase_option (string)

  • Added property manufacturer (string)

  • Added property business_units (string)

  • Added property late_charge_inclusive_adder (string)

  • Added property property_tax_inclusive_adder (string)

  • Added property origination_fee_inclusive_adder (string)

POST /config/interest-chart/criteria

Return Type:

Changed content type : application/json

  • Changed property interestCriteria (object)

    • Added property financed_amount (array)

      Multiple Financed Amount in array format for Interest Rate Chart Criteria

    • Deleted property financed_amount_range (array)

      Multiple Financed Amount in array format for Interest Rate Chart Criteria

POST /config/rv-chart/criteria

Return Type:

Changed content type : application/json

  • Changed property criteria (object)

    • Added property financed_amount (array)

      Multiple Financed Amount in array format for RV Chart Criteria

    • Added property purchase_option (array)

      Multiple Purchase Option in array format for Commission Chart Criteria

POST /config/down-payment/criteria

Return Type:

Changed content type : application/json

  • Changed property criteria (object)

    • Added property financed_amount (array)

      Multiple Financed Amount in array format for Down Payment Chart Criteria

      Items (string):

POST /config/commissions/criteria

Return Type:

Changed content type : application/json

  • Changed property criteria (object)

    • Added property financed_amount (array)

      Multiple Financed Amount in array format for Commission Chart Criteria

      Items (string):

    • Added property purchase_option (array)

      Multiple Purchase Option in array format for Commission Chart Criteria

POST /config/subsidy/criteria

Return Type:

Changed content type : application/json

  • Changed property criteria (object)

    • Added property financed_amount (array)

      Multiple Financed Amount in array format for Subsidy Chart Criteria

      Items (string):

GET /config/down-payment/filter

Parameters:

Added: financed_amount in query

GET /config/down-payment

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    Changed items (object):

    • Added property financed_amount (array)

      Multiple Financed Amount in array format for Down Payment Chart Criteria

POST /config/down-payment

Return Type:

Changed content type : application/json

  • Added property financed_amount (array)

    Multiple Financed Amount in array format for Down Payment Chart Criteria

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Added property financed_amount (array)

      Multiple Financed Amount in array format for Down Payment Chart Criteria

GET /config/down-payment/{down_payment_id}

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Added property financed_amount (array)

      Multiple Financed Amount in array format for Down Payment Chart Criteria

DELETE /config/down-payment/{down_payment_id}

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Added property financed_amount (array)

      Multiple Financed Amount in array format for Down Payment Chart Criteria

PATCH /config/down-payment/{down_payment_id}

Return Type:

Changed content type : application/json

  • Added property financed_amount (array)

    Multiple Financed Amount in array format for Down Payment Chart Criteria

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Added property financed_amount (array)

      Multiple Financed Amount in array format for Down Payment Chart Criteria

GET /config/commissions/filter

Parameters:

Added: financed_amount in query

Added: purchase_option in query

GET /config/commissions

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    Changed items (object):

    • Added property financed_amount (array)

      Multiple Financed Amount in array format for Commission Chart Criteria

    • Added property purchase_option (array)

      Multiple Purchase Option in array format for Commission Chart Criteria

POST /config/commissions

Return Type:

Changed content type : application/json

  • Added property financed_amount (array)

    Multiple Financed Amount in array format for Commission Chart Criteria

  • Added property purchase_option (array)

    Multiple Purchase Option in array format for Commission Chart Criteria

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Added property financed_amount (array)

      Multiple Financed Amount in array format for Commission Chart Criteria

    • Added property purchase_option (array)

      Multiple Purchase Option in array format for Commission Chart Criteria

GET /config/commissions/{commission_id}

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Added property financed_amount (array)

      Multiple Financed Amount in array format for Commission Chart Criteria

    • Added property purchase_option (array)

      Multiple Purchase Option in array format for Commission Chart Criteria

DELETE /config/commissions/{commission_id}

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Added property financed_amount (array)

      Multiple Financed Amount in array format for Commission Chart Criteria

    • Added property purchase_option (array)

      Multiple Purchase Option in array format for Commission Chart Criteria

PATCH /config/commissions/{commission_id}

Return Type:

Changed content type : application/json

  • Added property financed_amount (array)

    Multiple Financed Amount in array format for Commission Chart Criteria

  • Added property purchase_option (array)

    Multiple Purchase Option in array format for Commission Chart Criteria

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Added property financed_amount (array)

      Multiple Financed Amount in array format for Commission Chart Criteria

    • Added property purchase_option (array)

      Multiple Purchase Option in array format for Commission Chart Criteria

GET /config/subsidy/filter

Parameters:

Added: financed_amount in query

GET /config/subsidy

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    Changed items (object):

    • Added property financed_amount (array)

      Multiple Financed Amount in array format for Subsidy Chart Criteria

POST /config/subsidy

Return Type:

Changed content type : application/json

  • Added property financed_amount (array)

    Multiple Financed Amount in array format for Subsidy Chart Criteria

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Added property financed_amount (array)

      Multiple Financed Amount in array format for Subsidy Chart Criteria

GET /config/subsidy/{subsidy_id}

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Added property financed_amount (array)

      Multiple Financed Amount in array format for Subsidy Chart Criteria

DELETE /config/subsidy/{subsidy_id}

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Added property financed_amount (array)

      Multiple Financed Amount in array format for Subsidy Chart Criteria

PATCH /config/subsidy/{subsidy_id}

Return Type:

Changed content type : application/json

  • Added property financed_amount (array)

    Multiple Financed Amount in array format for Subsidy Chart Criteria

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Added property financed_amount (array)

      Multiple Financed Amount in array format for Subsidy Chart Criteria

GET /config/financial-product

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    Changed items (object):

    • Added property program_end_of_terms (object)

      • Property is_active (boolean)

      • Property is_deleted (boolean)

      • Property id (integer)

        Program End of Term id

      • Property purchase_option_type (string)

        Program End of Term Type

      • Property purchase_option_applicable (string)

        Program End of Term Purchase Option Applicable

      • Property lender_id (string)

        Program End of Term Lender id

    • Changed property financial_parameters (array)

      Changed items (object):

      • Changed property rental_frequency (array)

        Rental Frequency of Financial Parameter

        Changed items (integer -> string):

GET /config/financial-product/{financial_product_id}

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Added property program_end_of_terms (object)

    • Changed property financial_parameters (array)

      Changed items (object):

      • Changed property rental_frequency (array)

        Rental Frequency of Financial Parameter

        Changed items (integer -> string):

DELETE /config/financial-product/{financial_product_id}

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Added property program_end_of_terms (object)

    • Changed property financial_parameters (array)

      Changed items (object):

      • Changed property rental_frequency (array)

        Rental Frequency of Financial Parameter

        Changed items (integer -> string):

PATCH /config/financial-product/{financial_product_id}

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Added property program_end_of_terms (object)

    • Changed property financial_parameters (array)

      Changed items (object):

      • Changed property rental_frequency (array)

        Rental Frequency of Financial Parameter

        Changed items (integer -> string):

POST /config/financial-product/create-fp

Return Type:

Changed content type : application/json

  • Added property program_end_of_terms (object)

  • Changed property financial_product_financial_parameter (object)

    • Changed property rental_frequency (array)

      Rental Frequency of Financial Parameter

      Changed items (integer -> string):

Return Type:

Changed response : 201 Created

Successful Response

  • Changed content type : application/json

    • Added property program_end_of_terms (object)

    • Changed property financial_parameters (array)

      Changed items (object):

      • Changed property rental_frequency (array)

        Rental Frequency of Financial Parameter

        Changed items (integer -> string):

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

Return Type:

Changed content type : application/json

  • Added property program_end_of_terms (object)

  • Changed property financial_product_financial_parameter (object)

    • Changed property rental_frequency (array)

      Rental Frequency of Financial Parameter

      Changed items (integer -> string):

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Added property program_end_of_terms (object)

    • Changed property financial_parameters (array)

      Changed items (object):

      • Changed property rental_frequency (array)

        Rental Frequency of Financial Parameter

        Changed items (integer -> string):

GET /config/financial-parameter/

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    Changed items (object):

    • Changed property rental_frequency (array)

      Rental Frequency of Financial Parameter

      Changed items (integer -> string):

POST /config/financial-parameter/

Return Type:

Changed content type : application/json

  • Changed property rental_frequency (array)

    Rental Frequency of Financial Parameter

    Changed items (integer -> string):

Return Type:

Changed response : 201 Created

Successful Response

  • Changed content type : application/json

    • Changed property rental_frequency (array)

      Rental Frequency of Financial Parameter

      Changed items (integer -> string):

GET /config/financial-parameter/{financial_parameter_id}

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Changed property rental_frequency (array)

      Rental Frequency of Financial Parameter

      Changed items (integer -> string):

DELETE /config/financial-parameter/{financial_parameter_id}

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Changed property rental_frequency (array)

      Rental Frequency of Financial Parameter

      Changed items (integer -> string):

PATCH /config/financial-parameter/{financial_parameter_id}

Return Type:

Changed content type : application/json

  • Changed property rental_frequency (array)

    Rental Frequency of Financial Parameter

    Changed items (integer -> string):

Return Type:

Changed response : 200 OK

Successful Response

  • Changed content type : application/json

    • Changed property rental_frequency (array)

      Rental Frequency of Financial Parameter

      Changed items (integer -> string):

POST /config/programs/all/

Return Type:

Changed content type : application/json

  • Added property credit_rating (string)

    Credit rating

  • Deleted property credit_rating_id (string)

    System Generated Credit Rating Id

  • Changed property rental_frequency (integer -> string)

    Rental Frequency available with Program

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_end_of_terms (object)

      • Changed property financial_parameters (array)

        Changed items (object):

        • Changed property rental_frequency (array)

          Rental Frequency of Financial Parameter

          Changed items (integer -> string):

Version 1.0.14Version 1.0.12