Developer Docs
Flex
Technical Changelog
Version 1.3.6

API Doc Version 1.3.6

What's Changed

POST /Calculate/StraightLineAmortization

Request:

Changed content type : application/json

  • Changed property startDate (string)

    Provide Start Date (YYYY-MM-DD)

Return Type:

Changed response : 200 OK

Success

  • Changed content type : application/json

    Changed items (object):

    It holds the response of Straight line amorization

    • Changed property postingDate (string)

      Posted Date (YYYY-MM-DD)

    • Changed property fromDate (string)

      From / Start Date (YYYY-MM-DD)

POST /Calculate/StraightLineWithActualNumberOfDays

Request:

Changed content type : application/json

  • Changed property startDate (string)

    Provide Contract Start Date (YYYY-MM-DD)

  • Changed property endDate (string)

    Provide Contract End Date (YYYY-MM-DD)

Return Type:

Changed response : 200 OK

Success

  • Changed content type : application/json

    Changed items (object):

    It holds the response of the amortization for actual number of days.

    • Changed property postingDate (string)

      Provides the Posting Date (YYYY-MM-DD)

    • Changed property fromDate (string)

      Provides the From date (YYYY-MM-DD)

    • Changed property toDate (string)

      Provides the To date (YYYY-MM-DD)

POST /Calculate/ReverseDownPayment

Request:

Changed content type : application/json

  • Changed property structureRental (array)

    Structured Rental Amount

Return Type:

Changed response : 200 OK

Success

  • Changed content type : application/json

    • Changed property netFinancedAmount (number)

      Net Financed Amount

    • Changed property downPayment (number)

      Down Payment

POST /Calculate/ReverseFinanceAmount

Return Type:

Changed response : 200 OK

Success

  • Changed content type : application/json

    • Changed property netFinancedAmount (number)

      Net Financed Amount

    • Changed property financedAmount (number)

      Financed Amount

POST /Calculate/ReverseCalculateDuration

Request:

Changed content type : application/json

  • Changed property rentalFrequency (string)

    Payment Frequency i.e. Weekly, Fortnightly, Monthly, Quarterly, SemiAnnual or Annual

  • Changed property rentalMode (string)

    Provide Payment Mode - Advance or Arrear

POST /Calculate/CalculateAPR

Request:

Changed content type : application/json

  • Added property isCompounded (boolean)

    IsCompounded boolean flag

  • Added property compoundingFrequency (string)

    Compunding Frequency Monthly , Daily

  • Deleted property basisOfPeriodicInterest (string)

    Periodic Interest Calculation Method i.e. 1=Simple, 2=CompoundedMonthlyDirectConversion and 3=CompoundedMonthlyFirstAnnualThenPeriodic

  • Changed property contractStartDate (string)

    Contract Start Date (YYYY-MM-DD)

  • Changed property rentalSlabs (array)

    Use this structure to provide the range of rental stream

    Changed items (object):

    Rental Slabs to define stream of rentals

    • Changed property rentalDueDate (string)

      Rental Due Date (YYYY-MM-DD)

    • Changed property rentalType (string)

      Rental Type - Valid values are 'Auto','Structured','Interest Only','Zero','BonusPayment'

      Removed enum values:

      • None
      • Auto
      • Balloon
      • InterestOnly
      • ResidualValue
      • Structured
      • ValueDate
      • Ext
      • VatDeferral
      • Zero
      • BonusPayment

POST /Calculate/CalculateAPROnActual

Request:

Changed content type : application/json

  • Changed property financedAmount (number)

    Proovide Financed Amount

  • Changed property rentalMode (string)

    Provide Payment Mode - Advance or Arrear

  • Changed property contractStartDate (string)

    Contract Start Date (YYYY-MM-DD)

  • Changed property plan (array)

    Provide Repayment Plan

    Changed items (object):

    • Changed property netRentalAmount (number)

      Amount Of Rental

    • Changed property rentalDueDate (string)

      Rental Due Date (YYYY-MM-DD)

    • Changed property rentalNo (integer)

      Rental Number

    • Changed property rentalType (string)

      Rental Type - Valid values are 'Auto','Structured','Interest Only','Zero','BonusPayment'

