Get Lease Model Cost Instalment API

Description

Get details on the quote based on the search parameters

Security

Logged in user has quote API permissions

URL

GET https://exampleserver.com/api/lease-model-cost-instalment?make={make}&model={model}&sub-model={sub-model}&term={term}&kilometres={kilometres}}

Parameters        

1. make: [string, mandatory] search by make code        
2. model: [string, mandatory] search by model code        
3. sub-model: [string, optional] search by sub-model code        
4. term: [int, mandatory] search by term        
5. kilometres: [int, mandatory] search by kilometres
   

Response

Field	Type	Description
LeaseModelCost	LeaseModelCostInstalmentModel	The calculated results, if successful

LeaseModelCostInstalmentModel

Field	Type	Description
netRental	Decimal	The instalment amount
gstOnNetRental	Decimal	The GST on instalment amount
grossRental	Decimal	The gross rental amount

Example

{"netRental": 0,

"gstOnNetRental": 0,                                                                                                                                               

"grossRental": 0

} 

Error Codes

HTTP Status Code	Type
200	OK (Success)
204	No Content (no records match the search)
401	Unauthorised (not Authenticated)
403	Forbidden (invalid Authorisation)
503	Service Unavailable (due to maintenance)

Online Documentation

https://api.argos.co.nz/WebApi/swagger/ui/index/

• Related Articles

• Get Account Details API

  Description Retrieve the system specific details for an account Security Logged in user has account API permissions URL GET http://exampleserver.com/api/{system}/{accountId}?calculationDate=date Parameters system: [Required, part of URL] One of (case ...

• Get Account Transactions API

  Description Retrieve the transactions for an account Security Logged in user has account API permissions URL GET ...

• Get Interest Profile API

  Description Get details for a specific interest profile Security Logged in user has interest profile API permissions URL GET http://exampleserver.com/api/ interestProfiles/{ interestProfileId} Parameters interestProfileId: [Required, part of URL] ...

• Get Stock Audit Report Data API

  Description Get stock audit checklist report data columns required by external audit systems Security Logged in user has stock audit API permissions API Version Argos API V6 URL GET ...

• Get All Clients API

  Description Get a list of all clients in the system Security Logged in user has client API permissions URL GET http://exampleserver.com/api/v6/clients?clientCode={clientCode}&clientName={clientName}&activeOnly={false}&groupCode={groupCode} Parameters ...