Performs a finance calculation and returns the result.
POST {{baseUrl}}/calculation?proposal-id=<integer>&office-id=<integer>&amount-financed=<double>
This endpoint performs a finance calculation and returns the result. The result will not be persisted.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
proposal-id | string | The unique identifier for the proposal on which the new calculation will be based on. If not set, the office-id param is used. | |
office-id | string | The unique identifier for the office on which the new calculation will be based on, if no proposal-id is specified. If not set, the first office of the current user is selected. | |
amount-financed | string | The amount financed for the calculation. This field will only be considered (and is mandatory) if no proposal-id is specified. |
Request Body
{"sheet"=>{"introducerPricelistId"=>"<integer>", "marketProductId"=>"<integer>", "paymentMethod"=>{"id"=>"<integer>", "name"=>"<string>"}, "paymentMode"=>"<string>", "paymentPeriod"=>"<string>", "term"=>"<integer>", "paymentProfile"=>{"profile1"=>"<integer>", "profile2"=>"<integer>"}, "paymentPerMonth"=>"<double>", "customerPto"=>"<double>", "residualValue"=>{"amount"=>"<double>", "percentage"=>"<double>", "usePercentage"=>"<boolean>", "manualSet"=>"<boolean>"}, "commissions"=>[{"type"=>{"id"=>"<integer>", "name"=>"<string>", "readonly"=>"<boolean>"}, "amount"=>"<double>", "percentage"=>"<double>", "usePercentage"=>"<boolean>", "manualSet"=>"<boolean>"}, {"type"=>{"id"=>"<integer>", "name"=>"<string>", "readonly"=>"<boolean>"}, "amount"=>"<double>", "percentage"=>"<double>", "usePercentage"=>"<boolean>", "manualSet"=>"<boolean>"}], "fees"=>[{"feeType"=>{"id"=>"<integer>", "name"=>"<string>", "readonly"=>"<boolean>", "code"=>"<string>"}, "name"=>"<string>", "amount"=>"<double>", "manualSet"=>"<boolean>", "feeIncluded"=>"<boolean>"}, {"feeType"=>{"id"=>"<integer>", "name"=>"<string>", "readonly"=>"<boolean>", "code"=>"<string>"}, "name"=>"<string>", "amount"=>"<double>", "manualSet"=>"<boolean>", "feeIncluded"=>"<boolean>"}], "specialPayments"=>[{"amount"=>"<double>", "type"=>{"id"=>"<integer>", "name"=>"<string>", "readonly"=>"<boolean>", "downPaymentType"=>"<boolean>", "code"=>"<string>"}, "equipmentDetails"=>"<string>", "serialNumber"=>"<string>"}, {"amount"=>"<double>", "type"=>{"id"=>"<integer>", "name"=>"<string>", "readonly"=>"<boolean>", "downPaymentType"=>"<boolean>", "code"=>"<string>"}, "equipmentDetails"=>"<string>", "serialNumber"=>"<string>"}], "optionFee"=>"<double>"}, "operation"=>"<string>"}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
{"sheet":{"created":"2016-06-19T01:58:01.332Z","marketProductId":8882513,"introducerPricelistId":-4608341,"paymentPeriod":"\u003cstring\u003e","paymentMethod":{"id":"\u003cinteger\u003e","name":"\u003cstring\u003e"},"paymentMode":"\u003cstring\u003e","rentals":[{"value":98698519.51311341,"startDate":"2015-09-07","period":"\u003cstring\u003e","numberOfRentals":31783555,"paymentsPerRental":-5487396.197602302},{"value":54903028.85020393,"startDate":"1952-06-29","period":"\u003cstring\u003e","numberOfRentals":852427,"paymentsPerRental":-48923807.69724683}],"interestRate":-18106272.927004725,"customerPto":-25471377.374991894,"tariffRate":-71829873.10062115,"calcTariffRate":16920469.135626927,"selloutTariffRate":-20002731.604206935,"upgradeValue":-73371632.17772552,"totalAssetValue":63942903.62073901,"amountFinanced":47014186.32859352,"vatAmount":84999753.1111978,"residualValue":{"amount":"\u003cdouble\u003e","percentage":"\u003cdouble\u003e","usePercentage":"\u003cboolean\u003e","manualSet":"\u003cboolean\u003e"},"term":-84324606,"commissions":[{"type":{"id":"\u003cinteger\u003e","name":"\u003cstring\u003e","readonly":"\u003cboolean\u003e"},"amount":"\u003cdouble\u003e","percentage":"\u003cdouble\u003e","usePercentage":"\u003cboolean\u003e","manualSet":"\u003cboolean\u003e"},{"type":{"id":"\u003cinteger\u003e","name":"\u003cstring\u003e","readonly":"\u003cboolean\u003e"},"amount":"\u003cdouble\u003e","percentage":"\u003cdouble\u003e","usePercentage":"\u003cboolean\u003e","manualSet":"\u003cboolean\u003e"}],"fees":[{"feeType":{"id":"\u003cinteger\u003e","name":"\u003cstring\u003e","readonly":"\u003cboolean\u003e","code":"\u003cstring\u003e"},"name":"\u003cstring\u003e","amount":"\u003cdouble\u003e","manualSet":"\u003cboolean\u003e","feeIncluded":"\u003cboolean\u003e"},{"feeType":{"id":"\u003cinteger\u003e","name":"\u003cstring\u003e","readonly":"\u003cboolean\u003e","code":"\u003cstring\u003e"},"name":"\u003cstring\u003e","amount":"\u003cdouble\u003e","manualSet":"\u003cboolean\u003e","feeIncluded":"\u003cboolean\u003e"}],"specialPayments":[{"amount":"\u003cdouble\u003e","type":{"id":"\u003cinteger\u003e","name":"\u003cstring\u003e","readonly":"\u003cboolean\u003e","downPaymentType":"\u003cboolean\u003e","code":"\u003cstring\u003e"},"equipmentDetails":"\u003cstring\u003e","serialNumber":"\u003cstring\u003e"},{"amount":"\u003cdouble\u003e","type":{"id":"\u003cinteger\u003e","name":"\u003cstring\u003e","readonly":"\u003cboolean\u003e","downPaymentType":"\u003cboolean\u003e","code":"\u003cstring\u003e"},"equipmentDetails":"\u003cstring\u003e","serialNumber":"\u003cstring\u003e"}],"specialPaymentsSum":46106574.76641515,"optionFee":-18703140.077906072},"errors":["laboris in aute ut","nostrud pariatur"],"warnings":["adipisicing","et in"]}