POST /Calculate/AnnualToPeriodicRateConversion

Return Type:

Changed response : 200 OK

Success

  • Changed content type : application/json

    • Changed property periodicInterestRate (number)

      Periodic Interest Rate

POST /Calculate/PeriodicToAnnualRateConversion

Return Type:

Changed response : 200 OK

Success

  • Changed content type : application/json

    • Changed property annualInterestRate (number)

      Annual Interst Rate

POST /Calculate/CalculateFlatRate

Request:

Changed content type : application/json

  • Added property residualValue (number)

    Please provide the Residual Value Amount

  • Added property rentalSlabs (array)

    Please provide Rentals Slabs for calculation of Flat Rate

    Items (object):

    Rental Slabs to define stream of rentals

    • Property startTerm (integer)

      Start Term

    • Property endTerm (integer)

      End Term

    • Property amount (number)

      Amount of Rental

    • Property rentalDueDate (string)

      Rental Due Date (YYYY-MM-DD)

    • Property rentalType (string)

      Rental Type - Valid values are 'Auto','Structured','Interest Only','Zero','BonusPayment'

  • Added property payables (array)

    List of Payables

    Items (object):

    • Property componentName (string)

      Component Name

    • Property amount (number)

      Amount

  • Added property receivables (array)

    List of Receivables

    Items (object):

  • Deleted property paymentAmount (number)

    Payment Amount

  • Deleted property numberOfPayments (integer)

    Number Of Payments

Return Type:

Changed response : 200 OK

Success

  • Changed content type : application/json

    • Changed property flatRate (number)

      Calculated Flat Rate

POST /Calculate/CalculateAmortizationAfterRestructuring

Request:

Changed content type : application/json

  • Changed property rentalDetails (array)

    Restructured rental details

    Changed items (object):

    • Changed property rentalDueDate (string)

      This Feild Shows Rental Due Date (YYYY-MM-DD)

    • Changed property openingPrincipal (number)

      Opening Principal

    • Changed property totalRentalPrincipalInclusiveOfTax (number)

      Total Rental Principal Inclusive Of Tax

    • Changed property totalRentalInterestInclusiveOfTax (number)

      Total Rental Interest Inclusive Of Tax

    • Changed property netRentalAmount (number)

      Net Rental Amount

    • Changed property periodicInterest (number)

      Periodic Interest

    • Changed property closingCompoundInterest (number)

      Closing Compound Interest

    • Changed property totalTaxOnRentalInterest (number)

      Total Tax On Rental Interest

    • Changed property totalTaxOnRentalPrincipal (number)

      Total Tax On Rental Principal

    • Changed property totalTaxOnRental (number)

      Total Tax On Rental

    • Changed property totalPeriodicInterestExclusiveOfTax (number)

      Total Periodic Interest Exclusive Of Tax

    • Changed property totalTaxOnPeriodicInterest (number)

      Total Tax On Periodic Interest

    • Changed property totalRentalInterestExclusiveOfTax (number)

      Total Rental Interest Exclusive Of Tax

    • Changed property totalRentalPrincipalExclusiveOfTax (number)

      Total Rental Principal Exclusive Of Tax

    • Changed property contractInclusiveInsuranceAmount (number)

      Contract Inclusive Insurance Amount

    • Changed property rentalTotalAmount (number)

      Rental Total Amount

    • Changed property closingPrincipal (number)

      Closing Principal

Return Type:

Changed response : 200 OK

Success

  • Changed content type : application/json

    Changed items (object):

    • Added property amortizedAmount (number)

      Provides the Amortized Amount

    • Added property fromDate (string)

      Provides the From date (YYYY-MM-DD)

    • Added property toDate (string)

      Provides the To date (YYYY-MM-DD)

    • Added property noOfDays (number)

      Provides Number of days

    • Deleted property from (string)

    • Deleted property to (string)

    • Deleted property numberOfDays (number)

    • Deleted property amortizedAmout (number)

    • Changed property serialNumber (integer)

      Provides the Serial Number

    • Changed property postingDate (string)

      Provides the Posting Date (YYYY-MM-DD)

    • Changed property rentalNumber (integer)

      Rental Number

POST /Calculate/ChangeRentalDueDate

Request:

