API Doc Version 1.0.21

What's Changed

GET /config/vehicle-detail

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  Changed items (object):

  New optional properties:

  • dealer_options

  • Changed property dealer_options (array -> array)

    List of dealer options

GET /config/financial-product/{financial_product_id}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property financial_parameters (array)

    Changed items (object):

    • Changed property rental_frequency (array)

      Rental Frequency of Financial Parameter

      Changed items (string):

      An enumeration.

      Added enum values:

      • Monthly
      • Quarterly
      • SemiAnnual
      • Annual
      • Weekly
      • Fortnightly
      • ``

    • Changed property calculation_method (string -> string)

      An enumeration.

    • Changed property rental_mode (string -> string)

      An enumeration.

    • Changed property rate_conversion_method (string -> string)

      An enumeration.

    • Changed property rv_balloon_type (string -> string)

      An enumeration.

    • Changed property rv_calculation_method (string -> string)

      An enumeration.

  • Changed property program_commission (object)

    • Changed property commission_type (string -> string)

      An enumeration.

    • Changed property amortization_method (string -> string)

      An enumeration.

    • Changed property commission_override (string -> string)

      An enumeration.

  • Changed property program_subsidy (object)

    • Changed property calculation_method (string -> string)

      An enumeration.

    • Changed property amortization_method (string -> string)

      An enumeration.

    • Changed property tax_amortization (string -> string)

      An enumeration.

    • Changed property subsidy_override (string -> string)

      An enumeration.

  • Changed property program_end_of_terms (object)

    • Changed property purchase_option_type (string -> string)

      An enumeration.

    • Changed property purchase_option_applicable (string -> string)

      An enumeration.

PATCH /config/financial-product/{financial_product_id}

Request:

Changed content type : application/json

• Changed property finance_type (string -> string)

  An enumeration.

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property financial_parameters (array)

    Changed items (object):

    • Changed property rental_frequency (array)

      Rental Frequency of Financial Parameter

      Changed items (string):

      An enumeration.

      Added enum values:

      • Monthly
      • Quarterly
      • SemiAnnual
      • Annual
      • Weekly
      • Fortnightly
      • ``

    • Changed property calculation_method (string -> string)

      An enumeration.

    • Changed property rental_mode (string -> string)

      An enumeration.

    • Changed property rate_conversion_method (string -> string)

      An enumeration.

    • Changed property rv_balloon_type (string -> string)

      An enumeration.

    • Changed property rv_calculation_method (string -> string)

      An enumeration.

  • Changed property program_commission (object)

    • Changed property commission_type (string -> string)

      An enumeration.

    • Changed property amortization_method (string -> string)

      An enumeration.

    • Changed property commission_override (string -> string)

      An enumeration.

  • Changed property program_subsidy (object)

    • Changed property calculation_method (string -> string)

      An enumeration.

    • Changed property amortization_method (string -> string)

      An enumeration.

    • Changed property tax_amortization (string -> string)

      An enumeration.

    • Changed property subsidy_override (string -> string)

      An enumeration.

  • Changed property program_end_of_terms (object)

    • Changed property purchase_option_type (string -> string)

      An enumeration.

    • Changed property purchase_option_applicable (string -> string)

      An enumeration.

POST /config/financial-product/create-fp

Request:

Changed content type : application/json

• Changed property financial_product_general (object)

  • Changed property finance_type (string -> string)

    An enumeration.

• Changed property financial_product_financial_parameter (object)

  • Changed property rental_frequency (array)

    Rental Frequency of Financial Parameter

    Changed items (string):

    An enumeration.

    Added enum values:

    • Monthly
    • Quarterly
    • SemiAnnual
    • Annual
    • Weekly
    • Fortnightly
    • ``

  • Changed property calculation_method (string -> string)

    An enumeration.

  • Changed property rental_mode (string -> string)

    An enumeration.

  • Changed property rate_conversion_method (string -> string)

    An enumeration.

  • Changed property rv_balloon_type (string -> string)

    An enumeration.

  • Changed property rv_calculation_method (string -> string)

    An enumeration.

