ReferencesOpenapiOrigination
List quotes
List quotes for the specified deal, organisation, and workspace, with optional status and pagination filters.
Authorization
ApiKeyAuth x-api-key<token>
API key for authentication
In: header
Path Parameters
orgId*string
workspaceId*string
dealId*string
Query Parameters
status?array<>
page?number
Default
1Range
1 <= valuelimit?number
Default
25Range
1 <= value <= 100Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://app.np.aws.karia.com.au/api/v0/organisation/string/workspace/string/origination/deal/string/quote"{
"items": [
{
"id": 0,
"name": "string",
"description": "string",
"status": "draft",
"quoteReference": "string",
"organisationId": 0,
"workspaceId": 0,
"dealId": 0,
"createdAt": "2019-08-24T14:15:22Z",
"createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",
"lastUpdatedAt": "2019-08-24T14:15:22Z",
"lastUpdatedBy": "9eca4444-bb39-4c34-8088-e204f5c15d34",
"deletedAt": "2019-08-24T14:15:22Z",
"generatedQuoteDocuments": [],
"supportingDocuments": [],
"startingQuoteDetails": {
"payrollCycle": "string",
"grossAnnualSalary": "string"
},
"vehicleDetails": {
"vehicleType": "car",
"nvicOrAutograbId": "string",
"make": "string",
"model": "string",
"typeBadge": "string",
"bodyStyle": "string",
"driveType": "string",
"modelYear": "string",
"condition": "new",
"numberOfDoors": "string",
"transmissionType": "string",
"fuelType": "string",
"engineType": "string",
"exteriorColour": "string",
"interiorTrim": "string",
"vin": "string",
"engineNumber": "string",
"buildDate": "string",
"registrationNumber": "string",
"odometer": "string",
"odometerUnit": "KM",
"dealerOrPrivate": "dealer",
"vehicleSupplier": "string",
"supplierContact": {
"email": "user@example.com",
"phone": "string"
},
"vehicleIds": {
"autograbId": "string",
"glassesNvicId": "string",
"redbookId": "string"
},
"options": []
},
"quoteVehiclePurchaseQuote": {
"drivewayPrice": "string",
"saleType": "dealer_sale_new",
"applyMaxClaimableGstCap": true,
"stateForStampDuty": "string",
"stampDutyCategory": "string",
"stateOfRegistration": "string",
"addLuxuryCarTax": "string",
"luxuryCarThresholdCategory": "fuel_efficient_vehicle"
},
"quoteVehiclePricing": {
"vehiclePrice": {
"exGstAmount": "string",
"gstAmount": "string",
"incGstAmount": "string"
},
"dealerFees": {
"exGstAmount": "string",
"gstAmount": "string",
"incGstAmount": "string"
},
"stampDuty": {
"amount": "string",
"defaultValue": "2000.00"
},
"initialRegistration": {
"amount": "string",
"defaultValue": "3500.00"
},
"luxuryCarTax": {
"amount": "string",
"estimatedValue": "2000.00"
},
"totalStatutoryCosts": "string",
"gstClaimed": "string",
"totalVehicleAmountFinanced": "string"
},
"quoteFinanceDetails": {
"leaseTerm": "string",
"leaseStartDate": "string",
"leaseEndDate": "string",
"financier": "string",
"financierOther": "string",
"financierRate": "string",
"paymentScheduleType": "string",
"monthDeferred": "string",
"financeContractId": "string",
"residualRates": {
"highResidualRate": "65",
"atoMethod": "46",
"lowResidualRate": "35",
"selectedResidual": {
"percentage": "string",
"exGstAmount": "0.00",
"gstAmount": "0.00",
"incGstAmount": "0.00"
}
},
"vehicleAmountFinanced": {
"exGstAmount": "0.00",
"gstAmount": "0.00",
"incGstAmount": "0.00"
},
"financedAmount": {
"otherFinancedAmounts": [
{
"name": "string",
"exGstAmount": "0.00",
"gstAmount": "0.00",
"incGstAmount": "0.00"
}
],
"otherFinancedSubTotal": {
"exGstAmount": "0.00",
"gstAmount": "0.00",
"incGstAmount": "0.00"
}
},
"financierFees": {
"establishmentFee": {
"exGstAmount": "0.00",
"gstAmount": "0.00",
"incGstAmount": "0.00"
},
"ppsr": {
"exGstAmount": "0.00",
"gstAmount": "0.00",
"incGstAmount": "0.00"
},
"financierFeesSubTotal": {
"exGstAmount": "0.00",
"gstAmount": "0.00",
"incGstAmount": "0.00"
}
},
"commission": {
"percentage": "string",
"amounts": {
"exGstAmount": "0.00",
"gstAmount": "0.00",
"incGstAmount": "0.00"
},
"documentFee": {
"exGstAmount": "0.00",
"gstAmount": "0.00",
"incGstAmount": "0.00"
},
"otherCommissionAmounts": [
{
"name": "string",
"exGstAmount": "0.00",
"gstAmount": "0.00",
"incGstAmount": "0.00"
}
]
},
"totalAmountFinanced": {
"exGstAmount": "0.00",
"gstAmount": "0.00",
"incGstAmount": "0.00"
},
"totalInvestmentAmount": {
"exGstAmount": "0.00",
"gstAmount": "0.00",
"incGstAmount": "0.00"
},
"financePayments": {
"monthlyPaymentToFinanciers": {
"exGstAmount": "0.00",
"gstAmount": "0.00",
"incGstAmount": "0.00"
},
"monthlyBudgetedFinancePayments": {
"exGstAmount": "0.00",
"gstAmount": "0.00",
"incGstAmount": "0.00"
},
"payrollCycleBudgetedFinancePayments": {
"exGstAmount": "0.00",
"gstAmount": "0.00",
"incGstAmount": "0.00"
}
}
},
"quoteBudgetDetails": {
"vehicleCategory": "string",
"vehicleSize": "string",
"annualKilometres": 15000,
"values": {
"electricity": {
"evRate": 28,
"unit": "kWh/100 kms",
"atoMethod": false
},
"fuel": {
"fuelRate": 28,
"unit": "kWh/100 kms"
},
"hybrid": {
"fuelRate": 28,
"unit": "kWh/100 kms"
},
"maintenance": {
"rate": 4,
"unit": "cents/kms"
},
"tyres": {
"costPerTyre": 320,
"replacementTyres": 4
},
"registration": {
"type": "Renewal",
"count": 0
},
"vehicleInsurance": {
"provider": "Mercurien",
"hasAdvancedSettings": false
}
},
"budgetCategories": [
{
"name": "accessories",
"description": "",
"enabled": true,
"recommExGstAmount": 0,
"exGstAmount": 0,
"gstAmount": 0,
"incGstAmount": 0,
"payrollCycleExGstAmount": 0,
"payrollCycleGstAmount": 0,
"payrollCycleIncGstAmount": 0
}
],
"totalOperatingBudget": {
"recommExGstAmount": 0,
"exGstAmount": 0,
"gstAmount": 0,
"incGstAmount": 0,
"payrollCycleExGstAmount": 0,
"payrollCycleGstAmount": 0,
"payrollCycleIncGstAmount": 0
},
"cycleType": "Monthly"
},
"quoteTaxDetails": {
"fbtMethod": "statutory",
"employerFbtType": "standard",
"fbtCollectionType": "ecm",
"claimableVehicleBusinessUse": 100,
"fbtBaseValue": 0,
"lossDeductibility": {
"include": true,
"recommendedAmount": 0,
"customAmount": 0
},
"employerEntitledToGstCredits": true,
"helpHecsDebt": true,
"preTaxContribution": 0,
"postTaxContribution": 0,
"estimatedEmployeeFbtLiability": 0,
"estimatedEmployerFbtLiability": 0,
"runningCosts": {
"payrollCycle": 0,
"annual": 0
},
"incomeTax": {
"salary": {
"currentSalaryPayrollCycle": 0,
"estimatedSalaryPayrollCycle": 0
},
"preTaxContribution": {
"currentPreTaxContributionPayrollCycle": 0,
"estimatedPreTaxContributionPayrollCycle": 0
},
"postTaxContribution": {
"currentPostTaxContributionPayrollCycle": 0,
"estimatedPostTaxContributionPayrollCycle": 0
},
"taxableIncome": {
"currentTaxableIncomePayrollCycle": 0,
"estimatedTaxableIncomePayrollCycle": 0
},
"taxPayable": {
"currentTaxPayablePayrollCycle": 0,
"estimatedTaxPayablePayrollCycle": 0
},
"netIncome": {
"currentNetIncomePayrollCycle": 0,
"currentNetIncome": 0,
"estimatedNetIncomePayrollCycle": 0,
"estimatedNetIncome": 0
},
"taxSavings": {
"currentTaxSavingsPayrollCycle": 0,
"estimatedTaxSavingsPayrollCycle": 0,
"currentTaxSavings": 0,
"estimatedTaxSavings": 0
},
"netCost": {
"currentNetCostPayrollCycle": 0,
"estimatedNetCostPayrollCycle": 0,
"currentNetCost": 0,
"estimatedNetCost": 0
}
}
},
"quotePolicyDetails": {
"version": "1",
"revision": "1",
"policies": [
{
"policyReference": "string",
"policyTerm": 0,
"insurer": "aami",
"insuranceType": "comprehensive_insurance",
"managementType": "fleet",
"startDate": "2019-08-24",
"endDate": "2019-08-24"
}
]
}
}
],
"pagination": {
"total": 0,
"page": 0,
"limit": 0,
"totalPages": 0
}
}{
"code": "BAD_REQUEST",
"message": "Invalid input data",
"issues": []
}{
"code": "UNAUTHORIZED",
"message": "Authorization not provided",
"issues": []
}{
"code": "FORBIDDEN",
"message": "Insufficient access",
"issues": []
}{
"code": "NOT_FOUND",
"message": "Not found",
"issues": []
}{
"code": "INTERNAL_SERVER_ERROR",
"message": "Internal server error",
"issues": []
}