Changed content type : application/json

  • Changed property newRentalDueDate (string)

    New Rental Due Date (YYYY-MM-DD)

  • Changed property rentalDetails (array)

    Current Rental Plan

    Changed items (object):

    • Changed property rentalDueDate (string)

      This Feild Shows Rental Due Date (YYYY-MM-DD)

    • Changed property openingPrincipal (number)

      Opening Principal

    • Changed property totalRentalPrincipalInclusiveOfTax (number)

      Total Rental Principal Inclusive Of Tax

    • Changed property totalRentalInterestInclusiveOfTax (number)

      Total Rental Interest Inclusive Of Tax

    • Changed property netRentalAmount (number)

      Net Rental Amount

    • Changed property periodicInterest (number)

      Periodic Interest

    • Changed property closingCompoundInterest (number)

      Closing Compound Interest

    • Changed property totalTaxOnRentalInterest (number)

      Total Tax On Rental Interest

    • Changed property totalTaxOnRentalPrincipal (number)

      Total Tax On Rental Principal

    • Changed property totalTaxOnRental (number)

      Total Tax On Rental

    • Changed property totalPeriodicInterestExclusiveOfTax (number)

      Total Periodic Interest Exclusive Of Tax

    • Changed property totalTaxOnPeriodicInterest (number)

      Total Tax On Periodic Interest

    • Changed property totalRentalInterestExclusiveOfTax (number)

      Total Rental Interest Exclusive Of Tax

    • Changed property totalRentalPrincipalExclusiveOfTax (number)

      Total Rental Principal Exclusive Of Tax

    • Changed property contractInclusiveInsuranceAmount (number)

      Contract Inclusive Insurance Amount

    • Changed property rentalTotalAmount (number)

      Rental Total Amount

    • Changed property closingPrincipal (number)

      Closing Principal

Return Type:

Changed response : 200 OK

Success

  • Changed content type : application/json

    • Changed property repaymentPlan (array)

      Repayment Plan after change of Due Date

      Changed items (object):

      This class holds the repayment plan.

      • Changed property rentalDueDate (string)

        Due Date of Rental (YYYY-MM-DD)

POST /Calculate/AmortizeByAnnuity

Request:

Changed content type : application/json

  • Changed property contractStartDate (string)

    Provide Contract Start Date (YYYY-MM-DD)

  • Changed property rentalDetails (array)

    Provide List of Rental Details

    Changed items (object):

    This class is used to define the rental details which is passed as list to Amortization By Annuity Method Input Parameters

    • Changed property rentalDueDate (string)

      Provide Rental Due Date (YYYY-MM-DD)

Return Type:

Changed response : 200 OK

Success

  • Changed content type : application/json

    Changed items (object):

    It holds the response of the amortization on annuity.

    • Changed property postingDate (string)

      Provides the Posting Date (YYYY-MM-DD)

    • Changed property fromDate (string)

      Provides the From date (YYYY-MM-DD)

    • Changed property toDate (string)

      Provides the To date (YYYY-MM-DD)

POST /Calculate/StraightLineProRataAmortization

Request:

Changed content type : application/json

  • Changed property startDate (string)

    Provide Start Date (YYYY-MM-DD)

POST /Calculate/CreateRentalAmortization365

Request:

Changed content type : application/json

  • Changed property startDate (string)

    Start Date (YYYY-MM-DD)

  • Changed property rentalStream (array)

    This structure is used to provide irregular/seasonal payments

    Changed items (object):

    • Changed property dueDate (string)

      Due Date (YYYY-MM-DD)

Return Type:

Changed response : 200 OK

Success

  • Changed content type : application/json

    • Changed property repaymentPlan (array)

      This holds the repayment plan generated by the calculation engine.

      Changed items (object):

      This class holds the repayment plan.

      • Changed property rentalDueDate (string)

        Due Date of Rental (YYYY-MM-DD)

POST /Calculate/CreateRentalAmortization360

Request:

Changed content type : application/json

  • Changed property startDate (string)

    Start Date (YYYY-MM-DD)

  • Changed property rentalStream (array)

    This structure is used to provide irregular/seasonal payments

    Changed items (object):

    • Changed property dueDate (string)

      Due Date (YYYY-MM-DD)

