Sales Orders (1.1.7)
This API can be used to retrieve sales order information and to create sales order actions.
[1.1.7]
Added Additional Invoice Party of type array and invoiceAllocationType Enum.
[1.1.6]
Removed ap2 from server list
[1.1.5]
Removed Shared Component References as nullable should be true and cannot be overriden if used with shared.
[1.1.4]
Added nullable to true for most of Properties to be in sync with bundled Sales, Additional End Point.
[1.1.3]
Added app-registry-id
[1.1.2]
Added security, Fixed enum issues and Response for SalesType
[1.1.1]
trade-in ,sales type response changed to array.
[1.1.0]
Changes in URL Path and Servers URL Names.
[1.0.0]
First version. Based on Sales Domain Bundled API Specs.
Create sales order
Create sales order.\r\nProvide the full object or just the mandatary (order information) and make add-ons with separate methods.
Authorizations:
Request Body schema: application/json
required | object Gets or Sets OrderInformation |
object or null Gets or Sets InvoiceParties | |
object or null Gets or Sets ContactParties | |
Array of objects or null or null (SalesOrderInventoryVehicle) Gets or Sets SalesOrderVehicle | |
Array of objects or null or null (SalesOrderTradeInVehicle) Gets or Sets SalesOrderVehicle | |
object or null Gets or Sets metadata |
Responses
Request samples
- Payload
{- "orderInformation": {
- "externalSalesOrderReference": "REF1235",
- "orderDate": "2021-07-16T00:00:00.000Z",
- "handOver": {
- "deliveryDate": "2021-07-16T00:00:00.000Z",
- "estimatedDeliveryDate": "2021-07-16T00:00:00.000Z"
}, - "salesPerson": {
- "salesPersonId": "string",
- "name": "string"
}, - "salesType": "RETAIL",
- "comments": "Information on Sales"
}, - "invoiceParties": {
- "mainInvoiceParty": {
- "payeeType": "FINANCE",
- "invoiceAllocationType": "CUSTOMER",
- "payee": {
- "customerId": "123459",
- "companyId": "982713",
- "payeeName": "John Doe",
- "addresses": {
- "home": {
- "physicalAddress": {
- "streetType": "Avenue",
- "streetName": "Mill Lane",
- "houseNumber": "7",
- "buildingName": "ABS",
- "floorNumber": "5",
- "doorNumber": "1001",
- "blockName": "B",
- "estate": "DBB",
- "postalCode": "SE4 1UU",
- "suburb": "Washington",
- "city": "London",
- "county": "Italy",
- "province": "CY",
- "countryCode": "GB"
}, - "postalAddress": {
- "poBoxName": "AB PO",
- "poBoxNumber": "12",
- "poBoxSuite": "12",
- "postalCode": "99772",
- "suburb": "Caps",
- "city": "London",
- "county": "Italy",
- "province": "CY",
- "countryCode": "GB"
}
}
}, - "contactInformation": {
- "home": {
- "mobile": "123-123123",
- "landline": "111-234567",
- "fax": "111-355754",
- "email": "mike@something.com"
}, - "work": {
- "mobile": "122-124433",
- "landline": "122-234567",
- "fax": "122-355754",
- "email": "mike@work.com"
}
}
}, - "invoiceValue": {
- "netValue": 100,
- "discount": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "finance": {
- "schemeName": "Sample Scheme",
- "rate": 90,
- "period": 60,
- "periodUnit": "MONTH",
- "periodPayment": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "yearlyMileage": 10000,
- "mileageUnit": "KM",
- "guaranteedFutureValue": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "initialPayment": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "financeType": "LEASE"
}, - "deposit": {
- "depositToPay": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "depositsTaken": [
- {
- "amount": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "paymentMethod": "CASH",
- "receiptNumber": "76531234",
- "notes": "Sample Note"
}
]
}
}, - "additionalMainInvoiceParties": [
- {
- "payeeType": "FINANCE",
- "invoiceAllocationType": "CUSTOMER",
- "payee": {
- "customerId": "123459",
- "companyId": "982713",
- "payeeName": "John Doe",
- "addresses": {
- "home": {
- "physicalAddress": {
- "streetType": "Avenue",
- "streetName": "Mill Lane",
- "houseNumber": "7",
- "buildingName": "ABS",
- "floorNumber": "5",
- "doorNumber": "1001",
- "blockName": "B",
- "estate": "DBB",
- "postalCode": "SE4 1UU",
- "suburb": "Washington",
- "city": "London",
- "county": "Italy",
- "province": "CY",
- "countryCode": "GB"
}, - "postalAddress": {
- "poBoxName": "AB PO",
- "poBoxNumber": "12",
- "poBoxSuite": "12",
- "postalCode": "99772",
- "suburb": "Caps",
- "city": "London",
- "county": "Italy",
- "province": "CY",
- "countryCode": "GB"
}
}
}, - "contactInformation": {
- "home": {
- "mobile": "123-123123",
- "landline": "111-234567",
- "fax": "111-355754",
- "email": "mike@something.com"
}, - "work": {
- "mobile": "122-124433",
- "landline": "122-234567",
- "fax": "122-355754",
- "email": "mike@work.com"
}
}
}, - "invoiceValue": {
- "netValue": 100,
- "discount": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "finance": {
- "schemeName": "Sample Scheme",
- "rate": 90,
- "period": 60,
- "periodUnit": "MONTH",
- "periodPayment": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "yearlyMileage": 10000,
- "mileageUnit": "KM",
- "guaranteedFutureValue": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "initialPayment": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "financeType": "LEASE"
}, - "deposit": {
- "depositToPay": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "depositsTaken": [
- {
- "amount": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "paymentMethod": "CASH",
- "receiptNumber": "76531234",
- "notes": "Sample Note"
}
]
}
}
], - "supplementaryInvoiceParty": {
- "payeeType": "FINANCE",
- "invoiceAllocationType": "CUSTOMER",
- "payee": {
- "customerId": "123459",
- "companyId": "982713",
- "payeeName": "John Doe",
- "addresses": {
- "home": {
- "physicalAddress": {
- "streetType": "Avenue",
- "streetName": "Mill Lane",
- "houseNumber": "7",
- "buildingName": "ABS",
- "floorNumber": "5",
- "doorNumber": "1001",
- "blockName": "B",
- "estate": "DBB",
- "postalCode": "SE4 1UU",
- "suburb": "Washington",
- "city": "London",
- "county": "Italy",
- "province": "CY",
- "countryCode": "GB"
}, - "postalAddress": {
- "poBoxName": "AB PO",
- "poBoxNumber": "12",
- "poBoxSuite": "12",
- "postalCode": "99772",
- "suburb": "Caps",
- "city": "London",
- "county": "Italy",
- "province": "CY",
- "countryCode": "GB"
}
}
}, - "contactInformation": {
- "home": {
- "mobile": "123-123123",
- "landline": "111-234567",
- "fax": "111-355754",
- "email": "mike@something.com"
}, - "work": {
- "mobile": "122-124433",
- "landline": "122-234567",
- "fax": "122-355754",
- "email": "mike@work.com"
}
}
}, - "invoiceValue": {
- "netValue": 100,
- "discount": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "finance": {
- "schemeName": "Sample Scheme",
- "rate": 90,
- "period": 60,
- "periodUnit": "MONTH",
- "periodPayment": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "yearlyMileage": 10000,
- "mileageUnit": "KM",
- "guaranteedFutureValue": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "initialPayment": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "financeType": "LEASE"
}, - "deposit": {
- "depositToPay": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "depositsTaken": [
- {
- "amount": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "paymentMethod": "CASH",
- "receiptNumber": "76531234",
- "notes": "Sample Note"
}
]
}
}
}, - "contactParties": {
- "salesContact": {
- "customerId": "123459",
- "companyId": "982713",
- "payeeName": "John Doe",
- "addresses": {
- "home": {
- "physicalAddress": {
- "streetType": "Avenue",
- "streetName": "Mill Lane",
- "houseNumber": "7",
- "buildingName": "ABS",
- "floorNumber": "5",
- "doorNumber": "1001",
- "blockName": "B",
- "estate": "DBB",
- "postalCode": "SE4 1UU",
- "suburb": "Washington",
- "city": "London",
- "county": "Italy",
- "province": "CY",
- "countryCode": "GB"
}, - "postalAddress": {
- "poBoxName": "AB PO",
- "poBoxNumber": "12",
- "poBoxSuite": "12",
- "postalCode": "99772",
- "suburb": "Caps",
- "city": "London",
- "county": "Italy",
- "province": "CY",
- "countryCode": "GB"
}
}
}, - "contactInformation": {
- "home": {
- "mobile": "123-123123",
- "landline": "111-234567",
- "fax": "111-355754",
- "email": "mike@something.com"
}, - "work": {
- "mobile": "122-124433",
- "landline": "122-234567",
- "fax": "122-355754",
- "email": "mike@work.com"
}
}
}
}, - "vehicles": [
- {
- "vehicleId": "string",
- "prices": {
- "listPrice": {
- "netValue": 100,
- "discount": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "carTax": 19.99,
- "currencyCode": "GBP"
}, - "costPrice": {
- "netValue": 100,
- "discount": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "carTax": 19.99,
- "currencyCode": "GBP"
}, - "deliveryPrice": {
- "netValue": 100,
- "discount": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "nonRecoverableCosts": [
- {
- "actualCost": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "estimatedCost": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "code": "COST2",
- "description": "Sample Cost"
}
], - "carTax": {
- "startDate": "2021-07-16T00:00:00.000Z",
- "type": "BPM",
- "carTaxNew": {
- "carTax": 19.99,
- "currencyCode": "GBP"
}
}
}, - "specification": {
- "primaryExteriorColor": {
- "code": "RED01",
- "description": "Maroon Red",
- "colorType": "METALLIC",
- "prices": {
- "costPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "listPrice": {
- "netValue": 100,
- "discount": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "carTax": 19.99,
- "currencyCode": "GBP"
}
}
}, - "secondaryExteriorColor": {
- "code": "RED01",
- "description": "Maroon Red",
- "colorType": "METALLIC",
- "prices": {
- "costPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "listPrice": {
- "netValue": 100,
- "discount": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "carTax": 19.99,
- "currencyCode": "GBP"
}
}
}, - "primaryInteriorColor": {
- "code": "BLACK01",
- "description": "Black",
- "colorType": "OTHER",
- "prices": {
- "costPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "listPrice": {
- "netValue": 100,
- "discount": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "carTax": 19.99,
- "currencyCode": "GBP"
}
}
}, - "secondaryInteriorColor": {
- "code": "BLACK01",
- "description": "Black",
- "colorType": "OTHER",
- "prices": {
- "costPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "listPrice": {
- "netValue": 100,
- "discount": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "carTax": 19.99,
- "currencyCode": "GBP"
}
}
}, - "optionPacks": [
- {
- "code": "LEATHER",
- "description": "Leather Trim",
- "type": "MANUFACTURERSTANDARD",
- "packPrices": {
- "costPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "listPrice": {
- "netValue": 100,
- "discount": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "carTax": 19.99,
- "currencyCode": "GBP"
}
}, - "options": [
- {
- "type": "MANUFACTURERSTANDARD",
- "code": "string",
- "description": "string",
- "optionPrices": {
- "costPrice": {
- "netValue": null,
- "grossValue": null,
- "taxValue": null,
- "taxRate": null,
- "currencyCode": null
}, - "listPrice": {
- "netValue": null,
- "discount": null,
- "grossValue": null,
- "taxValue": null,
- "taxRate": null,
- "carTax": null,
- "currencyCode": null
}
}
}
]
}
], - "options": [
- {
- "type": "MANUFACTURERSTANDARD",
- "code": "string",
- "description": "string",
- "optionPrices": {
- "costPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "listPrice": {
- "netValue": 100,
- "discount": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "carTax": 19.99,
- "currencyCode": "GBP"
}
}
}
]
}
}
], - "tradeInVehicles": [
- {
- "vehicleId": "string",
- "description": {
- "class": "CAR",
- "make": "DACIA",
- "model": "SANDERO",
- "variant": "TCE 90",
- "modelYear": 2019,
- "vehicle": "This is a great car",
- "exteriorColor": "Metallic Red",
- "interiorColor": "Black Leather"
}, - "identification": {
- "vin": "1FTHF25H1JNB79097",
- "chassis": "68060",
- "licensePlate": "TOY-123",
- "engineNumber": "12345678"
}, - "mileage": {
- "unit": "KM",
- "value": 120000
}, - "referenceData": {
- "providerId": "DMS",
- "makeCode": "SA",
- "modelCode": "SAMPLE",
- "variantCode": "123560",
- "vehicleCode": "ABC12345656",
- "serviceGroupCode": "S2251-10",
- "exteriorColorCode": "C12345",
- "interiorColorCode": "T12345"
}, - "technicalData": {
- "engineConcept": "LPG",
- "primaryEngine": {
- "fuelType": "DIESEL",
- "engineNumber": "123456789",
- "cylinderCapacity": 1690,
- "enginePower": {
- "horsePower": 120,
- "kiloWatts": 90.8
}
}, - "secondaryEngine": {
- "fuelType": "DIESEL",
- "engineNumber": "123456789",
- "cylinderCapacity": 1690,
- "enginePower": {
- "horsePower": 120,
- "kiloWatts": 90.8
}
}, - "steering": "RIGHT",
- "transmission": {
- "transmissionType": "OTHER",
- "numberOfGears": 6
}, - "numberOfDoors": 5,
- "bodyStyle": "OTHER",
- "numberOfSeats": 5,
- "electricRange": {
- "unit": "KM",
- "value": 120000
}, - "fuelTank": {
- "capacity": 75,
- "capacityUnit": "LITRES"
}, - "testRegimeData": {
- "regimeType": "NEDC",
- "regimeData": [
- {
- "level": "TOTAL",
- "consumption": {
- "unit": "m/l",
- "cycles": [
- {
- "type": "COMBINED",
- "value": 6.2
}
]
}, - "emission": {
- "unit": "kg/100km",
- "cycles": [
- {
- "type": "COMBINED",
- "value": 6.2
}
], - "nox": 100
}
}
]
}
}, - "dates": {
- "registrationDate": "2021-07-16T00:00:00.000Z",
- "firstRegistrationDate": "2021-07-16T00:00:00.000Z"
}, - "valuationPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "outstandingFinanceValue": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "offerPrice": {
- "netValue": 100,
- "grossValue": 100,
- "taxValue": 10,
- "taxRate": 19.99,
- "carTax": 0,
- "currencyCode": "GBP"
}, - "carTax": {
- "startDate": "2021-07-16T00:00:00.000Z",
- "type": "BPM",
- "carTaxNew": {
- "carTax": 19.99,
- "currencyCode": "GBP"
}
}, - "vatQualifyingVehicle": false
}
], - "metadata": {
- "auditData": {
- "userId": "string",
- "userName": "string"
}
}
}
Response samples
- 201
{- "salesOrderId": "12345"
}
Update sales order basic information
Update sales order basic information.
Authorizations:
path Parameters
salesOrderId required | string Sales Order Id |
Request Body schema: application/json
object | |
object or null This additional metadata section is always passed when action is performed to resource. |
Responses
Request samples
- Payload
{- "orderInformation": {
- "externalSalesOrderReference": "REF1235",
- "orderDate": "2021-07-16T00:00:00.000Z",
- "handOver": {
- "deliveryDate": "2021-07-16T00:00:00.000Z",
- "estimatedDeliveryDate": "2021-07-16T00:00:00.000Z"
}, - "salesPerson": {
- "salesPersonId": "string",
- "name": "string"
}, - "salesType": "RETAIL",
- "comments": "Information on Sales"
}, - "metadata": {
- "auditData": {
- "userId": "string",
- "userName": "string"
}
}
}
Response samples
- 404
{- "responseCode": 0,
- "Message": "string",
- "additional": [
- "string"
], - "correlationId": "string"
}
Confirm sales order
Confirms sales order. After that the modification is no longer possible.
Authorizations:
path Parameters
salesOrderId required | string Sales Order Id |
Request Body schema: application/json
object or null This additional metadata section is always passed when action is performed to resource. |
Responses
Request samples
- Payload
{- "metadata": {
- "auditData": {
- "userId": "string",
- "userName": "string"
}
}
}
Response samples
- 404
{- "responseCode": 0,
- "Message": "string",
- "additional": [
- "string"
], - "correlationId": "string"
}
Cancel sales order
Cancels sales order. After that the modification is no longer possible.
Authorizations:
path Parameters
salesOrderId required | string Sales Order Id |
Request Body schema: application/json
object or null This additional metadata section is always passed when action is performed to resource. |
Responses
Request samples
- Payload
{- "metadata": {
- "auditData": {
- "userId": "string",
- "userName": "string"
}
}
}
Response samples
- 404
{- "responseCode": 0,
- "Message": "string",
- "additional": [
- "string"
], - "correlationId": "string"
}
Add trade-in vehicle
Adds trade-in vehicle to the sales order.
Authorizations:
path Parameters
salesOrderId required | string Sales Order Id |
Request Body schema: application/json
object or null | |
object or null This additional metadata section is always passed when action is performed to resource. |
Responses
Request samples
- Payload
{- "tradeInVehicle": {
- "vehicleId": "string",
- "description": {
- "class": "CAR",
- "make": "DACIA",
- "model": "SANDERO",
- "variant": "TCE 90",
- "modelYear": 2019,
- "vehicle": "This is a great car",
- "exteriorColor": "Metallic Red",
- "interiorColor": "Black Leather"
}, - "identification": {
- "vin": "1FTHF25H1JNB79097",
- "chassis": "68060",
- "licensePlate": "TOY-123",
- "engineNumber": "12345678"
}, - "mileage": {
- "unit": "KM",
- "value": 120000
}, - "referenceData": {
- "providerId": "DMS",
- "makeCode": "SA",
- "modelCode": "SAMPLE",
- "variantCode": "123560",
- "vehicleCode": "ABC12345656",
- "serviceGroupCode": "S2251-10",
- "exteriorColorCode": "C12345",
- "interiorColorCode": "T12345"
}, - "technicalData": {
- "engineConcept": "LPG",
- "primaryEngine": {
- "fuelType": "DIESEL",
- "engineNumber": "123456789",
- "cylinderCapacity": 1690,
- "enginePower": {
- "horsePower": 120,
- "kiloWatts": 90.8
}
}, - "secondaryEngine": {
- "fuelType": "DIESEL",
- "engineNumber": "123456789",
- "cylinderCapacity": 1690,
- "enginePower": {
- "horsePower": 120,
- "kiloWatts": 90.8
}
}, - "steering": "RIGHT",
- "transmission": {
- "transmissionType": "OTHER",
- "numberOfGears": 6
}, - "numberOfDoors": 5,
- "bodyStyle": "OTHER",
- "numberOfSeats": 5,
- "electricRange": {
- "unit": "KM",
- "value": 120000
}, - "fuelTank": {
- "capacity": 75,
- "capacityUnit": "LITRES"
}, - "testRegimeData": {
- "regimeType": "NEDC",
- "regimeData": [
- {
- "level": "TOTAL",
- "consumption": {
- "unit": "m/l",
- "cycles": [
- {
- "type": "COMBINED",
- "value": 6.2
}
]
}, - "emission": {
- "unit": "kg/100km",
- "cycles": [
- {
- "type": "COMBINED",
- "value": 6.2
}
], - "nox": 100
}
}
]
}
}, - "dates": {
- "registrationDate": "2021-07-16T00:00:00.000Z",
- "firstRegistrationDate": "2021-07-16T00:00:00.000Z"
}, - "valuationPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "outstandingFinanceValue": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "offerPrice": {
- "netValue": 100,
- "grossValue": 100,
- "taxValue": 10,
- "taxRate": 19.99,
- "carTax": 0,
- "currencyCode": "GBP"
}, - "carTax": {
- "startDate": "2021-07-16T00:00:00.000Z",
- "type": "BPM",
- "carTaxNew": {
- "carTax": 19.99,
- "currencyCode": "GBP"
}
}, - "vatQualifyingVehicle": false
}, - "metadata": {
- "auditData": {
- "userId": "string",
- "userName": "string"
}
}
}
Response samples
- 200
- 404
[- {
- "vehicleId": "string",
- "description": {
- "class": "CAR",
- "make": "DACIA",
- "model": "SANDERO",
- "variant": "TCE 90",
- "modelYear": 2019,
- "vehicle": "This is a great car",
- "exteriorColor": "Metallic Red",
- "interiorColor": "Black Leather"
}, - "identification": {
- "vin": "1FTHF25H1JNB79097",
- "chassis": "68060",
- "licensePlate": "TOY-123",
- "engineNumber": "12345678"
}, - "mileage": {
- "unit": "KM",
- "value": 120000
}, - "referenceData": {
- "providerId": "DMS",
- "makeCode": "SA",
- "modelCode": "SAMPLE",
- "variantCode": "123560",
- "vehicleCode": "ABC12345656",
- "serviceGroupCode": "S2251-10",
- "exteriorColorCode": "C12345",
- "interiorColorCode": "T12345"
}, - "technicalData": {
- "engineConcept": "LPG",
- "primaryEngine": {
- "fuelType": "DIESEL",
- "engineNumber": "123456789",
- "cylinderCapacity": 1690,
- "enginePower": {
- "horsePower": 120,
- "kiloWatts": 90.8
}
}, - "secondaryEngine": {
- "fuelType": "DIESEL",
- "engineNumber": "123456789",
- "cylinderCapacity": 1690,
- "enginePower": {
- "horsePower": 120,
- "kiloWatts": 90.8
}
}, - "steering": "RIGHT",
- "transmission": {
- "transmissionType": "OTHER",
- "numberOfGears": 6
}, - "numberOfDoors": 5,
- "bodyStyle": "OTHER",
- "numberOfSeats": 5,
- "electricRange": {
- "unit": "KM",
- "value": 120000
}, - "fuelTank": {
- "capacity": 75,
- "capacityUnit": "LITRES"
}, - "testRegimeData": {
- "regimeType": "NEDC",
- "regimeData": [
- {
- "level": "TOTAL",
- "consumption": {
- "unit": "m/l",
- "cycles": [
- {
- "type": "COMBINED",
- "value": 6.2
}
]
}, - "emission": {
- "unit": "kg/100km",
- "cycles": [
- {
- "type": "COMBINED",
- "value": 6.2
}
], - "nox": 100
}
}
]
}
}, - "dates": {
- "registrationDate": "2021-07-16T00:00:00.000Z",
- "firstRegistrationDate": "2021-07-16T00:00:00.000Z"
}, - "valuationPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "outstandingFinanceValue": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "offerPrice": {
- "netValue": 100,
- "grossValue": 100,
- "taxValue": 10,
- "taxRate": 19.99,
- "carTax": 0,
- "currencyCode": "GBP"
}, - "carTax": {
- "startDate": "2021-07-16T00:00:00.000Z",
- "type": "BPM",
- "carTaxNew": {
- "carTax": 19.99,
- "currencyCode": "GBP"
}
}, - "vatQualifyingVehicle": false
}
]
Removes trade-in vehicle
Removes the trade-in vehicle from sales order
Authorizations:
path Parameters
salesOrderId required | string Sales Order Id |
Request Body schema: application/json
vehicleId | string or null |
object or null This additional metadata section is always passed when action is performed to resource. |
Responses
Request samples
- Payload
{- "vehicleId": "string",
- "metadata": {
- "auditData": {
- "userId": "string",
- "userName": "string"
}
}
}
Response samples
- 404
{- "responseCode": 0,
- "Message": "string",
- "additional": [
- "string"
], - "correlationId": "string"
}
Adds vehicle for sale
Adds the vehicle for sale to sales order
Authorizations:
path Parameters
salesOrderId required | string Sales Order Id |
Request Body schema: application/json
object or null | |
object or null This additional metadata section is always passed when action is performed to resource. |
Responses
Request samples
- Payload
{- "vehicle": {
- "vehicleId": "string",
- "prices": {
- "listPrice": {
- "netValue": 100,
- "discount": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "carTax": 19.99,
- "currencyCode": "GBP"
}, - "costPrice": {
- "netValue": 100,
- "discount": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "carTax": 19.99,
- "currencyCode": "GBP"
}, - "deliveryPrice": {
- "netValue": 100,
- "discount": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "nonRecoverableCosts": [
- {
- "actualCost": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "estimatedCost": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "code": "COST2",
- "description": "Sample Cost"
}
], - "carTax": {
- "startDate": "2021-07-16T00:00:00.000Z",
- "type": "BPM",
- "carTaxNew": {
- "carTax": 19.99,
- "currencyCode": "GBP"
}
}
}, - "specification": {
- "primaryExteriorColor": {
- "code": "RED01",
- "description": "Maroon Red",
- "colorType": "METALLIC",
- "prices": {
- "costPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "listPrice": {
- "netValue": 100,
- "discount": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "carTax": 19.99,
- "currencyCode": "GBP"
}
}
}, - "secondaryExteriorColor": {
- "code": "RED01",
- "description": "Maroon Red",
- "colorType": "METALLIC",
- "prices": {
- "costPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "listPrice": {
- "netValue": 100,
- "discount": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "carTax": 19.99,
- "currencyCode": "GBP"
}
}
}, - "primaryInteriorColor": {
- "code": "BLACK01",
- "description": "Black",
- "colorType": "OTHER",
- "prices": {
- "costPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "listPrice": {
- "netValue": 100,
- "discount": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "carTax": 19.99,
- "currencyCode": "GBP"
}
}
}, - "secondaryInteriorColor": {
- "code": "BLACK01",
- "description": "Black",
- "colorType": "OTHER",
- "prices": {
- "costPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "listPrice": {
- "netValue": 100,
- "discount": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "carTax": 19.99,
- "currencyCode": "GBP"
}
}
}, - "optionPacks": [
- {
- "code": "LEATHER",
- "description": "Leather Trim",
- "type": "MANUFACTURERSTANDARD",
- "packPrices": {
- "costPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "listPrice": {
- "netValue": 100,
- "discount": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "carTax": 19.99,
- "currencyCode": "GBP"
}
}, - "options": [
- {
- "type": "MANUFACTURERSTANDARD",
- "code": "string",
- "description": "string",
- "optionPrices": {
- "costPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "listPrice": {
- "netValue": 100,
- "discount": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "carTax": 19.99,
- "currencyCode": "GBP"
}
}
}
]
}
], - "options": [
- {
- "type": "MANUFACTURERSTANDARD",
- "code": "string",
- "description": "string",
- "optionPrices": {
- "costPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "listPrice": {
- "netValue": 100,
- "discount": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "carTax": 19.99,
- "currencyCode": "GBP"
}
}
}
]
}
}, - "metadata": {
- "auditData": {
- "userId": "string",
- "userName": "string"
}
}
}
Response samples
- 404
{- "responseCode": 0,
- "Message": "string",
- "additional": [
- "string"
], - "correlationId": "string"
}
Removes vehicle for sale
Removes the vehicle for sales from sales order
Authorizations:
path Parameters
salesOrderId required | string Sales Order Id |
Request Body schema: application/json
vehicleId | string or null |
object or null This additional metadata section is always passed when action is performed to resource. |
Responses
Request samples
- Payload
{- "vehicleId": "string",
- "metadata": {
- "auditData": {
- "userId": "string",
- "userName": "string"
}
}
}
Response samples
- 404
{- "responseCode": 0,
- "Message": "string",
- "additional": [
- "string"
], - "correlationId": "string"
}
Update invoice parties
Update main invoice party on sales order
Authorizations:
path Parameters
salesOrderId required | string Sales Order Id |
Request Body schema: application/json
object or null | |
object or null This additional metadata section is always passed when action is performed to resource. |
Responses
Request samples
- Payload
{- "invoiceParties": {
- "mainInvoiceParty": {
- "payeeType": "FINANCE",
- "invoiceAllocationType": "CUSTOMER",
- "payee": {
- "customerId": "123459",
- "companyId": "982713",
- "payeeName": "John Doe",
- "addresses": {
- "home": {
- "physicalAddress": {
- "streetType": "Avenue",
- "streetName": "Mill Lane",
- "houseNumber": "7",
- "buildingName": "ABS",
- "floorNumber": "5",
- "doorNumber": "1001",
- "blockName": "B",
- "estate": "DBB",
- "postalCode": "SE4 1UU",
- "suburb": "Washington",
- "city": "London",
- "county": "Italy",
- "province": "CY",
- "countryCode": "GB"
}, - "postalAddress": {
- "poBoxName": "AB PO",
- "poBoxNumber": "12",
- "poBoxSuite": "12",
- "postalCode": "99772",
- "suburb": "Caps",
- "city": "London",
- "county": "Italy",
- "province": "CY",
- "countryCode": "GB"
}
}
}, - "contactInformation": {
- "home": {
- "mobile": "123-123123",
- "landline": "111-234567",
- "fax": "111-355754",
- "email": "mike@something.com"
}, - "work": {
- "mobile": "122-124433",
- "landline": "122-234567",
- "fax": "122-355754",
- "email": "mike@work.com"
}
}
}, - "invoiceValue": {
- "netValue": 100,
- "discount": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "finance": {
- "schemeName": "Sample Scheme",
- "rate": 90,
- "period": 60,
- "periodUnit": "MONTH",
- "periodPayment": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "yearlyMileage": 10000,
- "mileageUnit": "KM",
- "guaranteedFutureValue": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "initialPayment": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "financeType": "LEASE"
}, - "deposit": {
- "depositToPay": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "depositsTaken": [
- {
- "amount": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "paymentMethod": "CASH",
- "receiptNumber": "76531234",
- "notes": "Sample Note"
}
]
}
}, - "additionalMainInvoiceParties": [
- {
- "payeeType": "FINANCE",
- "invoiceAllocationType": "CUSTOMER",
- "payee": {
- "customerId": "123459",
- "companyId": "982713",
- "payeeName": "John Doe",
- "addresses": {
- "home": {
- "physicalAddress": {
- "streetType": "Avenue",
- "streetName": "Mill Lane",
- "houseNumber": "7",
- "buildingName": "ABS",
- "floorNumber": "5",
- "doorNumber": "1001",
- "blockName": "B",
- "estate": "DBB",
- "postalCode": "SE4 1UU",
- "suburb": "Washington",
- "city": "London",
- "county": "Italy",
- "province": "CY",
- "countryCode": "GB"
}, - "postalAddress": {
- "poBoxName": "AB PO",
- "poBoxNumber": "12",
- "poBoxSuite": "12",
- "postalCode": "99772",
- "suburb": "Caps",
- "city": "London",
- "county": "Italy",
- "province": "CY",
- "countryCode": "GB"
}
}
}, - "contactInformation": {
- "home": {
- "mobile": "123-123123",
- "landline": "111-234567",
- "fax": "111-355754",
- "email": "mike@something.com"
}, - "work": {
- "mobile": "122-124433",
- "landline": "122-234567",
- "fax": "122-355754",
- "email": "mike@work.com"
}
}
}, - "invoiceValue": {
- "netValue": 100,
- "discount": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "finance": {
- "schemeName": "Sample Scheme",
- "rate": 90,
- "period": 60,
- "periodUnit": "MONTH",
- "periodPayment": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "yearlyMileage": 10000,
- "mileageUnit": "KM",
- "guaranteedFutureValue": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "initialPayment": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "financeType": "LEASE"
}, - "deposit": {
- "depositToPay": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "depositsTaken": [
- {
- "amount": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "paymentMethod": "CASH",
- "receiptNumber": "76531234",
- "notes": "Sample Note"
}
]
}
}
], - "supplementaryInvoiceParty": {
- "payeeType": "FINANCE",
- "invoiceAllocationType": "CUSTOMER",
- "payee": {
- "customerId": "123459",
- "companyId": "982713",
- "payeeName": "John Doe",
- "addresses": {
- "home": {
- "physicalAddress": {
- "streetType": "Avenue",
- "streetName": "Mill Lane",
- "houseNumber": "7",
- "buildingName": "ABS",
- "floorNumber": "5",
- "doorNumber": "1001",
- "blockName": "B",
- "estate": "DBB",
- "postalCode": "SE4 1UU",
- "suburb": "Washington",
- "city": "London",
- "county": "Italy",
- "province": "CY",
- "countryCode": "GB"
}, - "postalAddress": {
- "poBoxName": "AB PO",
- "poBoxNumber": "12",
- "poBoxSuite": "12",
- "postalCode": "99772",
- "suburb": "Caps",
- "city": "London",
- "county": "Italy",
- "province": "CY",
- "countryCode": "GB"
}
}
}, - "contactInformation": {
- "home": {
- "mobile": "123-123123",
- "landline": "111-234567",
- "fax": "111-355754",
- "email": "mike@something.com"
}, - "work": {
- "mobile": "122-124433",
- "landline": "122-234567",
- "fax": "122-355754",
- "email": "mike@work.com"
}
}
}, - "invoiceValue": {
- "netValue": 100,
- "discount": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "finance": {
- "schemeName": "Sample Scheme",
- "rate": 90,
- "period": 60,
- "periodUnit": "MONTH",
- "periodPayment": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "yearlyMileage": 10000,
- "mileageUnit": "KM",
- "guaranteedFutureValue": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "initialPayment": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "financeType": "LEASE"
}, - "deposit": {
- "depositToPay": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "depositsTaken": [
- {
- "amount": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "paymentMethod": "CASH",
- "receiptNumber": "76531234",
- "notes": "Sample Note"
}
]
}
}
}, - "metadata": {
- "auditData": {
- "userId": "string",
- "userName": "string"
}
}
}
Response samples
- 404
{- "responseCode": 0,
- "Message": "string",
- "additional": [
- "string"
], - "correlationId": "string"
}
Updates sales contact party
Adds contact party to sales order
Authorizations:
path Parameters
salesOrderId required | string Sales Order Id |
Request Body schema: application/json
object or null | |
object or null This additional metadata section is always passed when action is performed to resource. |
Responses
Request samples
- Payload
{- "contactParties": {
- "salesContact": {
- "customerId": "123459",
- "companyId": "982713",
- "payeeName": "John Doe",
- "addresses": {
- "home": {
- "physicalAddress": {
- "streetType": "Avenue",
- "streetName": "Mill Lane",
- "houseNumber": "7",
- "buildingName": "ABS",
- "floorNumber": "5",
- "doorNumber": "1001",
- "blockName": "B",
- "estate": "DBB",
- "postalCode": "SE4 1UU",
- "suburb": "Washington",
- "city": "London",
- "county": "Italy",
- "province": "CY",
- "countryCode": "GB"
}, - "postalAddress": {
- "poBoxName": "AB PO",
- "poBoxNumber": "12",
- "poBoxSuite": "12",
- "postalCode": "99772",
- "suburb": "Caps",
- "city": "London",
- "county": "Italy",
- "province": "CY",
- "countryCode": "GB"
}
}
}, - "contactInformation": {
- "home": {
- "mobile": "123-123123",
- "landline": "111-234567",
- "fax": "111-355754",
- "email": "mike@something.com"
}, - "work": {
- "mobile": "122-124433",
- "landline": "122-234567",
- "fax": "122-355754",
- "email": "mike@work.com"
}
}
}
}, - "metadata": {
- "auditData": {
- "userId": "string",
- "userName": "string"
}
}
}
Response samples
- 404
{- "responseCode": 0,
- "Message": "string",
- "additional": [
- "string"
], - "correlationId": "string"
}
Updates Accounts Receivable.
Update sales order accounts receivable to main/supplementary invoice
Authorizations:
path Parameters
salesOrderId required | string Sales Order Id |
Request Body schema: application/json
object or null Account ID Data | |
object or null This additional metadata section is always passed when action is performed to resource. |
Responses
Request samples
- Payload
{- "accountsReceivable": {
- "mainInvoiceAccount": {
- "accountId": "acc124"
}, - "supplementaryInvoiceAccount": {
- "accountId": "acc124"
}
}, - "metadata": {
- "auditData": {
- "userId": "string",
- "userName": "string"
}
}
}
Response samples
- 404
{- "responseCode": 0,
- "Message": "string",
- "additional": [
- "string"
], - "correlationId": "string"
}
Get sales order
Returns a sales order with given id.
Authorizations:
path Parameters
salesOrderId required | string Sales Order Id |
Responses
Response samples
- 200
- 404
{- "salesOrderId": "string",
- "status": "INPROGRESS",
- "orderInformation": {
- "externalSalesOrderReference": "REF1235",
- "orderDate": "2021-07-16T00:00:00.000Z",
- "handOver": {
- "deliveryDate": "2021-07-16T00:00:00.000Z",
- "estimatedDeliveryDate": "2021-07-16T00:00:00.000Z"
}, - "salesPerson": {
- "salesPersonId": "string",
- "name": "string"
}, - "salesType": "RETAIL",
- "comments": "Information on Sales"
}, - "invoiceParties": {
- "mainInvoiceParty": {
- "payeeType": "FINANCE",
- "invoiceAllocationType": "CUSTOMER",
- "payee": {
- "customerId": "123459",
- "companyId": "982713",
- "payeeName": "John Doe",
- "addresses": {
- "home": {
- "physicalAddress": {
- "streetType": "Avenue",
- "streetName": "Mill Lane",
- "houseNumber": "7",
- "buildingName": "ABS",
- "floorNumber": "5",
- "doorNumber": "1001",
- "blockName": "B",
- "estate": "DBB",
- "postalCode": "SE4 1UU",
- "suburb": "Washington",
- "city": "London",
- "county": "Italy",
- "province": "CY",
- "countryCode": "GB"
}, - "postalAddress": {
- "poBoxName": "AB PO",
- "poBoxNumber": "12",
- "poBoxSuite": "12",
- "postalCode": "99772",
- "suburb": "Caps",
- "city": "London",
- "county": "Italy",
- "province": "CY",
- "countryCode": "GB"
}
}
}, - "contactInformation": {
- "home": {
- "mobile": "123-123123",
- "landline": "111-234567",
- "fax": "111-355754",
- "email": "mike@something.com"
}, - "work": {
- "mobile": "122-124433",
- "landline": "122-234567",
- "fax": "122-355754",
- "email": "mike@work.com"
}
}
}, - "invoiceValue": {
- "netValue": 100,
- "discount": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "finance": {
- "schemeName": "Sample Scheme",
- "rate": 90,
- "period": 60,
- "periodUnit": "MONTH",
- "periodPayment": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "yearlyMileage": 10000,
- "mileageUnit": "KM",
- "guaranteedFutureValue": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "initialPayment": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "financeType": "LEASE"
}, - "deposit": {
- "depositToPay": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "depositsTaken": [
- {
- "amount": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "paymentMethod": "CASH",
- "receiptNumber": "76531234",
- "notes": "Sample Note"
}
]
}
}, - "additionalMainInvoiceParties": [
- {
- "payeeType": "FINANCE",
- "invoiceAllocationType": "CUSTOMER",
- "payee": {
- "customerId": "123459",
- "companyId": "982713",
- "payeeName": "John Doe",
- "addresses": {
- "home": {
- "physicalAddress": {
- "streetType": "Avenue",
- "streetName": "Mill Lane",
- "houseNumber": "7",
- "buildingName": "ABS",
- "floorNumber": "5",
- "doorNumber": "1001",
- "blockName": "B",
- "estate": "DBB",
- "postalCode": "SE4 1UU",
- "suburb": "Washington",
- "city": "London",
- "county": "Italy",
- "province": "CY",
- "countryCode": "GB"
}, - "postalAddress": {
- "poBoxName": "AB PO",
- "poBoxNumber": "12",
- "poBoxSuite": "12",
- "postalCode": "99772",
- "suburb": "Caps",
- "city": "London",
- "county": "Italy",
- "province": "CY",
- "countryCode": "GB"
}
}
}, - "contactInformation": {
- "home": {
- "mobile": "123-123123",
- "landline": "111-234567",
- "fax": "111-355754",
- "email": "mike@something.com"
}, - "work": {
- "mobile": "122-124433",
- "landline": "122-234567",
- "fax": "122-355754",
- "email": "mike@work.com"
}
}
}, - "invoiceValue": {
- "netValue": 100,
- "discount": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "finance": {
- "schemeName": "Sample Scheme",
- "rate": 90,
- "period": 60,
- "periodUnit": "MONTH",
- "periodPayment": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "yearlyMileage": 10000,
- "mileageUnit": "KM",
- "guaranteedFutureValue": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "initialPayment": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "financeType": "LEASE"
}, - "deposit": {
- "depositToPay": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "depositsTaken": [
- {
- "amount": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "paymentMethod": "CASH",
- "receiptNumber": "76531234",
- "notes": "Sample Note"
}
]
}
}
], - "supplementaryInvoiceParty": {
- "payeeType": "FINANCE",
- "invoiceAllocationType": "CUSTOMER",
- "payee": {
- "customerId": "123459",
- "companyId": "982713",
- "payeeName": "John Doe",
- "addresses": {
- "home": {
- "physicalAddress": {
- "streetType": "Avenue",
- "streetName": "Mill Lane",
- "houseNumber": "7",
- "buildingName": "ABS",
- "floorNumber": "5",
- "doorNumber": "1001",
- "blockName": "B",
- "estate": "DBB",
- "postalCode": "SE4 1UU",
- "suburb": "Washington",
- "city": "London",
- "county": "Italy",
- "province": "CY",
- "countryCode": "GB"
}, - "postalAddress": {
- "poBoxName": "AB PO",
- "poBoxNumber": "12",
- "poBoxSuite": "12",
- "postalCode": "99772",
- "suburb": "Caps",
- "city": "London",
- "county": "Italy",
- "province": "CY",
- "countryCode": "GB"
}
}
}, - "contactInformation": {
- "home": {
- "mobile": "123-123123",
- "landline": "111-234567",
- "fax": "111-355754",
- "email": "mike@something.com"
}, - "work": {
- "mobile": "122-124433",
- "landline": "122-234567",
- "fax": "122-355754",
- "email": "mike@work.com"
}
}
}, - "invoiceValue": {
- "netValue": 100,
- "discount": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "finance": {
- "schemeName": "Sample Scheme",
- "rate": 90,
- "period": 60,
- "periodUnit": "MONTH",
- "periodPayment": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "yearlyMileage": 10000,
- "mileageUnit": "KM",
- "guaranteedFutureValue": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "initialPayment": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "financeType": "LEASE"
}, - "deposit": {
- "depositToPay": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "depositsTaken": [
- {
- "amount": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "paymentMethod": "CASH",
- "receiptNumber": "76531234",
- "notes": "Sample Note"
}
]
}
}
}, - "contactParties": {
- "salesContact": {
- "customerId": "123459",
- "companyId": "982713",
- "payeeName": "John Doe",
- "addresses": {
- "home": {
- "physicalAddress": {
- "streetType": "Avenue",
- "streetName": "Mill Lane",
- "houseNumber": "7",
- "buildingName": "ABS",
- "floorNumber": "5",
- "doorNumber": "1001",
- "blockName": "B",
- "estate": "DBB",
- "postalCode": "SE4 1UU",
- "suburb": "Washington",
- "city": "London",
- "county": "Italy",
- "province": "CY",
- "countryCode": "GB"
}, - "postalAddress": {
- "poBoxName": "AB PO",
- "poBoxNumber": "12",
- "poBoxSuite": "12",
- "postalCode": "99772",
- "suburb": "Caps",
- "city": "London",
- "county": "Italy",
- "province": "CY",
- "countryCode": "GB"
}
}
}, - "contactInformation": {
- "home": {
- "mobile": "123-123123",
- "landline": "111-234567",
- "fax": "111-355754",
- "email": "mike@something.com"
}, - "work": {
- "mobile": "122-124433",
- "landline": "122-234567",
- "fax": "122-355754",
- "email": "mike@work.com"
}
}
}
}, - "vehicles": [
- {
- "vehicleId": "string",
- "prices": {
- "listPrice": {
- "netValue": 100,
- "discount": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "carTax": 19.99,
- "currencyCode": "GBP"
}, - "costPrice": {
- "netValue": 100,
- "discount": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "carTax": 19.99,
- "currencyCode": "GBP"
}, - "deliveryPrice": {
- "netValue": 100,
- "discount": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "nonRecoverableCosts": [
- {
- "actualCost": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "estimatedCost": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "code": "COST2",
- "description": "Sample Cost"
}
], - "carTax": {
- "startDate": "2021-07-16T00:00:00.000Z",
- "type": "BPM",
- "carTaxNew": {
- "carTax": 19.99,
- "currencyCode": "GBP"
}
}
}, - "specification": {
- "primaryExteriorColor": {
- "code": "RED01",
- "description": "Maroon Red",
- "colorType": "METALLIC",
- "prices": {
- "costPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "listPrice": {
- "netValue": 100,
- "discount": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "carTax": 19.99,
- "currencyCode": "GBP"
}
}
}, - "secondaryExteriorColor": {
- "code": "RED01",
- "description": "Maroon Red",
- "colorType": "METALLIC",
- "prices": {
- "costPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "listPrice": {
- "netValue": 100,
- "discount": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "carTax": 19.99,
- "currencyCode": "GBP"
}
}
}, - "primaryInteriorColor": {
- "code": "BLACK01",
- "description": "Black",
- "colorType": "OTHER",
- "prices": {
- "costPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "listPrice": {
- "netValue": 100,
- "discount": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "carTax": 19.99,
- "currencyCode": "GBP"
}
}
}, - "secondaryInteriorColor": {
- "code": "BLACK01",
- "description": "Black",
- "colorType": "OTHER",
- "prices": {
- "costPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "listPrice": {
- "netValue": 100,
- "discount": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "carTax": 19.99,
- "currencyCode": "GBP"
}
}
}, - "optionPacks": [
- {
- "code": "LEATHER",
- "description": "Leather Trim",
- "type": "MANUFACTURERSTANDARD",
- "packPrices": {
- "costPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "listPrice": {
- "netValue": 100,
- "discount": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "carTax": 19.99,
- "currencyCode": "GBP"
}
}, - "options": [
- {
- "type": "MANUFACTURERSTANDARD",
- "code": "string",
- "description": "string",
- "optionPrices": {
- "costPrice": {
- "netValue": null,
- "grossValue": null,
- "taxValue": null,
- "taxRate": null,
- "currencyCode": null
}, - "listPrice": {
- "netValue": null,
- "discount": null,
- "grossValue": null,
- "taxValue": null,
- "taxRate": null,
- "carTax": null,
- "currencyCode": null
}
}
}
]
}
], - "options": [
- {
- "type": "MANUFACTURERSTANDARD",
- "code": "string",
- "description": "string",
- "optionPrices": {
- "costPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "listPrice": {
- "netValue": 100,
- "discount": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "carTax": 19.99,
- "currencyCode": "GBP"
}
}
}
]
}
}
], - "tradeInVehicles": [
- {
- "vehicleId": "string",
- "description": {
- "class": "CAR",
- "make": "DACIA",
- "model": "SANDERO",
- "variant": "TCE 90",
- "modelYear": 2019,
- "vehicle": "This is a great car",
- "exteriorColor": "Metallic Red",
- "interiorColor": "Black Leather"
}, - "identification": {
- "vin": "1FTHF25H1JNB79097",
- "chassis": "68060",
- "licensePlate": "TOY-123",
- "engineNumber": "12345678"
}, - "mileage": {
- "unit": "KM",
- "value": 120000
}, - "referenceData": {
- "providerId": "DMS",
- "makeCode": "SA",
- "modelCode": "SAMPLE",
- "variantCode": "123560",
- "vehicleCode": "ABC12345656",
- "serviceGroupCode": "S2251-10",
- "exteriorColorCode": "C12345",
- "interiorColorCode": "T12345"
}, - "technicalData": {
- "engineConcept": "LPG",
- "primaryEngine": {
- "fuelType": "DIESEL",
- "engineNumber": "123456789",
- "cylinderCapacity": 1690,
- "enginePower": {
- "horsePower": 120,
- "kiloWatts": 90.8
}
}, - "secondaryEngine": {
- "fuelType": "DIESEL",
- "engineNumber": "123456789",
- "cylinderCapacity": 1690,
- "enginePower": {
- "horsePower": 120,
- "kiloWatts": 90.8
}
}, - "steering": "RIGHT",
- "transmission": {
- "transmissionType": "OTHER",
- "numberOfGears": 6
}, - "numberOfDoors": 5,
- "bodyStyle": "OTHER",
- "numberOfSeats": 5,
- "electricRange": {
- "unit": "KM",
- "value": 120000
}, - "fuelTank": {
- "capacity": 75,
- "capacityUnit": "LITRES"
}, - "testRegimeData": {
- "regimeType": "NEDC",
- "regimeData": [
- {
- "level": "TOTAL",
- "consumption": {
- "unit": "m/l",
- "cycles": [
- {
- "type": "COMBINED",
- "value": 6.2
}
]
}, - "emission": {
- "unit": "kg/100km",
- "cycles": [
- {
- "type": "COMBINED",
- "value": 6.2
}
], - "nox": 100
}
}
]
}
}, - "dates": {
- "registrationDate": "2021-07-16T00:00:00.000Z",
- "firstRegistrationDate": "2021-07-16T00:00:00.000Z"
}, - "valuationPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "outstandingFinanceValue": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "offerPrice": {
- "netValue": 100,
- "grossValue": 100,
- "taxValue": 10,
- "taxRate": 19.99,
- "carTax": 0,
- "currencyCode": "GBP"
}, - "carTax": {
- "startDate": "2021-07-16T00:00:00.000Z",
- "type": "BPM",
- "carTaxNew": {
- "carTax": 19.99,
- "currencyCode": "GBP"
}
}, - "vatQualifyingVehicle": false
}
], - "links": [
- {
- "method": [
- "DELETE"
], - "rel": "string",
- "href": "string",
- "title": "string"
}
]
}