• Changed property program_commission (object)

  • Changed property commission_type (string -> string)

    An enumeration.

  • Changed property amortization_method (string -> string)

    An enumeration.

  • Changed property commission_override (string -> string)

    An enumeration.

• Changed property program_subsidy (object)

  • Changed property calculation_method (string -> string)

    An enumeration.

  • Changed property amortization_method (string -> string)

    An enumeration.

  • Changed property tax_amortization (string -> string)

    An enumeration.

  • Changed property subsidy_override (string -> string)

    An enumeration.

• Changed property program_end_of_terms (object)

  • Changed property purchase_option_type (string -> string)

    An enumeration.

  • Changed property purchase_option_applicable (string -> string)

    An enumeration.

Return Type:

Changed response : 201 Created

Successful Response

• Changed content type : application/json

  • Changed property financial_parameters (array)

    Changed items (object):

    • Changed property rental_frequency (array)

      Rental Frequency of Financial Parameter

      Changed items (string):

      An enumeration.

      Added enum values:

      • Monthly
      • Quarterly
      • SemiAnnual
      • Annual
      • Weekly
      • Fortnightly
      • ``

    • Changed property calculation_method (string -> string)

      An enumeration.

    • Changed property rental_mode (string -> string)

      An enumeration.

    • Changed property rate_conversion_method (string -> string)

      An enumeration.

    • Changed property rv_balloon_type (string -> string)

      An enumeration.

    • Changed property rv_calculation_method (string -> string)

      An enumeration.

  • Changed property program_commission (object)

    • Changed property commission_type (string -> string)

      An enumeration.

    • Changed property amortization_method (string -> string)

      An enumeration.

    • Changed property commission_override (string -> string)

      An enumeration.

  • Changed property program_subsidy (object)

    • Changed property calculation_method (string -> string)

      An enumeration.

    • Changed property amortization_method (string -> string)

      An enumeration.

    • Changed property tax_amortization (string -> string)

      An enumeration.

    • Changed property subsidy_override (string -> string)

      An enumeration.

  • Changed property program_end_of_terms (object)

    • Changed property purchase_option_type (string -> string)

      An enumeration.

    • Changed property purchase_option_applicable (string -> string)

      An enumeration.

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

Request:

Changed content type : application/json

• Changed property financial_product_general (object)

  • Changed property finance_type (string -> string)

    An enumeration.

• Changed property financial_product_financial_parameter (object)

  • Changed property rental_frequency (array)

    Rental Frequency of Financial Parameter

    Changed items (string):

    An enumeration.

    Added enum values:

    • Monthly
    • Quarterly
    • SemiAnnual
    • Annual
    • Weekly
    • Fortnightly
    • ``

  • Changed property calculation_method (string -> string)

    An enumeration.

  • Changed property rental_mode (string -> string)

    An enumeration.

  • Changed property rate_conversion_method (string -> string)

    An enumeration.

  • Changed property rv_balloon_type (string -> string)

    An enumeration.

  • Changed property rv_calculation_method (string -> string)

    An enumeration.

• Changed property program_commission (object)

  • Changed property commission_type (string -> string)

    An enumeration.

  • Changed property amortization_method (string -> string)

    An enumeration.

  • Changed property commission_override (string -> string)

    An enumeration.

• Changed property program_subsidy (object)

  • Changed property calculation_method (string -> string)

    An enumeration.

  • Changed property amortization_method (string -> string)

    An enumeration.

  • Changed property tax_amortization (string -> string)

    An enumeration.

  • Changed property subsidy_override (string -> string)

    An enumeration.