Return Type:

Changed response : 200 OK

Success

  • Changed content type : application/json

    • Changed property repaymentPlan (array)

      This holds the repayment plan generated by the calculation engine.

      Changed items (object):

      This class holds the repayment plan.

      • Changed property rentalDueDate (string)

        Due Date of Rental (YYYY-MM-DD)

POST /Calculate/CreateRentalAmortizationAnnuityOnActual

Return Type:

Changed response : 200 OK

Success

  • Changed content type : application/json

    • Changed property repaymentPlan (array)

      This holds the repayment plan generated by the calculation engine.

      Changed items (object):

      This class holds the repayment plan.

      • Changed property rentalDueDate (string)

        Due Date of Rental (YYYY-MM-DD)

POST /Calculate/StepUpRentalCalculation

Return Type:

Changed response : 200 OK

Success

  • Changed content type : application/json

    • Changed property repaymentPlan (array)

      Payment Plan

      Changed items (object):

      This class holds the repayment plan.

      • Changed property rentalDueDate (string)

        Due Date of Rental (YYYY-MM-DD)

POST /Calculate/StepDownRentalCalculation

Return Type:

Changed response : 200 OK

Success

  • Changed content type : application/json

    • Changed property repaymentPlan (array)

      Payment Plan

      Changed items (object):

      This class holds the repayment plan.

      • Changed property rentalDueDate (string)

        Due Date of Rental (YYYY-MM-DD)

POST /Calculate/TargetRateBaseSubsidy

Request:

Changed content type : application/json

  • Changed property rentalSlabs (array)

    Changed items (object):

    Rental Slabs to define stream of rentals

    • Changed property rentalDueDate (string)

      Rental Due Date (YYYY-MM-DD)

    • Changed property rentalType (string)

      Rental Type - Valid values are 'Auto','Structured','Interest Only','Zero','BonusPayment'

      Removed enum values:

      • None
      • Auto
      • Balloon
      • InterestOnly
      • ResidualValue
      • Structured
      • ValueDate
      • Ext
      • VatDeferral
      • Zero
      • BonusPayment

POST /Calculate/SplitSubsidyBetweenDealerandManufacturer

Request:

Changed content type : application/json

  • Changed property rentalSlabs (array)

    Changed items (object):

    Rental Slabs to define stream of rentals

    • Changed property rentalDueDate (string)

      Rental Due Date (YYYY-MM-DD)

    • Changed property rentalType (string)

      Rental Type - Valid values are 'Auto','Structured','Interest Only','Zero','BonusPayment'

      Removed enum values:

      • None
      • Auto
      • Balloon
      • InterestOnly
      • ResidualValue
      • Structured
      • ValueDate
      • Ext
      • VatDeferral
      • Zero
      • BonusPayment

POST /Calculate/CalculateUpSellCommission

Request:

Changed content type : application/json

  • Changed property rentalSlabs (array)

    Rental Amount Stream

    Changed items (object):

    Rental Slabs to define stream of rentals

    • Changed property rentalDueDate (string)

      Rental Due Date (YYYY-MM-DD)

    • Changed property rentalType (string)

      Rental Type - Valid values are 'Auto','Structured','Interest Only','Zero','BonusPayment'

      Removed enum values:

      • None
      • Auto
      • Balloon
      • InterestOnly
      • ResidualValue
      • Structured
      • ValueDate
      • Ext
      • VatDeferral
      • Zero
      • BonusPayment

POST /Calculate/ExtendRV

Request:

Changed content type : application/json

  • Changed property repaymentPlan (array)

    This will be used to populate the the repayment plan

    Changed items (object):

    This class holds the repayment plan.

    • Changed property rentalDueDate (string)

      Due Date of Rental (YYYY-MM-DD)

Return Type:

Changed response : 200 OK

Success

  • Changed content type : application/json

    Changed items (object):

    This class holds the repayment plan.

    • Changed property rentalDueDate (string)

      Due Date of Rental (YYYY-MM-DD)

POST /Calculate/CreateRentalAmortizationWithTax

Request:

Changed content type : application/json

  • Changed property startDate (string)

    Provide Start Date (YYYY-MM-DD)

Return Type:

Changed response : 200 OK

Success

  • Changed content type : application/json

    • Changed property repaymentPlan (array)

      Repayment Plan with Tax

      Changed items (object):

      This class holds the repayment plan.

      • Changed property rentalDueDate (string)

        Due Date of Rental (YYYY-MM-DD)

POST /Calculate/CreateIncomeTaxPosting

Request:

Changed content type : application/json

  • Changed property startDate (string)

    Provide Start Date (YYYY-MM-DD)

POST /Calculate/CreateIncomeExpenseAmortization

Request:

Changed content type : application/json

  • Changed property startDate (string)

    Provide Start Date (YYYY-MM-DD)

Return Type:

Changed response : 200 OK

Success

  • Changed content type : application/json

    Changed items (object):

    • Changed property plan (array)

      Object to hold Subsidized Plan

      Changed items (object):

      This class holds the repayment plan.

      • Changed property rentalDueDate (string)

        Due Date of Rental (YYYY-MM-DD)

POST /Calculate/IncomeExpenseTaxAmortization

Request:

Changed content type : application/json

  • Changed property startDate (string)

    Provide Start Date (YYYY-MM-DD)

Return Type:

Changed response : 200 OK

Success

  • Changed content type : application/json

    Changed items (object):

    • Changed property plan (array)

      Object to hold Subsidized Plan

      Changed items (object):

      This class holds the repayment plan.

      • Changed property rentalDueDate (string)

        Due Date of Rental (YYYY-MM-DD)

POST /Calculate/CreateRentalAmortization

Request:

Changed content type : application/json

  • Changed property startDate (string)

    Provide Start Date (YYYY-MM-DD)

Return Type:

Changed response : 200 OK

Success

  • Changed content type : application/json

    • Changed property repaymentPlan (array)

      This holds the repayment plan generated by the calculation engine.

      Changed items (object):

      This class holds the repayment plan.

      • Changed property rentalDueDate (string)

        Due Date of Rental (YYYY-MM-DD)

POST /Calculate/RentalAmountAnnuityWithVAT

Request:

Changed content type : application/json

  • Added property rentalNumberForVatDefferal (integer)

    Rental to indicate for Vat Defferal Amount

POST /Calculate/RentalAmountAnnuityForComponent

Return Type:

Changed response : 200 OK

Success

  • Changed content type : application/json

    • Changed property consolidatedPlan (array)

      Property for the consolidated plan

      Changed items (object):

      This class holds the repayment plan.

      • Changed property rentalDueDate (string)

        Due Date of Rental (YYYY-MM-DD)

POST /Calculate/RentalAmountAnnuity365

Request:

Changed content type : application/json

  • Added property vatTreatment (string)

    Enum to hold the decision for VatTreatment

    Enum values:

    • VATPaidUpfront
    • VATDeferral
    • VATAmortizeOverTheTerm

  • Added property vatAmount (number)

    Vat amount

  • Added property vatPercentage (number)

    Vat percentage

  • Added property rentalNumberForVatDefferal (integer)

    Rental to indicate for Vat Defferal Amount

Return Type:

Changed response : 200 OK

Success

  • Changed content type : application/json

    • Added property updatedFinancedAmount (number)

      Holds financed amount including VAT

    • Changed property repaymentPlan (array)

      Holds payment plan

      Changed items (object):

      This class holds the repayment plan.

      • Changed property rentalDueDate (string)

        Due Date of Rental (YYYY-MM-DD)

POST /Calculate/RentalAmountActual360

Request:

Changed content type : application/json

  • Added property vatTreatment (string)

    Enum to hold the decision for VatTreatment

  • Added property vatAmount (number)

    Vat amount

  • Added property vatPercentage (number)

    Vat percentage

  • Added property rentalNumberForVatDefferal (integer)

    Rental to indicate for Vat Defferal Amount

Return Type:

Changed response : 200 OK

Success

  • Changed content type : application/json

    • Added property updatedFinancedAmount (number)

      Holds financed amount including VAT

    • Changed property repaymentPlan (array)

      Holds payment plan

      Changed items (object):

      This class holds the repayment plan.

      • Changed property rentalDueDate (string)

        Due Date of Rental (YYYY-MM-DD) -->

Version 1.3.7