• Changed property program_end_of_terms (object)

  • Changed property purchase_option_type (string -> string)

    An enumeration.

  • Changed property purchase_option_applicable (string -> string)

    An enumeration.

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  • Changed property financial_parameters (array)

    Changed items (object):

    • Changed property rental_frequency (array)

      Rental Frequency of Financial Parameter

      Changed items (string):

      An enumeration.

      Added enum values:

      • Monthly
      • Quarterly
      • SemiAnnual
      • Annual
      • Weekly
      • Fortnightly
      • ``

    • Changed property calculation_method (string -> string)

      An enumeration.

    • Changed property rental_mode (string -> string)

      An enumeration.

    • Changed property rate_conversion_method (string -> string)

      An enumeration.

    • Changed property rv_balloon_type (string -> string)

      An enumeration.

    • Changed property rv_calculation_method (string -> string)

      An enumeration.

  • Changed property program_commission (object)

    • Changed property commission_type (string -> string)

      An enumeration.

    • Changed property amortization_method (string -> string)

      An enumeration.

    • Changed property commission_override (string -> string)

      An enumeration.

  • Changed property program_subsidy (object)

    • Changed property calculation_method (string -> string)

      An enumeration.

    • Changed property amortization_method (string -> string)

      An enumeration.

    • Changed property tax_amortization (string -> string)

      An enumeration.

    • Changed property subsidy_override (string -> string)

      An enumeration.

  • Changed property program_end_of_terms (object)

    • Changed property purchase_option_type (string -> string)

      An enumeration.

    • Changed property purchase_option_applicable (string -> string)

      An enumeration.

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

Parameters:

Added: lender_id in header

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

Parameters:

Added: lender_id in header

GET /config/Financed-Amount/filter

Parameters:

Changed: financed_amount_from in query

Changed: financed_amount_to in query

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

Get dealer fee record provided by dealer Code

Parameters:

Changed: dealer_code in path

GET /config/dealer/{dealer_code}/fees

Parameters:

Changed: dealer_code in path

GET /config/vehicle-detail/{vin}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  New optional properties:

  • dealer_options

  • Changed property dealer_options (array -> array)

    List of dealer options

POST /config/vehicle-detail/

Request:

Changed content type : application/json

New optional properties:

• dealer_options

• Changed property dealer_options (array -> array)

  List of dealer options

Return Type:

Changed response : 201 Created

Successful Response

• Changed content type : application/json

  New optional properties:

  • dealer_options

  • Changed property dealer_options (array -> array)

    List of dealer options

PATCH /config/vehicle-detail/{vehicle_detail_id}

Request:

Changed content type : application/json

New optional properties:

• dealer_options

• Changed property dealer_options (array -> array)

  List of dealer options

DELETE /config/vehicle-detail/{vehicle_id}

Return Type:

Changed response : 200 OK

Successful Response

• Changed content type : application/json

  New optional properties:

  • dealer_options

  • Changed property dealer_options (array -> array)

    List of dealer options

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

    • Changed property financial_parameters (array)

      Changed items (object):

      • Changed property rental_frequency (array)

        Rental Frequency of Financial Parameter

        Changed items (string):

        An enumeration.

        Added enum values:

        • Monthly
        • Quarterly
        • SemiAnnual
        • Annual
        • Weekly
        • Fortnightly
        • ``

      • Changed property calculation_method (string -> string)

        An enumeration.

      • Changed property rental_mode (string -> string)

        An enumeration.

      • Changed property rate_conversion_method (string -> string)

        An enumeration.

      • Changed property rv_balloon_type (string -> string)

        An enumeration.

      • Changed property rv_calculation_method (string -> string)

        An enumeration.

    • Changed property program_commission (object)

      • Changed property commission_type (string -> string)

        An enumeration.

      • Changed property amortization_method (string -> string)

        An enumeration.

      • Changed property commission_override (string -> string)

        An enumeration.

    • Changed property program_subsidy (object)

      • Changed property calculation_method (string -> string)

        An enumeration.

      • Changed property amortization_method (string -> string)

        An enumeration.

      • Changed property tax_amortization (string -> string)

        An enumeration.

      • Changed property subsidy_override (string -> string)

        An enumeration.

    • Changed property program_end_of_terms (object)

      • Changed property purchase_option_type (string -> string)

        An enumeration.

      • Changed property purchase_option_applicable (string -> string)

        An enumeration.