Codeweavers maintains an import service on services.codeweavers.net for the facilitation of data uploads (vehicledata, residual data etc) which comes from other systems.
\r\nThis is a standard HTTPS url which accepts a POST payload of the content and required authentication information. Authentication via HTTP Basic Authentication is supported.
\r\nIntegration into the service is trivial from both command line functionality in both *nix and Windows environments using cURL or Powershell (for example).
\r\nOur import services have numerous advantages over legacy FTP/SFTP implementations including:
\r\nAs this is HTTP Standard file upload/POST the functionality can be used by a browser without additional functionality; any alternative method of POSTing the file will also work (Talend Open Studio, .NET, perl, python, ruby, java etc). Underlying service documentation is available at: https://docs.codeweavers.net/#tag/import
\r\nWe have an example UI that can be used to test uploads into the service manually and is available at: https://services.codeweavers.net/Fileupload.html this UI simply provides the service in a view that users can easily fill out manually.
", "operationId": "ImportController_Upload", "consumes": [], "produces": [ "application/json", "text/json", "text/javascript", "application/reports+json" ], "parameters": [ { "name": "importType", "in": "path", "required": true, "type": "string" }, { "name": "request.importSettings", "in": "query", "required": false, "type": "array", "items": {}, "collectionFormat": "multi" }, { "name": "X-CW-ApiKey", "in": "header", "description": "Codeweavers ApiKey used for public APIs. Additionally a system can be specified by prepending the system name and a hyphen to the ApiKey e.g. \"Codeweavers-************\"", "required": false, "type": "apiKey" }, { "name": "Authorization", "in": "header", "description": "User credentials used server to server required for secure APIs", "required": false, "type": "basic" }, { "name": "X-CW-AuthenticationToken", "in": "header", "description": "User auth token from login required for secure APIs", "required": false, "type": "string" }, { "name": "X-CW-RetailerIdentifier", "in": "header", "description": "Choose a dealer in relation to the authenticating group using a predefined identifier. The action will take place in the context of that retailer.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/RootSuccessResponse" } }, "4XX": { "description": "Request Error", "schema": { "$ref": "#/definitions/RootErrorResponse" } } } } }, "/api/guest/initialise/order": { "post": { "tags": [ "guest" ], "summary": "Authenticates a guest user and sets them up an order they have access to", "operationId": "GuestJourneyInitialisationController_InitialiseWithOrder", "consumes": [ "application/json", "text/json", "text/javascript", "application/x-www-form-urlencoded", "application/reports+json" ], "produces": [ "application/json", "text/json", "text/javascript", "application/reports+json" ], "parameters": [ { "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/InitialiseOrderRequest" } }, { "name": "X-CW-ApiKey", "in": "header", "description": "Codeweavers ApiKey used for public APIs. Additionally a system can be specified by prepending the system name and a hyphen to the ApiKey e.g. \"Codeweavers-************\"", "required": false, "type": "apiKey" }, { "name": "Authorization", "in": "header", "description": "User credentials used server to server required for secure APIs", "required": false, "type": "basic" }, { "name": "X-CW-AuthenticationToken", "in": "header", "description": "User auth token from login required for secure APIs", "required": false, "type": "string" }, { "name": "X-CW-RetailerIdentifier", "in": "header", "description": "Choose a dealer in relation to the authenticating group using a predefined identifier. The action will take place in the context of that retailer.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CheckoutJourneyInitialisationResponse" } }, "4XX": { "description": "Request Error", "schema": { "$ref": "#/definitions/RootErrorResponse" } } } } }, "/api/guest/initialise/proposal": { "post": { "tags": [ "guest" ], "summary": "Authenticates a guest user and sets them up a proposal they have access to", "operationId": "GuestJourneyInitialisationController_InitialiseWithProposal", "consumes": [ "application/json", "text/json", "text/javascript", "application/x-www-form-urlencoded", "application/reports+json" ], "produces": [ "application/json", "text/json", "text/javascript", "application/reports+json" ], "parameters": [ { "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/InitialiseProposalRequest" } }, { "name": "X-CW-ApiKey", "in": "header", "description": "Codeweavers ApiKey used for public APIs. Additionally a system can be specified by prepending the system name and a hyphen to the ApiKey e.g. \"Codeweavers-************\"", "required": false, "type": "apiKey" }, { "name": "Authorization", "in": "header", "description": "User credentials used server to server required for secure APIs", "required": false, "type": "basic" }, { "name": "X-CW-AuthenticationToken", "in": "header", "description": "User auth token from login required for secure APIs", "required": false, "type": "string" }, { "name": "X-CW-RetailerIdentifier", "in": "header", "description": "Choose a dealer in relation to the authenticating group using a predefined identifier. The action will take place in the context of that retailer.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CommonJourneyInitialisationResponse" } }, "4XX": { "description": "Request Error", "schema": { "$ref": "#/definitions/RootErrorResponse" } } } } }, "/api/action-availability/start-apply": { "post": { "tags": [ "action-availability" ], "summary": "Returns whether a quote, proposal, or order is in a valid state to be used to start the apply journey.", "operationId": "ActionAvailabilityController_StartApplyAvailability", "consumes": [ "application/json", "text/json", "text/javascript", "application/x-www-form-urlencoded", "application/reports+json" ], "produces": [ "application/json", "text/json", "text/javascript", "application/reports+json" ], "parameters": [ { "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CheckActionAvailabilityRequest" } }, { "name": "X-CW-ApiKey", "in": "header", "description": "Codeweavers ApiKey used for public APIs. Additionally a system can be specified by prepending the system name and a hyphen to the ApiKey e.g. \"Codeweavers-************\"", "required": false, "type": "apiKey" }, { "name": "Authorization", "in": "header", "description": "User credentials used server to server required for secure APIs", "required": false, "type": "basic" }, { "name": "X-CW-AuthenticationToken", "in": "header", "description": "User auth token from login required for secure APIs", "required": false, "type": "string" }, { "name": "X-CW-RetailerIdentifier", "in": "header", "description": "Choose a dealer in relation to the authenticating group using a predefined identifier. The action will take place in the context of that retailer.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CheckActionAvailabilityResponse" } }, "4XX": { "description": "Request Error", "schema": { "$ref": "#/definitions/RootErrorResponse" } } } } }, "/api/action-availability/start-checkout": { "post": { "tags": [ "action-availability" ], "summary": "Returns whether a quote, proposal, or order is in a valid state to be used to start the checkout journey.", "operationId": "ActionAvailabilityController_StartCheckoutAvailability", "consumes": [ "application/json", "text/json", "text/javascript", "application/x-www-form-urlencoded", "application/reports+json" ], "produces": [ "application/json", "text/json", "text/javascript", "application/reports+json" ], "parameters": [ { "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CheckActionAvailabilityRequest" } }, { "name": "X-CW-ApiKey", "in": "header", "description": "Codeweavers ApiKey used for public APIs. Additionally a system can be specified by prepending the system name and a hyphen to the ApiKey e.g. \"Codeweavers-************\"", "required": false, "type": "apiKey" }, { "name": "Authorization", "in": "header", "description": "User credentials used server to server required for secure APIs", "required": false, "type": "basic" }, { "name": "X-CW-AuthenticationToken", "in": "header", "description": "User auth token from login required for secure APIs", "required": false, "type": "string" }, { "name": "X-CW-RetailerIdentifier", "in": "header", "description": "Choose a dealer in relation to the authenticating group using a predefined identifier. The action will take place in the context of that retailer.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CheckActionAvailabilityResponse" } }, "4XX": { "description": "Request Error", "schema": { "$ref": "#/definitions/RootErrorResponse" } } } } }, "/api/action-availability/start-credit-check": { "post": { "tags": [ "action-availability" ], "summary": "Returns whether a quote, proposal, or order is in a valid state to be used to start the credit check journey.", "operationId": "ActionAvailabilityController_StartCreditCheckAvailability", "consumes": [ "application/json", "text/json", "text/javascript", "application/x-www-form-urlencoded", "application/reports+json" ], "produces": [ "application/json", "text/json", "text/javascript", "application/reports+json" ], "parameters": [ { "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CheckActionAvailabilityRequest" } }, { "name": "X-CW-ApiKey", "in": "header", "description": "Codeweavers ApiKey used for public APIs. Additionally a system can be specified by prepending the system name and a hyphen to the ApiKey e.g. \"Codeweavers-************\"", "required": false, "type": "apiKey" }, { "name": "Authorization", "in": "header", "description": "User credentials used server to server required for secure APIs", "required": false, "type": "basic" }, { "name": "X-CW-AuthenticationToken", "in": "header", "description": "User auth token from login required for secure APIs", "required": false, "type": "string" }, { "name": "X-CW-RetailerIdentifier", "in": "header", "description": "Choose a dealer in relation to the authenticating group using a predefined identifier. The action will take place in the context of that retailer.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CheckActionAvailabilityResponse" } }, "4XX": { "description": "Request Error", "schema": { "$ref": "#/definitions/RootErrorResponse" } } } } }, "/api/action-availability/start-reserve": { "post": { "tags": [ "action-availability" ], "summary": "Returns whether a quote, proposal, or order is in a valid state to be used to start the reserve journey.", "operationId": "ActionAvailabilityController_StartReserveAvailability", "consumes": [ "application/json", "text/json", "text/javascript", "application/x-www-form-urlencoded", "application/reports+json" ], "produces": [ "application/json", "text/json", "text/javascript", "application/reports+json" ], "parameters": [ { "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CheckActionAvailabilityRequest" } }, { "name": "X-CW-ApiKey", "in": "header", "description": "Codeweavers ApiKey used for public APIs. Additionally a system can be specified by prepending the system name and a hyphen to the ApiKey e.g. \"Codeweavers-************\"", "required": false, "type": "apiKey" }, { "name": "Authorization", "in": "header", "description": "User credentials used server to server required for secure APIs", "required": false, "type": "basic" }, { "name": "X-CW-AuthenticationToken", "in": "header", "description": "User auth token from login required for secure APIs", "required": false, "type": "string" }, { "name": "X-CW-RetailerIdentifier", "in": "header", "description": "Choose a dealer in relation to the authenticating group using a predefined identifier. The action will take place in the context of that retailer.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CheckActionAvailabilityResponse" } }, "4XX": { "description": "Request Error", "schema": { "$ref": "#/definitions/RootErrorResponse" } } } } }, "/api/action-availability/start-part-exchange": { "post": { "tags": [ "action-availability" ], "summary": "Returns whether a proposal, or order is in a valid state to be used to start the part exchange journey.", "operationId": "ActionAvailabilityController_StartPartExchangeAvailability", "consumes": [ "application/json", "text/json", "text/javascript", "application/x-www-form-urlencoded", "application/reports+json" ], "produces": [ "application/json", "text/json", "text/javascript", "application/reports+json" ], "parameters": [ { "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CheckActionAvailabilityRequest" } }, { "name": "X-CW-ApiKey", "in": "header", "description": "Codeweavers ApiKey used for public APIs. Additionally a system can be specified by prepending the system name and a hyphen to the ApiKey e.g. \"Codeweavers-************\"", "required": false, "type": "apiKey" }, { "name": "Authorization", "in": "header", "description": "User credentials used server to server required for secure APIs", "required": false, "type": "basic" }, { "name": "X-CW-AuthenticationToken", "in": "header", "description": "User auth token from login required for secure APIs", "required": false, "type": "string" }, { "name": "X-CW-RetailerIdentifier", "in": "header", "description": "Choose a dealer in relation to the authenticating group using a predefined identifier. The action will take place in the context of that retailer.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CheckActionAvailabilityResponse" } }, "4XX": { "description": "Request Error", "schema": { "$ref": "#/definitions/RootErrorResponse" } } } } }, "/api/action-availability/start-vehicle-alert": { "post": { "tags": [ "action-availability" ], "summary": "Returns whether an organisation is in a valid state to be used to start the vehicle alert journey.", "operationId": "ActionAvailabilityController_StartVehicleAlertAvailability", "consumes": [], "produces": [ "application/json", "text/json", "text/javascript", "application/reports+json" ], "parameters": [ { "name": "X-CW-ApiKey", "in": "header", "description": "Codeweavers ApiKey used for public APIs. Additionally a system can be specified by prepending the system name and a hyphen to the ApiKey e.g. \"Codeweavers-************\"", "required": false, "type": "apiKey" }, { "name": "Authorization", "in": "header", "description": "User credentials used server to server required for secure APIs", "required": false, "type": "basic" }, { "name": "X-CW-AuthenticationToken", "in": "header", "description": "User auth token from login required for secure APIs", "required": false, "type": "string" }, { "name": "X-CW-RetailerIdentifier", "in": "header", "description": "Choose a dealer in relation to the authenticating group using a predefined identifier. The action will take place in the context of that retailer.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CheckActionAvailabilityResponse" } }, "4XX": { "description": "Request Error", "schema": { "$ref": "#/definitions/RootErrorResponse" } } } } }, "/api/action-availability/start-rate-for-risk": { "post": { "tags": [ "action-availability" ], "summary": "Returns whether a quote, proposal, or order is in a valid state to be used to start the rate for risk apply journey.", "operationId": "ActionAvailabilityController_StartRateForRiskAvailability", "consumes": [ "application/json", "text/json", "text/javascript", "application/x-www-form-urlencoded", "application/reports+json" ], "produces": [ "application/json", "text/json", "text/javascript", "application/reports+json" ], "parameters": [ { "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CheckActionAvailabilityRequest" } }, { "name": "X-CW-ApiKey", "in": "header", "description": "Codeweavers ApiKey used for public APIs. Additionally a system can be specified by prepending the system name and a hyphen to the ApiKey e.g. \"Codeweavers-************\"", "required": false, "type": "apiKey" }, { "name": "Authorization", "in": "header", "description": "User credentials used server to server required for secure APIs", "required": false, "type": "basic" }, { "name": "X-CW-AuthenticationToken", "in": "header", "description": "User auth token from login required for secure APIs", "required": false, "type": "string" }, { "name": "X-CW-RetailerIdentifier", "in": "header", "description": "Choose a dealer in relation to the authenticating group using a predefined identifier. The action will take place in the context of that retailer.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CheckActionAvailabilityResponse" } }, "4XX": { "description": "Request Error", "schema": { "$ref": "#/definitions/RootErrorResponse" } } } } }, "/api/action-availability/start-customer-suitability": { "post": { "tags": [ "action-availability" ], "summary": "Returns whether a quote, proposal, or order is in a valid state to be used to start the customer suitability apply journey.", "operationId": "ActionAvailabilityController_StartCustomerSuitabilityAvailability", "consumes": [ "application/json", "text/json", "text/javascript", "application/x-www-form-urlencoded", "application/reports+json" ], "produces": [ "application/json", "text/json", "text/javascript", "application/reports+json" ], "parameters": [ { "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CheckActionAvailabilityRequest" } }, { "name": "X-CW-ApiKey", "in": "header", "description": "Codeweavers ApiKey used for public APIs. Additionally a system can be specified by prepending the system name and a hyphen to the ApiKey e.g. \"Codeweavers-************\"", "required": false, "type": "apiKey" }, { "name": "Authorization", "in": "header", "description": "User credentials used server to server required for secure APIs", "required": false, "type": "basic" }, { "name": "X-CW-AuthenticationToken", "in": "header", "description": "User auth token from login required for secure APIs", "required": false, "type": "string" }, { "name": "X-CW-RetailerIdentifier", "in": "header", "description": "Choose a dealer in relation to the authenticating group using a predefined identifier. The action will take place in the context of that retailer.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CheckActionAvailabilityResponse" } }, "4XX": { "description": "Request Error", "schema": { "$ref": "#/definitions/RootErrorResponse" } } } } }, "/api/vehicles/search": { "post": { "tags": [ "vehicles" ], "summary": "Search over your vehicles, returning the results.", "operationId": "VehiclesController_Search", "consumes": [ "application/json", "text/json", "text/javascript", "application/x-www-form-urlencoded", "application/reports+json" ], "produces": [ "application/json", "text/json", "text/javascript", "application/reports+json" ], "parameters": [ { "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/VehicleSearchRequest" } }, { "name": "X-CW-ApiKey", "in": "header", "description": "Codeweavers ApiKey used for public APIs. Additionally a system can be specified by prepending the system name and a hyphen to the ApiKey e.g. \"Codeweavers-************\"", "required": false, "type": "apiKey" }, { "name": "Authorization", "in": "header", "description": "User credentials used server to server required for secure APIs", "required": false, "type": "basic" }, { "name": "X-CW-AuthenticationToken", "in": "header", "description": "User auth token from login required for secure APIs", "required": false, "type": "string" }, { "name": "X-CW-RetailerIdentifier", "in": "header", "description": "Choose a dealer in relation to the authenticating group using a predefined identifier. The action will take place in the context of that retailer.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/VehicleSearchResponse" } }, "4XX": { "description": "Request Error", "schema": { "$ref": "#/definitions/RootErrorResponse" } } } } }, "/api/vehicles/search-with-facets": { "post": { "tags": [ "vehicles" ], "summary": "Search over your vehicles, returning the results and their facets.", "operationId": "VehiclesController_SearchWithFacets", "consumes": [ "application/json", "text/json", "text/javascript", "application/x-www-form-urlencoded", "application/reports+json" ], "produces": [ "application/json", "text/json", "text/javascript", "application/reports+json" ], "parameters": [ { "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/VehicleSearchRequest" } }, { "name": "X-CW-ApiKey", "in": "header", "description": "Codeweavers ApiKey used for public APIs. Additionally a system can be specified by prepending the system name and a hyphen to the ApiKey e.g. \"Codeweavers-************\"", "required": false, "type": "apiKey" }, { "name": "Authorization", "in": "header", "description": "User credentials used server to server required for secure APIs", "required": false, "type": "basic" }, { "name": "X-CW-AuthenticationToken", "in": "header", "description": "User auth token from login required for secure APIs", "required": false, "type": "string" }, { "name": "X-CW-RetailerIdentifier", "in": "header", "description": "Choose a dealer in relation to the authenticating group using a predefined identifier. The action will take place in the context of that retailer.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/VehicleSearchWithFacetsResponse" } }, "4XX": { "description": "Request Error", "schema": { "$ref": "#/definitions/RootErrorResponse" } } } } }, "/api/vehicles/search/groups": { "post": { "tags": [ "vehicles" ], "summary": "Search over your vehicles, returning the results grouped by the type specified in the request.", "operationId": "VehiclesController_SearchGroups", "consumes": [ "application/json", "text/json", "text/javascript", "application/x-www-form-urlencoded", "application/reports+json" ], "produces": [ "application/json", "text/json", "text/javascript", "application/reports+json" ], "parameters": [ { "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/VehicleSearchRequest" } }, { "name": "X-CW-ApiKey", "in": "header", "description": "Codeweavers ApiKey used for public APIs. Additionally a system can be specified by prepending the system name and a hyphen to the ApiKey e.g. \"Codeweavers-************\"", "required": false, "type": "apiKey" }, { "name": "Authorization", "in": "header", "description": "User credentials used server to server required for secure APIs", "required": false, "type": "basic" }, { "name": "X-CW-AuthenticationToken", "in": "header", "description": "User auth token from login required for secure APIs", "required": false, "type": "string" }, { "name": "X-CW-RetailerIdentifier", "in": "header", "description": "Choose a dealer in relation to the authenticating group using a predefined identifier. The action will take place in the context of that retailer.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/VehicleGroupResponse" } }, "4XX": { "description": "Request Error", "schema": { "$ref": "#/definitions/RootErrorResponse" } } } } }, "/api/vehicles/search-with-facets/groups": { "post": { "tags": [ "vehicles" ], "summary": "Search over your vehicles, returning the results grouped by the type specified in the request and their facets.", "operationId": "VehiclesController_SearchGroupsWithFacets", "consumes": [ "application/json", "text/json", "text/javascript", "application/x-www-form-urlencoded", "application/reports+json" ], "produces": [ "application/json", "text/json", "text/javascript", "application/reports+json" ], "parameters": [ { "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/VehicleSearchRequest" } }, { "name": "X-CW-ApiKey", "in": "header", "description": "Codeweavers ApiKey used for public APIs. Additionally a system can be specified by prepending the system name and a hyphen to the ApiKey e.g. \"Codeweavers-************\"", "required": false, "type": "apiKey" }, { "name": "Authorization", "in": "header", "description": "User credentials used server to server required for secure APIs", "required": false, "type": "basic" }, { "name": "X-CW-AuthenticationToken", "in": "header", "description": "User auth token from login required for secure APIs", "required": false, "type": "string" }, { "name": "X-CW-RetailerIdentifier", "in": "header", "description": "Choose a dealer in relation to the authenticating group using a predefined identifier. The action will take place in the context of that retailer.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/VehicleGroupWithFacetsResponse" } }, "4XX": { "description": "Request Error", "schema": { "$ref": "#/definitions/RootErrorResponse" } } } } }, "/api/vehicles/search/count": { "post": { "tags": [ "vehicles" ], "summary": "Search over your vehicles, returning only their counts.", "operationId": "VehiclesController_SearchCount", "consumes": [ "application/json", "text/json", "text/javascript", "application/x-www-form-urlencoded", "application/reports+json" ], "produces": [ "application/json", "text/json", "text/javascript", "application/reports+json" ], "parameters": [ { "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/VehicleSearchRequest" } }, { "name": "X-CW-ApiKey", "in": "header", "description": "Codeweavers ApiKey used for public APIs. Additionally a system can be specified by prepending the system name and a hyphen to the ApiKey e.g. \"Codeweavers-************\"", "required": false, "type": "apiKey" }, { "name": "Authorization", "in": "header", "description": "User credentials used server to server required for secure APIs", "required": false, "type": "basic" }, { "name": "X-CW-AuthenticationToken", "in": "header", "description": "User auth token from login required for secure APIs", "required": false, "type": "string" }, { "name": "X-CW-RetailerIdentifier", "in": "header", "description": "Choose a dealer in relation to the authenticating group using a predefined identifier. The action will take place in the context of that retailer.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/VehicleSearchCountResponse" } }, "4XX": { "description": "Request Error", "schema": { "$ref": "#/definitions/RootErrorResponse" } } } } }, "/api/vehicles/search/facets": { "post": { "tags": [ "vehicles" ], "summary": "Search over your vehicles, returning only their facets.", "operationId": "VehiclesController_SearchFacets", "consumes": [ "application/json", "text/json", "text/javascript", "application/x-www-form-urlencoded", "application/reports+json" ], "produces": [ "application/json", "text/json", "text/javascript", "application/reports+json" ], "parameters": [ { "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/VehicleSearchRequest" } }, { "name": "X-CW-ApiKey", "in": "header", "description": "Codeweavers ApiKey used for public APIs. Additionally a system can be specified by prepending the system name and a hyphen to the ApiKey e.g. \"Codeweavers-************\"", "required": false, "type": "apiKey" }, { "name": "Authorization", "in": "header", "description": "User credentials used server to server required for secure APIs", "required": false, "type": "basic" }, { "name": "X-CW-AuthenticationToken", "in": "header", "description": "User auth token from login required for secure APIs", "required": false, "type": "string" }, { "name": "X-CW-RetailerIdentifier", "in": "header", "description": "Choose a dealer in relation to the authenticating group using a predefined identifier. The action will take place in the context of that retailer.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/VehicleSearchFacetsResponse" } }, "4XX": { "description": "Request Error", "schema": { "$ref": "#/definitions/RootErrorResponse" } } } } }, "/api/vehicles": { "post": { "tags": [ "vehicles" ], "summary": "Save vehicles", "operationId": "VehiclesController_Save", "consumes": [ "application/json", "text/json", "text/javascript", "application/x-www-form-urlencoded", "application/reports+json" ], "produces": [ "application/json", "text/json", "text/javascript", "application/reports+json" ], "parameters": [ { "name": "request", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/SaveVehiclesRequest" } }, { "name": "X-CW-ApiKey", "in": "header", "description": "Codeweavers ApiKey used for public APIs. Additionally a system can be specified by prepending the system name and a hyphen to the ApiKey e.g. \"Codeweavers-************\"", "required": false, "type": "apiKey" }, { "name": "Authorization", "in": "header", "description": "User credentials used server to server required for secure APIs", "required": false, "type": "basic" }, { "name": "X-CW-AuthenticationToken", "in": "header", "description": "User auth token from login required for secure APIs", "required": false, "type": "string" }, { "name": "X-CW-RetailerIdentifier", "in": "header", "description": "Choose a dealer in relation to the authenticating group using a predefined identifier. The action will take place in the context of that retailer.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SaveVehiclesResponse" } }, "4XX": { "description": "Request Error", "schema": { "$ref": "#/definitions/RootErrorResponse" } } } } }, "/api/proposals": { "post": { "tags": [ "proposals" ], "summary": "Create a proposal", "operationId": "ProposalsController_Create", "consumes": [ "application/json", "text/json", "text/javascript", "application/x-www-form-urlencoded", "application/reports+json" ], "produces": [ "application/json", "text/json", "text/javascript", "application/reports+json" ], "parameters": [ { "name": "request", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/CreateProposalRequest" } }, { "name": "X-CW-ApiKey", "in": "header", "description": "Codeweavers ApiKey used for public APIs. Additionally a system can be specified by prepending the system name and a hyphen to the ApiKey e.g. \"Codeweavers-************\"", "required": false, "type": "apiKey" }, { "name": "Authorization", "in": "header", "description": "User credentials used server to server required for secure APIs", "required": false, "type": "basic" }, { "name": "X-CW-AuthenticationToken", "in": "header", "description": "User auth token from login required for secure APIs", "required": false, "type": "string" }, { "name": "X-CW-RetailerIdentifier", "in": "header", "description": "Choose a dealer in relation to the authenticating group using a predefined identifier. The action will take place in the context of that retailer.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CreateProposalResponse" } }, "4XX": { "description": "Request Error", "schema": { "$ref": "#/definitions/RootErrorResponse" } } } } }, "/api/proposals/{proposalReference}": { "get": { "tags": [ "proposals" ], "summary": "Gets the current state of a proposal", "operationId": "ProposalsController_Retrieve", "consumes": [], "produces": [ "application/json", "text/json", "text/javascript", "application/reports+json" ], "parameters": [ { "name": "proposalReference", "in": "path", "description": "", "required": true, "type": "string" }, { "name": "X-CW-ApiKey", "in": "header", "description": "Codeweavers ApiKey used for public APIs. Additionally a system can be specified by prepending the system name and a hyphen to the ApiKey e.g. \"Codeweavers-************\"", "required": false, "type": "apiKey" }, { "name": "Authorization", "in": "header", "description": "User credentials used server to server required for secure APIs", "required": false, "type": "basic" }, { "name": "X-CW-AuthenticationToken", "in": "header", "description": "User auth token from login required for secure APIs", "required": false, "type": "string" }, { "name": "X-CW-RetailerIdentifier", "in": "header", "description": "Choose a dealer in relation to the authenticating group using a predefined identifier. The action will take place in the context of that retailer.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ProposalResponse" } }, "4XX": { "description": "Request Error", "schema": { "$ref": "#/definitions/RootErrorResponse" } } } } }, "/api/proposals/{proposalReference}/personalinformation": { "put": { "tags": [ "proposals" ], "summary": "Overwrites any personal information on the proposal with the personal information provided in the request.\r\n \r\nIntended use-case is to allow external DMS or CRM system wants to launch a finance application journey without forcing reentry of all known data\r\n \r\nSuggested solution:\r\n- Create Proposal in Codeweavers' system\r\n- Accept the privacy policy\r\n- Use this API to prepopulate the proposal\r\n- Launch the proposal form (via the proposal form plugin for example)", "operationId": "ProposalsPersonalInformationController_UpdatePersonalInformation", "consumes": [ "application/json", "text/json", "text/javascript", "application/x-www-form-urlencoded", "application/reports+json" ], "produces": [ "application/json", "text/json", "text/javascript", "application/reports+json" ], "parameters": [ { "name": "proposalReference", "in": "path", "required": true, "type": "string" }, { "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/UpdateProposalPersonalInformationRequest" } }, { "name": "X-CW-ApiKey", "in": "header", "description": "Codeweavers ApiKey used for public APIs. Additionally a system can be specified by prepending the system name and a hyphen to the ApiKey e.g. \"Codeweavers-************\"", "required": false, "type": "apiKey" }, { "name": "Authorization", "in": "header", "description": "User credentials used server to server required for secure APIs", "required": false, "type": "basic" }, { "name": "X-CW-AuthenticationToken", "in": "header", "description": "User auth token from login required for secure APIs", "required": false, "type": "string" }, { "name": "X-CW-RetailerIdentifier", "in": "header", "description": "Choose a dealer in relation to the authenticating group using a predefined identifier. The action will take place in the context of that retailer.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } }, "4XX": { "description": "Request Error", "schema": { "$ref": "#/definitions/RootErrorResponse" } } } } }, "/api/proposals/{reference}/status": { "get": { "tags": [ "proposals" ], "summary": "Retrieve status of a proposal", "operationId": "ProposalsStatusController_RetrieveStatus", "consumes": [], "produces": [ "application/json", "text/json", "text/javascript", "application/reports+json" ], "parameters": [ { "name": "reference", "in": "path", "description": "", "required": true, "type": "string" }, { "name": "X-CW-ApiKey", "in": "header", "description": "Codeweavers ApiKey used for public APIs. Additionally a system can be specified by prepending the system name and a hyphen to the ApiKey e.g. \"Codeweavers-************\"", "required": false, "type": "apiKey" }, { "name": "Authorization", "in": "header", "description": "User credentials used server to server required for secure APIs", "required": false, "type": "basic" }, { "name": "X-CW-AuthenticationToken", "in": "header", "description": "User auth token from login required for secure APIs", "required": false, "type": "string" }, { "name": "X-CW-RetailerIdentifier", "in": "header", "description": "Choose a dealer in relation to the authenticating group using a predefined identifier. The action will take place in the context of that retailer.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ProposalStatusResponse" } }, "4XX": { "description": "Request Error", "schema": { "$ref": "#/definitions/RootErrorResponse" } } } } }, "/api/proposals/{proposalReference}/quote": { "get": { "tags": [ "proposals" ], "summary": "Retrieves the current active quote of a proposal.", "operationId": "ProposalsQuoteController_RetrieveQuote", "consumes": [], "produces": [ "application/json", "text/json", "text/javascript", "application/reports+json" ], "parameters": [ { "name": "proposalReference", "in": "path", "description": "", "required": true, "type": "string" }, { "name": "X-CW-ApiKey", "in": "header", "description": "Codeweavers ApiKey used for public APIs. Additionally a system can be specified by prepending the system name and a hyphen to the ApiKey e.g. \"Codeweavers-************\"", "required": false, "type": "apiKey" }, { "name": "Authorization", "in": "header", "description": "User credentials used server to server required for secure APIs", "required": false, "type": "basic" }, { "name": "X-CW-AuthenticationToken", "in": "header", "description": "User auth token from login required for secure APIs", "required": false, "type": "string" }, { "name": "X-CW-RetailerIdentifier", "in": "header", "description": "Choose a dealer in relation to the authenticating group using a predefined identifier. The action will take place in the context of that retailer.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FinanceQuotesResponse" } }, "4XX": { "description": "Request Error", "schema": { "$ref": "#/definitions/RootErrorResponse" } } } } }, "/api/proposals/{proposalReference}/notes": { "get": { "tags": [ "proposals" ], "summary": "Return notes for a given proposal reference", "operationId": "NotesController_RetrieveNotes", "consumes": [], "produces": [ "application/json", "text/json", "text/javascript", "application/reports+json" ], "parameters": [ { "name": "proposalReference", "in": "path", "description": "The reference of the proposal to lookup.", "required": true, "type": "string" }, { "name": "X-CW-ApiKey", "in": "header", "description": "Codeweavers ApiKey used for public APIs. Additionally a system can be specified by prepending the system name and a hyphen to the ApiKey e.g. \"Codeweavers-************\"", "required": false, "type": "apiKey" }, { "name": "Authorization", "in": "header", "description": "User credentials used server to server required for secure APIs", "required": false, "type": "basic" }, { "name": "X-CW-AuthenticationToken", "in": "header", "description": "User auth token from login required for secure APIs", "required": false, "type": "string" }, { "name": "X-CW-RetailerIdentifier", "in": "header", "description": "Choose a dealer in relation to the authenticating group using a predefined identifier. The action will take place in the context of that retailer.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ProposalNotesResponse" } }, "4XX": { "description": "Request Error", "schema": { "$ref": "#/definitions/RootErrorResponse" } } } } }, "/api/proposals/{proposalReference}/form": { "get": { "tags": [ "proposals" ], "summary": "Get a proposal form resource.", "operationId": "ProposalFormController_RetrieveForm", "consumes": [], "produces": [ "application/json", "text/json", "text/javascript", "application/reports+json" ], "parameters": [ { "name": "proposalReference", "in": "path", "description": "The reference of the proposal to retrieve.", "required": true, "type": "string" }, { "name": "request.formType", "in": "query", "description": "This value will dictate the structure of the form including the fields which are returned.", "required": true, "type": "string", "enum": [ "Affordability", "CustomerContactCapture", "CustomerCreditCheck", "CustomerDeliveryAddress", "EligibilityRateForRisk", "CustomerEnquiry", "CustomerFinanceApplication", "CustomerFinanceApplicationWithoutBankDetails", "CustomerReserve", "CustomerSoftSearch", "CustomerSuitability", "DecisionInPrinciple", "DriverPortal", "Eligibility", "FinancePortalExternalInitialise", "PartialFinanceApplication", "RetailerFinanceApplication", "RetailerLeadCapture", "Unknown" ] }, { "name": "request.minusFormTypes", "in": "query", "description": "Two form types may include the same field(s). When retrieving a form for FormType \"B\" minus FormType \"A\", FormType \"B\" will be returned without the fields that also exist on FormType \"A\".", "required": false, "type": "array", "items": { "type": "string", "enum": [ "Affordability", "CustomerContactCapture", "CustomerCreditCheck", "CustomerDeliveryAddress", "EligibilityRateForRisk", "CustomerEnquiry", "CustomerFinanceApplication", "CustomerFinanceApplicationWithoutBankDetails", "CustomerReserve", "CustomerSoftSearch", "CustomerSuitability", "DecisionInPrinciple", "DriverPortal", "Eligibility", "FinancePortalExternalInitialise", "PartialFinanceApplication", "RetailerFinanceApplication", "RetailerLeadCapture", "Unknown" ] }, "collectionFormat": "multi" }, { "name": "request.includeErrors", "in": "query", "description": "Retrieve the form with field errors for the given FormType.", "required": false, "type": "boolean" }, { "name": "X-CW-ApiKey", "in": "header", "description": "Codeweavers ApiKey used for public APIs. Additionally a system can be specified by prepending the system name and a hyphen to the ApiKey e.g. \"Codeweavers-************\"", "required": false, "type": "apiKey" }, { "name": "Authorization", "in": "header", "description": "User credentials used server to server required for secure APIs", "required": false, "type": "basic" }, { "name": "X-CW-AuthenticationToken", "in": "header", "description": "User auth token from login required for secure APIs", "required": false, "type": "string" }, { "name": "X-CW-RetailerIdentifier", "in": "header", "description": "Choose a dealer in relation to the authenticating group using a predefined identifier. The action will take place in the context of that retailer.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ProposalFormResponse" } }, "4XX": { "description": "Request Error", "schema": { "$ref": "#/definitions/RootErrorResponse" } } } } }, "/api/proposals/{proposalReference}/form/download": { "get": { "tags": [ "proposals" ], "summary": "Get a proposal form resource.", "operationId": "ProposalFormController_RetrieveFormToDownload", "consumes": [], "produces": [ "application/json", "text/json", "text/javascript", "application/reports+json" ], "parameters": [ { "name": "proposalReference", "in": "path", "description": "The reference of the proposal to retrieve.", "required": true, "type": "string" }, { "name": "request.formType", "in": "query", "description": "This value will dictate the structure of the form including the fields which are returned.", "required": true, "type": "string", "enum": [ "Affordability", "CustomerContactCapture", "CustomerCreditCheck", "CustomerDeliveryAddress", "EligibilityRateForRisk", "CustomerEnquiry", "CustomerFinanceApplication", "CustomerFinanceApplicationWithoutBankDetails", "CustomerReserve", "CustomerSoftSearch", "CustomerSuitability", "DecisionInPrinciple", "DriverPortal", "Eligibility", "FinancePortalExternalInitialise", "PartialFinanceApplication", "RetailerFinanceApplication", "RetailerLeadCapture", "Unknown" ] }, { "name": "request.minusFormTypes", "in": "query", "description": "Two form types may include the same field(s). When retrieving a form for FormType \"B\" minus FormType \"A\", FormType \"B\" will be returned without the fields that also exist on FormType \"A\".", "required": false, "type": "array", "items": { "type": "string", "enum": [ "Affordability", "CustomerContactCapture", "CustomerCreditCheck", "CustomerDeliveryAddress", "EligibilityRateForRisk", "CustomerEnquiry", "CustomerFinanceApplication", "CustomerFinanceApplicationWithoutBankDetails", "CustomerReserve", "CustomerSoftSearch", "CustomerSuitability", "DecisionInPrinciple", "DriverPortal", "Eligibility", "FinancePortalExternalInitialise", "PartialFinanceApplication", "RetailerFinanceApplication", "RetailerLeadCapture", "Unknown" ] }, "collectionFormat": "multi" }, { "name": "request.includeErrors", "in": "query", "description": "Retrieve the form with field errors for the given FormType.", "required": false, "type": "boolean" }, { "name": "X-CW-ApiKey", "in": "header", "description": "Codeweavers ApiKey used for public APIs. Additionally a system can be specified by prepending the system name and a hyphen to the ApiKey e.g. \"Codeweavers-************\"", "required": false, "type": "apiKey" }, { "name": "Authorization", "in": "header", "description": "User credentials used server to server required for secure APIs", "required": false, "type": "basic" }, { "name": "X-CW-AuthenticationToken", "in": "header", "description": "User auth token from login required for secure APIs", "required": false, "type": "string" }, { "name": "X-CW-RetailerIdentifier", "in": "header", "description": "Choose a dealer in relation to the authenticating group using a predefined identifier. The action will take place in the context of that retailer.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/RootDocumentResponse" } }, "4XX": { "description": "Request Error", "schema": { "$ref": "#/definitions/RootErrorResponse" } } } } }, "/api/proposals/{proposalReference}/form-fields": { "put": { "tags": [ "proposals" ], "summary": "Updates the value of fields for the specified proposal reference.", "operationId": "ProposalFormController_UpdateFormFields", "consumes": [ "application/json", "text/json", "text/javascript", "application/x-www-form-urlencoded", "application/reports+json" ], "produces": [ "application/json", "text/json", "text/javascript", "application/reports+json" ], "parameters": [ { "name": "proposalReference", "in": "path", "description": "The reference of the form instance to set the value for.", "required": true, "type": "string" }, { "name": "request", "in": "body", "description": "The value to set the field to.", "required": true, "schema": { "$ref": "#/definitions/ProposalFormUpdateFieldsRequest" } }, { "name": "X-CW-ApiKey", "in": "header", "description": "Codeweavers ApiKey used for public APIs. Additionally a system can be specified by prepending the system name and a hyphen to the ApiKey e.g. \"Codeweavers-************\"", "required": false, "type": "apiKey" }, { "name": "Authorization", "in": "header", "description": "User credentials used server to server required for secure APIs", "required": false, "type": "basic" }, { "name": "X-CW-AuthenticationToken", "in": "header", "description": "User auth token from login required for secure APIs", "required": false, "type": "string" }, { "name": "X-CW-RetailerIdentifier", "in": "header", "description": "Choose a dealer in relation to the authenticating group using a predefined identifier. The action will take place in the context of that retailer.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ProposalFormUpdateResponse" } }, "4XX": { "description": "Request Error", "schema": { "$ref": "#/definitions/RootErrorResponse" } } } } }, "/api/proposals/{proposalReference}/form-field-data": { "put": { "tags": [ "proposals" ], "summary": "Updates the data for the specified field identifier on the proposal.", "operationId": "ProposalFormController_UpdateFormFieldData", "consumes": [ "application/json", "text/json", "text/javascript", "application/x-www-form-urlencoded", "application/reports+json" ], "produces": [ "application/json", "text/json", "text/javascript", "application/reports+json" ], "parameters": [ { "name": "proposalReference", "in": "path", "description": "The reference of the form instance to set the value for.", "required": true, "type": "string" }, { "name": "request", "in": "body", "description": "The value to set the field to.", "required": true, "schema": { "$ref": "#/definitions/ProposalFormUpdateFieldDataRequest" } }, { "name": "X-CW-ApiKey", "in": "header", "description": "Codeweavers ApiKey used for public APIs. Additionally a system can be specified by prepending the system name and a hyphen to the ApiKey e.g. \"Codeweavers-************\"", "required": false, "type": "apiKey" }, { "name": "Authorization", "in": "header", "description": "User credentials used server to server required for secure APIs", "required": false, "type": "basic" }, { "name": "X-CW-AuthenticationToken", "in": "header", "description": "User auth token from login required for secure APIs", "required": false, "type": "string" }, { "name": "X-CW-RetailerIdentifier", "in": "header", "description": "Choose a dealer in relation to the authenticating group using a predefined identifier. The action will take place in the context of that retailer.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ProposalFormUpdateResponse" } }, "4XX": { "description": "Request Error", "schema": { "$ref": "#/definitions/RootErrorResponse" } } } } }, "/api/proposals/{proposalReference}/form-action": { "post": { "tags": [ "proposals" ], "summary": "Handles the action request from a form action (add/delete section, etc)", "operationId": "ProposalFormController_ExecuteFormAction", "consumes": [ "application/json", "text/json", "text/javascript", "application/x-www-form-urlencoded", "application/reports+json" ], "produces": [ "application/json", "text/json", "text/javascript", "application/reports+json" ], "parameters": [ { "name": "proposalReference", "in": "path", "description": "The reference of the form instance to set the value for.", "required": true, "type": "string" }, { "name": "request", "in": "body", "description": "The action to apply.", "required": true, "schema": { "$ref": "#/definitions/ProposalActionRequest" } }, { "name": "X-CW-ApiKey", "in": "header", "description": "Codeweavers ApiKey used for public APIs. Additionally a system can be specified by prepending the system name and a hyphen to the ApiKey e.g. \"Codeweavers-************\"", "required": false, "type": "apiKey" }, { "name": "Authorization", "in": "header", "description": "User credentials used server to server required for secure APIs", "required": false, "type": "basic" }, { "name": "X-CW-AuthenticationToken", "in": "header", "description": "User auth token from login required for secure APIs", "required": false, "type": "string" }, { "name": "X-CW-RetailerIdentifier", "in": "header", "description": "Choose a dealer in relation to the authenticating group using a predefined identifier. The action will take place in the context of that retailer.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ProposalFormUpdateResponse" } }, "4XX": { "description": "Request Error", "schema": { "$ref": "#/definitions/RootErrorResponse" } } } } }, "/api/proposals/{proposalReference}/submit-form": { "post": { "tags": [ "proposals" ], "summary": "Allows a customer to submit the form.", "operationId": "ProposalFormController_SubmitForm", "consumes": [ "application/json", "text/json", "text/javascript", "application/x-www-form-urlencoded", "application/reports+json" ], "produces": [ "application/json", "text/json", "text/javascript", "application/reports+json" ], "parameters": [ { "name": "proposalReference", "in": "path", "description": "", "required": true, "type": "string" }, { "name": "request", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/ProposalSubmitRequest" } }, { "name": "X-CW-ApiKey", "in": "header", "description": "Codeweavers ApiKey used for public APIs. Additionally a system can be specified by prepending the system name and a hyphen to the ApiKey e.g. \"Codeweavers-************\"", "required": false, "type": "apiKey" }, { "name": "Authorization", "in": "header", "description": "User credentials used server to server required for secure APIs", "required": false, "type": "basic" }, { "name": "X-CW-AuthenticationToken", "in": "header", "description": "User auth token from login required for secure APIs", "required": false, "type": "string" }, { "name": "X-CW-RetailerIdentifier", "in": "header", "description": "Choose a dealer in relation to the authenticating group using a predefined identifier. The action will take place in the context of that retailer.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/RootSuccessResponse" } }, "4XX": { "description": "Request Error", "schema": { "$ref": "#/definitions/RootErrorResponse" } } } } }, "/api/proposals/{reference}/creditrating": { "get": { "tags": [ "proposals" ], "summary": "Retrieve credit rating", "operationId": "ProposalsCreditCheckController_GetCreditRating", "consumes": [], "produces": [ "application/json", "text/json", "text/javascript", "application/reports+json" ], "parameters": [ { "name": "reference", "in": "path", "description": "", "required": true, "type": "string" }, { "name": "X-CW-ApiKey", "in": "header", "description": "Codeweavers ApiKey used for public APIs. Additionally a system can be specified by prepending the system name and a hyphen to the ApiKey e.g. \"Codeweavers-************\"", "required": false, "type": "apiKey" }, { "name": "Authorization", "in": "header", "description": "User credentials used server to server required for secure APIs", "required": false, "type": "basic" }, { "name": "X-CW-AuthenticationToken", "in": "header", "description": "User auth token from login required for secure APIs", "required": false, "type": "string" }, { "name": "X-CW-RetailerIdentifier", "in": "header", "description": "Choose a dealer in relation to the authenticating group using a predefined identifier. The action will take place in the context of that retailer.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CreditCheckResponse" } }, "4XX": { "description": "Request Error", "schema": { "$ref": "#/definitions/RootErrorResponse" } } } } }, "/api/proposals/{proposalReference}/consent": { "get": { "tags": [ "proposals" ], "summary": "Get a proposal form resource.", "operationId": "ConsentController_RetrievePolicyConsent", "consumes": [], "produces": [ "application/json", "text/json", "text/javascript", "application/reports+json" ], "parameters": [ { "name": "proposalReference", "in": "path", "description": "The reference of the proposal to retrieve the privacy policy.", "required": true, "type": "string" }, { "name": "request.policyType", "in": "query", "description": "Indicates the policy and permissions that requires consent", "required": true, "type": "string", "enum": [ "Dpa", "MccDpa", "CloseOnlyDpa", "ConfusedPrivacyPolicy", "RetailerLeadCapture", "Account", "Eligibility", "MercedesCreditConsent", "ContactCapture", "DeliveryAddress", "ReservationTermsAndConditions", "AdditionalApplicantProposalCapturePrivacyPolicy", "FinanceApply", "MotorCreditCheck", "EmailMeThisQuote", "Marketing", "CommissionCapture", "Reserve", "ProposalCapture", "QuoteSave", "SoftSearch", "ContactForm", "PartExchange", "IddCapture" ] }, { "name": "X-CW-ApiKey", "in": "header", "description": "Codeweavers ApiKey used for public APIs. Additionally a system can be specified by prepending the system name and a hyphen to the ApiKey e.g. \"Codeweavers-************\"", "required": false, "type": "apiKey" }, { "name": "Authorization", "in": "header", "description": "User credentials used server to server required for secure APIs", "required": false, "type": "basic" }, { "name": "X-CW-AuthenticationToken", "in": "header", "description": "User auth token from login required for secure APIs", "required": false, "type": "string" }, { "name": "X-CW-RetailerIdentifier", "in": "header", "description": "Choose a dealer in relation to the authenticating group using a predefined identifier. The action will take place in the context of that retailer.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PrivacyPolicyResponse" } }, "4XX": { "description": "Request Error", "schema": { "$ref": "#/definitions/RootErrorResponse" } } } }, "post": { "tags": [ "proposals" ], "summary": "Get a proposal form resource.", "operationId": "ConsentController_RecordPolicyConsent", "consumes": [ "application/json", "text/json", "text/javascript", "application/x-www-form-urlencoded", "application/reports+json" ], "produces": [ "application/json", "text/json", "text/javascript", "application/reports+json" ], "parameters": [ { "name": "proposalReference", "in": "path", "description": "The reference of the proposal to update the privacy policy consent.", "required": true, "type": "string" }, { "name": "request", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/PrivacyPolicyConsentRequest" } }, { "name": "X-CW-ApiKey", "in": "header", "description": "Codeweavers ApiKey used for public APIs. Additionally a system can be specified by prepending the system name and a hyphen to the ApiKey e.g. \"Codeweavers-************\"", "required": false, "type": "apiKey" }, { "name": "Authorization", "in": "header", "description": "User credentials used server to server required for secure APIs", "required": false, "type": "basic" }, { "name": "X-CW-AuthenticationToken", "in": "header", "description": "User auth token from login required for secure APIs", "required": false, "type": "string" }, { "name": "X-CW-RetailerIdentifier", "in": "header", "description": "Choose a dealer in relation to the authenticating group using a predefined identifier. The action will take place in the context of that retailer.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } }, "4XX": { "description": "Request Error", "schema": { "$ref": "#/definitions/RootErrorResponse" } } } } }, "/api/proposals/{proposalReference}/auth/guestSession": { "post": { "tags": [ "proposals" ], "summary": "Create a guest session for a proposal", "operationId": "LoginProposalController_CreateGuestSession", "consumes": [ "application/json", "text/json", "text/javascript", "application/x-www-form-urlencoded", "application/reports+json" ], "produces": [ "application/json", "text/json", "text/javascript", "application/reports+json" ], "parameters": [ { "name": "proposalReference", "in": "path", "description": "", "required": true, "type": "string" }, { "name": "request", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/ProposalCreateGuestSessionRequest" } }, { "name": "X-CW-ApiKey", "in": "header", "description": "Codeweavers ApiKey used for public APIs. Additionally a system can be specified by prepending the system name and a hyphen to the ApiKey e.g. \"Codeweavers-************\"", "required": false, "type": "apiKey" }, { "name": "Authorization", "in": "header", "description": "User credentials used server to server required for secure APIs", "required": false, "type": "basic" }, { "name": "X-CW-AuthenticationToken", "in": "header", "description": "User auth token from login required for secure APIs", "required": false, "type": "string" }, { "name": "X-CW-RetailerIdentifier", "in": "header", "description": "Choose a dealer in relation to the authenticating group using a predefined identifier. The action will take place in the context of that retailer.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ProposalCreateGuestSessionResponse" } }, "4XX": { "description": "Request Error", "schema": { "$ref": "#/definitions/RootErrorResponse" } } } } }, "/api/finance/defaults": { "post": { "tags": [ "finance" ], "summary": "Retrieve finance defaults", "operationId": "FinanceDefaultsController_CalculateFinanceDefaults", "consumes": [ "application/json", "text/json", "text/javascript", "application/x-www-form-urlencoded", "application/reports+json" ], "produces": [ "application/json", "text/json", "text/javascript", "application/reports+json" ], "parameters": [ { "name": "request", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/FinanceProductParametersRequest" } }, { "name": "X-CW-ApiKey", "in": "header", "description": "Codeweavers ApiKey used for public APIs. Additionally a system can be specified by prepending the system name and a hyphen to the ApiKey e.g. \"Codeweavers-************\"", "required": false, "type": "apiKey" }, { "name": "Authorization", "in": "header", "description": "User credentials used server to server required for secure APIs", "required": false, "type": "basic" }, { "name": "X-CW-AuthenticationToken", "in": "header", "description": "User auth token from login required for secure APIs", "required": false, "type": "string" }, { "name": "X-CW-RetailerIdentifier", "in": "header", "description": "Choose a dealer in relation to the authenticating group using a predefined identifier. The action will take place in the context of that retailer.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/FinanceProductParametersResponse" } }, "4XX": { "description": "Request Error", "schema": { "$ref": "#/definitions/RootErrorResponse" } } } } }, "/api/finance/calculateresidual": { "post": { "tags": [ "finance" ], "summary": "Calculate residual", "operationId": "FinanceCalculateResidualController_CalculateResidual", "consumes": [ "application/json", "text/json", "text/javascript", "application/x-www-form-urlencoded", "application/reports+json" ], "produces": [ "application/json", "text/json", "text/javascript", "application/reports+json" ], "parameters": [ { "name": "request", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/CalculateResidualRequest" } }, { "name": "X-CW-ApiKey", "in": "header", "description": "Codeweavers ApiKey used for public APIs. Additionally a system can be specified by prepending the system name and a hyphen to the ApiKey e.g. \"Codeweavers-************\"", "required": false, "type": "apiKey" }, { "name": "Authorization", "in": "header", "description": "User credentials used server to server required for secure APIs", "required": false, "type": "basic" }, { "name": "X-CW-AuthenticationToken", "in": "header", "description": "User auth token from login required for secure APIs", "required": false, "type": "string" }, { "name": "X-CW-RetailerIdentifier", "in": "header", "description": "Choose a dealer in relation to the authenticating group using a predefined identifier. The action will take place in the context of that retailer.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ResidualResponse" } }, "4XX": { "description": "Request Error", "schema": { "$ref": "#/definitions/RootErrorResponse" } } } } }, "/api/finance/quote/{quoteReference}/termsandconditions": { "get": { "tags": [ "finance" ], "summary": "Retrieve terms and conditions", "operationId": "FinanceQuoteTermsAndConditionsController_RetrieveTermsAndConditions", "consumes": [], "produces": [ "application/json", "text/json", "text/javascript", "application/reports+json" ], "parameters": [ { "name": "quoteReference", "in": "path", "description": "", "required": true, "type": "string" }, { "name": "asHtml", "in": "query", "description": "", "required": false, "type": "boolean" }, { "name": "X-CW-ApiKey", "in": "header", "description": "Codeweavers ApiKey used for public APIs. Additionally a system can be specified by prepending the system name and a hyphen to the ApiKey e.g. \"Codeweavers-************\"", "required": false, "type": "apiKey" }, { "name": "Authorization", "in": "header", "description": "User credentials used server to server required for secure APIs", "required": false, "type": "basic" }, { "name": "X-CW-AuthenticationToken", "in": "header", "description": "User auth token from login required for secure APIs", "required": false, "type": "string" }, { "name": "X-CW-RetailerIdentifier", "in": "header", "description": "Choose a dealer in relation to the authenticating group using a predefined identifier. The action will take place in the context of that retailer.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TermsAndConditionsResponse" } }, "4XX": { "description": "Request Error", "schema": { "$ref": "#/definitions/RootErrorResponse" } } } } }, "/api/finance/calculatefordisplay": { "post": { "tags": [ "finance" ], "summary": "Calculate finance with content", "operationId": "CalculateForDisplayController_CalculateForDisplay", "consumes": [ "application/json", "text/json", "text/javascript", "application/x-www-form-urlencoded", "application/reports+json" ], "produces": [ "application/json", "text/json", "text/javascript", "application/reports+json" ], "parameters": [ { "name": "request", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/CalculateForDisplayRequest" } }, { "name": "X-CW-ApiKey", "in": "header", "description": "Codeweavers ApiKey used for public APIs. Additionally a system can be specified by prepending the system name and a hyphen to the ApiKey e.g. \"Codeweavers-************\"", "required": false, "type": "apiKey" }, { "name": "Authorization", "in": "header", "description": "User credentials used server to server required for secure APIs", "required": false, "type": "basic" }, { "name": "X-CW-AuthenticationToken", "in": "header", "description": "User auth token from login required for secure APIs", "required": false, "type": "string" }, { "name": "X-CW-RetailerIdentifier", "in": "header", "description": "Choose a dealer in relation to the authenticating group using a predefined identifier. The action will take place in the context of that retailer.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CalculateForDisplayResponse" } }, "4XX": { "description": "Request Error", "schema": { "$ref": "#/definitions/RootErrorResponse" } } } } }, "/api/digital-retail-store": { "get": { "tags": [ "digital-retail-store" ], "summary": "Retrieve all required information to build a store.", "operationId": "DigitalRetailStoreController_PresentDigitalRetailStore", "consumes": [], "produces": [ "application/json", "text/json", "text/javascript", "application/reports+json" ], "parameters": [ { "name": "X-CW-ApiKey", "in": "header", "description": "Codeweavers ApiKey used for public APIs. Additionally a system can be specified by prepending the system name and a hyphen to the ApiKey e.g. \"Codeweavers-************\"", "required": false, "type": "apiKey" }, { "name": "Authorization", "in": "header", "description": "User credentials used server to server required for secure APIs", "required": false, "type": "basic" }, { "name": "X-CW-AuthenticationToken", "in": "header", "description": "User auth token from login required for secure APIs", "required": false, "type": "string" }, { "name": "X-CW-RetailerIdentifier", "in": "header", "description": "Choose a dealer in relation to the authenticating group using a predefined identifier. The action will take place in the context of that retailer.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PresentDigitalRetailStore" } }, "4XX": { "description": "Request Error", "schema": { "$ref": "#/definitions/RootErrorResponse" } } } } }, "/api/digital-retail-store/action-availabilities": { "post": { "tags": [ "digital-retail-store" ], "summary": "Retrieve all required information to know which actions for a store are available. This uses the store to determine if the organisation has the required setup to make an action available.", "operationId": "DigitalRetailStoreController_PresentDigitalRetailStoreActionAvailabilities", "consumes": [], "produces": [ "application/json", "text/json", "text/javascript", "application/reports+json" ], "parameters": [ { "name": "X-CW-ApiKey", "in": "header", "description": "Codeweavers ApiKey used for public APIs. Additionally a system can be specified by prepending the system name and a hyphen to the ApiKey e.g. \"Codeweavers-************\"", "required": false, "type": "apiKey" }, { "name": "Authorization", "in": "header", "description": "User credentials used server to server required for secure APIs", "required": false, "type": "basic" }, { "name": "X-CW-AuthenticationToken", "in": "header", "description": "User auth token from login required for secure APIs", "required": false, "type": "string" }, { "name": "X-CW-RetailerIdentifier", "in": "header", "description": "Choose a dealer in relation to the authenticating group using a predefined identifier. The action will take place in the context of that retailer.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PresentDigitalRetailStoreActionAvailabilities" } }, "4XX": { "description": "Request Error", "schema": { "$ref": "#/definitions/RootErrorResponse" } } } } }, "/api/digital-retail-store/sitemap-data": { "get": { "tags": [ "digital-retail-store" ], "summary": "Retrieve all required information to serve a dynamic sitemap.xml file", "operationId": "DigitalRetailStoreController_PresentDigitalRetailStoreSiteMap", "consumes": [], "produces": [ "application/json", "text/json", "text/javascript", "application/reports+json" ], "parameters": [ { "name": "X-CW-ApiKey", "in": "header", "description": "Codeweavers ApiKey used for public APIs. Additionally a system can be specified by prepending the system name and a hyphen to the ApiKey e.g. \"Codeweavers-************\"", "required": false, "type": "apiKey" }, { "name": "Authorization", "in": "header", "description": "User credentials used server to server required for secure APIs", "required": false, "type": "basic" }, { "name": "X-CW-AuthenticationToken", "in": "header", "description": "User auth token from login required for secure APIs", "required": false, "type": "string" }, { "name": "X-CW-RetailerIdentifier", "in": "header", "description": "Choose a dealer in relation to the authenticating group using a predefined identifier. The action will take place in the context of that retailer.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PresentDigitalRetailStoreSiteMap" } }, "4XX": { "description": "Request Error", "schema": { "$ref": "#/definitions/RootErrorResponse" } } } } }, "/api/digital-retail-store/robots-data": { "get": { "tags": [ "digital-retail-store" ], "summary": "Retrieve all required information to serve a dynamic robots.txt file", "operationId": "DigitalRetailStoreController_PresentDigitalRetailStoreRobots", "consumes": [], "produces": [ "application/json", "text/json", "text/javascript", "application/reports+json" ], "parameters": [ { "name": "X-CW-ApiKey", "in": "header", "description": "Codeweavers ApiKey used for public APIs. Additionally a system can be specified by prepending the system name and a hyphen to the ApiKey e.g. \"Codeweavers-************\"", "required": false, "type": "apiKey" }, { "name": "Authorization", "in": "header", "description": "User credentials used server to server required for secure APIs", "required": false, "type": "basic" }, { "name": "X-CW-AuthenticationToken", "in": "header", "description": "User auth token from login required for secure APIs", "required": false, "type": "string" }, { "name": "X-CW-RetailerIdentifier", "in": "header", "description": "Choose a dealer in relation to the authenticating group using a predefined identifier. The action will take place in the context of that retailer.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PresentDigitalRetailStoreRobotsFile" } }, "4XX": { "description": "Request Error", "schema": { "$ref": "#/definitions/RootErrorResponse" } } } } }, "/api/digital-retail-store/landing-page": { "get": { "tags": [ "digital-retail-store" ], "summary": "Retrieve all required information to build a landing page.", "operationId": "DigitalRetailStoreController_PresentDigitalRetailStoreLandingPage", "consumes": [], "produces": [ "application/json", "text/json", "text/javascript", "application/reports+json" ], "parameters": [ { "name": "X-CW-ApiKey", "in": "header", "description": "Codeweavers ApiKey used for public APIs. Additionally a system can be specified by prepending the system name and a hyphen to the ApiKey e.g. \"Codeweavers-************\"", "required": false, "type": "apiKey" }, { "name": "Authorization", "in": "header", "description": "User credentials used server to server required for secure APIs", "required": false, "type": "basic" }, { "name": "X-CW-AuthenticationToken", "in": "header", "description": "User auth token from login required for secure APIs", "required": false, "type": "string" }, { "name": "X-CW-RetailerIdentifier", "in": "header", "description": "Choose a dealer in relation to the authenticating group using a predefined identifier. The action will take place in the context of that retailer.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PresentDigitalRetailStoreLandingPage" } }, "4XX": { "description": "Request Error", "schema": { "$ref": "#/definitions/RootErrorResponse" } } } } }, "/api/digital-retail-store/{slug}/vehicle-search-page": { "get": { "tags": [ "digital-retail-store" ], "summary": "Retrieve all required information to build a vehicles search page.", "operationId": "DigitalRetailStoreController_PresentDigitalRetailStoreVehicleSearchPage", "consumes": [], "produces": [ "application/json", "text/json", "text/javascript", "application/reports+json" ], "parameters": [ { "name": "slug", "in": "path", "required": true, "type": "string" }, { "name": "schemeReference", "in": "query", "required": false, "type": "string" }, { "name": "X-CW-ApiKey", "in": "header", "description": "Codeweavers ApiKey used for public APIs. Additionally a system can be specified by prepending the system name and a hyphen to the ApiKey e.g. \"Codeweavers-************\"", "required": false, "type": "apiKey" }, { "name": "Authorization", "in": "header", "description": "User credentials used server to server required for secure APIs", "required": false, "type": "basic" }, { "name": "X-CW-AuthenticationToken", "in": "header", "description": "User auth token from login required for secure APIs", "required": false, "type": "string" }, { "name": "X-CW-RetailerIdentifier", "in": "header", "description": "Choose a dealer in relation to the authenticating group using a predefined identifier. The action will take place in the context of that retailer.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PresentDigitalRetailStoreVehicleSearchPage" } }, "4XX": { "description": "Request Error", "schema": { "$ref": "#/definitions/RootErrorResponse" } } } } }, "/api/digital-retail-store/{slug}/vehicle-details-page/{hash}": { "get": { "tags": [ "digital-retail-store" ], "summary": "Retrieve all required information to build a vehicles details page.", "operationId": "DigitalRetailStoreController_PresentDigitalRetailStoreVehicleDetailsPage", "consumes": [], "produces": [ "application/json", "text/json", "text/javascript", "application/reports+json" ], "parameters": [ { "name": "slug", "in": "path", "required": true, "type": "string" }, { "name": "hash", "in": "path", "required": true, "type": "string" }, { "name": "schemeReference", "in": "query", "required": false, "type": "string" }, { "name": "X-CW-ApiKey", "in": "header", "description": "Codeweavers ApiKey used for public APIs. Additionally a system can be specified by prepending the system name and a hyphen to the ApiKey e.g. \"Codeweavers-************\"", "required": false, "type": "apiKey" }, { "name": "Authorization", "in": "header", "description": "User credentials used server to server required for secure APIs", "required": false, "type": "basic" }, { "name": "X-CW-AuthenticationToken", "in": "header", "description": "User auth token from login required for secure APIs", "required": false, "type": "string" }, { "name": "X-CW-RetailerIdentifier", "in": "header", "description": "Choose a dealer in relation to the authenticating group using a predefined identifier. The action will take place in the context of that retailer.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PresentDigitalRetailStoreVehicleDetailsPage" } }, "4XX": { "description": "Request Error", "schema": { "$ref": "#/definitions/RootErrorResponse" } } } } }, "/api/digital-retail-store/{slug}/vehicle-details-page/{hash}/action-availabilities": { "post": { "tags": [ "digital-retail-store" ], "summary": "Retrieve all required information to know which actions for a vehicles details page are available. This uses the vehicle and its quote to determine if the organisation they are linked to has the required setup to make an action available.", "operationId": "DigitalRetailStoreController_PresentDigitalRetailStoreVehicleDetailsPageActionAvailabilities", "consumes": [ "application/json", "text/json", "text/javascript", "application/x-www-form-urlencoded", "application/reports+json" ], "produces": [ "application/json", "text/json", "text/javascript", "application/reports+json" ], "parameters": [ { "name": "slug", "in": "path", "required": true, "type": "string" }, { "name": "hash", "in": "path", "required": true, "type": "string" }, { "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/PresentDigitalRetailStoreVehicleDetailsPageActionAvailabilitiesRequest" } }, { "name": "X-CW-ApiKey", "in": "header", "description": "Codeweavers ApiKey used for public APIs. Additionally a system can be specified by prepending the system name and a hyphen to the ApiKey e.g. \"Codeweavers-************\"", "required": false, "type": "apiKey" }, { "name": "Authorization", "in": "header", "description": "User credentials used server to server required for secure APIs", "required": false, "type": "basic" }, { "name": "X-CW-AuthenticationToken", "in": "header", "description": "User auth token from login required for secure APIs", "required": false, "type": "string" }, { "name": "X-CW-RetailerIdentifier", "in": "header", "description": "Choose a dealer in relation to the authenticating group using a predefined identifier. The action will take place in the context of that retailer.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PresentDigitalRetailStoreVehicleDetailsPageActionAvailabilities" } }, "4XX": { "description": "Request Error", "schema": { "$ref": "#/definitions/RootErrorResponse" } } } } }, "/api/digital-retail-store/navigate-to/vehicle-details-page/for-vehicle/{dataSet}/{codeType}/{code}": { "get": { "tags": [ "digital-retail-store" ], "summary": "Redirect to the vehicle details page of the requested vehicle using it's codes.", "operationId": "DigitalRetailStoreController_NavigateToDigitalRetailStoreVehicleDetailsPageForVehicle", "consumes": [], "produces": [ "application/json", "text/json", "text/javascript", "application/reports+json" ], "parameters": [ { "name": "dataSet", "in": "path", "required": true, "type": "string", "enum": [ "Unknown", "Cap", "Glass", "Codeweavers", "Ids", "Ivs", "Psa", "CapLcv", "Glasses", "Tfs", "PsaComcar", "Autobiz", "Brego" ] }, { "name": "codeType", "in": "path", "required": true, "type": "string", "enum": [ "Unknown", "CapCarShortCode", "CapLcvShortCode", "CapBikeShortCode", "CapLongCode", "Glass", "Titre", "Ids", "CodeweaversDerivativeIdentifier", "CodeweaversStockIdentifier", "Ivs", "ExternalVehicleId", "Vrm", "Vin", "Vid", "BmvsCode", "KeeId", "JLR5000Code", "FcaConfiguratorSlug", "VolvoCode", "JlrComboCode", "AutoTraderDerivativeIdentifier", "FreeText", "TeslaDescription", "BaumusterCode", "TribalDerivativeIdentifier", "SkodaCode", "SeatCode", "VolkswagenCode", "AudiCode", "CazanaId", "Jato", "Mpv", "SubaruCode", "Infocar", "VolvoConfigurationCode", "TriumphCode", "Blvd", "AutobizVersionId", "AutoVistaNatCode", "BregoDerivativeIdentifier" ] }, { "name": "code", "in": "path", "required": true, "type": "string" }, { "name": "X-CW-ApiKey", "in": "header", "description": "Codeweavers ApiKey used for public APIs. Additionally a system can be specified by prepending the system name and a hyphen to the ApiKey e.g. \"Codeweavers-************\"", "required": false, "type": "apiKey" }, { "name": "Authorization", "in": "header", "description": "User credentials used server to server required for secure APIs", "required": false, "type": "basic" }, { "name": "X-CW-AuthenticationToken", "in": "header", "description": "User auth token from login required for secure APIs", "required": false, "type": "string" }, { "name": "X-CW-RetailerIdentifier", "in": "header", "description": "Choose a dealer in relation to the authenticating group using a predefined identifier. The action will take place in the context of that retailer.", "required": false, "type": "string" } ], "responses": { "302": { "description": "Found" }, "4XX": { "description": "Request Error", "schema": { "$ref": "#/definitions/RootErrorResponse" } } } } }, "/api/digital-retail-store/navigate-to/vehicle-details-page/for-vehicle/by-hash/{hash}": { "get": { "tags": [ "digital-retail-store" ], "summary": "Redirect to the vehicle details page of the requested vehicle using it's hash.", "operationId": "DigitalRetailStoreController_NavigateToDigitalRetailStoreVehicleDetailsPageForVehicleByHash", "consumes": [], "produces": [ "application/json", "text/json", "text/javascript", "application/reports+json" ], "parameters": [ { "name": "hash", "in": "path", "required": true, "type": "string" }, { "name": "X-CW-ApiKey", "in": "header", "description": "Codeweavers ApiKey used for public APIs. Additionally a system can be specified by prepending the system name and a hyphen to the ApiKey e.g. \"Codeweavers-************\"", "required": false, "type": "apiKey" }, { "name": "Authorization", "in": "header", "description": "User credentials used server to server required for secure APIs", "required": false, "type": "basic" }, { "name": "X-CW-AuthenticationToken", "in": "header", "description": "User auth token from login required for secure APIs", "required": false, "type": "string" }, { "name": "X-CW-RetailerIdentifier", "in": "header", "description": "Choose a dealer in relation to the authenticating group using a predefined identifier. The action will take place in the context of that retailer.", "required": false, "type": "string" } ], "responses": { "302": { "description": "Found" }, "4XX": { "description": "Request Error", "schema": { "$ref": "#/definitions/RootErrorResponse" } } } } }, "/api/digital-retail-store/navigate-to/vehicle-details-page/for-quote/{quoteReference}": { "get": { "tags": [ "digital-retail-store" ], "summary": "Redirect to the vehicle details page of the requested vehicle using it's quote.", "operationId": "DigitalRetailStoreController_NavigateToDigitalRetailStoreVehicleDetailsPageForQuote", "consumes": [], "produces": [ "application/json", "text/json", "text/javascript", "application/reports+json" ], "parameters": [ { "name": "quoteReference", "in": "path", "required": true, "type": "string" }, { "name": "X-CW-ApiKey", "in": "header", "description": "Codeweavers ApiKey used for public APIs. Additionally a system can be specified by prepending the system name and a hyphen to the ApiKey e.g. \"Codeweavers-************\"", "required": false, "type": "apiKey" }, { "name": "Authorization", "in": "header", "description": "User credentials used server to server required for secure APIs", "required": false, "type": "basic" }, { "name": "X-CW-AuthenticationToken", "in": "header", "description": "User auth token from login required for secure APIs", "required": false, "type": "string" }, { "name": "X-CW-RetailerIdentifier", "in": "header", "description": "Choose a dealer in relation to the authenticating group using a predefined identifier. The action will take place in the context of that retailer.", "required": false, "type": "string" } ], "responses": { "302": { "description": "Found" }, "4XX": { "description": "Request Error", "schema": { "$ref": "#/definitions/RootErrorResponse" } } } } }, "/api/digital-retail-store/header": { "get": { "tags": [ "digital-retail-store" ], "summary": "Retrieve header configuration to be displayed within Digital Store", "operationId": "DigitalRetailStoreController_PresentDigitalRetailStoreHeader", "consumes": [], "produces": [ "application/json", "text/json", "text/javascript", "application/reports+json" ], "parameters": [ { "name": "X-CW-ApiKey", "in": "header", "description": "Codeweavers ApiKey used for public APIs. Additionally a system can be specified by prepending the system name and a hyphen to the ApiKey e.g. \"Codeweavers-************\"", "required": false, "type": "apiKey" }, { "name": "Authorization", "in": "header", "description": "User credentials used server to server required for secure APIs", "required": false, "type": "basic" }, { "name": "X-CW-AuthenticationToken", "in": "header", "description": "User auth token from login required for secure APIs", "required": false, "type": "string" }, { "name": "X-CW-RetailerIdentifier", "in": "header", "description": "Choose a dealer in relation to the authenticating group using a predefined identifier. The action will take place in the context of that retailer.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PresentDigitalRetailStoreHeaderConfiguration" } }, "4XX": { "description": "Request Error", "schema": { "$ref": "#/definitions/RootErrorResponse" } } } } }, "/api/digital-retail-store/footer": { "get": { "tags": [ "digital-retail-store" ], "summary": "Retrieve footer configuration to be displayed within Digital Store", "operationId": "DigitalRetailStoreController_PresentDigitalRetailStoreFooter", "consumes": [], "produces": [ "application/json", "text/json", "text/javascript", "application/reports+json" ], "parameters": [ { "name": "X-CW-ApiKey", "in": "header", "description": "Codeweavers ApiKey used for public APIs. Additionally a system can be specified by prepending the system name and a hyphen to the ApiKey e.g. \"Codeweavers-************\"", "required": false, "type": "apiKey" }, { "name": "Authorization", "in": "header", "description": "User credentials used server to server required for secure APIs", "required": false, "type": "basic" }, { "name": "X-CW-AuthenticationToken", "in": "header", "description": "User auth token from login required for secure APIs", "required": false, "type": "string" }, { "name": "X-CW-RetailerIdentifier", "in": "header", "description": "Choose a dealer in relation to the authenticating group using a predefined identifier. The action will take place in the context of that retailer.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PresentDigitalRetailStoreFooterConfiguration" } }, "4XX": { "description": "Request Error", "schema": { "$ref": "#/definitions/RootErrorResponse" } } } } }, "/api/digital-retail-store/{slug}/content-page": { "get": { "tags": [ "digital-retail-store" ], "summary": "Retrieve all required information for a given content page.", "operationId": "DigitalRetailStoreController_PresentDigitalRetailStoreContentPage", "consumes": [], "produces": [ "application/json", "text/json", "text/javascript", "application/reports+json" ], "parameters": [ { "name": "slug", "in": "path", "required": true, "type": "string" }, { "name": "X-CW-ApiKey", "in": "header", "description": "Codeweavers ApiKey used for public APIs. Additionally a system can be specified by prepending the system name and a hyphen to the ApiKey e.g. \"Codeweavers-************\"", "required": false, "type": "apiKey" }, { "name": "Authorization", "in": "header", "description": "User credentials used server to server required for secure APIs", "required": false, "type": "basic" }, { "name": "X-CW-AuthenticationToken", "in": "header", "description": "User auth token from login required for secure APIs", "required": false, "type": "string" }, { "name": "X-CW-RetailerIdentifier", "in": "header", "description": "Choose a dealer in relation to the authenticating group using a predefined identifier. The action will take place in the context of that retailer.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PresentDigitalRetailStoreContentPage" } }, "4XX": { "description": "Request Error", "schema": { "$ref": "#/definitions/RootErrorResponse" } } } } }, "/api/digital-retail-store/vehicle-details-page/content-areas": { "get": { "tags": [ "digital-retail-store" ], "summary": "Retrieve digital retail store content areas for vehicle detail page.", "operationId": "DigitalRetailStoreController_PresentDigitalRetailStoreContentAreas", "consumes": [], "produces": [ "application/json", "text/json", "text/javascript", "application/reports+json" ], "parameters": [ { "name": "X-CW-ApiKey", "in": "header", "description": "Codeweavers ApiKey used for public APIs. Additionally a system can be specified by prepending the system name and a hyphen to the ApiKey e.g. \"Codeweavers-************\"", "required": false, "type": "apiKey" }, { "name": "Authorization", "in": "header", "description": "User credentials used server to server required for secure APIs", "required": false, "type": "basic" }, { "name": "X-CW-AuthenticationToken", "in": "header", "description": "User auth token from login required for secure APIs", "required": false, "type": "string" }, { "name": "X-CW-RetailerIdentifier", "in": "header", "description": "Choose a dealer in relation to the authenticating group using a predefined identifier. The action will take place in the context of that retailer.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PresentDigitalRetailStoreContentAreas" } }, "4XX": { "description": "Request Error", "schema": { "$ref": "#/definitions/RootErrorResponse" } } } } }, "/api/digital-retail-store/store-builder": { "get": { "tags": [ "digital-retail-store" ], "summary": "Retrieve all store builder pages for the store.", "operationId": "DigitalRetailStoreController_PresentDigitalRetailStoreStoreBuilderPages", "consumes": [], "produces": [ "application/json", "text/json", "text/javascript", "application/reports+json" ], "parameters": [ { "name": "X-CW-ApiKey", "in": "header", "description": "Codeweavers ApiKey used for public APIs. Additionally a system can be specified by prepending the system name and a hyphen to the ApiKey e.g. \"Codeweavers-************\"", "required": false, "type": "apiKey" }, { "name": "Authorization", "in": "header", "description": "User credentials used server to server required for secure APIs", "required": false, "type": "basic" }, { "name": "X-CW-AuthenticationToken", "in": "header", "description": "User auth token from login required for secure APIs", "required": false, "type": "string" }, { "name": "X-CW-RetailerIdentifier", "in": "header", "description": "Choose a dealer in relation to the authenticating group using a predefined identifier. The action will take place in the context of that retailer.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/RetrieveStoreBuilderPagesResponse" } }, "4XX": { "description": "Request Error", "schema": { "$ref": "#/definitions/RootErrorResponse" } } } } }, "/api/digital-retail-store/store-builder/{pageReference}": { "get": { "tags": [ "digital-retail-store" ], "summary": "Retrieve a store builder page by reference.", "operationId": "DigitalRetailStoreController_PresentDigitalRetailStoreStoreBuilderPage", "consumes": [], "produces": [ "application/json", "text/json", "text/javascript", "application/reports+json" ], "parameters": [ { "name": "pageReference", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "X-CW-ApiKey", "in": "header", "description": "Codeweavers ApiKey used for public APIs. Additionally a system can be specified by prepending the system name and a hyphen to the ApiKey e.g. \"Codeweavers-************\"", "required": false, "type": "apiKey" }, { "name": "Authorization", "in": "header", "description": "User credentials used server to server required for secure APIs", "required": false, "type": "basic" }, { "name": "X-CW-AuthenticationToken", "in": "header", "description": "User auth token from login required for secure APIs", "required": false, "type": "string" }, { "name": "X-CW-RetailerIdentifier", "in": "header", "description": "Choose a dealer in relation to the authenticating group using a predefined identifier. The action will take place in the context of that retailer.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/RetrieveStoreBuilderPageResponse" } }, "4XX": { "description": "Request Error", "schema": { "$ref": "#/definitions/RootErrorResponse" } } } } }, "/api/digital-retail-store/search-page/location": { "get": { "tags": [ "digital-retail-store" ], "summary": "Retrieve search page configuration to be displayed within Digital Store", "operationId": "DigitalRetailStoreController_RetrieveDigitalRetailStoreSearchPageLocationConfiguration", "consumes": [], "produces": [ "application/json", "text/json", "text/javascript", "application/reports+json" ], "parameters": [ { "name": "X-CW-ApiKey", "in": "header", "description": "Codeweavers ApiKey used for public APIs. Additionally a system can be specified by prepending the system name and a hyphen to the ApiKey e.g. \"Codeweavers-************\"", "required": false, "type": "apiKey" }, { "name": "Authorization", "in": "header", "description": "User credentials used server to server required for secure APIs", "required": false, "type": "basic" }, { "name": "X-CW-AuthenticationToken", "in": "header", "description": "User auth token from login required for secure APIs", "required": false, "type": "string" }, { "name": "X-CW-RetailerIdentifier", "in": "header", "description": "Choose a dealer in relation to the authenticating group using a predefined identifier. The action will take place in the context of that retailer.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/RetrieveDigitalRetailStoreSearchPageLocationConfigurationResponse" } }, "4XX": { "description": "Request Error", "schema": { "$ref": "#/definitions/RootErrorResponse" } } } } }, "/api/digital-retail-store/financial-disclaimer": { "get": { "tags": [ "digital-retail-store" ], "summary": "Retrieve search page configuration to be displayed within Digital Store", "operationId": "DigitalRetailStoreController_RetrieveDigitalRetailStoreFinancialDisclaimer", "consumes": [], "produces": [ "application/json", "text/json", "text/javascript", "application/reports+json" ], "parameters": [ { "name": "X-CW-ApiKey", "in": "header", "description": "Codeweavers ApiKey used for public APIs. Additionally a system can be specified by prepending the system name and a hyphen to the ApiKey e.g. \"Codeweavers-************\"", "required": false, "type": "apiKey" }, { "name": "Authorization", "in": "header", "description": "User credentials used server to server required for secure APIs", "required": false, "type": "basic" }, { "name": "X-CW-AuthenticationToken", "in": "header", "description": "User auth token from login required for secure APIs", "required": false, "type": "string" }, { "name": "X-CW-RetailerIdentifier", "in": "header", "description": "Choose a dealer in relation to the authenticating group using a predefined identifier. The action will take place in the context of that retailer.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/RetrieveDigitalRetailStoreFinancialDisclaimerResponse" } }, "4XX": { "description": "Request Error", "schema": { "$ref": "#/definitions/RootErrorResponse" } } } } } }, "definitions": { "RootErrorResponse": { "type": "object", "properties": { "Error": { "$ref": "#/definitions/ErrorResponse" } } }, "ErrorResponse": { "type": "object", "properties": { "UserMessage": { "type": "string" }, "TechnicalMessage": { "type": "string" }, "Code": { "type": "string" } } }, "AccountDetailsRetrieveResponse": { "type": "object", "properties": { "Name": { "$ref": "#/definitions/PersonName" }, "Contacts": { "type": "array", "items": { "$ref": "#/definitions/PersonContact" } }, "IsVerified": { "type": "boolean" }, "VerifiedAt": { "format": "date-time", "type": "string" }, "RegisteredAt": { "format": "date-time", "type": "string" }, "Reference": { "type": "string" }, "NotificationSubscriptions": { "type": "array", "items": { "$ref": "#/definitions/NotificationSubscription" } } } }, "PersonName": { "required": [ "Title", "First", "Last" ], "type": "object", "properties": { "Title": { "type": "string" }, "First": { "type": "string" }, "Last": { "type": "string" } } }, "PersonContact": { "type": "object", "properties": { "IsPrimary": { "type": "boolean" }, "Value": { "type": "string" }, "Type": { "enum": [ "Telephone", "Email", "Fax" ], "type": "string" } } }, "NotificationSubscription": { "type": "object", "properties": { "Name": { "type": "string" }, "IsSelected": { "type": "boolean" } } }, "AccountDetailsUpdateRequest": { "required": [ "Name" ], "type": "object", "properties": { "Name": { "$ref": "#/definitions/PersonName" } } }, "UpdatePasswordRequest": { "required": [ "ExistingPassword", "NewPassword" ], "type": "object", "properties": { "ExistingPassword": { "type": "string" }, "NewPassword": { "type": "string" } } }, "RetrievePlatformAvailableApplicationsResponse": { "type": "object", "properties": { "Applications": { "type": "array", "items": { "$ref": "#/definitions/CodeweaversPlatformApplication" } } } }, "CodeweaversPlatformApplication": { "type": "object", "properties": { "DisplayName": { "type": "string" }, "IdentitySlug": { "type": "string" }, "Abbreviation": { "type": "string" }, "LogoColour": { "type": "string" }, "BaseUrl": { "type": "string" }, "IconUrl": { "type": "string" }, "IsAvailableInAppSwitcher": { "type": "boolean" } } }, "GetAllOrdersResponse": { "type": "object", "properties": { "Orders": { "type": "array", "items": { "$ref": "#/definitions/GetOrderResponse" } } } }, "GetOrderResponse": { "type": "object", "properties": { "Reference": { "type": "string" }, "Payments": { "type": "array", "items": { "$ref": "#/definitions/OrderPayment" } }, "Quote": { "$ref": "#/definitions/FinanceQuotesResponse" }, "PartExchange": { "$ref": "#/definitions/PartExchangeResponse" }, "Retailer": { "$ref": "#/definitions/OrganisationResponse" }, "Status": { "$ref": "#/definitions/OrderStatusOverview" }, "CustomerActions": { "type": "array", "items": { "$ref": "#/definitions/CustomerAction" } }, "CreatedAt": { "format": "date-time", "type": "string" }, "Delivery": { "$ref": "#/definitions/OrderDeliveryOverview" } } }, "OrderPayment": { "type": "object", "properties": { "Description": { "type": "string" }, "TransactionDate": { "format": "date-time", "type": "string" }, "Amount": { "format": "double", "type": "number" }, "Type": { "type": "string" }, "Status": { "type": "string" } } }, "FinanceQuotesResponse": { "type": "object", "properties": { "Vehicle": { "$ref": "#/definitions/Vehicle" }, "Retailer": { "$ref": "#/definitions/OrganisationResponse" }, "Finance": { "$ref": "#/definitions/FinanceDetails" } } }, "PartExchangeResponse": { "type": "object", "properties": { "Reference": { "type": "string" }, "Offer": { "$ref": "#/definitions/PartExchangeOffer" }, "OutstandingFinance": { "format": "double", "type": "number" }, "CreatedAt": { "format": "date-time", "type": "string" }, "Offers": { "type": "array", "items": { "$ref": "#/definitions/PartExchangeOffer" } }, "ActiveOffer": { "$ref": "#/definitions/PartExchangeOffer" }, "QuotedOffer": { "$ref": "#/definitions/PartExchangeOffer" }, "PartExchangeVehicle": { "$ref": "#/definitions/PartExchangeVehicle" } } }, "OrganisationResponse": { "type": "object", "properties": { "Name": { "type": "string" }, "Introducer": { "type": "string" }, "Reference": { "type": "string" }, "Address": { "$ref": "#/definitions/OrganisationAddress" }, "Contacts": { "type": "array", "items": { "$ref": "#/definitions/PersonContact" } }, "ExternalReferences": { "type": "array", "items": { "$ref": "#/definitions/OrganisationIdentifier" } }, "ExternalLinks": { "type": "array", "items": { "$ref": "#/definitions/OrganisationExternalLink" } }, "Outlets": { "type": "array", "items": { "$ref": "#/definitions/OrganisationOutlet" } }, "Groups": { "type": "array", "items": { "$ref": "#/definitions/OrganisationGroup" } }, "Website": { "type": "string" }, "Franchise": { "$ref": "#/definitions/OrganisationFranchise" }, "Legal": { "$ref": "#/definitions/OrganisationLegal" }, "StockLocation": { "type": "string" }, "TradingName": { "type": "string" }, "BrandingName": { "type": "string" }, "Theme": { "type": "string" }, "Type": { "type": "string" }, "DistanceFromLocation": { "$ref": "#/definitions/Distance" }, "Active": { "type": "boolean" }, "OrganisationReference": { "type": "string" }, "OrganisationReferences": { "type": "array", "items": { "$ref": "#/definitions/OrganisationReference" } }, "OffersWebsite": { "type": "string" } } }, "OrderStatusOverview": { "type": "object", "properties": { "IsOrderCompleted": { "type": "boolean" }, "IsOrderCancellable": { "type": "boolean" }, "IsCheckoutCompleted": { "type": "boolean" }, "IsOrderEditable": { "type": "boolean" }, "IsFinanceApplicationCompleted": { "type": "boolean" }, "IsReservationCompleted": { "type": "boolean" }, "IsVehicleConfirmed": { "type": "boolean" }, "IsFinanceConfirmed": { "type": "boolean" }, "IsPartExchangeValuationComplete": { "type": "boolean" }, "IsPartExchangeComplete": { "type": "boolean" }, "IsPartExchangeExpired": { "type": "boolean" }, "IsHandoverCompleted": { "type": "boolean" }, "IsHandoverDateConfirmed": { "type": "boolean" }, "IsVapsCompleted": { "type": "boolean" }, "IsPaymentStepCompleted": { "type": "boolean" }, "Order": { "$ref": "#/definitions/OrderOverview" }, "FinanceApplication": { "$ref": "#/definitions/OrderFinanceApplication" }, "Reservation": { "$ref": "#/definitions/OrderReservationStatus" }, "FinanceApplicationStatus": { "$ref": "#/definitions/FinanceApplicationStatus" }, "Validity": { "$ref": "#/definitions/OrderValidity" }, "OrderUpdates": { "type": "array", "items": { "$ref": "#/definitions/OrderUpdate" } } } }, "CustomerAction": { "type": "object", "properties": { "Type": { "type": "string" }, "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "IsComplete": { "type": "boolean" }, "DateCompleted": { "format": "date-time", "type": "string" }, "Notifications": { "type": "array", "items": { "type": "string" } } } }, "OrderDeliveryOverview": { "type": "object", "properties": { "HandoverType": { "enum": [ "NotSet", "ForDelivery", "ForCollection" ], "type": "string" } } }, "Vehicle": { "type": "object", "properties": { "Hash": { "description": "The vehicles unique identifier able to be used for site navigation and lookups.", "type": "string" }, "Reference": { "description": "A reference to this exact version of this vehicle at the point in time the lookup was done.", "type": "string" }, "Images": { "type": "array", "items": { "$ref": "#/definitions/Image" } }, "Videos": { "type": "array", "items": { "$ref": "#/definitions/VehicleVideo" } }, "Physical": { "$ref": "#/definitions/PhysicalVehicle" }, "Specification": { "$ref": "#/definitions/VehicleSpecification" }, "Retailer": { "$ref": "#/definitions/OrganisationResponse" }, "AdditionalData": { "type": "object", "additionalProperties": { "type": "string" } }, "Marketing": { "$ref": "#/definitions/VehicleMarketingInformation", "description": "Allows for custom text to be saved and returned from our services, holding values specific to advertising the vehicle." } } }, "FinanceDetails": { "type": "object", "properties": { "Key": { "type": "string" }, "Quote": { "$ref": "#/definitions/FinanceFigures" }, "Product": { "$ref": "#/definitions/FinanceProduct" }, "Retailer": { "$ref": "#/definitions/OrganisationResponse" } } }, "PartExchangeOffer": { "type": "object", "properties": { "Reference": { "type": "string" }, "Amount": { "format": "double", "type": "number" }, "Expires": { "format": "date-time", "type": "string" }, "HasExpired": { "type": "boolean" }, "Equity": { "format": "double", "type": "number" }, "CreatedAt": { "format": "date-time", "type": "string" }, "Origin": { "enum": [ "Unknown", "ExternalValuation", "CustomRetailerValuation" ], "type": "string" }, "Status": { "enum": [ "Unknown", "Active", "InActive", "Deleted" ], "type": "string" }, "UserReference": { "type": "string" }, "Questions": { "type": "array", "items": { "$ref": "#/definitions/PartExchangeQuestion" } } } }, "PartExchangeQuestion": { "required": [ "Id", "Answer" ], "type": "object", "properties": { "Id": { "type": "string" }, "Answer": { "type": "string" } } }, "PartExchangeVehicle": { "required": [ "Mileage", "MileageUnit", "ExternalReference", "FirstRegistration", "CurrentOwnerRegistration", "Specification" ], "type": "object", "properties": { "Mileage": { "format": "int32", "description": "Amount of miles or kilometers recorded on the vehicle", "maximum": 2147483647, "minimum": 1, "type": "integer" }, "MileageUnit": { "enum": [ "Miles", "Kilometres", "Mil" ], "type": "string" }, "Vin": { "type": "string" }, "ExteriorColour": { "$ref": "#/definitions/PhysicalVehicleColour" }, "InteriorColour": { "$ref": "#/definitions/PhysicalVehicleColour" }, "ExternalReference": { "description": "A reference used by the external system or if exists the part exchange value provider", "type": "string" }, "FirstRegistration": { "$ref": "#/definitions/VehicleRegistration" }, "CurrentOwnerRegistration": { "$ref": "#/definitions/VehicleRegistration" }, "Specification": { "$ref": "#/definitions/PartExchangeSpecification" } } }, "OrganisationAddress": { "type": "object", "properties": { "NameNumber": { "type": "string" }, "Line1": { "type": "string" }, "Line2": { "type": "string" }, "Line3": { "type": "string" }, "TownCity": { "type": "string" }, "County": { "type": "string" }, "Postcode": { "type": "string" }, "Country": { "$ref": "#/definitions/OrganisationAddressCountry" }, "Location": { "$ref": "#/definitions/OrganisationAddressLocation" } } }, "OrganisationIdentifier": { "description": "Identifies the organisation that should be used in the request context.", "required": [ "Type" ], "type": "object", "properties": { "Type": { "enum": [ "AssociatedDealerKey", "CodeweaversReference", "AutotraderDID", "ManufacturerCode", "BlackhorseDealerKey", "FCADealerId", "RCIDealerId", "VWGroupDealerId", "LexDealerID", "CreditasReference", "MbGssn", "MbDealerId", "BentleyDealerId", "VauxhallDealerId", "FleetwareBrokerId", "JBRRetailerId", "GeronimoRetailerReference", "HyundaiDealerId", "BorderwayId", "MGDealerId", "MazdaDealerId", "CloseShortCode", "TFSDealerId", "BmwRetailerId", "VolvoSystemCode", "VolvoSantanderCode", "VolvoLocationCode", "SuzukiRetailerId", "VolvoSelektVendorNumber", "MotordeskRetailerReference", "PSADealerId", "AutoConvert", "PinnacleDealerId", "EurodriveReference", "ModixRetailerReference", "LookersDealerId", "FIMLRetailerCode", "OpelRetailerId", "NavigatorRetailerReference", "MiniRetailerId", "RedfishRetailerReference", "AutofinityDealerId", "BlackhorseGroupId", "MotorradRetailerId", "AutomotivRetailerReference", "CarMoneyNorthWestReference", "NorthridgeRetailerId", "MannIslandDealershipId", "NissanDealerId", "ModixVendorKey", "RCIGroupId", "VolvoParmaCode", "ITTectureDealerId", "AACarsRetailerReference", "CarMoneyReference", "BlueCubesRetailerReference", "MotonovoDealerCode", "BlueskyRetailerReference", "AutoHQRetailerReference", "AlexGottRetailerReference", "67DegreesRetailerReference", "AutoUnionFinanceReference", "NovunaReference", "ToyotaDealerId", "LexusDealerId", "TandemReference", "GenesisDealerId", "NovunaSSOReference", "FocalStrategyRetailerReference", "MotonovoLowRateCode", "BmwBunoID", "NexusPointRetailerReference", "QubaRetailerReference", "BlackHorseEnhancedGfvReference", "IntervivosRetailerReference", "AlpheraReference", "OctaneReference", "HondaDealerId", "CarDealer5RetailerReference", "ClickDealerRetailerReference", "ContactAdvantageRetailerReference", "CreativeCowRetailerReference", "DealernetRetailerReference", "DealerwebRetailerReference", "DesignamiteRetailerReference", "Dragon2000RetailerReference", "GforcesRetailerReference", "HandHRetailerReference", "HaswentRetailerReference", "ICanSeeRetailerReference", "MTCRetailerReference", "PonderosaRetailerReference", "RBPRetailerReference", "RedRouteRetailerReference", "SpectralsRetailerReference", "SpidersnetRetailerReference", "StarkwoodRetailerReference", "TeclanRetailerReference", "ThewholecaboodleRetailerReference", "Web21stRetailerReference", "VirtualShowroomRetailerReference", "DealerWebsRetailerReference", "KeyLoopBusinessUnit" ], "type": "string" }, "Value": { "description": "The value to identify the organisation, typically an ID or a reference.", "type": "string" } } }, "OrganisationExternalLink": { "type": "object", "properties": { "Type": { "enum": [ "Unknown", "Imprint", "Vehicle" ], "type": "string" }, "Value": { "type": "string" } } }, "OrganisationOutlet": { "type": "object", "properties": { "Name": { "type": "string" }, "Reference": { "type": "string" }, "OutletReference": { "type": "string" } } }, "OrganisationGroup": { "type": "object", "properties": { "Name": { "type": "string" }, "Reference": { "type": "string" }, "Type": { "type": "string" }, "GroupReference": { "type": "string" } } }, "OrganisationFranchise": { "type": "object", "properties": { "CapId": { "type": "string" }, "Name": { "type": "string" }, "Logo": { "$ref": "#/definitions/Image" } } }, "OrganisationLegal": { "type": "object", "properties": { "Identifiers": { "$ref": "#/definitions/OrganisationLegalIdentifiers" } } }, "Distance": { "type": "object", "properties": { "Unit": { "enum": [ "Miles", "Kilometres", "Mil" ], "type": "string" }, "Value": { "format": "double", "type": "number" }, "UnitAbbreviation": { "type": "string" } } }, "OrganisationReference": { "type": "object", "properties": { "Key": { "type": "string" }, "Value": { "type": "string" } } }, "OrderOverview": { "type": "object", "properties": { "Type": { "enum": [ "Unknown", "Deleted", "Cancelled", "Created", "Started", "AwaitingDelivery", "Completed", "VehicleOrderedByDealer", "Building", "Reserved", "WaitingForRetailer", "WaitingForCustomer", "QuoteChangedByDealer", "TakenOffline" ], "type": "string" }, "Description": { "type": "string" }, "DisplayName": { "type": "string" } } }, "OrderFinanceApplication": { "type": "object", "properties": { "Type": { "type": "string" }, "Description": { "type": "string" }, "DisplayName": { "type": "string" } } }, "OrderReservationStatus": { "type": "object", "properties": { "Type": { "enum": [ "Unknown", "NotReserved", "Pending", "Reserved", "Expired" ], "type": "string" }, "Description": { "type": "string" }, "ReservedVehicleDoesNotMatchQuoted": { "type": "boolean" } } }, "FinanceApplicationStatus": { "type": "object", "properties": { "DisplayName": { "type": "string" }, "Description": { "type": "string" } } }, "OrderValidity": { "type": "object", "properties": { "QuoteIsValid": { "type": "boolean" }, "VehicleIsValid": { "type": "boolean" }, "ErrorMessage": { "type": "string" } } }, "OrderUpdate": { "type": "object", "properties": { "OrderUpdateType": { "enum": [ "Unknown", "PrivacyPolicyAccepted", "QuoteSubmitted", "QuoteApproved" ], "type": "string" }, "Created": { "format": "date-time", "type": "string" } } }, "Image": { "type": "object", "properties": { "Url": { "type": "string" }, "Description": { "type": "string" }, "AltText": { "type": "string" } } }, "VehicleVideo": { "type": "object", "properties": { "Link": { "type": "string" }, "OriginalLink": { "type": "string" }, "Type": { "enum": [ "Unknown", "YouTube" ], "type": "string" }, "Thumbnail": { "type": "string" } } }, "PhysicalVehicle": { "required": [ "Type", "Status", "OnTheRoadPrice" ], "type": "object", "properties": { "Type": { "enum": [ "Unknown", "Car", "Lcv", "Bike", "Other", "NonVehicleAsset" ], "type": "string" }, "ExternalVehicleId": { "description": "This is your unique identifier for the vehicle. It should be unique across all your vehicles and try not to recycle them. Suggestions are VRM or VIN, but it can be anything.", "type": "string" }, "SourceVehicleId": { "description": "This is the unique identifier for the vehicle from it's original source. It should be unique across all your vehicles and try not to recycle them. Suggestions are VRM or VIN, but it can be anything.", "type": "string" }, "Vin": { "description": "If known, the Vin helps identify your vehicle is you have vehicle lookups enabled.", "type": "string" }, "Status": { "enum": [ "Unknown", "PreOwned", "Preregistered", "Demonstrator", "New", "BuildToOrder" ], "type": "string" }, "CostBreakdown": { "$ref": "#/definitions/CostBreakdown", "description": "If you want to specify a breakdown of the OnTheRoadPrice you can do this here. Mostly applicable for new vehicles." }, "OnTheRoadPrice": { "format": "double", "description": "The price the customer must pay to drive away with the vehicle (includes all non-financed fees, where applicable)", "maximum": 999999999, "minimum": 1, "type": "number" }, "IsReserved": { "description": "read-only. mostly for responses, has no effect on imports (see ReservedDate)", "type": "boolean" }, "Mileage": { "format": "int32", "description": "current Odometer reading for the vehicle", "type": "integer" }, "MileageUnit": { "enum": [ "Miles", "Kilometres", "Mil" ], "type": "string" }, "MileageVerified": { "type": "boolean" }, "InteriorColour": { "$ref": "#/definitions/PhysicalVehicleColour" }, "ExteriorColour": { "$ref": "#/definitions/PhysicalVehicleColour" }, "CodeweaversStockIdentifier": { "description": "This is the unique vehicle identifier in the Codeweavers system - it will be assigned by codeweavers when stock is saved so you should not specify it for imports", "type": "string" }, "IsFranchiseApproved": { "description": "Indicating whether or not the vehicle is in a franchise approved programme.", "type": "boolean" }, "FranchiseApprovedProgramme": { "description": "The name of the franchise approved programme.", "type": "string" }, "NumberOfRegisteredOwners": { "format": "int32", "description": "The number of registered owners this vehicle has had.", "type": "integer" }, "DateRetailerReceivedVehicle": { "format": "date-time", "type": "string" }, "Registration": { "$ref": "#/definitions/VehicleRegistration" }, "Source": { "description": "set by codeweavers on stock saving", "type": "string" }, "EquipmentOptions": { "type": "array", "items": { "$ref": "#/definitions/VehicleEquipmentOption" } }, "ExternalVehicleLink": { "description": "link to the vehicle on your website", "type": "string" }, "ExternalLinks": { "type": "array", "items": { "$ref": "#/definitions/ExternalLink" } }, "Images": { "type": "array", "items": { "$ref": "#/definitions/Image" } }, "Videos": { "description": "Link for vehicle video", "type": "array", "items": { "$ref": "#/definitions/VehicleVideo" } }, "ValueAddedProducts": { "type": "array", "items": { "$ref": "#/definitions/ValueAddedProductInformation" } }, "Codes": { "description": "If you know the vehicle codes you can provide them here, if not and you have vehicle lookup enabled these will be populated as part of the lookup", "type": "array", "items": { "$ref": "#/definitions/Code" } }, "DateOfManufacture": { "format": "date-time", "type": "string" }, "VatStatus": { "description": "if vat needs paying on the vehicle", "enum": [ "Unknown", "NotPaid", "FullyPaid", "Margin", "StandardVatAsDeposit" ], "type": "string" }, "EnvironmentalData": { "$ref": "#/definitions/EnvironmentalData" }, "LastUpdated": { "format": "date-time", "type": "string" }, "FundingStatus": { "description": " Paid = Retailer has to be contacted directly if another wishes to fulfill an order using this vehicle\r\n Consigned = Retailer has been assigned the vehicle, however any other retailer can use this vehicle to fulfill an order\r\nUnConsigned = No retailer has a relationship with the vehicle and any is able to use it to fulfill an order", "enum": [ "Unknown", "Paid", "Consigned", "UnConsigned" ], "type": "string" }, "FactoryOrderNumber": { "type": "string" }, "PricingIncludesGovernmentGrant": { "description": "set this to true if the vehicle price already includes the government grant for electric vehicles", "type": "boolean" }, "NoLongerAvailable": { "description": "this is true if the vehicle is no longer available (eg, no longer in stock, or has been reserved)", "type": "boolean" }, "ReservedDate": { "format": "date-time", "description": "ReservedDate can be used to mark a vehicle reserved in an external system (vehicles reserved through the codeweavers platform get this for applied as part of the reservation process)\r\nNote that reserved vehicles generally don't calculate or appear in stock searches by default.\r\nLeave null or empty for un-reserved vehicles, set it to a date (eg '2021-06-23') for reserved vehicles", "type": "string" }, "CataloguePrice": { "format": "double", "description": "The price of the vehicle when it was new.", "type": "number" } } }, "VehicleSpecification": { "type": "object", "properties": { "CostBreakdown": { "$ref": "#/definitions/CostBreakdown" }, "CostBreakdownExcludingSalesTax": { "$ref": "#/definitions/CostBreakdown" }, "Tax": { "$ref": "#/definitions/VehicleTaxes" }, "OnTheRoadPrice": { "format": "double", "type": "number" }, "FuelType": { "type": "string" }, "Transmission": { "type": "string" }, "MilesPerGallon": { "format": "double", "type": "number" }, "EnginePower": { "$ref": "#/definitions/EnginePower" }, "Emissions": { "format": "double", "type": "number" }, "Manufacturer": { "type": "string" }, "Model": { "type": "string" }, "Variant": { "type": "string" }, "Derivative": { "type": "string" }, "TrimName": { "type": "string" }, "TrimCode": { "format": "int32", "type": "integer" }, "Doors": { "format": "int32", "type": "integer" }, "Drive": { "type": "string" }, "BodyStyle": { "type": "string" }, "Description": { "type": "string" }, "BootCapacity": { "format": "int32", "type": "integer" }, "EngineSize": { "format": "int32", "type": "integer" }, "Seats": { "format": "int32", "type": "integer" }, "ZeroTo60": { "format": "double", "type": "number" }, "DiscontinuedDate": { "format": "date-time", "type": "string" }, "IntroducedDate": { "format": "date-time", "type": "string" }, "Type": { "enum": [ "Unknown", "Car", "Lcv", "Bike", "Other", "NonVehicleAsset" ], "type": "string" }, "GovernmentGrantCategory": { "type": "string" }, "DataSet": { "enum": [ "Unknown", "Cap", "Glass", "Codeweavers", "Ids", "Ivs", "Psa", "CapLcv", "Glasses", "Tfs", "PsaComcar", "Autobiz", "Brego" ], "type": "string" }, "DataSetCode": { "$ref": "#/definitions/Code" }, "Codes": { "type": "array", "items": { "$ref": "#/definitions/Code" } }, "EquipmentOptions": { "type": "array", "items": { "$ref": "#/definitions/VehicleEquipmentOption" } }, "ModelYear": { "type": "string" }, "IsRde2Compliant": { "type": "boolean" }, "EnvironmentalData": { "$ref": "#/definitions/EnvironmentalData" }, "FiscalPower": { "format": "int32", "type": "integer" }, "SubsequentRoadFundLicence": { "format": "double", "type": "number" }, "SixMonthsSubsequentRoadFundLicence": { "format": "double", "type": "number" } } }, "VehicleMarketingInformation": { "type": "object", "properties": { "Header": { "description": "The primary marketing information for a vehicle. Would normally include the manufacturer and model.", "type": "string" }, "Subheader": { "description": "The secondary marketing information for a vehicle. Would normally include the variant and derivative.", "type": "string" }, "FeaturedBanner": { "description": "The featured marketing information for a vehicle. Would normally include the key features of the vehicle.", "type": "string" }, "Features": { "description": "Selected features that are to be highlighted when displaying vehicle details", "type": "array", "items": { "$ref": "#/definitions/MarketingFeature" } } } }, "FinanceFigures": { "type": "object", "properties": { "TotalPrice": { "format": "double", "type": "number" }, "TotalPriceExcludingDiscounts": { "format": "double", "type": "number" }, "TotalDeposit": { "format": "double", "type": "number" }, "TotalRegularPayment": { "format": "double", "type": "number" }, "TotalFirstPayment": { "format": "double", "type": "number" }, "OnTheRoadPriceIncludingDiscounts": { "format": "double", "type": "number" }, "AdvancedRentals": { "format": "int32", "type": "integer" }, "Deposit": { "$ref": "#/definitions/FinanceDeposit" }, "Balance": { "format": "double", "type": "number" }, "Term": { "format": "int32", "type": "integer" }, "Residual": { "format": "double", "type": "number" }, "ExcessMileageRate": { "format": "double", "type": "number" }, "UnderMileageRate": { "format": "double", "type": "number" }, "AnnualMileage": { "format": "int32", "type": "integer" }, "ContractMileage": { "format": "int32", "type": "integer" }, "Fees": { "type": "array", "items": { "$ref": "#/definitions/FinanceFee" } }, "Apr": { "format": "double", "type": "number" }, "TotalAmountPayable": { "format": "double", "type": "number" }, "RateOfInterest": { "format": "double", "type": "number" }, "QuoteActions": { "type": "object", "additionalProperties": { "type": "string" } }, "Payments": { "type": "array", "items": { "$ref": "#/definitions/FinancePayment" } }, "RegularPayment": { "format": "double", "type": "number" }, "QuoteReference": { "type": "string" }, "ValidFrom": { "format": "date-time", "type": "string" }, "ValidTo": { "format": "date-time", "type": "string" }, "RegisterBy": { "format": "date-time", "type": "string" }, "ChargesForCredit": { "format": "double", "type": "number" }, "HasExpired": { "type": "boolean" }, "Discounts": { "type": "array", "items": { "$ref": "#/definitions/PriceDiscount" } }, "ValueAddedProducts": { "type": "array", "items": { "$ref": "#/definitions/FinanceValueAddedProduct" } }, "QuotedAt": { "format": "date-time", "type": "string" }, "Notifications": { "type": "array", "items": { "$ref": "#/definitions/FinanceNotification" } }, "ContractLength": { "format": "int32", "type": "integer" }, "IsPersonalised": { "type": "boolean" }, "TotalNumberOfRegularPayments": { "format": "int32", "type": "integer" }, "TotalContribution": { "format": "double", "type": "number" }, "IsRepresentativeExample": { "type": "boolean" }, "Accessories": { "type": "array", "items": { "$ref": "#/definitions/FinanceAccessory" } }, "ChannelKey": { "type": "string" }, "PartExchangeOfferReference": { "type": "string" }, "MaintenanceProducts": { "type": "array", "items": { "$ref": "#/definitions/MaintenanceProduct" } }, "Eligibility": { "$ref": "#/definitions/EligibilityCalculationResult" }, "VehicleReference": { "type": "string" }, "Entity": { "type": "string" }, "IsPromotionalFinance": { "type": "boolean" }, "CurrencyCode": { "type": "string" }, "BenefitInKind": { "type": "array", "items": { "$ref": "#/definitions/BenefitInKindResult" } }, "SalarySacrifice": { "type": "array", "items": { "$ref": "#/definitions/SalarySacrificeDetails" } }, "CustomerSelectedCreditTier": { "enum": [ "Unknown", "BelowAverage", "Fair", "Good", "VeryGood", "Excellent" ], "type": "string" }, "PaymentFrequency": { "enum": [ "Monthly", "Quarterly", "Annually" ], "type": "string" }, "WholeLifeCostRental": { "format": "double", "type": "number" }, "CostToDriverRental": { "format": "double", "type": "number" } } }, "FinanceProduct": { "type": "object", "properties": { "Key": { "type": "string" }, "Type": { "type": "string" }, "Name": { "type": "string" }, "TermName": { "type": "string" }, "IsResidualBased": { "type": "boolean" }, "Lender": { "type": "string" }, "LenderReference": { "type": "string" }, "LenderLogo": { "type": "string" }, "ExternalIdentifier": { "type": "string" }, "MaintenanceProvider": { "type": "string" }, "HasApr": { "type": "boolean" }, "FamilyKey": { "type": "string" }, "IsForBusinessUse": { "type": "boolean" }, "PromoCode": { "type": "string" } } }, "PhysicalVehicleColour": { "type": "object", "properties": { "Description": { "type": "string" }, "Value": { "description": "Value is read-only, it gets mapped from the description to set the base colour for facet searches.", "enum": [ "Unknown", "Beige", "Bronze", "Gold", "Indigo", "Pink", "Silver", "White", "Black", "Brown", "Green", "Magenta", "Navy", "Purple", "Turquoise", "Yellow", "Blue", "Burgundy", "Grey", "Maroon", "Orange", "Red" ], "type": "string" }, "ImageUrl": { "type": "string" } } }, "VehicleRegistration": { "type": "object", "properties": { "RegistrationNumber": { "description": "The unique identifier issued by the local authority", "type": "string" }, "DateRegisteredWithDvla": { "format": "date-time", "description": "The date that the registration number was registered with the local authorities", "type": "string" }, "CountryCode": { "description": "Country the registration took place supplied is ISO 3166-1 alpha-2 format https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2", "type": "string" } } }, "PartExchangeSpecification": { "required": [ "Manufacturer", "Model", "Type" ], "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Manufacturer": { "type": "string" }, "Model": { "type": "string" }, "Derivative": { "type": "string" }, "Description": { "type": "string" }, "Type": { "enum": [ "Unknown", "Car", "Lcv", "Bike", "Other", "NonVehicleAsset" ], "type": "string" }, "Doors": { "format": "int32", "type": "integer" }, "EngineSize": { "format": "int32", "type": "integer" }, "FuelType": { "type": "string" }, "Transmission": { "type": "string" } } }, "OrganisationAddressCountry": { "type": "object", "properties": { "Description": { "type": "string" }, "LanguageCode": { "type": "string" }, "Alpha2Code": { "type": "string" } } }, "OrganisationAddressLocation": { "type": "object", "properties": { "Latitude": { "format": "double", "type": "number" }, "Longitude": { "format": "double", "type": "number" } } }, "OrganisationLegalIdentifiers": { "type": "object", "properties": { "CompanyRegistrationNumber": { "type": "string" }, "CommercialRegistrationNumber": { "type": "string" } } }, "CostBreakdown": { "type": "object", "properties": { "BasePrice": { "format": "double", "type": "number" }, "RoadFundLicence": { "format": "double", "type": "number" }, "RegistrationFee": { "format": "double", "type": "number" }, "Delivery": { "format": "double", "type": "number" }, "RetailerDiscount": { "format": "double", "type": "number" }, "BrandDiscount": { "format": "double", "type": "number" }, "GovernmentGrant": { "format": "double", "type": "number" }, "EquipmentOptionsTotal": { "format": "double", "type": "number" }, "Plates": { "format": "double", "type": "number" }, "GovernmentCharge": { "format": "double", "type": "number" } } }, "VehicleEquipmentOption": { "type": "object", "properties": { "Name": { "type": "string" }, "Description": { "type": "string" }, "Category": { "type": "string" }, "IsStandard": { "type": "boolean" }, "Id": { "type": "string" }, "PackId": { "type": "string" }, "Price": { "format": "double", "type": "number" }, "PriceExcludingSalesTax": { "format": "double", "type": "number" }, "ListPriceExcludingSalesTax": { "format": "double", "type": "number" }, "ListPriceIncludingSalesTax": { "format": "double", "type": "number" }, "IsFeatured": { "type": "boolean" }, "Discount": { "$ref": "#/definitions/OptionDiscount" }, "Classification": { "enum": [ "Unknown", "PanoramicSunroof", "SlidingSunroof", "LeatherSeats", "HeatedSeats", "NavigationSystem", "HeadsUpDisplaySystem", "PremiumSoundSystem", "RearCameraSystem", "FullCameraSystem", "ParkingSensors", "AdaptiveCruiseControl", "Towbar", "AirSuspension", "AppleCarPlay", "AndroidAuto", "StartStop", "BlindSpotMonitoring", "XenonHeadlights", "VolvoOnCall" ], "type": "string" }, "Locale": { "type": "string" } } }, "ExternalLink": { "type": "object", "properties": { "Url": { "type": "string" }, "Type": { "enum": [ "Unknown", "VehicleTaxCalculation", "VehicleAuditing" ], "type": "string" }, "Provider": { "enum": [ "Unknown", "Ototo", "CarPass", "Carfax" ], "type": "string" } } }, "ValueAddedProductInformation": { "type": "object", "properties": { "Name": { "type": "string" }, "IsSelected": { "type": "boolean" }, "Price": { "format": "double", "type": "number" }, "Type": { "enum": [ "Unknown", "Warranty" ], "type": "string" }, "Profile": { "enum": [ "Unknown", "Cash", "RegularPayment" ], "type": "string" }, "Duration": { "$ref": "#/definitions/ValueAddedProductDuration" } } }, "Code": { "required": [ "Type", "Value" ], "type": "object", "properties": { "Type": { "enum": [ "Unknown", "CapCarShortCode", "CapLcvShortCode", "CapBikeShortCode", "CapLongCode", "Glass", "Titre", "Ids", "CodeweaversDerivativeIdentifier", "CodeweaversStockIdentifier", "Ivs", "ExternalVehicleId", "Vrm", "Vin", "Vid", "BmvsCode", "KeeId", "JLR5000Code", "FcaConfiguratorSlug", "VolvoCode", "JlrComboCode", "AutoTraderDerivativeIdentifier", "FreeText", "TeslaDescription", "BaumusterCode", "TribalDerivativeIdentifier", "SkodaCode", "SeatCode", "VolkswagenCode", "AudiCode", "CazanaId", "Jato", "Mpv", "SubaruCode", "Infocar", "VolvoConfigurationCode", "TriumphCode", "Blvd", "AutobizVersionId", "AutoVistaNatCode", "BregoDerivativeIdentifier" ], "type": "string" }, "Value": { "type": "string" } } }, "EnvironmentalData": { "type": "object", "properties": { "IsPreliminary": { "type": "boolean" }, "Fuel": { "$ref": "#/definitions/FuelData" }, "Battery": { "$ref": "#/definitions/BatteryData" }, "Type": { "enum": [ "Unknown", "Configured", "Minimum", "Maximum", "Standard" ], "type": "string" }, "TestingStandardProcedure": { "enum": [ "Unknown", "WLTP", "NEDC" ], "type": "string" }, "Classifications": { "type": "array", "items": { "$ref": "#/definitions/ClassificationData" } } } }, "VehicleTaxes": { "type": "object", "properties": { "TotalAnnualTaxAmount": { "format": "double", "type": "number" } } }, "EnginePower": { "required": [ "Unit", "Value" ], "type": "object", "properties": { "Unit": { "enum": [ "BrakeHorsePower", "Pferdestarke", "Kilowatts", "HorsePower" ], "type": "string" }, "Value": { "format": "int32", "type": "integer" } } }, "MarketingFeature": { "type": "object", "properties": { "Label": { "description": "A label which describes the value being presented.", "type": "string" }, "DisplayLabel": { "description": "A label which describes the value being presented, in a format which is displayable to the customer.", "type": "string" }, "Value": { "description": "The value of the feature.", "type": "string" }, "DisplayValue": { "description": "The value of the feature, in a format which is displayable to the customer.", "type": "string" } } }, "FinanceDeposit": { "type": "object", "properties": { "Cash": { "format": "double", "type": "number" }, "Settlement": { "format": "double", "type": "number" }, "PartExchange": { "format": "double", "type": "number" }, "ManufacturerContribution": { "format": "double", "type": "number" }, "RetailerContribution": { "format": "double", "type": "number" }, "LenderLoyaltyBonus": { "format": "double", "type": "number" }, "LenderContribution": { "format": "double", "type": "number" }, "TaxPayable": { "format": "double", "type": "number" } } }, "FinanceFee": { "type": "object", "properties": { "Type": { "type": "string" }, "Amount": { "format": "double", "type": "number" }, "ExternalIdentifier": { "type": "string" }, "Profile": { "type": "string" } } }, "FinancePayment": { "type": "object", "properties": { "Amount": { "format": "double", "type": "number" }, "NumberOfPayments": { "format": "int32", "type": "integer" } } }, "PriceDiscount": { "type": "object", "properties": { "Type": { "type": "string" }, "Amount": { "format": "double", "type": "number" }, "Description": { "type": "string" } } }, "FinanceValueAddedProduct": { "type": "object", "properties": { "Name": { "type": "string" }, "Profile": { "type": "string" }, "Amount": { "format": "double", "type": "number" }, "Key": { "type": "string" }, "ExternalIdentifier": { "type": "string" }, "Apr": { "format": "double", "type": "number" }, "Type": { "type": "string" }, "VatState": { "enum": [ "Unknown", "Inclusive", "Exclusive" ], "type": "string" }, "VatExempt": { "type": "boolean" }, "IsSelected": { "type": "boolean" }, "TotalAmountPayable": { "format": "double", "type": "number" }, "PaymentSchedule": { "type": "array", "items": { "$ref": "#/definitions/FinancePaymentSchedule" } }, "CostBreakdown": { "type": "array", "items": { "$ref": "#/definitions/FinanceAdditionalPaymentBreakdown" } }, "RegularPayment": { "format": "double", "type": "number" } } }, "FinanceNotification": { "type": "object", "properties": { "Code": { "format": "int32", "type": "integer" }, "Data": { "type": "string" }, "Message": { "type": "string" } } }, "FinanceAccessory": { "type": "object", "properties": { "Name": { "type": "string" }, "Amount": { "format": "double", "type": "number" }, "Identifier": { "type": "string" } } }, "MaintenanceProduct": { "type": "object", "properties": { "Description": { "type": "string" }, "ExternalIdentifier": { "type": "string" }, "Balance": { "format": "double", "type": "number" } } }, "EligibilityCalculationResult": { "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Likelihood": { "format": "double", "type": "number" }, "Apr": { "format": "double", "type": "number" } } }, "BenefitInKindResult": { "type": "object", "properties": { "FinancialYear": { "type": "string" }, "MonthlyCost": { "format": "double", "type": "number" }, "Rate": { "format": "double", "type": "number" } } }, "SalarySacrificeDetails": { "type": "object", "properties": { "FinancialYear": { "type": "string" }, "ActualGrossSacrifice": { "format": "double", "type": "number" }, "NetCostToEmployee": { "format": "double", "type": "number" }, "EmployeeBenefitInKind": { "format": "double", "type": "number" }, "TaxSaving": { "format": "double", "type": "number" }, "NationalInsuranceSaving": { "format": "double", "type": "number" }, "TotalSaving": { "format": "double", "type": "number" } } }, "OptionDiscount": { "type": "object", "properties": { "Type": { "enum": [ "Unknown", "Amount", "Percentage" ], "type": "string" }, "Value": { "format": "double", "type": "number" }, "DiscountedAmountIncludingSalesTax": { "format": "double", "type": "number" }, "DiscountedAmountExcludingSalesTax": { "format": "double", "type": "number" }, "PercentageOfListPrice": { "format": "double", "type": "number" } } }, "ValueAddedProductDuration": { "type": "object", "properties": { "Value": { "format": "int32", "type": "integer" }, "Unit": { "enum": [ "Unknown", "Days", "Weeks", "Months", "Years" ], "type": "string" } } }, "FuelData": { "type": "object", "properties": { "Emissions": { "$ref": "#/definitions/FuelInformation" }, "FuelConsumption": { "$ref": "#/definitions/FuelInformation" } } }, "BatteryData": { "type": "object", "properties": { "RangeConsumption": { "$ref": "#/definitions/BatteryInformation" }, "EnergyConsumption": { "$ref": "#/definitions/BatteryInformation" }, "Health": { "$ref": "#/definitions/BatteryHealth" }, "Capacity": { "$ref": "#/definitions/BatteryCapacity" }, "ChargingInformation": { "$ref": "#/definitions/BatteryChargingInformation" } } }, "TyresData": { "type": "object", "properties": { "EnergyLabels": { "type": "array", "items": { "$ref": "#/definitions/TyreEnergyLabelInformation" } } } }, "ClassificationData": { "type": "object", "properties": { "ClassificationType": { "enum": [ "Unknown", "CritAir", "EuropeanUnionEmissionStandard", "EuropeanUnionEnergyEfficiencyStandard", "Dgt" ], "type": "string" }, "Value": { "type": "string" } } }, "FinancePaymentSchedule": { "type": "object", "properties": { "NumberOfPayments": { "format": "int32", "type": "integer" }, "RegularPayment": { "format": "double", "type": "number" } } }, "FinanceAdditionalPaymentBreakdown": { "type": "object", "properties": { "Type": { "type": "string" }, "Value": { "format": "double", "type": "number" } } }, "FuelInformation": { "type": "object", "properties": { "ExtraHigh": { "format": "double", "type": "number" }, "High": { "format": "double", "type": "number" }, "Medium": { "format": "double", "type": "number" }, "Low": { "format": "double", "type": "number" }, "Combined": { "format": "double", "description": "This field is required to calculate RFL for non hybrid-plugin vehicles", "type": "number" }, "WeightedCombined": { "format": "double", "description": "This field is required to calculate RFL for hybrid-plugin vehicles", "type": "number" } } }, "BatteryInformation": { "type": "object", "properties": { "ExtraHigh": { "format": "double", "type": "number" }, "High": { "format": "double", "type": "number" }, "Medium": { "format": "double", "type": "number" }, "Low": { "format": "double", "type": "number" }, "City": { "format": "double", "type": "number" }, "Combined": { "format": "double", "type": "number" } } }, "BatteryHealth": { "type": "object", "properties": { "Percentage": { "format": "double", "type": "number" } } }, "BatteryCapacity": { "type": "object", "properties": { "Value": { "format": "double", "type": "number" } } }, "BatteryChargingInformation": { "type": "object", "properties": { "MaximumChargingRate": { "format": "double", "type": "number" } } }, "TyreEnergyLabelInformation": { "type": "object", "properties": { "Image": { "$ref": "#/definitions/Image" }, "AppliesTo": { "enum": [ "AllTyres", "FrontTyres", "RearTyres" ], "type": "string" } } }, "GetAllTeamOrdersResponse": { "type": "object", "properties": { "Orders": { "type": "array", "items": { "$ref": "#/definitions/TeamOrderDetails" } } } }, "TeamOrderDetails": { "type": "object", "properties": { "OrderReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "ApplicantName": { "$ref": "#/definitions/PersonName" }, "Status": { "$ref": "#/definitions/OrderStatusOverview" } } }, "GetAllBasketsResponse": { "type": "object", "properties": { "Baskets": { "type": "array", "items": { "$ref": "#/definitions/Basket" } } } }, "Basket": { "type": "object", "properties": { "RetailerId": { "type": "string" }, "LastModified": { "format": "date-time", "type": "string" }, "ItemReferences": { "type": "array", "items": { "type": "string" } } } }, "BasketResponse": { "type": "object", "properties": { "BasketReference": { "type": "string" }, "RetailerId": { "format": "int32", "type": "integer" }, "Items": { "type": "array", "items": { "$ref": "#/definitions/BasketItemResponse" } } } }, "BasketItemResponse": { "type": "object", "properties": { "ItemReference": { "type": "string" }, "Reference": { "type": "string" }, "DetailsPageUrl": { "type": "string" }, "OrderReference": { "type": "string" }, "PartExchange": { "$ref": "#/definitions/PartExchangeResponse" }, "Quote": { "$ref": "#/definitions/FinanceQuotesResponse" }, "Validity": { "$ref": "#/definitions/BasketItemStatus" } } }, "BasketItemStatus": { "type": "object", "properties": { "QuoteIsValid": { "type": "boolean" }, "VehicleIsValid": { "type": "boolean" }, "ErrorMessage": { "type": "string" } } }, "AddItemToBasketRequest": { "type": "object", "properties": { "ItemReference": { "type": "string" }, "QuoteReference": { "type": "string" }, "PartExchangeReference": { "type": "string" }, "OrderReference": { "type": "string" }, "DetailsPageUrl": { "type": "string" } } }, "UpdateBasketItemRequest": { "type": "object", "properties": { "QuoteReference": { "type": "string" }, "PartExchangeReference": { "type": "string" }, "OrderReference": { "type": "string" }, "DetailsPageUrl": { "type": "string" } } }, "AccountPartExchangesResponse": { "type": "object", "properties": { "PartExchangeReferences": { "type": "array", "items": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } }, "PartExchanges": { "type": "array", "items": { "$ref": "#/definitions/PartExchangeResponse" } } } }, "DeleteAllSessionsForUserResponse": { "type": "object", "properties": {} }, "StartEmailVerificationRequestModel": { "required": [ "Username", "ExternalSystemKey" ], "type": "object", "properties": { "Username": { "type": "string" }, "ExternalSystemKey": { "type": "string" }, "Application": { "type": "string" }, "DeliveryMethod": { "enum": [ "DO_NOT_USE", "LINK_IN_EMAIL", "CODE_IN_EMAIL" ], "type": "string" } } }, "CompleteEmailVerificationRequestModel": { "required": [ "Token" ], "type": "object", "properties": { "Token": { "type": "string" } } }, "GetEmailVerificationRequestModel": { "required": [ "Username" ], "type": "object", "properties": { "Username": { "type": "string" } } }, "GetEmailVerificationResponseModel": { "type": "object", "properties": { "Verified": { "type": "boolean" } } }, "MarketingPreferencesForAccountResponse": { "type": "object", "properties": { "Organisations": { "type": "array", "items": { "$ref": "#/definitions/MarketingPreferenceRetailer" } } } }, "MarketingPreferenceRetailer": { "type": "object", "properties": { "MarketingPreferences": { "type": "array", "items": { "$ref": "#/definitions/MarketingPreference" } }, "Organisation": { "$ref": "#/definitions/OrganisationResponse" } } }, "MarketingPreference": { "type": "object", "properties": { "Type": { "enum": [ "Unknown", "Telephone", "Sms", "Email" ], "type": "string" }, "OptedIn": { "type": "boolean" }, "DisplayName": { "type": "string" } } }, "RetailerMarketingPreferencesForAccountResponse": { "type": "object", "properties": { "MarketingPreferences": { "type": "array", "items": { "$ref": "#/definitions/MarketingPreference" } } } }, "UpdateMarketingPreferencesRequest": { "type": "object", "properties": { "MarketingPreferences": { "type": "array", "items": { "$ref": "#/definitions/MarketingPreference" } } } }, "UpdateMarketingPreferencesResponse": { "type": "object", "properties": {} }, "UpdatePartExchangeRequest": { "type": "object", "properties": { "OrganisationIdentifier": { "$ref": "#/definitions/OrganisationIdentifier" } } }, "AccountEventsResponse": { "type": "object", "properties": {} }, "QuoteEventRequest": { "type": "object", "properties": { "Action": { "enum": [ "Unknown", "FinanceAdjusted", "QuoteViewed", "EnquirySubmitted", "EnquiryStarted" ], "type": "string" }, "OrganisationIdentifier": { "$ref": "#/definitions/OrganisationIdentifier" } } }, "GetRoleInvitesNotReviewedResponse": { "type": "object", "properties": { "Results": { "type": "array", "items": { "$ref": "#/definitions/InvitationNotReviewed" } } } }, "InvitationNotReviewed": { "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Email": { "type": "string" }, "RoleName": { "type": "string" }, "TimeOfInvitation": { "format": "date-time", "type": "string" }, "OrganisationCount": { "format": "int32", "type": "integer" }, "InvitedBy": { "type": "string" }, "SystemInvitedTo": { "type": "string" } } }, "RoleInviteReviewRequest": { "type": "object", "properties": { "InviteReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "IsAccepted": { "type": "boolean" } } }, "RoleInviteReviewResponse": { "type": "object", "properties": {} }, "StartSetupResponse": { "type": "object", "properties": { "QrCodeAsBase64String": { "type": "string" }, "ManualEntryDetails": { "$ref": "#/definitions/ManualEntry" } } }, "ManualEntry": { "type": "object", "properties": { "SharedSecret": { "type": "string" }, "Issuer": { "type": "string" }, "Label": { "type": "string" }, "Algorithm": { "type": "string" }, "Type": { "type": "string" }, "TimePeriodInSeconds": { "format": "int32", "type": "integer" }, "NumberOfDigits": { "format": "int32", "type": "integer" } } }, "CompleteSetupRequest": { "required": [ "Code" ], "type": "object", "properties": { "Code": { "type": "string" } } }, "RootSuccessResponse": { "type": "object", "properties": {} }, "DisableRequest": { "required": [ "Code" ], "type": "object", "properties": { "Code": { "type": "string" } } }, "StatusResponse": { "type": "object", "properties": { "Status": { "type": "string" }, "Description": { "type": "string" } } }, "RegenerateBackUpCodesModelResponse": { "type": "object", "properties": { "BackUpCodes": { "type": "array", "items": { "type": "string" } } } }, "StatusResponseV2": { "type": "object", "properties": { "Sms": { "$ref": "#/definitions/TwoFactorAuthenticationStatus" }, "App": { "$ref": "#/definitions/TwoFactorAuthenticationStatus" }, "CanGenerateBackupCodes": { "type": "boolean" }, "BackUpCodes": { "$ref": "#/definitions/BackUpCodes" } } }, "TwoFactorAuthenticationStatus": { "type": "object", "properties": { "Status": { "type": "string" }, "Description": { "type": "string" }, "LastFourDigitsOfMobileNumber": { "type": "string" } } }, "BackUpCodes": { "type": "object", "properties": { "CanGenerateBackupCodes": { "type": "boolean" }, "HasBackupCodes": { "type": "boolean" }, "BackUpCodesRemaining": { "format": "int32", "type": "integer" } } }, "StartSetupRequest": { "required": [ "MobilePhoneNumber" ], "type": "object", "properties": { "MobilePhoneNumber": { "type": "string" } } }, "AbortSetupRequest": { "type": "object", "properties": {} }, "CompleteSetupSmsRequest": { "required": [ "Code" ], "type": "object", "properties": { "Code": { "type": "string" } } }, "DisableSmsBasedRequest": { "required": [ "Code" ], "type": "object", "properties": { "Code": { "type": "string" } } }, "SmsStatusResponse": { "type": "object", "properties": { "Status": { "type": "string" }, "Description": { "type": "string" }, "LastFourDigitsOfMobileNumber": { "type": "string" } } }, "SendCodeToPhoneRequest": { "required": [ "Username", "ExternalSystemKey" ], "type": "object", "properties": { "Username": { "type": "string" }, "ExternalSystemKey": { "type": "string" } } }, "GetUserProposalAccessModel": { "type": "object", "properties": { "ProposalsAccessedByUser": { "type": "array", "items": { "$ref": "#/definitions/ProposalAccessByUserModel" } } } }, "ProposalAccessByUserModel": { "type": "object", "properties": { "ProposalReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "DayOfAccess": { "format": "date-time", "type": "string" } } }, "LoginActivityForUserModel": { "type": "object", "properties": { "LoginActivityForUser": { "type": "array", "items": { "$ref": "#/definitions/UserLoginEventModel" } } } }, "UserLoginEventModel": { "type": "object", "properties": { "OccuredAt": { "format": "date-time", "type": "string" }, "IpAddress": { "type": "string" }, "UserAgent": { "type": "string" }, "Success": { "type": "boolean" }, "ActiveSession": { "type": "boolean" }, "ActiveLogin": { "type": "boolean" }, "Origin": { "type": "string" }, "Referer": { "type": "string" }, "ErrorMessage": { "type": "string" }, "SessionToken": { "type": "string" }, "TlsCipher": { "type": "string" } } }, "EmailActivityForUserModel": { "type": "object", "properties": { "EmailActivityForUser": { "type": "array", "items": { "$ref": "#/definitions/UserEmailEventModel" } }, "IsOnBounceList": { "type": "boolean" }, "IsOnBlockList": { "type": "boolean" }, "IsOnSpamList": { "type": "boolean" } } }, "UserEmailEventModel": { "type": "object", "properties": { "BouncedAt": { "format": "date-time", "type": "string" }, "DeferredAt": { "format": "date-time", "type": "string" }, "DeliveredAt": { "format": "date-time", "type": "string" }, "DroppedAt": { "format": "date-time", "type": "string" }, "ProcessedAt": { "format": "date-time", "type": "string" }, "SentAt": { "format": "date-time", "type": "string" }, "Subject": { "type": "string" }, "WebhookMessageId": { "type": "string" } } }, "DownloadActivityForUserModel": { "type": "object", "properties": { "DownloadActivityForUser": { "type": "array", "items": { "$ref": "#/definitions/UserDownloadEventForUserModel" } } } }, "UserDownloadEventForUserModel": { "type": "object", "properties": { "Day": { "type": "string" }, "SystemRawValue": { "format": "int64", "type": "integer" }, "SystemDisplayValue": { "type": "string" } } }, "GetUserDownloadActivityForDayModel": { "type": "object", "properties": { "Breakdown": { "type": "array", "items": { "$ref": "#/definitions/EndpointNameWithBytes" } } } }, "EndpointNameWithBytes": { "type": "object", "properties": { "Endpoint": { "type": "string" }, "DisplayValue": { "type": "string" }, "RawValue": { "format": "int64", "type": "integer" } } }, "GetBusyUsersAcrossSystemByRoleRequest": { "required": [ "Date" ], "type": "object", "properties": { "Top": { "format": "int32", "maximum": 999, "minimum": 1, "type": "integer" }, "RoleId": { "format": "int32", "maximum": 32, "minimum": 1, "type": "integer" }, "Date": { "type": "string" } } }, "GetBusyUsersAcrossSystemByRoleResponse": { "type": "object", "properties": { "History": { "type": "array", "items": { "$ref": "#/definitions/UserHistory" } } } }, "UserHistory": { "type": "object", "properties": { "Username": { "type": "string" }, "UserReference": { "type": "string" }, "History": { "type": "array", "items": { "$ref": "#/definitions/Information" } } } }, "Information": { "type": "object", "properties": { "DisplayValue": { "type": "string" }, "RawValue": { "format": "int64", "type": "integer" }, "Day": { "type": "string" } } }, "ThirdPartySubscriptionsResponse": { "type": "object", "properties": { "Options": { "type": "array", "items": { "enum": [ "DigitalUnit", "Audi", "VWFS", "VWManufacturer", "Equifax", "Alphabet", "BMWManufacturer", "BMWFS", "MercedesBenzManufacturer", "Motonovo", "Juice", "FCA", "LandRover", "Jaguar", "JLR", "LexAutolease", "Volvo", "Codeweavers", "PSA", "RCI", "Vauxhall", "PSAEurope", "Orchestrator", "Anchor", "BlackHorse", "PSAFinance", "V12", "Bentley", "FinanceIreland", "BnpParibas", "TFS", "AutoTrader", "RobinsAndDay", "OpelFinance", "OpelFinanceItaly", "OpelFinanceSpain", "OpelFinanceFrance", "Octane", "Santander", "AstonMartin", "Novuna", "Northridge", "Honda", "FcaUKImport", "Hyundai" ], "type": "string" } } } }, "RegisterRequest": { "required": [ "Name", "Password", "Email", "ExternalSystemKey" ], "type": "object", "properties": { "Token": { "type": "string" }, "Name": { "$ref": "#/definitions/PersonName" }, "Password": { "type": "string" }, "Email": { "type": "string" }, "PrivacyPolicyAccepted": { "format": "int32", "type": "integer" }, "ExternalSystemKey": { "type": "string" } } }, "VerifyPlatformSingleSignOnTokenRequest": { "required": [ "ExternalSystemKey" ], "type": "object", "properties": { "Provider": { "type": "string" }, "IdToken": { "type": "string" }, "ExternalSystemKey": { "type": "string" }, "Application": { "type": "string" }, "WorkspaceKey": { "type": "string" }, "AccessToken": { "type": "string" } } }, "VerifySingleSignOnTokenModel": { "type": "object", "properties": { "UserToken": { "type": "string" } } }, "SearchUsersCrossSystemRequestModel": { "required": [ "Query" ], "type": "object", "properties": { "Query": { "type": "string" }, "BeginsWithSearch": { "type": "boolean" } } }, "SearchUsersCrossSystemResponseModel": { "type": "object", "properties": { "Results": { "type": "array", "items": { "$ref": "#/definitions/SearchUsersCrossSystemResult" } } } }, "SearchUsersCrossSystemResult": { "type": "object", "properties": { "Username": { "type": "string" }, "IsVerified": { "type": "boolean" }, "UserReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "SystemId": { "format": "int32", "type": "integer" }, "ExternalSystemKey": { "type": "string" }, "RoleName": { "type": "string" }, "ActiveOnSystem": { "type": "boolean" }, "PrimaryDealerId": { "format": "int32", "type": "integer" }, "PrimaryDealerTradingName": { "type": "string" }, "ControlPanelUrl": { "type": "string" }, "LastLogin": { "type": "string" }, "NumberOfLogins": { "format": "int64", "type": "integer" } } }, "CheckActionAvailabilityRequest": { "type": "object", "properties": { "QuoteReference": { "description": "Not necessary if providing either a Proposal or Order reference.\r\nA Quote reference can be obtained via the calculate for display or vehicle search APIs.\r\nThis can also be passed in alongside a Proposal or Order reference; if this is done then the response will say if the action is available for the Proposal or Order if this Quote is appended to it.", "type": "string" }, "ProposalReference": { "description": "Not necessary if providing either a Quote or Order reference.\r\nA Proposal reference can be obtained from the Proposal Initialise API.", "type": "string" }, "OrderReference": { "description": "Not necessary if providing either a Quote or Proposal reference.\r\nAn Order reference can be obtained from the Order Initialise API.", "type": "string" } } }, "CheckActionAvailabilityResponse": { "type": "object", "properties": { "IsActionAvailable": { "description": "Indicates whether the action is available based on the state of the Quote, Order or Proposal.", "type": "boolean" }, "UnavailableReasonCode": { "description": "When the action has been deemed unavailable the reason code can be used to recover the user's journey.\r\n \r\n\"80041\" = No valid quote could be ascertained for an action that requires one.\r\n\"80098\" = No valid payment provider could be found for an action that requires one.\r\n\"80100\" = Vehicle has been reserved and is no longer available.\r\n\"80134\" = A quote has been passed in on a different vehicle to the vehicle currently active on the passed in proposal or order.\r\n\"83016\" = This action is not supported for this type of vehicle.\r\n\"83017\" = The requested proposal or order reference is not a valid order for an action that requires one.\r\n\"83018\" = The requested order has been cancelled.\r\n\"83019\" = The organisation does not have the requested action as part of its setup.\r\n\"83020\" = A different quote has been requested to the one currently on the order after the vehicle has been reserved.\r\n\"83022\" = The vehicle has had its base price amended since the active quote was generated and the customer has not put money down on the vehicle.\r\n\"83031\" = No valid part exchange provider could be found for an action that requires one.\r\n\"83032\" = No valid vehicle alert templates were found.\r\n\"83036\" = The required information to perform the check was not present in the request.\r\n\"83042\" = The digital retail store does not have the requested product as part of its setup.", "type": "string" } } }, "PostcodeLookUpRequest": { "type": "object", "properties": { "Postcode": { "type": "string" } } }, "PostcodeLookupResponse": { "type": "object", "properties": { "Provider": { "enum": [ "Unknown", "Loqate", "Google" ], "type": "string" }, "Addresses": { "type": "array", "items": { "$ref": "#/definitions/PostcodeLookupResult" } } } }, "PostcodeLookupResult": { "type": "object", "properties": { "Id": { "type": "string" }, "Description": { "type": "string" } } }, "AddressLookupResponse": { "type": "object", "properties": { "Address": { "$ref": "#/definitions/AddressLookupResult" } } }, "AddressLookupResult": { "type": "object", "properties": { "NameNumber": { "type": "string" }, "Line1": { "type": "string" }, "Line2": { "type": "string" }, "Line3": { "type": "string" }, "TownCity": { "type": "string" }, "County": { "type": "string" }, "Postcode": { "type": "string" }, "CountryIso2": { "type": "string" } } }, "GeolocationLookupRequest": { "type": "object", "properties": { "CountryCode": { "description": "Geo lookups require a parameter of the country code to be successful. We will default this to your organisations country however if you require to perform a lookup in a different country you can specify the country code to ensure the lookup works as expected.", "type": "string" }, "AddressDescription": { "description": "Allows for a free text search over geolocations.", "type": "string" }, "Longitude": { "format": "double", "description": "Used in conjunction with Latitude, this property will allow for a reverse lookup of an address for the provided geolocation.", "type": "number" }, "Latitude": { "format": "double", "description": "Used in conjunction with Longitude, this property will allow for a reverse lookup of an address for the provided geolocation.", "type": "number" } } }, "GeolocationLookupResponse": { "type": "object", "properties": { "GeoLocationResult": { "$ref": "#/definitions/GeoLocationResult" } } }, "GeoLocationResult": { "type": "object", "properties": { "AddressDescription": { "type": "string" }, "Longitude": { "format": "double", "type": "number" }, "Latitude": { "format": "double", "type": "number" } } }, "GeolocationSearchRequest": { "type": "object", "properties": { "AddressDescription": { "description": "Allows for a free text search over geolocations.", "type": "string" }, "PartialSearch": { "description": "Allows for suggestions to be returned from partial matches.", "type": "boolean" } } }, "GeolocationSearchResponse": { "type": "object", "properties": { "Results": { "type": "array", "items": { "$ref": "#/definitions/GeoLocationResult" } } } }, "AdminFileUploadRequest": { "type": "object", "properties": { "File": { "type": "string" }, "FileName": { "type": "string" } } }, "AdminFileUploadResponse": { "type": "object", "properties": { "FileUrl": { "type": "string" } } }, "AdminUpdateListResponse": { "type": "object", "properties": { "Updates": { "type": "array", "items": { "$ref": "#/definitions/AdminUpdateSummary" } }, "Pagination": { "$ref": "#/definitions/IPaginationResponse" } } }, "AdminUpdateSummary": { "type": "object", "properties": { "Id": { "type": "string" }, "Title": { "type": "string" }, "Summary": { "type": "string" }, "ThumbnailUrl": { "type": "string" }, "PublishedDate": { "format": "date-time", "type": "string" }, "LastEditedDate": { "format": "date-time", "type": "string" }, "ExpirationDate": { "format": "date-time", "type": "string" }, "Tags": { "type": "array", "items": { "type": "string" } } } }, "IPaginationResponse": { "type": "object", "properties": { "Page": { "format": "int32", "type": "integer" }, "ResultsPerPage": { "format": "int32", "type": "integer" }, "TotalPages": { "format": "int32", "type": "integer" }, "TotalResults": { "format": "int32", "type": "integer" } } }, "AdminNewUpdatesResponse": { "type": "object", "properties": { "IdList": { "type": "array", "items": { "type": "string" } }, "Articles": { "type": "array", "items": { "$ref": "#/definitions/AdminUpdateSummary" } } } }, "AdminGetListOfUpdatesRequest": { "type": "object", "properties": { "Page": { "format": "int32", "type": "integer" }, "ResultsPerPage": { "format": "int32", "type": "integer" }, "Tags": { "type": "array", "items": { "type": "string" } }, "RequestedScope": { "enum": [ "AppScoped", "AdminGlobal" ], "type": "string" } } }, "AdminGetSuggestedArticlesRequest": { "type": "object", "properties": { "Id": { "type": "string" }, "Tags": { "type": "array", "items": { "type": "string" } } } }, "AdminSuggestedArticlesResponse": { "type": "object", "properties": { "Articles": { "type": "array", "items": { "$ref": "#/definitions/AdminUpdateSummary" } } } }, "AdminUpdateResponse": { "type": "object", "properties": { "Title": { "type": "string" }, "Content": { "type": "string" }, "BannerUrl": { "type": "string" }, "ThumbnailUrl": { "type": "string" }, "Summary": { "type": "string" }, "PublishedDate": { "format": "date-time", "type": "string" }, "LastEditedDate": { "format": "date-time", "type": "string" }, "ExpirationDate": { "format": "date-time", "type": "string" }, "Tags": { "type": "array", "items": { "type": "string" } } } }, "RetrieveCommerceHubConfigurationResponse": { "type": "object", "properties": { "DuplicateQuote": { "type": "boolean" }, "Providers": { "type": "boolean" }, "PreApproval": { "type": "boolean" }, "UseKanbanBoard": { "type": "boolean" }, "Statistics": { "type": "boolean" }, "Quoting": { "type": "boolean" }, "Leads": { "type": "boolean" }, "Customers": { "type": "boolean" }, "Proposals": { "type": "boolean" }, "ShowroomReporting": { "type": "boolean" }, "ShowroomUserManagement": { "type": "boolean" }, "FourSquare": { "type": "boolean" }, "VehicleSuggestions": { "type": "boolean" }, "ProfileButton": { "type": "boolean" }, "PartExchangeRules": { "type": "boolean" }, "ExportCustomerInformation": { "type": "boolean" }, "ShowroomRemoteApply": { "type": "boolean" }, "FranchiseApprovedVehicleSelection": { "type": "boolean" }, "Orders": { "type": "boolean" }, "Payments": { "type": "boolean" }, "PersistVaps": { "type": "boolean" }, "Volvo": { "type": "boolean" }, "EnableCalculationEndpointStats": { "type": "boolean" }, "ShowEndpointHitsInCalculationStats": { "type": "boolean" }, "ShowroomAccess": { "type": "boolean" }, "Promotions": { "type": "boolean" }, "EnableNonMotorAsset": { "type": "boolean" }, "HideAprFromShowroomQuickQuote": { "type": "boolean" }, "EnableShowroomCommunication": { "type": "boolean" }, "EnableShowroomVaps": { "type": "boolean" }, "SrDisableCommissionOverride": { "type": "boolean" }, "WorkQueues": { "type": "boolean" }, "Vehicles": { "type": "boolean" } } }, "RetrievePluginsConfigurationResponse": { "type": "object", "properties": { "PluginType": { "enum": [ "Unknown", "FinanceFinder", "Flexicalc", "Slidercalc", "Multicalc", "Creditcalc", "Motonovo", "BlackHorse", "Arden", "Alphera", "RollsRoyce", "AstonMartin", "Bentley", "FCA", "LondonTaxiCompany", "Fincalc", "BlackHorseTesla", "BrokerFinanceCalculator" ], "type": "string" }, "SystemKey": { "type": "string" }, "ThemeKey": { "type": "string" }, "ThemeVariant": { "$ref": "#/definitions/AppConfigurationThemeVariant" }, "AuthenticatedOrganisation": { "$ref": "#/definitions/AppConfigurationOrganisation" }, "ContextOrganisation": { "$ref": "#/definitions/AppConfigurationOrganisation" }, "LocaleConfiguration": { "$ref": "#/definitions/AppConfigurationLocaleConfiguration" } } }, "AppConfigurationThemeVariant": { "type": "object", "properties": { "Key": { "type": "string" }, "Name": { "type": "string" }, "CssUrl": { "type": "string" }, "CssVars": { "type": "string" }, "LogoUrl": { "type": "string" }, "LogoHeaderUrl": { "type": "string" }, "FaviconUrl": { "type": "string" }, "NavbarLogoUrl": { "type": "string" }, "VideoStyle": { "type": "string" }, "Videos": { "type": "array", "items": { "$ref": "#/definitions/VideoLink" } } } }, "AppConfigurationOrganisation": { "type": "object", "properties": { "Id": { "type": "string" }, "Name": { "type": "string" }, "Reference": { "type": "string" }, "Language": { "type": "string" }, "CountryCode": { "type": "string" }, "IsoCountryCode": { "enum": [ "Unknown", "Afghanistan", "Albania", "Antarctica", "Algeria", "AmericanSamoa", "Andorra", "Angola", "AntiguaandBarbuda", "Azerbaijan", "Argentina", "Australia", "Austria", "Bahamas", "Bahrain", "Bangladesh", "Armenia", "Barbados", "Belgium", "Bermuda", "Bhutan", "PlurinationalStateofBolivia", "BosniaAndHerzegovina", "Botswana", "BouvetIsland", "Brazil", "Belize", "BritishIndianOceanTerritory", "SolomonIslands", "BritishVirginIslands", "BruneiDarussalam", "Bulgaria", "Myanmar", "Burundi", "Belarus", "Cambodia", "Cameroon", "Canada", "CaboVerde", "CaymanIslands", "CentralAfricanRepublic", "SriLanka", "Chad", "Chile", "China", "TaiwanProvinceofChina", "ChristmasIsland", "CocosKeelingIslands", "Colombia", "Comoros", "Mayotte", "Congo", "DemocraticRepublicoftheCongo", "CookIslands", "CostaRica", "Croatia", "Cuba", "Cyprus", "Czechia", "CzechRepublic", "Benin", "Denmark", "Dominica", "DominicanRepublic", "Ecuador", "ElSalvador", "EquatorialGuinea", "Ethiopia", "Eritrea", "Estonia", "FaroeIslands", "FalklandIslands", "SouthGeorgiaandtheSouthSandwichIslands", "Fiji", "Finland", "ÅlandIslands", "France", "FrenchGuiana", "FrenchPolynesia", "FrenchSouthernTerritories", "Djibouti", "Gabon", "Georgia", "Gambia", "StateofPalestine", "Germany", "Ghana", "Gibraltar", "Kiribati", "Greece", "Greenland", "Grenada", "Guadeloupe", "Guam", "Guatemala", "Guinea", "Guyana", "Haiti", "HeardIslandandMcDonaldIslands", "HolySee", "Honduras", "HongKong", "Hungary", "Iceland", "India", "Indonesia", "Iran", "Iraq", "Ireland", "Israel", "Italy", "CôtedIvoire", "Jamaica", "Japan", "Kazakhstan", "Jordan", "Kenya", "DemocraticPeoplesRepublicofKorea", "RepublicofKorea", "Kuwait", "Kyrgyzstan", "LaoPeoplesDemocraticRepublic", "Lebanon", "Lesotho", "Latvia", "Liberia", "Libya", "Liechtenstein", "Lithuania", "Luxembourg", "Macao", "Madagascar", "Malawi", "Malaysia", "Maldives", "Mali", "Malta", "Martinique", "Mauritania", "Mauritius", "Mexico", "Monaco", "Mongolia", "RepublicofMoldova", "Montenegro", "Montserrat", "Morocco", "Mozambique", "Oman", "Namibia", "Nauru", "Nepal", "Netherlands", "Curaçao", "Aruba", "SintMaartenDutchPart", "BonaireSintEustatiusandSaba", "NewCaledonia", "Vanuatu", "NewZealand", "Nicaragua", "Niger", "Nigeria", "Niue", "NorfolkIsland", "Norway", "NorthernMarianaIslands", "UnitedStatesMinorOutlyingIslands", "FederatedStatesofMicronesia", "MarshallIslands", "Palau", "Pakistan", "Panama", "PapuaNewGuinea", "Paraguay", "Peru", "Philippines", "Pitcairn", "Poland", "Portugal", "GuineaBissau", "TimorLeste", "PuertoRico", "Qatar", "Réunion", "Romania", "RussianFederation", "Rwanda", "SaintBarthélemy", "SaintHelenaAscensionandTristandaCunha", "SaintKittsandNevis", "Anguilla", "SaintLucia", "SaintMartinFrenchpart", "SaintPierreandMiquelon", "SaintVincentandtheGrenadines", "SanMarino", "SaoTomeandPrincipe", "SaudiArabia", "Senegal", "Serbia", "Seychelles", "SierraLeone", "Singapore", "Slovakia", "VietNam", "Slovenia", "Somalia", "SouthAfrica", "Zimbabwe", "Spain", "SouthSudan", "Sudan", "WesternSahara", "Suriname", "SvalbardandJanMayen", "Eswatini", "Sweden", "Switzerland", "SyrianArabRepublic", "Tajikistan", "Thailand", "Togo", "Tokelau", "Tonga", "TrinidadandTobago", "UnitedArabEmirates", "Tunisia", "Turkey", "Turkmenistan", "TurksandCaicosIslands", "Tuvalu", "Uganda", "Ukraine", "NorthMacedonia", "Egypt", "UnitedKingdom", "Guernsey", "Jersey", "IsleofMan", "Tanzania", "UnitedStatesofAmerica", "VirginIslands", "BurkinaFaso", "Uruguay", "Uzbekistan", "Venezuela", "WallisandFutuna", "Samoa", "Yemen", "Zambia" ], "type": "string" }, "TradingName": { "type": "string" }, "Website": { "type": "string" }, "Type": { "type": "string" }, "ApiKey": { "type": "string" }, "SystemKey": { "type": "string" } } }, "AppConfigurationLocaleConfiguration": { "type": "object", "properties": { "DefaultLocale": { "type": "string" }, "Locales": { "type": "array", "items": { "type": "string" } }, "AvailableLocalesInformation": { "type": "array", "items": { "$ref": "#/definitions/AppConfigurationAvailableLocale" } }, "DefaultLocaleInformation": { "$ref": "#/definitions/AppConfigurationAvailableLocale" } } }, "VideoLink": { "type": "object", "properties": { "Name": { "type": "string" }, "Url": { "type": "string" }, "Thumbnail": { "type": "string" } } }, "AppConfigurationAvailableLocale": { "type": "object", "properties": { "CountryCode": { "type": "string" }, "CurrencySymbol": { "type": "string" }, "Description": { "type": "string" }, "DurationDisplayName": { "type": "string" }, "LanguageCode": { "type": "string" }, "Locale": { "type": "string" }, "MileageDisplayName": { "type": "string" }, "NativeDescription": { "type": "string" } } }, "RetrieveCustomerCommerceConfigurationResponse": { "type": "object", "properties": { "ThemeKey": { "type": "string" }, "ThemeVariant": { "$ref": "#/definitions/AppConfigurationThemeVariant" }, "AuthenticatedOrganisation": { "$ref": "#/definitions/AppConfigurationOrganisation" }, "ContextOrganisation": { "$ref": "#/definitions/AppConfigurationOrganisation" }, "ThirdPartyGoogleAnalyticConfiguration": { "$ref": "#/definitions/AppConfigurationGoogleAnalyticsConfiguration" }, "ThirdPartyGoogleTagManagerConfiguration": { "$ref": "#/definitions/AppConfigurationGoogleTagManagerConfiguration" }, "LocaleConfiguration": { "$ref": "#/definitions/AppConfigurationLocaleConfiguration" }, "CookieComplianceConfiguration": { "$ref": "#/definitions/AppConfigurationCookieComplianceConfiguration" }, "FinanceConfiguration": { "$ref": "#/definitions/AppConfigurationFinanceConfiguration" }, "DomainConfiguration": { "$ref": "#/definitions/AppConfigurationDomainConfiguration" }, "ModuleFeatures": { "$ref": "#/definitions/AppConfigurationModuleFeatures" }, "DigitalRetailStore": { "$ref": "#/definitions/AppConfigurationDigitalRetailStore" }, "VehiclesStoreConfiguration": { "$ref": "#/definitions/AppConfigurationVehiclesStoreConfiguration" }, "TempLogInfo": { "$ref": "#/definitions/AppConfigurationTempLogInfo" } } }, "AppConfigurationGoogleAnalyticsConfiguration": { "type": "object", "properties": { "TrackingCode": { "type": "string" } } }, "AppConfigurationGoogleTagManagerConfiguration": { "type": "object", "properties": { "TrackingCode": { "type": "string" } } }, "AppConfigurationCookieComplianceConfiguration": { "type": "object", "properties": { "Provider": { "enum": [ "Unknown", "Codeweavers", "OneTrust" ], "type": "string" }, "ExternalScriptSrc": { "type": "string" } } }, "AppConfigurationFinanceConfiguration": { "type": "object", "properties": { "DefaultToFinanceSearch": { "type": "boolean" }, "RequiresPersonalisation": { "type": "boolean" }, "RequiresItemisation": { "type": "boolean" } } }, "AppConfigurationDomainConfiguration": { "type": "object", "properties": { "AllowIndexing": { "type": "boolean" }, "RedirectUrl": { "type": "string" }, "ApiKey": { "type": "string" } } }, "AppConfigurationModuleFeatures": { "type": "object", "properties": { "CreditCheck": { "type": "boolean" }, "FinanceApplication": { "type": "boolean" }, "EnquiryForm": { "type": "boolean" }, "PartExchange": { "type": "boolean" }, "Checkout": { "type": "boolean" }, "ReserveVehicle": { "type": "boolean" } } }, "AppConfigurationDigitalRetailStore": { "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } }, "AppConfigurationVehiclesStoreConfiguration": { "type": "object", "properties": { "StoreName": { "type": "string" }, "Slugs": { "type": "array", "items": { "$ref": "#/definitions/AppConfigurationSearchConfigurationSlug" } }, "Imagery": { "$ref": "#/definitions/AppConfigurationVehicleImagery" }, "Chat": { "$ref": "#/definitions/AppConfigurationChat" }, "PartExchange": { "$ref": "#/definitions/AppConfigurationPartExchange" } } }, "AppConfigurationTempLogInfo": { "type": "object", "properties": { "Name": { "type": "string" }, "Reference": { "type": "string" }, "StoreExists": { "type": "boolean" }, "Origin": { "type": "string" } } }, "AppConfigurationSearchConfigurationSlug": { "type": "object", "properties": { "Slug": { "type": "string" }, "IsDefault": { "type": "boolean" }, "SiteContent": { "$ref": "#/definitions/SiteInformationConfiguration" } } }, "AppConfigurationVehicleImagery": { "type": "object", "properties": { "AspectRatio": { "type": "string" }, "Provider": { "$ref": "#/definitions/AppConfigurationVehicleImageryProvider" } } }, "AppConfigurationChat": { "type": "object", "properties": { "Provider": { "$ref": "#/definitions/AppConfigurationChatProvider" } } }, "AppConfigurationPartExchange": { "type": "object", "properties": { "Provider": { "$ref": "#/definitions/AppConfigurationPartExchangeProvider" } } }, "SiteInformationConfiguration": { "type": "object", "properties": { "Title": { "type": "string" }, "Description": { "type": "string" } } }, "AppConfigurationVehicleImageryProvider": { "type": "object", "properties": { "Provider": { "enum": [ "Unknown", "AutosOnShow", "ImaginStudio" ], "type": "string" }, "Token": { "type": "string" }, "Version": { "type": "string" }, "Vehicles": { "$ref": "#/definitions/AppConfigurationVehicleImageryProviderVehicles" } } }, "AppConfigurationChatProvider": { "type": "object", "properties": { "Type": { "enum": [ "Unknown", "LivePerson" ], "type": "string" }, "TenantName": { "type": "string" }, "SriToken": { "type": "string" }, "ScriptLocation": { "type": "string" } } }, "AppConfigurationPartExchangeProvider": { "type": "object", "properties": { "Vehicles": { "$ref": "#/definitions/AppConfigurationPartExchangeProviderVehicles" } } }, "AppConfigurationVehicleImageryProviderVehicles": { "type": "object", "properties": { "LookupBy": { "enum": [ "Unknown", "Vrm", "Vin" ], "type": "string" } } }, "AppConfigurationPartExchangeProviderVehicles": { "type": "object", "properties": { "LookupBy": { "enum": [ "Selection", "Vrm" ], "type": "string" }, "LookupFor": { "enum": [ "Unknown", "Cap", "Glass", "Codeweavers", "Ids", "Ivs", "Psa", "CapLcv", "Glasses", "Tfs", "PsaComcar", "Autobiz", "Brego" ], "type": "string" } } }, "RetrieveCustomerCommerceAppConfigurationResponse": { "type": "object", "properties": { "IsConfiguredCorrectly": { "type": "boolean" }, "DisplayName": { "type": "string" } } }, "GetAllApplicationsResponse": { "type": "object", "properties": { "Applications": { "type": "array", "items": { "$ref": "#/definitions/ApplicationModel" } } } }, "ApplicationModel": { "type": "object", "properties": { "Name": { "type": "string" }, "Description": { "type": "string" }, "Id": { "format": "int32", "type": "integer" }, "Modules": { "type": "array", "items": { "$ref": "#/definitions/ApplicationModuleModel" } } } }, "ApplicationModuleModel": { "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "Name": { "type": "string" }, "DisplayName": { "type": "string" }, "Description": { "type": "string" } } }, "CreateApplicationRequest": { "required": [ "Name", "Description", "Id", "Modules" ], "type": "object", "properties": { "Name": { "type": "string" }, "Description": { "type": "string" }, "Id": { "format": "int32", "type": "integer" }, "Modules": { "type": "array", "items": { "$ref": "#/definitions/ApplicationModuleModel" } } } }, "CreateApplicationResponse": { "type": "object", "properties": {} }, "UpdateApplicationResponse": { "type": "object", "properties": {} }, "DeleteApplicationResponse": { "type": "object", "properties": {} }, "PlatformApplicationResponse": { "type": "object", "properties": { "DisplayName": { "type": "string" }, "IdentitySlug": { "type": "string" }, "Abbreviation": { "type": "string" }, "LogoColour": { "type": "string" }, "BaseUrl": { "type": "string" }, "IconUrl": { "type": "string" }, "IsAvailableInAppSwitcher": { "type": "boolean" } } }, "ManagedContentResponse": { "type": "object", "properties": { "Content": { "type": "string" }, "Id": { "type": "string" } } }, "GetOrganisationChannelsAuditResponse": { "type": "object", "properties": { "Versions": { "type": "array", "items": { "$ref": "#/definitions/ChannelVersion" } } } }, "ChannelVersion": { "type": "object", "properties": { "Channel": { "$ref": "#/definitions/Channel" }, "DeletedAt": { "format": "date-time", "type": "string" }, "Message": { "type": "string" }, "UserReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "ChannelType": { "$ref": "#/definitions/ChannelType" } } }, "Channel": { "type": "object", "properties": { "OrganisationId": { "format": "int32", "type": "integer" }, "OrganisationReference": { "type": "string" }, "MappingKeys": { "type": "array", "items": { "$ref": "#/definitions/MappingKey" } }, "Type": { "$ref": "#/definitions/ChannelType" }, "Active": { "type": "boolean" }, "UseFinancePackageTermGroups": { "type": "boolean" }, "UseTermGroupNameAsKey": { "type": "boolean" }, "RepresentativeProductFamilyPreference": { "type": "string" }, "RepresentativeExampleMappingKeyPreference": { "type": "string" } } }, "ChannelType": { "type": "object", "properties": { "Key": { "type": "string" } } }, "MappingKey": { "type": "object", "properties": { "Key": { "type": "string" }, "DisplayName": { "type": "string" }, "TermGroupMappings": { "type": "array", "items": { "$ref": "#/definitions/TermGroupMapping" } }, "DynamicMappings": { "type": "array", "items": { "$ref": "#/definitions/DynamicMapping" } }, "DisplayOrder": { "format": "int32", "type": "integer" } } }, "TermGroupMapping": { "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "TermGroupId": { "format": "int32", "type": "integer" }, "TermGroupSystemId": { "format": "int32", "type": "integer" }, "ValidFrom": { "format": "date-time", "type": "string" }, "ValidTo": { "format": "date-time", "type": "string" }, "Precedence": { "format": "int32", "type": "integer" }, "Rate": { "format": "double", "type": "number" }, "RateType": { "enum": [ "Undefined", "Apr", "CustomerRate", "Commission", "RateSpread", "CommissionCashPricePercentage", "NoSellout", "CommissionBalancePercentage", "Aer", "Yield", "CommissionCashPricePercentageVatExclusive" ], "type": "string" }, "OverrideRate": { "type": "boolean" }, "Rules": { "type": "array", "items": { "$ref": "#/definitions/ChannelRule" } } } }, "DynamicMapping": { "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "ProductFamilyName": { "type": "string" }, "LenderName": { "type": "string" }, "ValidFrom": { "format": "date-time", "type": "string" }, "ValidTo": { "format": "date-time", "type": "string" }, "Precedence": { "format": "int32", "type": "integer" }, "Rate": { "format": "double", "type": "number" }, "RateType": { "enum": [ "Undefined", "Apr", "CustomerRate", "Commission", "RateSpread", "CommissionCashPricePercentage", "NoSellout", "CommissionBalancePercentage", "Aer", "Yield", "CommissionCashPricePercentageVatExclusive" ], "type": "string" }, "OverrideRate": { "type": "boolean" }, "Rules": { "type": "array", "items": { "$ref": "#/definitions/ChannelRule" } } } }, "ChannelRule": { "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "Value": { "type": "string" } } }, "SsoFormResponse": { "type": "object", "properties": { "Action": { "type": "string" }, "Method": { "type": "string" }, "FormData": { "type": "object", "additionalProperties": { "type": "string" } } } }, "PasswordValidationRequest": { "type": "object", "properties": { "SystemKey": { "type": "string" }, "Password": { "type": "string" } } }, "PasswordValidationResponse": { "type": "object", "properties": { "Rules": { "type": "array", "items": { "$ref": "#/definitions/ValidationRule" } } } }, "ValidationRule": { "type": "object", "properties": { "Description": { "type": "string" }, "HasPassed": { "type": "boolean" } } }, "SwitchSystemRequest": { "required": [ "Application", "SystemReference" ], "type": "object", "properties": { "Application": { "type": "string" }, "SystemReference": { "format": "int32", "type": "integer" } } }, "ApiLoginResponse": { "type": "object", "properties": { "AuthToken": { "type": "string" }, "SessionTransferToken": { "type": "string" }, "BrandingName": { "type": "string" } } }, "ImpersonateRequest": { "required": [ "Application", "Reason" ], "type": "object", "properties": { "Application": { "type": "string" }, "Reason": { "type": "string" }, "SystemKey": { "type": "string" }, "SystemId": { "format": "int32", "type": "integer" }, "UserReference": { "type": "string" }, "AppKey": { "type": "string" }, "Authenticator": { "type": "string" } } }, "GetAuthenticatorsResponse": { "type": "object", "properties": { "Authenticators": { "type": "array", "items": { "$ref": "#/definitions/Authenticator" } } } }, "Authenticator": { "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "Name": { "type": "string" }, "SignInUrl": { "type": "string" }, "SignOutUrl": { "type": "string" }, "TimeOutUrl": { "type": "string" }, "SessionTimespanInSeconds": { "format": "int32", "type": "integer" } } }, "SessionBrandingResponse": { "type": "object", "properties": { "Id": { "type": "string" }, "DisplayName": { "type": "string" }, "Images": { "type": "object", "additionalProperties": { "type": "string" } }, "VideoStyleKey": { "type": "string" }, "TemplateStyle": { "type": "string" }, "LogoUrl": { "type": "string" }, "LogoHeaderUrl": { "type": "string" }, "FaviconUrl": { "type": "string" }, "SmallLogoUrl": { "type": "string" }, "CssVars": { "type": "string" }, "CssUrl": { "type": "string" } } }, "BrandingResponse": { "type": "object", "properties": { "BrandingExists": { "type": "boolean" }, "PageTitle": { "type": "string" }, "CssUrl": { "type": "string" }, "LogoUrl": { "type": "string" }, "LogoHeaderUrl": { "type": "string" }, "FaviconUrl": { "type": "string" }, "SmallLogoUrl": { "type": "string" } } }, "UpdateBrandingRequest": { "type": "object", "properties": { "VideoStyle": { "type": "string" }, "TemplateStyle": { "type": "string" }, "BrandingName": { "type": "string" }, "DisplayName": { "type": "string" }, "StyleProperties": { "type": "object", "additionalProperties": { "type": "string" } }, "Images": { "type": "array", "items": { "enum": [ "Logo", "BackgroundImage", "Favicon", "PartExchangeBackgroundImage" ], "type": "string" } } } }, "BrandingDetailsResponse": { "type": "object", "properties": { "Id": { "type": "string" }, "Name": { "type": "string" }, "StyleProperties": { "type": "object", "additionalProperties": { "type": "string" } }, "Images": { "type": "object", "additionalProperties": { "type": "string" } }, "VideoStyle": { "type": "string" }, "TemplateStyle": { "type": "string" } } }, "GetCaptureLocationsResponse": { "type": "object", "properties": { "CaptureLocations": { "type": "array", "items": { "type": "string" } } } }, "GetChannelTypesResponse": { "type": "object", "properties": { "Types": { "type": "array", "items": { "$ref": "#/definitions/ChannelTypeMetaData" } } } }, "ChannelTypeMetaData": { "type": "object", "properties": { "Key": { "type": "string" }, "Description": { "type": "string" }, "DisplayName": { "type": "string" } } }, "CreateChannelRequest": { "required": [ "Type" ], "type": "object", "properties": { "Type": { "$ref": "#/definitions/ChannelType" }, "AuditMessage": { "type": "string" } } }, "CreateChannelResponse": { "type": "object", "properties": { "Reference": { "type": "string" } } }, "ChannelsStatsResponse": { "type": "object", "properties": { "ChannelStats": { "type": "array", "items": { "$ref": "#/definitions/ChannelStats" } } } }, "ChannelStats": { "type": "object", "properties": { "Type": { "$ref": "#/definitions/ChannelType" }, "LastHit": { "format": "date-time", "type": "string" } } }, "GetOrganisationChannelsResponse": { "type": "object", "properties": { "Channels": { "type": "array", "items": { "$ref": "#/definitions/ChannelWithSystemGeneratedData" } } } }, "ChannelWithSystemGeneratedData": { "type": "object", "properties": { "Reference": { "type": "string" }, "MetaData": { "$ref": "#/definitions/ChannelTypeMetaData" }, "OrganisationId": { "format": "int32", "type": "integer" }, "OrganisationReference": { "type": "string" }, "MappingKeys": { "type": "array", "items": { "$ref": "#/definitions/MappingKey" } }, "Type": { "$ref": "#/definitions/ChannelType" }, "Active": { "type": "boolean" }, "UseFinancePackageTermGroups": { "type": "boolean" }, "UseTermGroupNameAsKey": { "type": "boolean" }, "RepresentativeProductFamilyPreference": { "type": "string" }, "RepresentativeExampleMappingKeyPreference": { "type": "string" } } }, "GetOrganisationChannelResponse": { "type": "object", "properties": { "Channel": { "$ref": "#/definitions/ChannelWithSystemGeneratedData" } } }, "UpdateChannelRequest": { "type": "object", "properties": { "Channel": { "$ref": "#/definitions/Channel" }, "AuditMessage": { "type": "string" } } }, "UpdateChannelResponse": { "type": "object", "properties": {} }, "ConfigResponse": { "type": "object", "properties": { "Value": { "type": "string" }, "Values": { "type": "object", "additionalProperties": { "type": "string" } }, "HasError": { "type": "boolean", "readOnly": true }, "Errors": { "type": "array", "items": { "$ref": "#/definitions/ErrorResponse" }, "readOnly": true }, "IsAuthenticated": { "type": "boolean" } } }, "RetrieveContentRequest": { "type": "object", "properties": { "ContentRequests": { "type": "array", "items": { "$ref": "#/definitions/ContentRequest" } } } }, "ContentRequest": { "type": "object", "properties": { "Key": { "type": "string" }, "QuoteReference": { "type": "string" } } }, "RetrieveContentResponse": { "type": "object", "properties": { "ContentResponse": { "type": "array", "items": { "$ref": "#/definitions/ContentResponseDto" } } } }, "ContentResponseDto": { "type": "object", "properties": { "Key": { "type": "string" }, "Content": { "type": "string" } } }, "CreateContentSetForWorkspaceRequest": { "type": "object", "properties": { "Title": { "type": "string" } } }, "RootCreateResponse": { "type": "object", "properties": {} }, "GetOrganisationsByAContentSetResponse": { "type": "object", "properties": { "Organisations": { "type": "array", "items": { "$ref": "#/definitions/OrganisationByContentSet" } } } }, "OrganisationByContentSet": { "type": "object", "properties": { "Name": { "type": "string" }, "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } }, "GetContentSetResponse": { "type": "object", "properties": { "ContentSets": { "type": "array", "items": { "type": "string" } }, "ContentTagSets": { "type": "array", "items": { "$ref": "#/definitions/KeyValuePair[String,String]" } } } }, "KeyValuePair[String,String]": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } } }, "SaveContentDetailsRequest": { "type": "object", "properties": { "Content": { "$ref": "#/definitions/ContentDetails" } } }, "ContentDetails": { "type": "object", "properties": { "Id": { "type": "string" }, "Set": { "type": "string" }, "Name": { "type": "string" }, "Keys": { "type": "array", "items": { "type": "string" } }, "Content": { "type": "string" }, "TagSets": { "type": "array", "items": { "$ref": "#/definitions/KeyValuePair[String,String]" } } } }, "SaveContentDetailsResponse": { "type": "object", "properties": { "Content": { "$ref": "#/definitions/ContentDetails" } } }, "GetContentResponse": { "type": "object", "properties": { "Contents": { "type": "array", "items": { "$ref": "#/definitions/Content" } }, "Dealers": { "type": "array", "items": { "$ref": "#/definitions/Dealer" } } } }, "Content": { "type": "object", "properties": { "Id": { "type": "string" }, "Name": { "type": "string" } } }, "Dealer": { "type": "object", "properties": { "Id": { "type": "string" }, "Name": { "type": "string" } } }, "GetContentDetailsResponse": { "type": "object", "properties": { "Content": { "$ref": "#/definitions/ContentDetails" } } }, "DeleteContentDetailsResponse": { "type": "object", "properties": {} }, "RemoveOrganisationFromContentSetResponse": { "type": "object", "properties": {} }, "AssignOrganisationToContentSetResponse": { "type": "object", "properties": {} }, "SearchOrganisationsByNameResponse": { "type": "object", "properties": { "Dealers": { "type": "array", "items": { "$ref": "#/definitions/Dealer" } } } }, "GetAllPrivacyPoliciesByWorkspaceReferenceResponse": { "type": "object", "properties": { "Policies": { "type": "array", "items": { "$ref": "#/definitions/PrivacyPolicy" } } } }, "PrivacyPolicy": { "type": "object", "properties": { "Title": { "type": "string" }, "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Content": { "type": "string" }, "CaptureLocations": { "type": "array", "items": { "type": "string" } }, "ContentSet": { "type": "string" }, "EntityTypeIds": { "type": "array", "items": { "format": "int32", "type": "integer" } }, "Locales": { "type": "array", "items": { "type": "string" } } } }, "GetContentSetsForAWorkspaceResponse": { "type": "object", "properties": { "ContentSets": { "type": "array", "items": { "type": "string" } } } }, "GetCorporateVapTemplatesResponse": { "type": "object", "properties": { "Vaps": { "type": "array", "items": { "$ref": "#/definitions/CorporateVapTemplate" } } } }, "CorporateVapTemplate": { "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Name": { "type": "string" }, "CalculationType": { "enum": [ "Unknown", "RegularPaymentSpreadNonInterestBearing", "Financeable", "PSA_GAP", "PERCENTAGE_OF_ADVANCE", "PSA_DEATH_INSURANCE", "VapPaidForByDeposit", "RegularPaymentNonInterestBearing", "PercentageOfAdvancePlusInterestBearingFees", "PsaFinancialLossGuarantee", "FlatAmountPaidByMonthlyFinancePayment", "AdminFee", "DisplayOnly", "PercentageOfMonthlyPaymentIncludingVAT", "BandedFixedMonthlyServiceFee", "RegularPaymentNonInterestBearingIncludingInitialPayment", "FinancedSpainOpeningFee", "MercedesExternalVapCalculation", "VapCalculatedByLenderSystem", "PsaServicingAmountSpreadAcrossPayments", "StellantisRegularPaymentSpreadNonInterestBearing", "NovunaMaintenanceServicePackVap", "StellantisServiceVap", "StellantisFixedAmountInsuranceServiceVap", "StellantisFiscalPowerVap", "StellantisBrakeHorsePowerVap", "StellantisCreditInsuranceVap", "StellantisServiceVapIncludingDeposit", "NonInterestBearingServiceRental", "StellantisBrakeHorsePowerVapExcludingDeposit", "PaidByDepositOrPositiveEquity", "NovunaCorporateReliefVehicleVap", "MonthlyAmountSpreadNonInterestBearing", "MonthlyAmountSpreadInterestBearing", "NovunaCorporateMaintenanceVap", "NovunaCorporateTyresVap", "NovunaCorporateBreakdownVap", "TotalAmountSpreadInterestBearing", "PercentageOfMonthlyAmountSpreadNonInterestBearing", "PercentageOfMonthlyAmountSpreadInterestBearing", "PercentageOfTotalAmountSpreadNonInterestBearing", "PercentageOfTotalAmountSpreadInterestBearing" ], "type": "string" }, "Key": { "type": "string" }, "ExternalIdentifier": { "type": "string" }, "IsCompulsory": { "type": "boolean" }, "RequiredOnScheme": { "type": "boolean" }, "VehicleFields": { "type": "array", "items": { "$ref": "#/definitions/ReturnedCorporateVapTemplateVehicleFields" } } } }, "ReturnedCorporateVapTemplateVehicleFields": { "type": "object", "properties": { "VehicleType": { "enum": [ "Unknown", "Car", "Lcv", "Bike", "Other", "NonVehicleAsset", "Hgv", "LastElement" ], "type": "string" }, "Fields": { "type": "array", "items": { "$ref": "#/definitions/CorporateVapTemplateField" } } } }, "CorporateVapTemplateField": { "type": "object", "properties": { "Name": { "type": "string" }, "Value": { "type": "string" }, "Type": { "enum": [ "Amount", "Percentage", "String", "Number", "Option" ], "type": "string" } } }, "UpsertCorporateVapTemplateRequest": { "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Name": { "type": "string" }, "Type": { "enum": [ "Unknown", "GuaranteedAssetProtection", "ServicePlan", "Warranty", "TyreInsurance", "BreakdownAssistance", "CosmeticProtection", "Other", "LifeInsurance", "Maintenance", "Delivery", "VehicleInsurance", "LicenceProtection", "FinesInsurance", "CreditProtectionInsurance", "AdminFee", "Mot", "RentalInsurance", "RentalInsuranceLight", "AlloyInsurance", "CosmeticRepair", "PaintProtection", "PaymentProtectionInsurance", "Fuel", "Accessory" ], "type": "string" }, "CalculationType": { "enum": [ "Unknown", "RegularPaymentSpreadNonInterestBearing", "Financeable", "PSA_GAP", "PERCENTAGE_OF_ADVANCE", "PSA_DEATH_INSURANCE", "VapPaidForByDeposit", "RegularPaymentNonInterestBearing", "PercentageOfAdvancePlusInterestBearingFees", "PsaFinancialLossGuarantee", "FlatAmountPaidByMonthlyFinancePayment", "AdminFee", "DisplayOnly", "PercentageOfMonthlyPaymentIncludingVAT", "BandedFixedMonthlyServiceFee", "RegularPaymentNonInterestBearingIncludingInitialPayment", "FinancedSpainOpeningFee", "MercedesExternalVapCalculation", "VapCalculatedByLenderSystem", "PsaServicingAmountSpreadAcrossPayments", "StellantisRegularPaymentSpreadNonInterestBearing", "NovunaMaintenanceServicePackVap", "StellantisServiceVap", "StellantisFixedAmountInsuranceServiceVap", "StellantisFiscalPowerVap", "StellantisBrakeHorsePowerVap", "StellantisCreditInsuranceVap", "StellantisServiceVapIncludingDeposit", "NonInterestBearingServiceRental", "StellantisBrakeHorsePowerVapExcludingDeposit", "PaidByDepositOrPositiveEquity", "NovunaCorporateReliefVehicleVap", "MonthlyAmountSpreadNonInterestBearing", "MonthlyAmountSpreadInterestBearing", "NovunaCorporateMaintenanceVap", "NovunaCorporateTyresVap", "NovunaCorporateBreakdownVap", "TotalAmountSpreadInterestBearing", "PercentageOfMonthlyAmountSpreadNonInterestBearing", "PercentageOfMonthlyAmountSpreadInterestBearing", "PercentageOfTotalAmountSpreadNonInterestBearing", "PercentageOfTotalAmountSpreadInterestBearing" ], "type": "string" }, "Key": { "type": "string" }, "ExternalIdentifier": { "type": "string" }, "IsCompulsory": { "type": "boolean" }, "RequiredOnScheme": { "type": "boolean" }, "VehicleFields": { "type": "array", "items": { "$ref": "#/definitions/CorporateVapTemplateVehicleFields" } }, "Reason": { "type": "string" } } }, "CorporateVapTemplateVehicleFields": { "type": "object", "properties": { "VehicleType": { "enum": [ "Unknown", "Car", "Lcv", "Bike", "Other", "NonVehicleAsset", "Hgv", "LastElement" ], "type": "string" }, "Fields": { "type": "object", "additionalProperties": { "type": "string" } } } }, "UpsertCorporateVapTemplateResponse": { "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } }, "GetCorporateVapTemplateResponse": { "type": "object", "properties": { "Vap": { "$ref": "#/definitions/CorporateVapTemplate" } } }, "DeleteCorporateVapTemplateRequest": { "type": "object", "properties": { "Reason": { "type": "string" } } }, "GetCorporateVapTemplateAuditResponse": { "type": "object", "properties": { "Audits": { "type": "array", "items": { "$ref": "#/definitions/CorporateVapTemplateAudit" } } } }, "CorporateVapTemplateAudit": { "type": "object", "properties": { "OccurredAt": { "format": "date-time", "type": "string" }, "UserName": { "type": "string" }, "EventType": { "type": "string" }, "PreviousValue": { "type": "string" }, "CurrentValue": { "type": "string" }, "Reason": { "type": "string" } } }, "VapTemplateUsage": { "type": "object", "properties": { "Policies": { "type": "array", "items": { "$ref": "#/definitions/VapTemplateUsagePolicy" } } } }, "VapTemplateUsagePolicy": { "type": "object", "properties": { "Name": { "type": "string" }, "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Schemes": { "type": "array", "items": { "$ref": "#/definitions/VapTemplateUsageScheme" } } } }, "VapTemplateUsageScheme": { "type": "object", "properties": { "Name": { "type": "string" }, "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } }, "CostToChangeRequest": { "type": "object", "properties": { "TotalPrice": { "format": "double", "type": "number" }, "Settlement": { "format": "double", "type": "number" }, "PartExchange": { "format": "double", "type": "number" } } }, "CostToChangeResponse": { "type": "object", "properties": { "CostToChange": { "format": "double", "type": "number" }, "TotalPrice": { "format": "double", "type": "number" }, "Settlement": { "format": "double", "type": "number" }, "PartExchange": { "format": "double", "type": "number" } } }, "CountriesResponse": { "type": "object", "properties": { "Countries": { "type": "array", "items": { "$ref": "#/definitions/CountryData" } } } }, "CountryData": { "type": "object", "properties": { "Name": { "type": "string" }, "Alpha2Code": { "type": "string" }, "Languages": { "type": "array", "items": { "$ref": "#/definitions/CountryLanguageData" } } } }, "CountryLanguageData": { "type": "object", "properties": { "Description": { "type": "string" }, "Code": { "type": "string" } } }, "CreditLineApplicationsResponse": { "type": "object", "properties": { "Pagination": { "$ref": "#/definitions/Pagination" }, "CreditLineApplications": { "type": "array", "items": { "$ref": "#/definitions/CreditLineApplicationSummary" } } } }, "Pagination": { "type": "object", "properties": { "Page": { "format": "int32", "type": "integer" }, "ResultsPerPage": { "format": "int32", "type": "integer" }, "TotalPages": { "format": "int32", "type": "integer" }, "TotalResults": { "format": "int32", "type": "integer" } } }, "CreditLineApplicationSummary": { "type": "object", "properties": { "ProposalReference": { "type": "string" }, "ProposalId": { "format": "int32", "type": "integer" }, "CreatedAt": { "format": "date-time", "type": "string" }, "CreditLine": { "$ref": "#/definitions/CreditLineSummary" } } }, "CreditLineSummary": { "type": "object", "properties": { "TotalCredit": { "format": "double", "type": "number" }, "CreditAvailable": { "format": "double", "type": "number" }, "ExpiryDate": { "type": "string" }, "SingleArticleLimit": { "format": "double", "type": "number" } } }, "V12StatusUpdateRequest": { "type": "object", "properties": { "Pos": { "type": "string" }, "ProposalId": { "type": "string" }, "ProposalDescription": { "type": "string" }, "PayoutConditions": { "type": "string" }, "Messages": { "type": "string" }, "TimeStamp": { "type": "string" }, "ProposalStatus": { "type": "string" } } }, "ICodeweaversResponse": { "type": "object", "properties": {} }, "SantanderProposalUpdateRequest": { "type": "object", "properties": { "Userid": { "type": "string" }, "Password": { "type": "string" }, "OriginatorID": { "type": "string" }, "Underwriterid": { "type": "string" }, "OriginatorProposalReference": { "type": "string" }, "UnderwriterProposalReference": { "type": "string" }, "OperationType": { "type": "string" }, "OperationData": { "type": "string" } } }, "SantanderProposalUpdateResponse": { "type": "object", "properties": { "ReturnMessage": { "type": "string" } } }, "FinanceQuotationRequest": { "type": "object", "properties": { "Vehicles": { "type": "array", "items": { "$ref": "#/definitions/PsaVehicle" } }, "Credentials": { "$ref": "#/definitions/FinanceCredentials" }, "Customer": { "$ref": "#/definitions/FinanceCustomer" }, "Parameters": { "$ref": "#/definitions/PsaFinanceParameters" } } }, "PsaVehicle": { "type": "object", "properties": { "Id": { "type": "string" }, "TitreCode": { "type": "string" }, "BasicPrice": { "format": "double", "type": "number" }, "NetPrice": { "format": "double", "type": "number" }, "DealerContribution": { "format": "double", "type": "number" }, "Options": { "type": "array", "items": { "$ref": "#/definitions/PsaEquipmentOption" } } } }, "FinanceCredentials": { "type": "object", "properties": { "UserToken": { "type": "string" }, "Username": { "type": "string" }, "Password": { "type": "string" }, "ApiKey": { "type": "string" }, "SystemKey": { "type": "string" }, "Referrer": { "type": "string" }, "AssociatedDealerKey": { "type": "string" }, "RetailerIdentifier": { "type": "string" }, "OrganisationIdentifier": { "$ref": "#/definitions/AuthenticationOrganisationIdentifier" }, "Origin": { "type": "string" }, "Locale": { "type": "string" } } }, "FinanceCustomer": { "type": "object", "properties": { "Reference": { "type": "string" }, "Postcode": { "type": "string" }, "Age": { "format": "int32", "type": "integer" }, "Entity": { "type": "string" } } }, "PsaFinanceParameters": { "type": "object", "properties": { "Term": { "format": "int32", "type": "integer" }, "CashDeposit": { "format": "double", "type": "number" }, "DepositType": { "enum": [ "Unknown", "Amount", "Percentage", "AdvancePayments" ], "type": "string" }, "AnnualMileage": { "format": "int32", "type": "integer" }, "ProductKey": { "type": "string" }, "PartExchangeOutstandingFinance": { "format": "double", "type": "number" }, "PartExchangeValuation": { "format": "double", "type": "number" }, "PartExchangeContribution": { "format": "double", "type": "number" }, "PartExchangeCashback": { "format": "double", "type": "number" }, "PartExchangeEquity": { "format": "double", "type": "number" }, "IsPersonalisedQuote": { "type": "boolean" }, "SaveQuote": { "type": "boolean" }, "ValueAddedProducts": { "type": "array", "items": { "$ref": "#/definitions/ValueAddedProduct" } }, "IsTelematics": { "type": "boolean" }, "Discount": { "$ref": "#/definitions/FinanceDiscount" } } }, "PsaEquipmentOption": { "type": "object", "properties": { "Code": { "type": "string" }, "BasicPrice": { "format": "double", "description": "Without any Promotions", "type": "number" }, "NetPrice": { "format": "double", "description": "With Promotions", "type": "number" } } }, "AuthenticationOrganisationIdentifier": { "type": "object", "properties": { "Type": { "enum": [ "Unknown", "AuthenticatingOrganisationAssociatedKey" ], "type": "string" }, "Value": { "type": "string" } } }, "ValueAddedProduct": { "type": "object", "properties": { "Name": { "type": "string" }, "Price": { "format": "double", "type": "number" }, "Type": { "type": "string" }, "Profile": { "type": "string" }, "IsSelected": { "type": "boolean" }, "Key": { "type": "string" }, "ExternalIdentifier": { "type": "string" }, "Apr": { "format": "double", "type": "number" }, "VatState": { "enum": [ "Unknown", "Inclusive", "Exclusive" ], "type": "string" }, "RegularPayment": { "format": "double", "type": "number" }, "VatExempt": { "type": "boolean" } } }, "FinanceDiscount": { "type": "object", "properties": { "Type": { "type": "string" }, "Value": { "format": "double", "type": "number" }, "Customer": { "type": "string" }, "DepositContribution": { "type": "boolean" } } }, "AggregateFinanceQuotationResponse": { "type": "object", "properties": { "Results": { "type": "array", "items": { "$ref": "#/definitions/AggregateProductResult" } }, "HasError": { "type": "boolean" }, "Error": { "$ref": "#/definitions/DeprecatedError" } } }, "AggregateProductResult": { "type": "object", "properties": { "HasError": { "type": "boolean" }, "Error": { "$ref": "#/definitions/DeprecatedError" }, "Id": { "type": "string" }, "ProductKey": { "type": "string" }, "ProductName": { "type": "string" }, "TermsName": { "type": "string" }, "RegularPayment": { "format": "double", "type": "number" }, "Term": { "format": "int32", "type": "integer" }, "AnnualMileage": { "format": "int32", "type": "integer" }, "CashDeposit": { "format": "double", "type": "number" }, "Apr": { "format": "double", "type": "number" }, "PaymentSchedule": { "type": "array", "items": { "$ref": "#/definitions/DeprecatedPayment" } } } }, "DeprecatedError": { "type": "object", "properties": { "Code": { "type": "string" }, "DealerMessage": { "type": "string" }, "TechnicalMessage": { "type": "string" } } }, "DeprecatedPayment": { "type": "object", "properties": { "PaymentStepNumber": { "format": "int32", "type": "integer" }, "NumberOfPayments": { "format": "int32", "type": "integer" }, "TotalAmount": { "format": "double", "type": "number" }, "HasFinanceIncluded": { "type": "boolean" } } }, "OploUpdateStatusResponse": { "type": "object", "properties": {} }, "InvoiceExtractSearchRequest": { "type": "object", "properties": { "PaginationToken": { "type": "string" }, "ResultsPerPage": { "format": "int32", "type": "integer" }, "StartDate": { "format": "date-time", "type": "string" }, "EndDate": { "format": "date-time", "type": "string" } } }, "ContractExtractSearchRequest": { "type": "object", "properties": { "PaginationToken": { "type": "string" }, "ResultsPerPage": { "format": "int32", "type": "integer" }, "StartDate": { "format": "date-time", "type": "string" }, "EndDate": { "format": "date-time", "type": "string" } } }, "NorthridgeUpdateStatusRequest": { "type": "object", "properties": { "dealerref": { "type": "string" }, "dealer_custid": { "type": "string" }, "agreementno": { "type": "string" }, "document": { "type": "string" }, "esign": { "type": "string" }, "distanceesign": { "type": "string" }, "distanceesigninfo": { "type": "string" }, "decision": { "type": "string" }, "condition": { "type": "string" }, "versionNo": { "type": "string" }, "dateProduced": { "format": "date-time", "type": "string" } } }, "AddUserByDaimlerIdRequest": { "type": "object", "properties": { "OrganisationReferences": { "type": "array", "items": { "type": "string" } } } }, "AddUserByDaimlerIdResponse": { "type": "object", "properties": { "Reference": { "type": "string" }, "Email": { "type": "string" }, "Title": { "type": "string" }, "FirstName": { "type": "string" }, "LastName": { "type": "string" } } }, "MercedesStatusUpdateRequest": { "type": "object", "properties": { "notificationtype": { "type": "array", "items": { "type": "string" } }, "orderId": { "type": "string" }, "statuscode": { "type": "string" }, "proposalId": { "type": "string" }, "timestamp": { "format": "date-time", "type": "string" }, "origincode": { "type": "string" }, "docGenerationFlag": { "type": "string" }, "docGenerationErrorDescription": { "type": "string" } } }, "MercedesEsignNotificationRequest": { "type": "object", "properties": { "NotificationType": { "type": "string" }, "ProposalId": { "type": "string" }, "OrderId": { "type": "string" }, "SalesChannel": { "type": "string" }, "Name": { "type": "string" }, "Message": { "type": "string" }, "Signer": { "type": "string" }, "PackageId": { "type": "string" }, "Timestamp": { "type": "string" } } }, "MercedesSubmissionApplyRequest": { "type": "object", "properties": { "NewJourney": { "type": "boolean" }, "DoNotAttachPrivacyPolicyToCustomerEmail": { "type": "boolean" }, "SubmissionReason": { "type": "string" } } }, "MercedesCommissionDisclosureResponse": { "type": "object", "properties": { "Content": { "type": "string" } } }, "SignedMercedesCommissionDisclosureResponse": { "type": "object", "properties": { "Content": { "type": "string" }, "AgreedOn": { "format": "date-time", "type": "string" } } }, "MercedesCaptchaResponse": { "type": "object", "properties": {} }, "MarshStatusUpdateRequest": { "type": "object", "properties": { "master_proposal_id": { "format": "int32", "type": "integer" }, "external_reference": { "type": "string" }, "application_id": { "format": "int32", "type": "integer" }, "event_type_id": { "format": "int32", "type": "integer" }, "event_type_version_id": { "format": "int32", "type": "integer" }, "event_data": { "$ref": "#/definitions/MarshEventData" } } }, "MarshEventData": { "type": "object", "properties": { "status_id": { "format": "int32", "type": "integer" } } }, "MannIslandStatusUpdateRequest": { "type": "object", "properties": { "createdAt": { "type": "string" }, "proposalId": { "type": "string" }, "versionId": { "type": "string" }, "type": { "type": "string" }, "data": { "$ref": "#/definitions/MannIslandStatusData" } } }, "MannIslandStatusData": { "type": "object", "properties": { "versionId": { "type": "string" }, "status": { "type": "string" } } }, "CustomJlrSingleDerivativeImportRequest": { "type": "object", "properties": { "Manufacturer": { "type": "string" }, "UrlSlug": { "type": "string" } } }, "CustomJlrSingleDerivativeImportResponse": { "type": "object", "properties": { "Message": { "type": "string" } } }, "SearchOffersResponse": { "type": "object", "properties": { "Offers": { "type": "array", "items": { "$ref": "#/definitions/JlrOffer" } } } }, "JlrOffer": { "type": "object", "properties": { "Reference": { "type": "string" }, "Title": { "type": "string" }, "Category": { "type": "string" }, "Description": { "type": "string" }, "Subtitle": { "type": "string" }, "Images": { "type": "array", "items": { "$ref": "#/definitions/OfferImage" } }, "Links": { "type": "array", "items": { "$ref": "#/definitions/OfferLink" } }, "Vehicle": { "$ref": "#/definitions/OfferVehicleDetails" }, "Finance": { "$ref": "#/definitions/FinanceDetails" } } }, "OfferImage": { "type": "object", "properties": { "Category": { "type": "string" }, "Url": { "type": "string" }, "Description": { "type": "string" }, "AltText": { "type": "string" } } }, "OfferLink": { "type": "object", "properties": { "Url": { "type": "string" }, "Category": { "type": "string" }, "Text": { "type": "string" }, "Tooltip": { "type": "string" } } }, "OfferVehicleDetails": { "type": "object", "properties": { "IdentifierType": { "type": "string" }, "Identifier": { "type": "string" }, "Manufacturer": { "type": "string" }, "Model": { "type": "string" }, "Variant": { "type": "string" }, "Derivative": { "type": "string" }, "Code": { "type": "string" }, "Options": { "type": "array", "items": { "$ref": "#/definitions/OfferVehicleOption" } }, "OnTheRoadPrice": { "format": "double", "type": "number" }, "OnTheRoadPriceIncludingDiscounts": { "format": "double", "type": "number" } } }, "OfferVehicleOption": { "type": "object", "properties": { "Identifier": { "type": "string" }, "Name": { "type": "string" }, "Category": { "type": "string" }, "Price": { "format": "double", "type": "number" } } }, "ContentResponse": { "type": "object", "properties": { "Data": { "type": "array", "items": { "$ref": "#/definitions/ContentKeyValue" } } } }, "ContentKeyValue": { "type": "object", "properties": { "Id": { "type": "string" }, "Value": { "type": "string" } } }, "HunterMatchRequest": { "type": "object", "properties": { "Credentials": { "$ref": "#/definitions/FinanceCredentials" }, "NotificationInput": { "$ref": "#/definitions/HunterMatchNotificationInput" } } }, "HunterMatchNotificationInput": { "type": "object", "properties": { "Hunter2Notification": { "$ref": "#/definitions/HunterMatchNotification" } } }, "HunterMatchNotification": { "type": "object", "properties": { "NotificationType": { "type": "string" }, "Message": { "$ref": "#/definitions/HunterMatchMessage" } } }, "HunterMatchMessage": { "type": "object", "properties": { "WorkStatusNotification": { "$ref": "#/definitions/HunterMatchWorkStatusNotification" } } }, "HunterMatchWorkStatusNotification": { "type": "object", "properties": { "SubmissionNotificationNo": { "type": "string" }, "SubmissionNo": { "type": "string" }, "DateEventRaised": { "type": "string" }, "SubmissionIdentifer": { "type": "string" }, "VersionNo": { "type": "string" }, "DateOfSubmission": { "type": "string" }, "WorkStatusChangeDate": { "type": "string" }, "WorkStatusType": { "type": "string" }, "WorkStatusDescription": { "type": "string" }, "FraudStatusChangeDate": { "type": "string" }, "FraudStatusType": { "type": "string" }, "FraudStatusDescription": { "type": "string" } } }, "HunterMatchResponse": { "type": "object", "properties": { "Hunter2NotificationResponse": { "type": "string" } } }, "GetVehicleTableByIdResponse": { "type": "object", "properties": { "Name": { "type": "string" }, "Vehicles": { "type": "array", "items": { "$ref": "#/definitions/VehicleOverview" } } } }, "VehicleOverview": { "type": "object", "properties": { "Identifier": { "type": "string" }, "IdentifierType": { "enum": [ "Unknown", "Vrm", "Vin", "CapShortCode", "CapLongCode", "Titre", "Glasses", "CDL", "ABI", "FleetNet", "DHS", "CapShortEncrypted", "Ivs", "Suzuki", "CapDescription", "FordDescription", "VidCode", "Rams", "CodeweaversStockId", "PsaDescription", "Ids", "FreeText", "ManufacturerCode", "Search", "TeslaDescription", "AudiModelCode", "BmvsCode", "IvsModelToken", "CodeweaversDerivative", "CodeweaversDerivativeIdentifier", "JLR5000Code", "KeeId", "SecondaryManufacturer", "IvsBodyGroupCode", "FcaConfiguratorSlug", "CDI", "VolvoCode", "SkodaCode", "DealerStockId", "JlrComboCode", "BmwCapLongCode", "BmwCapShortCode", "BaumusterCode", "AutoTraderDerivativeIdentifier", "TribalDerivativeIdentifier", "Cazana", "Jato", "Mpv", "FcaCommercialModelDescription", "CapCarShortCode", "CapLcvShortCode", "CapBikeShortCode", "SubaruCode", "Infocar", "VolvoConfigurationCode", "ArgusCode", "TriumphCode", "AutoVistaNatCode", "Blvd", "BregoDerivativeIdentifier", "LastElement" ], "type": "string" }, "VehicleType": { "type": "string" }, "Description": { "type": "string" } } }, "GetVehicleContributionsTableApiResponse": { "type": "object", "properties": { "TableId": { "format": "int32", "type": "integer" }, "VersionId": { "format": "int32", "type": "integer" }, "SystemId": { "format": "int32", "type": "integer" }, "TableName": { "type": "string" }, "Contributions": { "type": "array", "items": { "$ref": "#/definitions/GetVehicleContributionsTableRecord" } } } }, "GetVehicleContributionsTableRecord": { "type": "object", "properties": { "VehicleType": { "type": "string" }, "IdentifierType": { "type": "string" }, "Identifier": { "type": "string" }, "RuleType": { "type": "string" }, "Value": { "type": "string" } } }, "FinanceTermResponse": { "required": [ "Name", "DefaultCalculationParameters" ], "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "Name": { "type": "string" }, "InternalDescription": { "type": "string" }, "ValidFrom": { "format": "date-time", "type": "string" }, "ValidTo": { "format": "date-time", "type": "string" }, "Product": { "$ref": "#/definitions/FinanceProductResponse" }, "DefaultCalculationParameters": { "$ref": "#/definitions/DefaultCalculationParametersResponse" }, "SubmissionKey": { "type": "string" }, "ExternalIdentifier": { "type": "string" }, "Active": { "type": "boolean" }, "CampaignId": { "format": "int32", "type": "integer" }, "TermsAndConditionsTemplateId": { "type": "string" }, "QuoteValid": { "format": "int32", "type": "integer" }, "FiguresValid": { "format": "int32", "type": "integer" } } }, "FinanceProductResponse": { "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "Name": { "type": "string" }, "Family": { "type": "string" }, "Description": { "type": "string" }, "Rules": { "$ref": "#/definitions/FinanceProductRules" } } }, "DefaultCalculationParametersResponse": { "required": [ "AnnualMileage", "DepositType", "Deposit", "Term" ], "type": "object", "properties": { "AnnualMileage": { "format": "int32", "type": "integer" }, "DepositType": { "enum": [ "Unknown", "Amount", "Percentage", "AdvancePayments" ], "type": "string" }, "Deposit": { "format": "double", "type": "number" }, "Term": { "format": "int32", "type": "integer" } } }, "FinanceProductRules": { "type": "object", "properties": { "Conditions": { "type": "array", "items": { "$ref": "#/definitions/Rule" } }, "Actions": { "type": "array", "items": { "$ref": "#/definitions/Rule" } } } }, "Rule": { "type": "object", "properties": { "Value": { "type": "string" }, "CommonTypeId": { "format": "int32", "type": "integer" } } }, "TermRuleGroupsResponse": { "required": [ "TermId" ], "type": "object", "properties": { "RuleGroups": { "type": "array", "items": { "$ref": "#/definitions/RuleGroup" } }, "TermId": { "format": "int32", "type": "integer" } } }, "RuleGroup": { "type": "object", "properties": { "Id": { "format": "int64", "type": "integer" }, "Name": { "type": "string" }, "IsShared": { "type": "boolean" }, "IsActive": { "type": "boolean" }, "Precedence": { "format": "int32", "type": "integer" }, "Actions": { "type": "array", "items": { "$ref": "#/definitions/Rule" } }, "Conditions": { "type": "array", "items": { "$ref": "#/definitions/Rule" } } } }, "FinanceTermVersionsResponse": { "type": "object", "properties": { "Versions": { "type": "array", "items": { "$ref": "#/definitions/FinanceTermVersion" } } } }, "FinanceTermVersion": { "type": "object", "properties": { "TermId": { "format": "int32", "type": "integer" }, "Auditing": { "$ref": "#/definitions/AuditingResponse" } } }, "AuditingResponse": { "type": "object", "properties": { "CreatedBy": { "$ref": "#/definitions/UserSummaryResponse" }, "CreatedAt": { "format": "date-time", "type": "string" }, "DeletedBy": { "$ref": "#/definitions/UserSummaryResponse" }, "DeletedAt": { "format": "date-time", "type": "string" } } }, "UserSummaryResponse": { "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "FirstName": { "type": "string" }, "LastName": { "type": "string" }, "Email": { "type": "string" } } }, "GetResidualConfigurationResponse": { "type": "object", "properties": { "Providers": { "type": "array", "items": { "$ref": "#/definitions/ResidualConfiguration" } } } }, "ResidualConfiguration": { "type": "object", "properties": { "Id": { "type": "string" }, "Key": { "type": "string" }, "Name": { "type": "string" }, "Visible": { "type": "boolean" }, "Editable": { "type": "boolean" }, "DisplayText": { "type": "string" }, "ManualResidualId": { "format": "int32", "type": "integer" }, "DataProviderId": { "format": "int32", "type": "integer" } } }, "GetProcessingRulesResponse": { "type": "object", "properties": { "Conditions": { "type": "object", "additionalProperties": { "$ref": "#/definitions/ProccesingRuleTypeResponse" } }, "Actions": { "type": "object", "additionalProperties": { "$ref": "#/definitions/ProccesingRuleTypeResponse" } } } }, "ProccesingRuleTypeResponse": { "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "LegacyId": { "format": "int32", "type": "integer" }, "Name": { "type": "string" }, "ValidationType": { "type": "string" }, "AllowMultiple": { "type": "boolean" }, "ValidationRegex": { "type": "string" }, "ValidationMessage": { "type": "string" }, "Description": { "type": "string" }, "isCondition": { "type": "boolean" }, "IsAvailableForSelection": { "type": "boolean" }, "IsAvailableForTerms": { "type": "boolean" }, "IsAvailableForProduct": { "type": "boolean" }, "IsAvailableForChannel": { "type": "boolean" }, "IsAvailableForVehicle": { "type": "boolean" }, "FinanceDomain": { "type": "string" }, "IsSelectable": { "type": "boolean" }, "JsonSchema": { "type": "string" } } }, "GetProductProfileRuleResponse": { "type": "object", "properties": { "Rules": { "type": "array", "items": { "$ref": "#/definitions/ProductProfileRule" } } } }, "ProductProfileRule": { "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "Name": { "type": "string" }, "DisplayName": { "type": "string" }, "AllowMultiple": { "type": "boolean" } } }, "FinanceIrelandUpdateStatusRequest": { "type": "object", "properties": { "Status": { "type": "string" }, "Notes": { "type": "string" } } }, "EvolutionStatusUpdateRequest": { "type": "object", "properties": { "ApplicationID": { "format": "int32", "type": "integer" }, "ProposalToken": { "type": "string" }, "MediaProviderRef": { "type": "string" }, "Event": { "type": "string" }, "Lenders": { "type": "array", "items": { "$ref": "#/definitions/EvolutionLender" } }, "EsignURL": { "type": "string" }, "EsignStatus": { "format": "int32", "type": "integer" } } }, "EvolutionLender": { "type": "object", "properties": { "LenderID": { "type": "string" }, "Sent": { "type": "boolean" }, "Status": { "format": "int32", "type": "integer" }, "EvoExtra": { "type": "boolean" }, "EvolutionProposal": { "$ref": "#/definitions/EvolutionProposal" } } }, "EvolutionProposal": { "type": "object", "properties": { "ProposalNumber": { "type": "string" }, "ConditionsApply": { "type": "boolean" }, "Conditions": { "type": "array", "items": { "$ref": "#/definitions/EvolutionCondition" } }, "EvolutionFigures": { "$ref": "#/definitions/EvolutionFigures" } } }, "EvolutionCondition": { "type": "object", "properties": { "Message": { "type": "string" } } }, "EvolutionFigures": { "type": "object", "properties": { "FirstPayment": { "format": "double", "type": "number" }, "LastPayment": { "format": "double", "type": "number" }, "RegularPayment": { "format": "double", "type": "number" }, "FlatRate": { "format": "double", "type": "number" }, "APR": { "format": "double", "type": "number" }, "TotalCharges": { "format": "double", "type": "number" }, "Advance": { "format": "double", "type": "number" }, "Term": { "format": "int32", "type": "integer" }, "FeeFront": { "format": "double", "type": "number" }, "FeeBack": { "format": "double", "type": "number" }, "FeeSpread": { "type": "boolean" }, "ExcessMileageCharges": { "type": "array", "items": { "$ref": "#/definitions/EvolutionExcessMileageCharge" } } } }, "EvolutionExcessMileageCharge": { "type": "object", "properties": { "MileageRange": { "type": "string" }, "ChargeInPence": { "format": "double", "type": "number" } } }, "EnquiryLabsStatusUpdateRequest": { "type": "object", "properties": { "LenderProposalReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "AgreementNumber": { "type": "string" }, "UpdateType": { "enum": [ "Unknown", "ProposalStatusUpdate", "ProposalNote" ], "type": "string" }, "UpdateValue": { "type": "string" } } }, "MercedesUpdateRequest": { "type": "object", "properties": { "UpdateDate": { "type": "string" } } }, "UpdateESignStatusRequest": { "type": "object", "properties": { "Status": { "type": "string" }, "ExternalIdentifier": { "type": "string" } } }, "CloseCalculationRequest": { "type": "object", "properties": { "Credentials": { "$ref": "#/definitions/FinanceCredentials" }, "CustomerParameters": { "$ref": "#/definitions/CloseParameters" }, "VehicleRequests": { "type": "array", "items": { "$ref": "#/definitions/CloseVehicleRequest" } }, "CustomerReference": { "type": "string" }, "Version": { "type": "string" }, "ResponseType": { "type": "string" } } }, "CloseParameters": { "type": "object", "properties": { "MaximumTerm": { "format": "int32", "type": "integer" }, "TotalDeposit": { "format": "double", "type": "number" }, "AnnualMileage": { "format": "int32", "type": "integer" }, "DepositType": { "enum": [ "Unknown", "Amount", "Percentage", "AdvancePayments" ], "type": "string" }, "RegularPayment": { "format": "int32", "type": "integer" }, "CalculateTo": { "enum": [ "RegularPayment", "CashDeposit" ], "type": "string" }, "CreditScore": { "format": "double", "type": "number" }, "Age": { "format": "int32", "type": "integer" }, "Postcode": { "type": "string" }, "MinimumPayment": { "format": "double", "type": "number" }, "MaximumPayment": { "format": "double", "type": "number" }, "DoNotSaveQuotes": { "type": "boolean" }, "BypassValidationRules": { "type": "boolean" }, "IsPersonalised": { "type": "boolean" } } }, "CloseVehicleRequest": { "type": "object", "properties": { "Id": { "type": "string" }, "Dealer": { "type": "string" }, "Vehicle": { "$ref": "#/definitions/CloseVehicle" }, "StockId": { "type": "string" }, "Products": { "type": "array", "items": { "$ref": "#/definitions/CloseProduct" } } } }, "CloseVehicle": { "type": "object", "properties": { "CashPrice": { "format": "double", "type": "number" }, "CurrentMileage": { "format": "int32", "type": "integer" }, "DateOfRegistration": { "type": "string" }, "IsNew": { "type": "boolean" }, "Identifier": { "type": "string" }, "IdentifierType": { "type": "string" }, "Type": { "type": "string" }, "VehicleType": { "enum": [ "Car", "Bike", "LCV" ], "type": "string", "readOnly": true }, "IsVatQualifying": { "type": "boolean" }, "StockId": { "type": "string" }, "ImageUrl": { "type": "string" }, "DealerVehicleUrl": { "type": "string" }, "DetailedPageUrl": { "type": "string" }, "RegistrationNumber": { "type": "string" }, "StockDate": { "type": "string" }, "ManualResidual": { "format": "double", "type": "number" }, "IsFranchiseApproved": { "type": "boolean" }, "VehicleTag": { "type": "string" } } }, "CloseProduct": { "type": "object", "properties": { "Key": { "type": "string" }, "OverrideCustomerParameters": { "$ref": "#/definitions/CloseParameters" }, "SellOut": { "$ref": "#/definitions/CloseSellOut" }, "FeeProfile": { "type": "string" }, "ResidualProfile": { "type": "string" } } }, "CloseSellOut": { "type": "object", "properties": { "Type": { "enum": [ "Undefined", "APR", "CustomerRate", "Commission", "RateSpread", "CommissionCashPricePercentage", "CommissionBalancePercentage" ], "type": "string" }, "Value": { "format": "double", "type": "number" } } }, "CloseCalculationResponse": { "type": "object", "properties": { "HasGlobalError": { "type": "boolean" }, "Error": { "$ref": "#/definitions/CloseError" }, "VehicleResults": { "type": "array", "items": { "$ref": "#/definitions/CloseVehicleResult" } }, "TypicalApr": { "type": "string" }, "RepresentativeExample": { "$ref": "#/definitions/CloseProductResult" }, "TimeTaken": { "format": "double", "type": "number" }, "CommsTimeTaken": { "format": "double", "type": "number" } } }, "CloseError": { "type": "object", "properties": { "UserError": { "type": "string" }, "TechnicalError": { "type": "string" } } }, "CloseVehicleResult": { "type": "object", "properties": { "Id": { "type": "string" }, "ProductResults": { "type": "array", "items": { "$ref": "#/definitions/CloseProductResult" } } } }, "CloseProductResult": { "type": "object", "properties": { "Key": { "type": "string" }, "HasError": { "type": "boolean" }, "Error": { "$ref": "#/definitions/CloseError" }, "Advisorys": { "$ref": "#/definitions/CloseAdvisorys" }, "Quote": { "$ref": "#/definitions/CloseQuote" }, "Notifications": { "$ref": "#/definitions/CloseNotifications" }, "Product": { "$ref": "#/definitions/CloseProductDetails" } } }, "CloseAdvisorys": { "type": "object", "properties": { "Advice": { "type": "array", "items": { "$ref": "#/definitions/CloseAdvice" } } } }, "CloseQuote": { "type": "object", "properties": { "QuoteReference": { "type": "string" }, "Product": { "$ref": "#/definitions/CloseProductDetails" }, "CashPrice": { "format": "double", "type": "number" }, "Deposit": { "format": "double", "type": "number" }, "Balance": { "format": "double", "type": "number" }, "Term": { "format": "int32", "type": "integer" }, "FirstPayment": { "format": "double", "type": "number" }, "RegularPayment": { "format": "double", "type": "number" }, "NumberOfRegularPayments": { "format": "int32", "type": "integer" }, "FinalPayment": { "format": "double", "type": "number" }, "Residual": { "format": "double", "type": "number" }, "ExcessMileage": { "format": "double", "type": "number" }, "AnnualMileage": { "format": "double", "type": "number" }, "DocumentationFee": { "$ref": "#/definitions/CloseFee" }, "OptionToPurchaseFee": { "$ref": "#/definitions/CloseFee" }, "APR": { "format": "double", "type": "number" }, "TotalAmountPayable": { "format": "double", "type": "number" }, "RateOfInterest": { "format": "double", "type": "number" }, "DepositContribution": { "format": "double", "type": "number" }, "ContractMileage": { "format": "int32", "type": "integer" }, "IsRepresentativeExample": { "type": "boolean" }, "TotalDeposit": { "format": "double", "type": "number" }, "CustomerDeposit": { "format": "double", "type": "number" }, "Fees": { "type": "array", "items": { "$ref": "#/definitions/CloseFee" } }, "Commission": { "format": "double", "type": "number" }, "InitialRate": { "format": "double", "type": "number" }, "InitialCommission": { "format": "double", "type": "number" }, "InstallmentRepayment": { "format": "double", "type": "number" }, "InstallmentInterest": { "format": "double", "type": "number" }, "ResidualRate": { "format": "double", "type": "number" }, "ResidualInterest": { "format": "double", "type": "number" }, "ResidualRepayment": { "format": "double", "type": "number" }, "CashPriceToDepositRatio": { "format": "double", "type": "number" }, "VehicleAge": { "format": "int32", "type": "integer" }, "GoodsType": { "type": "string" }, "DealerDivision": { "type": "string" }, "CustomerRate": { "format": "double", "type": "number" }, "GMFVPercentage": { "format": "double", "type": "number" } } }, "CloseNotifications": { "type": "object", "properties": { "Public": { "type": "array", "items": { "$ref": "#/definitions/CloseNotification" } }, "Private": { "type": "array", "items": { "$ref": "#/definitions/CloseNotification" } } } }, "CloseProductDetails": { "type": "object", "properties": { "Type": { "type": "string" }, "Name": { "type": "string" } } }, "CloseAdvice": { "type": "object", "properties": { "Value": { "type": "string" } } }, "CloseFee": { "type": "object", "properties": { "Amount": { "format": "double", "type": "number" }, "DisplayText": { "type": "string" }, "Description": { "type": "string" }, "WhenIsFeePaid": { "type": "string" } } }, "CloseNotification": { "type": "object", "properties": { "Message": { "type": "string" } } }, "CloseDocumentUpdateRequest": { "type": "object", "properties": { "Credentials": { "$ref": "#/definitions/FinanceCredentials" }, "Document": { "$ref": "#/definitions/CloseProposalDocument" } } }, "CloseProposalDocument": { "type": "object", "properties": { "Organisation": { "type": "string" }, "LenderProposalId": { "type": "string" }, "Document": { "type": "string" }, "DocumentType": { "type": "string" } } }, "CloseDocumentUpdateResponse": { "type": "object", "properties": { "Success": { "type": "boolean" }, "ResponseText": { "type": "string" } } }, "RegisterDealerStateRequest": { "type": "object", "properties": { "Credentials": { "$ref": "#/definitions/FinanceCredentials" }, "Actions": { "type": "array", "items": { "$ref": "#/definitions/CloseAction" } } } }, "CloseAction": { "type": "object", "properties": { "Type": { "enum": [ "CreateDealer", "UpdateDealer", "DeleteDealer", "PullPricingInfo" ], "type": "string" }, "DealerShortCode": { "type": "string" } } }, "CloseStatusUpdateRequest": { "type": "object", "properties": { "Credentials": { "$ref": "#/definitions/FinanceCredentials" }, "Proposal": { "$ref": "#/definitions/CloseProposalInformation" } } }, "CloseProposalInformation": { "type": "object", "properties": { "LenderProposalId": { "type": "string" }, "Status": { "type": "string" }, "Note": { "type": "string" } } }, "CloseStatusUpdateResponse": { "type": "object", "properties": { "Success": { "type": "boolean" }, "ResponseText": { "type": "string" } } }, "CdkFinanceQuoteCommissionResponse": { "type": "object", "properties": { "RetailerCommission": { "format": "double", "type": "number" }, "RetailerVolumeBonusPercentage": { "format": "double", "type": "number" } } }, "CustomBmwStockPriceRequest": { "required": [ "Vehicles" ], "type": "object", "properties": { "Organisation": { "$ref": "#/definitions/OrganisationIdentifier" }, "Vehicles": { "type": "array", "items": { "$ref": "#/definitions/CustomBmwStockPrice" } } } }, "CustomBmwStockPrice": { "required": [ "Vin" ], "type": "object", "properties": { "Vin": { "type": "string" }, "OnTheRoadPrice": { "format": "double", "type": "number" } } }, "SingleSignOnRequest": { "type": "object", "properties": { "AccessToken": { "type": "string" }, "Brand": { "type": "string" } } }, "SingleSignOnResponse": { "type": "object", "properties": { "UserToken": { "type": "string" }, "ExpiresAt": { "format": "date-time", "type": "string" } } }, "BmwSingleSignOnRequest": { "type": "object", "properties": { "AccessToken": { "type": "string" }, "FirstName": { "type": "string" }, "LastName": { "type": "string" }, "DealerNumber": { "type": "string" }, "Role": { "type": "string" }, "Brand": { "type": "string" }, "Environment": { "type": "string" } } }, "ListOrganisationAprResult": { "type": "object", "properties": { "OrganisationAprResults": { "type": "array", "items": { "$ref": "#/definitions/OrganisationAprResult" } }, "AuthenticationToken": { "type": "string" }, "ReportType": { "type": "string" }, "Brand": { "type": "string" } } }, "OrganisationAprResult": { "type": "object", "properties": { "PackageName": { "type": "string" }, "TermsId": { "type": "string" }, "TermsName": { "type": "string" }, "SubmissionKey": { "type": "string" }, "TermGroupId": { "type": "string" }, "ProductName": { "type": "string" }, "MappingSelloutRate": { "type": "string" }, "DealerId": { "type": "string" }, "TradingName": { "type": "string" } } }, "BmwReportResponse": { "type": "object", "properties": { "Value": { "type": "string", "readOnly": true } } }, "CustomBmwOfferResponse": { "type": "object", "properties": { "Offer": { "$ref": "#/definitions/Offer" } } }, "Offer": { "type": "object", "properties": { "OfferCode": { "type": "string" }, "OfferTitle": { "type": "string" }, "OfferSubtitle": { "type": "string" }, "OfferDescription": { "type": "string" }, "Active": { "type": "boolean" }, "HeadlineOffer": { "type": "boolean" }, "IsRepresentativeExample": { "type": "boolean" }, "ValidFrom": { "format": "date-time", "type": "string" }, "ValidTo": { "format": "date-time", "type": "string" }, "Quote": { "$ref": "#/definitions/OfferQuote" }, "Vehicle": { "$ref": "#/definitions/OfferVehicle" }, "Images": { "$ref": "#/definitions/OfferImages" }, "Additional": { "$ref": "#/definitions/OfferAdditional" } } }, "OfferQuote": { "type": "object", "properties": { "QuoteReference": { "type": "string" }, "ProductFamily": { "type": "string" }, "ProductKey": { "type": "string" }, "RegularPayment": { "format": "double", "type": "number" }, "Apr": { "format": "double", "type": "number" }, "CashDeposit": { "format": "double", "type": "number" }, "CustomerRate": { "format": "double", "type": "number" }, "TotalContribution": { "format": "double", "type": "number" }, "OnTheRoadPrice": { "format": "double", "type": "number" }, "ProductAbbreviation": { "type": "string" }, "Term": { "format": "int32", "type": "integer" }, "DepositContributions": { "type": "array", "items": { "$ref": "#/definitions/DepositContributionV2" } }, "AnnualMileage": { "format": "int32", "type": "integer" }, "IsTelematics": { "type": "boolean" }, "TotalRegularPayment": { "format": "double", "type": "number" } } }, "OfferVehicle": { "type": "object", "properties": { "Identifier": { "type": "string" }, "IdentifierType": { "type": "string" }, "Description": { "type": "string" }, "Model": { "type": "string" }, "BodyStyle": { "type": "string" }, "Derivative": { "type": "string" }, "Manufacturer": { "type": "string" }, "FuelType": { "type": "string" }, "Transmission": { "type": "string" }, "VehicleType": { "type": "string" }, "Doors": { "format": "int32", "type": "integer" }, "EngineSize": { "format": "int32", "type": "integer" }, "Emissions": { "format": "int32", "type": "integer" }, "Variant": { "type": "string" }, "Keywords": { "type": "array", "items": { "type": "string" } }, "InsuranceGroup": { "type": "string" }, "MilesPerGallon": { "format": "double", "type": "number" }, "SixMonthsSubsequentRoadFundLicence": { "format": "double", "type": "number" }, "EquipmentOptions": { "type": "array", "items": { "$ref": "#/definitions/EquipmentOptionV2" } }, "IsNew": { "type": "boolean" }, "CostBreakdown": { "$ref": "#/definitions/CostBreakdown" } } }, "OfferImages": { "type": "object", "properties": { "Banner": { "type": "string" }, "Tile": { "type": "string" }, "ImageUri": { "type": "string" }, "DerivativeImage": { "type": "string" }, "Gallery": { "type": "array", "items": { "type": "string" } } } }, "OfferAdditional": { "type": "object", "properties": { "ConfigId": { "type": "string" }, "ModelOverviewUrl": { "type": "string" }, "ModelSpecificationsUrl": { "type": "string" } } }, "DepositContributionV2": { "type": "object", "properties": { "Type": { "type": "string" }, "Amount": { "format": "double", "type": "number" } } }, "EquipmentOptionV2": { "type": "object", "properties": { "Id": { "type": "string" }, "Description": { "type": "string" }, "Price": { "format": "double", "type": "number" } } }, "CustomBmwOffersResponse": { "type": "object", "properties": { "Offers": { "type": "array", "items": { "$ref": "#/definitions/DeprecatedV1Offer" } }, "RepresentativeExample": { "$ref": "#/definitions/RepresentativeExample" } } }, "DeprecatedV1Offer": { "type": "object", "properties": { "OfferCode": { "type": "string" }, "OfferTitle": { "type": "string" }, "ConfigId": { "type": "string" }, "OfferDescription": { "type": "string" }, "HeadlineOffer": { "type": "boolean" }, "ImageUri": { "type": "string" }, "VehicleDescription": { "type": "string" }, "VehicleIdentifier": { "type": "string" }, "VehicleIdentifierType": { "type": "string" }, "Model": { "type": "string" }, "BodyStyle": { "type": "string" }, "ProductFamily": { "type": "string" }, "MonthlyPayment": { "format": "double", "type": "number" }, "APR": { "format": "double", "type": "number" }, "CustomerDeposit": { "format": "double", "type": "number" }, "TotalContribution": { "format": "double", "type": "number" }, "QuoteReference": { "type": "string" }, "Manufacturer": { "type": "string" }, "FuelType": { "type": "string" }, "Transmission": { "type": "string" }, "VehicleType": { "type": "string" }, "Door": { "format": "int32", "type": "integer" }, "EngineSize": { "format": "int32", "type": "integer" }, "Keywords": { "type": "array", "items": { "type": "string" } }, "OnTheRoadPrice": { "format": "double", "type": "number" }, "ModelOverviewUrl": { "type": "string" }, "OfferSubtitle": { "type": "string" }, "ModelSpecificationsUrl": { "type": "string" }, "BannerImage": { "type": "string" }, "TileImage": { "type": "string" }, "Gallery1": { "type": "string" }, "Gallery2": { "type": "string" }, "Gallery3": { "type": "string" }, "ValidTo": { "format": "date-time", "type": "string" }, "ValidFrom": { "format": "date-time", "type": "string" }, "IsRepresentativeExample": { "type": "boolean" }, "Term": { "format": "int32", "type": "integer" }, "AnnualMileage": { "format": "int32", "type": "integer" }, "DepositContributions": { "type": "array", "items": { "$ref": "#/definitions/DeprecatedV1DepositContribution" } } } }, "RepresentativeExample": { "type": "object", "properties": { "Term": { "format": "int32", "type": "integer" }, "MonthlyPayment": { "format": "double", "type": "number" }, "OnTheRoadCashPrice": { "format": "double", "type": "number" }, "CustomerDeposit": { "format": "double", "type": "number" }, "OurDepositContribution": { "format": "double", "type": "number" }, "TotalDeposit": { "format": "double", "type": "number" }, "TotalAmountOfCredit": { "format": "double", "type": "number" }, "OptionalFinalPayment": { "format": "double", "type": "number" }, "OptionToPurchaseFee": { "format": "double", "type": "number" }, "TotalAmoutPayable": { "format": "double", "type": "number" }, "RateOfInterest": { "format": "double", "type": "number" }, "Apr": { "format": "double", "type": "number" }, "Product": { "type": "string" }, "VehicleDescription": { "type": "string" }, "TermsAndConditions": { "type": "string" } } }, "DeprecatedV1DepositContribution": { "type": "object", "properties": { "Amount": { "format": "double", "type": "number" }, "Type": { "type": "string" }, "Description": { "type": "string" } } }, "BlackHorseCallbackRequest": { "type": "object", "properties": { "customer_id": { "format": "int32", "type": "integer" }, "proposal_id": { "format": "int32", "type": "integer" }, "update_type": { "type": "string" }, "update": { "type": "string" } } }, "AutoConvertUpdateStatusRequest": { "type": "object", "properties": { "LenderProposalReference": { "type": "string" }, "Status": { "type": "string" } } }, "DashboardSearchRequest": { "required": [ "Query" ], "type": "object", "properties": { "Query": { "type": "string" } } }, "DashboardSearchResponse": { "type": "object", "properties": { "Vehicles": { "$ref": "#/definitions/DashboardVehicles" } } }, "DashboardVehicles": { "type": "object", "properties": { "Results": { "type": "array", "items": { "$ref": "#/definitions/Vehicle" } } } }, "DashboardTypesResponse": { "type": "object", "properties": { "Folders": { "type": "array", "items": { "$ref": "#/definitions/DashboardFolder" } } } }, "DashboardFolder": { "type": "object", "properties": { "Name": { "type": "string" }, "Dashboards": { "type": "array", "items": { "$ref": "#/definitions/InsightsDashboard" } } } }, "InsightsDashboard": { "type": "object", "properties": { "Id": { "format": "uuid", "type": "string", "readOnly": true, "example": "00000000-0000-0000-0000-000000000000" }, "Name": { "type": "string", "readOnly": true } } }, "DashboardResponse": { "type": "object", "properties": { "Url": { "type": "string" } } }, "GetDashboardsResponse": { "type": "object", "properties": { "Dashboards": { "type": "array", "items": { "$ref": "#/definitions/Dashboard" } } } }, "Dashboard": { "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Type": { "enum": [ "Unknown", "Retailer", "Lender", "Internal" ], "type": "string" }, "Folder": { "type": "string" }, "Name": { "type": "string" }, "Provider": { "enum": [ "Unknown", "Metabase" ], "type": "string" }, "ParameterProviders": { "type": "array", "items": { "$ref": "#/definitions/DashboardParameter" } }, "ExternalReference": { "type": "string" }, "Organisations": { "type": "array", "items": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } } }, "DashboardParameter": { "type": "object", "properties": { "Type": { "enum": [ "Unknown", "Environment", "SystemKey", "Organisation", "OrganisationIncludingChildren", "LenderNames", "AppIds", "ExternalApplicationName", "Workspace" ], "type": "string" }, "ExternalProviderFieldName": { "type": "string" }, "Value": { "type": "string" } } }, "CreateDashboardRequest": { "type": "object", "properties": { "Folder": { "type": "string" }, "Name": { "type": "string" }, "Type": { "enum": [ "Unknown", "Retailer", "Lender", "Internal" ], "type": "string" }, "Provider": { "enum": [ "Unknown", "Metabase" ], "type": "string" }, "ParameterProviders": { "type": "array", "items": { "$ref": "#/definitions/DashboardParameter" } }, "ExternalReference": { "type": "string" }, "Organisations": { "type": "array", "items": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } } }, "CreateDashboardResponse": { "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Type": { "enum": [ "Unknown", "Retailer", "Lender", "Internal" ], "type": "string" }, "Folder": { "type": "string" }, "Name": { "type": "string" }, "Provider": { "enum": [ "Unknown", "Metabase" ], "type": "string" }, "ParameterProviders": { "type": "array", "items": { "$ref": "#/definitions/DashboardParameter" } }, "ExternalReference": { "type": "string" }, "Organisations": { "type": "array", "items": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } } }, "SearchDashboardsRequest": { "required": [ "Filters" ], "type": "object", "properties": { "Filters": { "$ref": "#/definitions/SearchDashboardFilters" } } }, "SearchDashboardFilters": { "required": [ "Dashboard" ], "type": "object", "properties": { "Dashboard": { "$ref": "#/definitions/DashboardFilters" } } }, "DashboardFilters": { "type": "object", "properties": { "AllowedNames": { "type": "array", "items": { "type": "string" } }, "AllowedFolders": { "type": "array", "items": { "type": "string" } }, "AllowedExternalReferences": { "type": "array", "items": { "type": "string" } }, "AllowedTypes": { "type": "array", "items": { "enum": [ "Unknown", "Retailer", "Lender", "Internal" ], "type": "string" } } } }, "SearchDashboardsResponse": { "type": "object", "properties": { "Dashboards": { "type": "array", "items": { "$ref": "#/definitions/Dashboard" } } } }, "GetDashboardTypesResponse": { "type": "object", "properties": { "ParameterTypes": { "type": "array", "items": { "$ref": "#/definitions/DashboardParameterType" } } } }, "DashboardParameterType": { "type": "object", "properties": { "Value": { "enum": [ "Unknown", "Environment", "SystemKey", "Organisation", "OrganisationIncludingChildren", "LenderNames", "AppIds", "ExternalApplicationName", "Workspace" ], "type": "string" } } }, "GetDashboardResponse": { "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Type": { "enum": [ "Unknown", "Retailer", "Lender", "Internal" ], "type": "string" }, "Folder": { "type": "string" }, "Name": { "type": "string" }, "Provider": { "enum": [ "Unknown", "Metabase" ], "type": "string" }, "ParameterProviders": { "type": "array", "items": { "$ref": "#/definitions/DashboardParameter" } }, "ExternalReference": { "type": "string" }, "Organisations": { "type": "array", "items": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } } }, "UpdateDashboardRequest": { "type": "object", "properties": { "Type": { "enum": [ "Unknown", "Retailer", "Lender", "Internal" ], "type": "string" }, "Folder": { "type": "string" }, "Name": { "type": "string" }, "Provider": { "enum": [ "Unknown", "Metabase" ], "type": "string" }, "ParameterProviders": { "type": "array", "items": { "$ref": "#/definitions/DashboardParameter" } }, "ExternalReference": { "type": "string" }, "Organisations": { "type": "array", "items": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } } }, "UpdateDashboardResponse": { "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Type": { "enum": [ "Unknown", "Retailer", "Lender", "Internal" ], "type": "string" }, "Folder": { "type": "string" }, "Name": { "type": "string" }, "Provider": { "enum": [ "Unknown", "Metabase" ], "type": "string" }, "ParameterProviders": { "type": "array", "items": { "$ref": "#/definitions/DashboardParameter" } }, "ExternalReference": { "type": "string" }, "Organisations": { "type": "array", "items": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } } }, "DeleteDashboardResponse": { "type": "object", "properties": {} }, "AvailableProcessingMeasureTypesModel": { "type": "object", "properties": { "CustomerJourneys": { "type": "array", "items": { "$ref": "#/definitions/DataProcessingType" } }, "ProcessingCategories": { "type": "array", "items": { "$ref": "#/definitions/DataProcessingType" } }, "SecurityMeasures": { "type": "array", "items": { "$ref": "#/definitions/DataProcessingType" } } } }, "DataProcessingType": { "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "Name": { "type": "string" } } }, "DataPolicyModel": { "required": [ "ProcessedRetentionScheduleInMonths", "UnprocessedRetentionScheduleInMonths", "DataController", "ProcessingMeasures" ], "type": "object", "properties": { "ProcessedRetentionScheduleInMonths": { "format": "int32", "type": "integer" }, "UnprocessedRetentionScheduleInMonths": { "format": "int32", "type": "integer" }, "DataController": { "$ref": "#/definitions/DataPolicyControllerDetails" }, "ProcessingMeasures": { "type": "array", "items": { "$ref": "#/definitions/ProcessingMeasureModel" } }, "SalesforceId": { "type": "string" }, "Messages": { "type": "array", "items": { "type": "string" } } } }, "DataPolicyControllerDetails": { "required": [ "Name", "Address", "Email", "Telephone" ], "type": "object", "properties": { "Name": { "type": "string" }, "Address": { "type": "string" }, "Email": { "type": "string" }, "Telephone": { "type": "string" } } }, "ProcessingMeasureModel": { "required": [ "JourneyTypeId", "ProcessingCategoryId", "SecurityMeasureTypeId" ], "type": "object", "properties": { "JourneyTypeId": { "format": "int32", "type": "integer" }, "ProcessingCategoryId": { "format": "int32", "type": "integer" }, "SecurityMeasureTypeId": { "format": "int32", "type": "integer" } } }, "SetCustomQuotaRequest": { "required": [ "CustomQuotaInGigabytes" ], "type": "object", "properties": { "CustomQuotaInGigabytes": { "format": "int32", "maximum": 999, "minimum": 0, "type": "integer" } } }, "GetCustomQuotaResponse": { "type": "object", "properties": { "CustomQuotaInGigabytes": { "format": "int32", "type": "integer" } } }, "DealerBrandingResponse": { "type": "object", "properties": { "BrandingExists": { "type": "boolean" }, "PageTitle": { "type": "string" }, "CssUrl": { "type": "string" }, "LogoUrl": { "type": "string" }, "LogoHeaderUrl": { "type": "string" }, "Name": { "type": "string" } } }, "RedirectResult": { "type": "object", "properties": { "Location": { "type": "string", "readOnly": true }, "Request": { "type": "object", "readOnly": true } } }, "DealerCreateUpdateRequest": { "type": "object", "properties": { "AssociatedKey": { "type": "string" }, "Id": { "format": "int32", "type": "integer" }, "Name": { "type": "string" }, "Address": { "$ref": "#/definitions/BusinessAddress" }, "Contact": { "$ref": "#/definitions/ContactInformation" }, "FCANumber": { "type": "string" }, "Active": { "type": "boolean" }, "RepublicOfIrelandDealer": { "type": "boolean" }, "CRMReference": { "type": "string" }, "Products": { "type": "array", "items": { "$ref": "#/definitions/DealerProduct" } }, "AssociatedDealers": { "type": "array", "items": { "$ref": "#/definitions/AssociatedDealer" } }, "AdditionalData": { "type": "object", "additionalProperties": { "type": "boolean" } }, "GroupDealers": { "type": "array", "items": { "$ref": "#/definitions/AssociatedDealer" } }, "Reference": { "type": "string" }, "_links": { "type": "object", "additionalProperties": { "$ref": "#/definitions/Href" }, "readOnly": true }, "_embedded": { "type": "object", "additionalProperties": { "type": "object" }, "readOnly": true } } }, "BusinessAddress": { "type": "object", "properties": { "NameNumber": { "type": "string" }, "Line1": { "type": "string" }, "Line2": { "type": "string" }, "Line3": { "type": "string" }, "TownCity": { "type": "string" }, "County": { "type": "string" }, "Postcode": { "type": "string" }, "IncludePostcode": { "type": "boolean" }, "Latitude": { "format": "double", "type": "number" }, "Longitude": { "format": "double", "type": "number" }, "Country": { "type": "string" } } }, "ContactInformation": { "type": "object", "properties": { "Email": { "type": "string" }, "PhoneNumber": { "type": "string" } } }, "DealerProduct": { "type": "object", "properties": { "Error": { "$ref": "#/definitions/ErrorResponse" }, "Id": { "format": "int32", "type": "integer" }, "Key": { "type": "string" }, "Sellout": { "$ref": "#/definitions/DeprecatedSellout" }, "GroupName": { "type": "string" }, "TermGroupId": { "format": "int32", "type": "integer" }, "Family": { "type": "string" }, "Lender": { "type": "string" }, "Description": { "type": "string" } } }, "AssociatedDealer": { "type": "object", "properties": { "Key": { "type": "string" }, "DealerName": { "type": "string" }, "DealerId": { "format": "int32", "type": "integer" } } }, "Href": { "type": "object", "properties": { "href": { "type": "string" } } }, "DeprecatedSellout": { "type": "object", "properties": { "Value": { "format": "double", "type": "number" }, "Type": { "description": "Possible values: \"Apr\", \"CustomerRate\", \"Aer\", \"RateSpread\", \"Yield\"", "type": "string" } } }, "PostDealerResponse": { "type": "object", "properties": { "Error": { "$ref": "#/definitions/ErrorResponse" }, "Id": { "format": "int32", "type": "integer" }, "_links": { "type": "object", "additionalProperties": { "$ref": "#/definitions/Href" }, "readOnly": true }, "_embedded": { "type": "object", "additionalProperties": { "type": "object" }, "readOnly": true } } }, "GetDealerResponse": { "type": "object", "properties": { "Error": { "$ref": "#/definitions/ErrorResponse" }, "IsBespoke": { "type": "boolean" }, "Id": { "format": "int32", "type": "integer" }, "Name": { "type": "string" }, "Address": { "$ref": "#/definitions/BusinessAddress" }, "Contact": { "$ref": "#/definitions/ContactInformation" }, "FCANumber": { "type": "string" }, "Active": { "type": "boolean" }, "RepublicOfIrelandDealer": { "type": "boolean" }, "CRMReference": { "type": "string" }, "Products": { "type": "array", "items": { "$ref": "#/definitions/DealerProduct" } }, "AssociatedDealers": { "type": "array", "items": { "$ref": "#/definitions/AssociatedDealer" } }, "AdditionalData": { "type": "object", "additionalProperties": { "type": "boolean" } }, "GroupDealers": { "type": "array", "items": { "$ref": "#/definitions/AssociatedDealer" } }, "Reference": { "type": "string" }, "_links": { "type": "object", "additionalProperties": { "$ref": "#/definitions/Href" }, "readOnly": true }, "_embedded": { "type": "object", "additionalProperties": { "type": "object" }, "readOnly": true } } }, "DealerProductRequest": { "type": "object", "properties": { "Products": { "type": "array", "items": { "$ref": "#/definitions/DealerProduct" } } } }, "BespokeFinanceRequest": { "type": "object", "properties": {} }, "UtmParameters": { "description": "Allows UTM parameters to be persisted for statistics and analytics purposes.", "type": "object", "properties": { "UtmCampaign": { "description": "Identifies a specific product promotion or strategic campaign.", "type": "string" }, "UtmContent": { "description": "Identifies what specifically was clicked, such as a banner ad or a text link.", "type": "string" }, "UtmMedium": { "description": "Identifies what type of link was used, such as cost per click or email.", "type": "string" }, "UtmSource": { "description": "Identifies which site sent the traffic.", "type": "string" }, "UtmTerm": { "description": "Identifies search terms.", "type": "string" } } }, "RootDocumentResponse": { "type": "object", "properties": {} }, "GetDocumentDetailsResponse": { "type": "object", "properties": { "Details": { "$ref": "#/definitions/DocumentDetail" } } }, "DocumentDetail": { "type": "object", "properties": { "Content": { "type": "string" } } }, "PerformDocumentActionRequest": { "type": "object", "properties": { "Action": { "enum": [ "Unknown", "ReadInFull" ], "type": "string" } } }, "PerformDocumentActionResponse": { "type": "object", "properties": {} }, "ProposalDetailsResponse": { "type": "object", "properties": { "Id": { "type": "string" }, "Applicants": { "type": "array", "items": { "$ref": "#/definitions/IndividualApplicantResponse" } }, "Organisations": { "type": "array", "items": { "$ref": "#/definitions/ProposalOrganisationResponse" } }, "BankDetails": { "$ref": "#/definitions/BankDetailsResponse" }, "Note": { "type": "string" }, "AssetType": { "type": "string" }, "EntityType": { "type": "string" }, "Dealer": { "$ref": "#/definitions/PlutusDealer" }, "QuoteReference": { "type": "string" }, "LenderProposalReference": { "type": "string" }, "AdditionalInformation": { "$ref": "#/definitions/AdditionalInformation" }, "ProposalId": { "format": "int32", "type": "integer" }, "Status": { "type": "string" }, "AssignedRetailerUser": { "$ref": "#/definitions/AssignedUserToProposal" }, "Type": { "enum": [ "Unknown", "Retail", "Fleet", "CreditLineApplication", "CreditLineOrder" ], "type": "string" }, "CustomerName": { "type": "string" }, "HasError": { "type": "boolean", "readOnly": true }, "Errors": { "type": "array", "items": { "$ref": "#/definitions/ErrorResponse" }, "readOnly": true }, "IsAuthenticated": { "type": "boolean" } } }, "IndividualApplicantResponse": { "type": "object", "properties": { "PersonalDetails": { "$ref": "#/definitions/PersonalDetailsResponse" }, "AddressHistory": { "type": "array", "items": { "$ref": "#/definitions/AddressResponse" } }, "EmploymentHistory": { "type": "array", "items": { "$ref": "#/definitions/EmploymentResponse" } } } }, "ProposalOrganisationResponse": { "type": "object", "properties": { "OrganisationDetails": { "$ref": "#/definitions/OrganisationDetailsResponse" }, "BusinessOwners": { "type": "array", "items": { "$ref": "#/definitions/BusinessOwnerResponse" } }, "AddressHistory": { "type": "array", "items": { "$ref": "#/definitions/AddressResponse" } } } }, "BankDetailsResponse": { "type": "object", "properties": { "AccountName": { "type": "string" }, "AccountType": { "type": "string" }, "SortCode": { "type": "string" }, "AccountNumber": { "type": "string" }, "BankName": { "type": "string" }, "BranchName": { "type": "string" }, "BankAddress": { "type": "string" }, "YearsAtBank": { "format": "int32", "type": "integer" } } }, "PlutusDealer": { "type": "object", "properties": { "Id": { "type": "string" }, "Name": { "type": "string" }, "Telephone": { "type": "string" }, "Email": { "type": "string" } } }, "AdditionalInformation": { "type": "object", "properties": { "RegistrationNumber": { "type": "string" }, "ChassisNumber": { "type": "string" }, "RegistrationDate": { "type": "string" }, "DeliveryMileage": { "type": "string" }, "DeliveryDate": { "type": "string" } } }, "AssignedUserToProposal": { "type": "object", "properties": { "UserReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Name": { "type": "string" } } }, "PersonalDetailsResponse": { "type": "object", "properties": { "Title": { "type": "string" }, "Forename": { "type": "string" }, "MiddleName": { "type": "string" }, "Surname": { "type": "string" }, "HomeTelephone": { "type": "string" }, "MobileTelephone": { "type": "string" }, "Email": { "type": "string" }, "DateOfBirth": { "format": "date-time", "type": "string" }, "Gender": { "type": "string" }, "MaritalStatus": { "type": "string" }, "Dependants": { "format": "int32", "type": "integer" }, "HighNetWorth": { "type": "boolean" }, "PurchasingForBusinessUse": { "type": "boolean" }, "PreviousSurname": { "type": "string" } } }, "AddressResponse": { "type": "object", "properties": { "Accommodation": { "type": "string" }, "Postcode": { "type": "string" }, "HouseNumber": { "type": "string" }, "HouseName": { "type": "string" }, "AddressLine1": { "type": "string" }, "AddressLine2": { "type": "string" }, "AddressLine3": { "type": "string" }, "TownCity": { "type": "string" }, "County": { "type": "string" }, "YearsAtAddress": { "format": "int32", "type": "integer" }, "MonthsAtAddress": { "format": "int32", "type": "integer" } } }, "EmploymentResponse": { "type": "object", "properties": { "Postcode": { "type": "string" }, "BuildingNumber": { "type": "string" }, "BuildingName": { "type": "string" }, "AddressLine1": { "type": "string" }, "AddressLine2": { "type": "string" }, "AddressLine3": { "type": "string" }, "TownCity": { "type": "string" }, "County": { "type": "string" }, "Employer": { "type": "string" }, "PhoneNumber": { "type": "string" }, "Occupation": { "type": "string" }, "Basis": { "type": "string" }, "Category": { "type": "string" }, "YearsAtEmployment": { "format": "int32", "type": "integer" }, "MonthsAtEmployment": { "format": "int32", "type": "integer" }, "GrossSalaryAnnual": { "type": "string" }, "TypicalNetIncomeMonthly": { "type": "string" } } }, "OrganisationDetailsResponse": { "type": "object", "properties": { "RegistrationNumber": { "type": "string" }, "DateEstablished": { "format": "date-time", "type": "string" }, "Telephone": { "type": "string" }, "IsVatRegistered": { "type": "boolean" }, "BusinessType": { "type": "string" }, "VatNumber": { "type": "string" }, "TradingName": { "type": "string" }, "NumberOfBusinessOwners": { "format": "int32", "type": "integer" }, "CharityNumber": { "type": "string" } } }, "BusinessOwnerResponse": { "type": "object", "properties": { "BusinessOwnerDetails": { "$ref": "#/definitions/BusinessOwnerDetailsResponse" }, "AddressHistory": { "type": "array", "items": { "$ref": "#/definitions/AddressResponse" } } } }, "BusinessOwnerDetailsResponse": { "type": "object", "properties": { "Title": { "type": "string" }, "Forename": { "type": "string" }, "MiddleName": { "type": "string" }, "Surname": { "type": "string" }, "HomeTelephone": { "type": "string" }, "MobileTelephone": { "type": "string" }, "Email": { "type": "string" }, "DateOfBirth": { "format": "date-time", "type": "string" }, "Gender": { "type": "string" }, "MaritalStatus": { "type": "string" }, "Dependants": { "format": "int32", "type": "integer" }, "IsGuarantor": { "type": "boolean" }, "IsAuthorisedSignatory": { "type": "boolean" }, "IncomeTaxRate": { "format": "int32", "type": "integer" } } }, "CustomerSelectedCreditTiers": { "type": "object", "properties": { "IsRequired": { "type": "boolean" }, "Default": { "enum": [ "Unknown", "BelowAverage", "Fair", "Good", "VeryGood", "Excellent" ], "type": "string" }, "Tiers": { "type": "array", "items": { "$ref": "#/definitions/CustomerSelectedCreditTier" } }, "OrderNo": { "format": "int32", "type": "integer" } } }, "CustomerSelectedCreditTier": { "type": "object", "properties": { "Value": { "enum": [ "Unknown", "BelowAverage", "Fair", "Good", "VeryGood", "Excellent" ], "type": "string" }, "Display": { "type": "string" } } }, "FeeElement": { "type": "object", "properties": { "Amount": { "format": "double", "type": "number" }, "Profile": { "type": "string" }, "Type": { "type": "string" }, "ExternalIdentifier": { "type": "string" } } }, "UserModuleReportRequest": { "type": "object", "properties": { "RoleId": { "type": "string" }, "UserReference": { "type": "string" }, "PrimaryDealerId": { "type": "string" } } }, "FinanceCalculationResponse": { "type": "object", "properties": { "HasError": { "type": "boolean" }, "Error": { "$ref": "#/definitions/ErrorResponse" }, "VehicleResults": { "type": "array", "items": { "$ref": "#/definitions/FinanceCalculationVehicleResult" } }, "FinanceOptions": { "$ref": "#/definitions/FinanceOptions" }, "CalculatingKey": { "type": "string" }, "RepresentativeExample": { "$ref": "#/definitions/FinanceProductResult" }, "CalculationViewPartial": { "type": "string" } } }, "FinanceCalculationVehicleResult": { "type": "object", "properties": { "FinanceProductResults": { "type": "array", "items": { "$ref": "#/definitions/FinanceProductResult" } }, "Id": { "type": "string" }, "HasError": { "type": "boolean" }, "Error": { "$ref": "#/definitions/FinanceError" } } }, "FinanceOptions": { "type": "object", "properties": { "DefaultAnnualMileage": { "format": "int32", "type": "integer" }, "DefaultTerm": { "format": "int32", "type": "integer" }, "Deposit": { "format": "double", "type": "number" }, "Terms": { "type": "array", "items": { "format": "int32", "type": "integer" } }, "AnnualMileages": { "type": "array", "items": { "format": "int32", "type": "integer" } }, "MinTerm": { "format": "int32", "type": "integer" }, "MaxTerm": { "format": "int32", "type": "integer" }, "MinMileage": { "format": "int32", "type": "integer" }, "MaxMileage": { "format": "int32", "type": "integer" } } }, "FinanceProductResult": { "type": "object", "properties": { "Key": { "type": "string" }, "HasError": { "type": "boolean" }, "Error": { "$ref": "#/definitions/FinanceError" }, "Notifications": { "$ref": "#/definitions/Notifications" }, "Quote": { "$ref": "#/definitions/FinanceQuote" }, "Product": { "$ref": "#/definitions/ProductDetails" }, "Data": { "type": "string" }, "Vehicle": { "$ref": "#/definitions/DeprecatedVehicle" }, "Descriptions": { "$ref": "#/definitions/Descriptions" }, "IsOffer": { "type": "boolean" }, "Offer": { "$ref": "#/definitions/DeprecatedOffer" } } }, "FinanceError": { "type": "object", "properties": { "DealerMessage": { "type": "string" }, "TechnicalMessage": { "type": "string" }, "Code": { "format": "int32", "type": "integer" } } }, "Notifications": { "type": "object", "properties": { "Public": { "type": "array", "items": { "$ref": "#/definitions/Notification" } } } }, "FinanceQuote": { "type": "object", "properties": { "AllInclusiveRegularPayment": { "format": "double", "type": "number" }, "Product": { "$ref": "#/definitions/ProductDetails" }, "CashPrice": { "format": "double", "type": "number" }, "TotalPrice": { "format": "double", "type": "number" }, "TotalDeposit": { "format": "double", "type": "number" }, "Deposit": { "format": "double", "type": "number" }, "Balance": { "format": "double", "type": "number" }, "Term": { "format": "int32", "type": "integer" }, "RegularPayment": { "format": "double", "type": "number" }, "Residual": { "format": "double", "type": "number" }, "ExcessMileageRate": { "format": "double", "type": "number" }, "AnnualMileage": { "format": "int32", "type": "integer" }, "ContractMileage": { "format": "int32", "type": "integer" }, "CostBreakdown": { "$ref": "#/definitions/DeprecatedCostBreakdown" }, "Fees": { "type": "array", "items": { "$ref": "#/definitions/DeprecatedFinanceFee" } }, "Apr": { "format": "double", "type": "number" }, "TotalAmountPayable": { "format": "double", "type": "number" }, "RateOfInterest": { "format": "double", "type": "number" }, "QuoteActions": { "type": "object", "additionalProperties": { "type": "string" } }, "QuoteLink": { "type": "string" }, "CustomerRate": { "format": "double", "type": "number" }, "DepositContribution": { "format": "double", "type": "number" }, "AdvancedRentals": { "format": "int32", "type": "integer" }, "IsRepresentativeExample": { "type": "boolean" }, "CashDeposit": { "format": "double", "type": "number" }, "Settlement": { "format": "double", "type": "number" }, "PartExchange": { "format": "double", "type": "number" }, "Payments": { "type": "array", "items": { "$ref": "#/definitions/Payment" } }, "PaymentsIncluded": { "type": "array", "items": { "$ref": "#/definitions/PaymentIncluded" } }, "AdditionalPayments": { "type": "array", "items": { "$ref": "#/definitions/AdditionalPayment" } }, "IsIncludedInMainQuote": { "type": "boolean" }, "QuoteReference": { "type": "string" }, "ValidFrom": { "format": "date-time", "type": "string" }, "ValidTo": { "format": "date-time", "type": "string" }, "RegisterBy": { "format": "date-time", "type": "string" }, "DepositContributions": { "type": "array", "items": { "$ref": "#/definitions/DeprecatedDepositContribution" } }, "CashPriceDiscounts": { "type": "array", "items": { "$ref": "#/definitions/CashPriceDiscount" } }, "Identifier": { "type": "string" }, "CalculationType": { "type": "string" }, "TotalAmountOfCharges": { "format": "double", "type": "number" }, "AmountOfCredit": { "format": "double", "type": "number" }, "TotalChargeForCredit": { "format": "double", "type": "number" }, "CustomerReference": { "type": "string" }, "Breakdown": { "type": "array", "items": { "$ref": "#/definitions/BreakdownElement" } }, "FinalPayment": { "format": "double", "type": "number" }, "RequestedSelloutValue": { "format": "double", "type": "number" }, "RequestedSellOutType": { "format": "int32", "type": "integer" }, "Age": { "type": "string" }, "Postcode": { "type": "string" }, "CalculatingDealerId": { "format": "int32", "type": "integer" }, "CalculatingDealerKey": { "type": "string" }, "Channel": { "$ref": "#/definitions/ChannelType" }, "NumberOfRegularPayments": { "format": "int32", "type": "integer" }, "TotalAmountPayableExcludingContributions": { "format": "double", "type": "number" }, "DepositContributionsBreakdown": { "type": "array", "items": { "$ref": "#/definitions/DepositContributionBreakdown" } }, "ValueAddedProducts": { "type": "array", "items": { "$ref": "#/definitions/ValueAddedProduct" } }, "ContractLength": { "format": "int32", "type": "integer" }, "DepositTaxPayable": { "format": "double", "type": "number" }, "RequestedDepositType": { "type": "string" }, "CalculatingOrganisationReferences": { "type": "object", "additionalProperties": { "type": "string" } }, "VehicleReference": { "type": "string" }, "BenefitInKind": { "type": "array", "items": { "$ref": "#/definitions/BenefitInKindResult" } }, "SalarySacrifice": { "type": "array", "items": { "$ref": "#/definitions/SalarySacrificeDetails" } }, "PaymentFrequency": { "enum": [ "Monthly", "Quarterly", "Annually" ], "type": "string" }, "WholeLifeCostRental": { "format": "double", "type": "number" }, "CostToDriverRental": { "format": "double", "type": "number" } } }, "ProductDetails": { "type": "object", "properties": { "Type": { "type": "string" }, "Name": { "type": "string" }, "IsCashSale": { "type": "boolean" }, "Id": { "format": "int32", "type": "integer" }, "TermsName": { "type": "string" }, "IsResidualBased": { "type": "boolean" }, "Key": { "type": "string" }, "Lender": { "type": "string" }, "LenderLogo": { "type": "string" }, "UniqueProductCode": { "type": "string" }, "ExternalIdentifier": { "type": "string" }, "PromoCode": { "type": "string" } } }, "DeprecatedVehicle": { "type": "object", "properties": { "IdentifierType": { "type": "string" }, "Identifier": { "type": "string" }, "VehicleType": { "type": "string" }, "Manufacturer": { "type": "string" }, "Model": { "type": "string" }, "Variant": { "type": "string" }, "Derivative": { "type": "string" }, "Description": { "type": "string" }, "BodyStyle": { "type": "string" }, "Transmission": { "type": "string" }, "ModelYear": { "format": "int32", "type": "integer" }, "RegistrationDate": { "type": "string" }, "FuelType": { "type": "string" }, "Doors": { "format": "int32", "type": "integer" }, "EngineSize": { "format": "int32", "type": "integer" }, "Emissions": { "type": "string" }, "EquipmentOptions": { "type": "array", "items": { "$ref": "#/definitions/DeprecatedEquipmentOptionV3" } }, "ImageUrl": { "type": "string" }, "VehicleStatus": { "enum": [ "Unknown", "PreOwned", "Preregistered", "Demonstrator", "New", "BuildToOrder" ], "type": "string" }, "RegistrationNumber": { "type": "string" }, "CurrentMileage": { "format": "int32", "type": "integer" } } }, "Descriptions": { "type": "object", "properties": { "FinanceSummary": { "type": "string" }, "ContributionsSummary": { "type": "string" } } }, "DeprecatedOffer": { "type": "object", "properties": { "Title": { "type": "string" }, "Description": { "type": "string" }, "Id": { "type": "string" } } }, "Notification": { "type": "object", "properties": { "Message": { "type": "string" }, "Code": { "type": "string" }, "Value": { "type": "string" } } }, "DeprecatedCostBreakdown": { "type": "object", "properties": { "Accessories": { "format": "double", "type": "number" }, "BasePrice": { "format": "double", "type": "number" }, "RoadFundLicence": { "format": "double", "type": "number" }, "RegistrationFee": { "format": "double", "type": "number" }, "Delivery": { "format": "double", "type": "number" }, "ManufacturerDelivery": { "format": "double", "type": "number" }, "OtrPrice": { "format": "double", "type": "number" }, "BrandDiscount": { "format": "double", "type": "number" }, "RetailerDiscount": { "format": "double", "type": "number" }, "GovernmentGrant": { "format": "double", "type": "number" }, "EquipmentOptionsTotal": { "format": "double", "type": "number" }, "Plates": { "format": "double", "type": "number" }, "GovernmentCharge": { "format": "double", "type": "number" } } }, "DeprecatedFinanceFee": { "type": "object", "properties": { "Amount": { "format": "double", "type": "number" }, "DisplayText": { "type": "string" }, "FeeType": { "type": "string" }, "Profile": { "type": "string" }, "ExternalIdentifier": { "type": "string" } } }, "Payment": { "type": "object", "properties": { "Amount": { "format": "double", "type": "number" }, "NumberOfPayments": { "format": "int32", "type": "integer" } } }, "PaymentIncluded": { "type": "object", "properties": { "Id": { "type": "string" }, "Amount": { "format": "double", "type": "number" }, "NumberOfPayments": { "format": "int32", "type": "integer" }, "Selected": { "type": "boolean" } } }, "AdditionalPayment": { "type": "object", "properties": { "Identifier": { "type": "string" }, "Selected": { "type": "boolean" }, "TotalAmountPayable": { "format": "double", "type": "number" }, "CashPrice": { "format": "double", "type": "number" }, "Payments": { "type": "array", "items": { "$ref": "#/definitions/Payment" } } } }, "DeprecatedDepositContribution": { "type": "object", "properties": { "Amount": { "format": "double", "type": "number" }, "Name": { "type": "string" }, "Description": { "type": "string" } } }, "CashPriceDiscount": { "type": "object", "properties": { "Amount": { "format": "double", "type": "number" }, "Name": { "type": "string" } } }, "BreakdownElement": { "type": "object", "properties": { "Type": { "type": "string" }, "Amount": { "format": "double", "type": "number" } } }, "DepositContributionBreakdown": { "type": "object", "properties": { "Type": { "type": "string" }, "Amount": { "format": "double", "type": "number" }, "Contributions": { "type": "array", "items": { "$ref": "#/definitions/DepositContributionItem" } } } }, "DeprecatedEquipmentOptionV3": { "type": "object", "properties": { "Id": { "type": "string" }, "Description": { "type": "string" }, "Price": { "format": "double", "type": "number" } } }, "DepositContributionItem": { "type": "object", "properties": { "Description": { "type": "string" }, "Amount": { "format": "double", "type": "number" } } }, "FinanceCalculationRequest": { "type": "object", "properties": { "Parameters": { "$ref": "#/definitions/DeprecatedFinanceParameters" }, "VehicleRequests": { "type": "array", "items": { "$ref": "#/definitions/DeprecatedFinanceCalculationVehicleRequest" } }, "Customer": { "$ref": "#/definitions/FinanceCustomer" }, "UtmParameters": { "$ref": "#/definitions/UtmParameters" }, "ValueAddedProducts": { "type": "array", "items": { "$ref": "#/definitions/ValueAddedProduct" } }, "DepositContributions": { "type": "array", "items": { "$ref": "#/definitions/ContributionOverride" } }, "CashPriceDiscounts": { "type": "array", "items": { "$ref": "#/definitions/ContributionOverride" } }, "Referrer": { "type": "string" } } }, "DeprecatedFinanceParameters": { "type": "object", "properties": { "Term": { "format": "int32", "type": "integer" }, "Deposit": { "format": "double", "type": "number" }, "DepositExcludingVat": { "format": "double", "type": "number" }, "DepositType": { "enum": [ "Unknown", "Amount", "Percentage", "AdvancePayments" ], "type": "string" }, "AnnualMileage": { "format": "int32", "type": "integer" }, "CalculationType": { "description": "The parameter that will be adjusted to meet the regular payment\r\nPossible values: \"CashDeposit\", \"Term\", \"RegularPayment\"", "type": "string" }, "RegularPayment": { "format": "double", "type": "number" }, "RegularPaymentExcludingVat": { "format": "double", "type": "number" }, "SpecificProductType": { "description": "Optionally specify a product/mapping key. The service will return all product keys if not used", "type": "string" }, "Settlement": { "format": "double", "type": "number" }, "PartExchange": { "type": "string" }, "DepositContribution": { "format": "double", "type": "number" }, "DepositContributionsOverride": { "type": "array", "items": { "$ref": "#/definitions/ContributionOverride" } }, "CashPriceDiscounts": { "type": "array", "items": { "$ref": "#/definitions/ContributionOverride" } }, "DisableCalculationCapping": { "type": "boolean" }, "DoNotSaveQuotes": { "type": "boolean" }, "BypassValidationRules": { "type": "boolean" }, "Sellout": { "$ref": "#/definitions/DeprecatedSellout" }, "CalculationTime": { "format": "date-time", "type": "string" }, "IsTelematics": { "type": "boolean" }, "IncludeInactiveOffers": { "type": "boolean" }, "IsPersonalised": { "type": "boolean" }, "CreditScore": { "format": "double", "type": "number" }, "OfferReference": { "type": "string" }, "PartExchangeOfferReference": { "type": "string" }, "PartExchangeReference": { "type": "string" }, "IsCalculateForOptions": { "type": "boolean" }, "ValueAddedProducts": { "description": "Usually additional products funded by the lender e.g GAP, Warranty, Cosmetic Protection", "type": "array", "items": { "$ref": "#/definitions/ValueAddedProduct" } }, "DeliveryDate": { "format": "date-time", "type": "string" }, "AnnualMileageUnit": { "enum": [ "Miles", "Kilometres", "Mil" ], "type": "string" }, "MaintenanceProvider": { "type": "string" }, "CashValuesAreVatExclusive": { "description": "Normally used on LCVs to separate VAT. Defaults to false", "type": "boolean" }, "CustomerSelectedCreditTier": { "enum": [ "Unknown", "BelowAverage", "Fair", "Good", "VeryGood", "Excellent" ], "type": "string" }, "IncludeNoFinanceOption": { "type": "boolean" }, "ReturnErrors": { "type": "boolean" }, "FinanceProductFamilyKeys": { "description": "Possible values: \"HP\", \"PCP\", \"LP\", \"CH\", \"PCH\", \"CP\" \"CS\"", "type": "array", "items": { "type": "string" } }, "IsForBusinessUse": { "type": "boolean" }, "Eligibility": { "$ref": "#/definitions/EligibilityParameters", "description": "A rate for risk reference to retrieve personalised quotes" }, "CalculateAsLenderPanel": { "description": "When true, returns all rate for risk quotes", "type": "boolean" }, "PromoCode": { "type": "string" }, "IncludeAllPromotionalFinance": { "type": "boolean" }, "PaymentProfile": { "enum": [ "Unknown", "SpreadRental", "TerminalPause" ], "type": "string" }, "PayVehicleVatWithDeposit": { "type": "boolean" } } }, "DeprecatedFinanceCalculationVehicleRequest": { "required": [ "Id" ], "type": "object", "properties": { "Id": { "description": "This Id is your unique identifier returned in the response for each vehicleRequest object", "type": "string" }, "Vehicle": { "$ref": "#/definitions/FinanceCalculationVehicle" }, "VehicleParameters": { "$ref": "#/definitions/VehicleParameters" }, "Products": { "description": "Allows you to specify individual finance parameters for each product key", "type": "array", "items": { "$ref": "#/definitions/FinanceCalculationProductRequest" } }, "AdditionalData": { "type": "object", "additionalProperties": { "type": "string" } }, "Channel": { "$ref": "#/definitions/ChannelType", "description": "Channel keys control the finance returned for different integrations. e.g. website vs DMS" }, "FinanceParameters": { "$ref": "#/definitions/DeprecatedFinanceParameters" }, "OrganisationIdentifier": { "$ref": "#/definitions/OrganisationIdentifier" } } }, "ContributionOverride": { "type": "object", "properties": { "Name": { "type": "string" }, "Value": { "type": "string" }, "Type": { "type": "string" }, "Uncapped": { "type": "boolean" }, "Description": { "type": "string" } } }, "EligibilityParameters": { "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } }, "FinanceCalculationVehicle": { "type": "object", "properties": { "CashPrice": { "format": "double", "type": "number" }, "CostBreakdown": { "$ref": "#/definitions/DeprecatedCostBreakdown" }, "EquipmentOptions": { "type": "string" }, "VehicleStatus": { "enum": [ "Unknown", "PreOwned", "Preregistered", "Demonstrator", "New", "BuildToOrder" ], "type": "string" }, "IsFranchiseApproved": { "type": "boolean" }, "FranchiseApprovedProgramme": { "type": "string" }, "VehicleTag": { "type": "string" }, "Identifier": { "type": "string" }, "IdentifierType": { "type": "string" }, "Type": { "type": "string" }, "StockId": { "type": "string" }, "ImageUrl": { "type": "string" }, "DealerVehicleUrl": { "type": "string" }, "IsVatQualifying": { "type": "boolean" }, "RegistrationNumber": { "type": "string" }, "CurrentMileage": { "format": "int32", "type": "integer" }, "CurrentMileageUnit": { "enum": [ "Miles", "Kilometres", "Mil" ], "type": "string" }, "RegistrationDate": { "type": "string" }, "RegistrationCountryCode": { "type": "string" }, "Description": { "type": "string" }, "Manufacturer": { "type": "string" }, "Model": { "type": "string" }, "Variant": { "type": "string" }, "Derivative": { "type": "string" }, "BodyStyle": { "type": "string" }, "Colour": { "type": "string" }, "Doors": { "format": "int32", "type": "integer" }, "Transmission": { "type": "string" }, "FuelType": { "type": "string" }, "CarbonDioxideEmission": { "type": "string" }, "EngineCapacity": { "format": "int32", "type": "integer" }, "YearOfManufacture": { "format": "int32", "type": "integer" }, "StockDate": { "format": "date-time", "type": "string" }, "ManualResidual": { "format": "double", "type": "number" }, "Vin": { "description": "Lenders with enhanced residuals will require this", "type": "string" }, "EnvironmentalData": { "$ref": "#/definitions/EnvironmentalData" }, "VatStatus": { "description": "If omitted, defaults to \"FullyPaid\"", "enum": [ "Unknown", "NotPaid", "FullyPaid", "Margin", "StandardVatAsDeposit" ], "type": "string" }, "FactoryOrderNumber": { "type": "string" }, "PricingIncludesGovernmentGrant": { "description": "If omitted, defaults to false. If the cash price already includes the Government Grant, set this to true", "type": "boolean" }, "ManualResidualAsPercentage": { "format": "int32", "type": "integer" }, "FiscalPower": { "format": "int32", "type": "integer" }, "BrakeHorsePower": { "format": "int32", "type": "integer" }, "GovernmentGrantCategory": { "type": "string" }, "SubsequentRoadFundLicence": { "format": "double", "type": "number" }, "SixMonthsSubsequentRoadFundLicence": { "format": "double", "type": "number" }, "Emissions": { "format": "int32", "type": "integer" }, "ExcessMileageRate": { "format": "double", "type": "number" }, "VehicleReference": { "$ref": "#/definitions/VehicleReference" }, "CataloguePrice": { "format": "double", "type": "number" } } }, "VehicleParameters": { "type": "object", "properties": { "CustomerSaving": { "format": "double", "type": "number" }, "CentreContribution": { "format": "double", "type": "number" }, "EquipmentOptions": { "type": "array", "items": { "$ref": "#/definitions/DeprecatedEquipmentOption" } }, "Accessories": { "type": "array", "items": { "$ref": "#/definitions/Accessory" } } } }, "FinanceCalculationProductRequest": { "type": "object", "properties": { "Key": { "type": "string" }, "OverrideFinanceParameters": { "$ref": "#/definitions/DeprecatedFinanceParameters" }, "Sellout": { "$ref": "#/definitions/DeprecatedSellout" }, "UniqueProductCode": { "type": "string" } } }, "VehicleReference": { "required": [ "Value" ], "type": "object", "properties": { "Value": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } }, "DeprecatedEquipmentOption": { "type": "object", "properties": { "Identifier": { "type": "string" }, "IdentifierType": { "type": "string" }, "Description": { "type": "string" }, "Price": { "format": "double", "type": "number" }, "Discount": { "format": "double", "type": "number" }, "IsStandard": { "type": "boolean" }, "Category": { "type": "string" }, "PackCode": { "type": "string" } } }, "Accessory": { "type": "object", "properties": { "Identifier": { "type": "string" }, "Description": { "type": "string" }, "Price": { "format": "double", "type": "number" }, "VatPercentage": { "format": "double", "type": "number" } } }, "BulkFinanceCalculationRequest": { "required": [ "Parameters", "VehicleRequests" ], "type": "object", "properties": { "Customer": { "$ref": "#/definitions/FinanceCustomer" }, "Parameters": { "$ref": "#/definitions/BulkFinanceParameters" }, "DepositContributions": { "type": "array", "items": { "$ref": "#/definitions/ContributionOverride" } }, "VehicleRequests": { "type": "array", "items": { "$ref": "#/definitions/DeprecatedFinanceCalculationVehicleRequest" } }, "Referrer": { "type": "string" }, "OfferCode": { "type": "string" } } }, "BulkFinanceParameters": { "type": "object", "properties": { "Terms": { "type": "array", "items": { "format": "int32", "type": "integer" } }, "Deposits": { "type": "array", "items": { "type": "string" } }, "AnnualMileages": { "type": "array", "items": { "format": "int32", "type": "integer" } }, "PartExchange": { "format": "double", "type": "number" }, "Settlement": { "format": "double", "type": "number" }, "EnableExtraQuoteDetails": { "type": "boolean" }, "CalculationTime": { "format": "date-time", "type": "string" }, "SellOut": { "$ref": "#/definitions/DeprecatedSellout" }, "EnableCalculationCapping": { "type": "boolean" }, "MileageUnit": { "type": "string" }, "ReturnErrors": { "type": "boolean" }, "CustomerSelectedCreditTiers": { "type": "array", "items": { "enum": [ "Unknown", "BelowAverage", "Fair", "Good", "VeryGood", "Excellent" ], "type": "string" } } } }, "BulkFinanceCalculationResponse": { "type": "object", "properties": { "Duration": { "format": "int64", "type": "integer" }, "HasError": { "type": "boolean" }, "Error": { "$ref": "#/definitions/ErrorResponse" }, "VehicleResults": { "type": "array", "items": { "$ref": "#/definitions/BulkFinanceCalculationVehicleResult" } } } }, "BulkFinanceCalculationVehicleResult": { "type": "object", "properties": { "FinanceProductResults": { "type": "array", "items": { "$ref": "#/definitions/BulkFinanceParameterResult" } }, "Id": { "type": "string" } } }, "BulkFinanceParameterResult": { "type": "object", "properties": { "Term": { "format": "int32", "type": "integer" }, "AnnualMileage": { "format": "int32", "type": "integer" }, "Deposits": { "format": "double", "type": "number" }, "CustomerSelectedCreditTier": { "enum": [ "Unknown", "BelowAverage", "Fair", "Good", "VeryGood", "Excellent" ], "type": "string" }, "ProductResults": { "type": "array", "items": { "$ref": "#/definitions/BulkFinanceProductResult" } } } }, "BulkFinanceProductResult": { "type": "object", "properties": { "Key": { "type": "string" }, "Payment": { "format": "double", "type": "number" }, "VatInclusivePayment": { "format": "double", "type": "number" }, "VatExclusivePayment": { "format": "double", "type": "number" }, "IsVatExclusive": { "type": "boolean" }, "Name": { "type": "string" }, "DealerTermsId": { "format": "int32", "type": "integer" }, "Id": { "format": "int32", "type": "integer" }, "TotalDeposit": { "format": "double", "type": "number" }, "AmountOfCredit": { "format": "double", "type": "number" }, "TotalAmountPayable": { "format": "double", "type": "number" }, "FixedRateOfInterest": { "format": "double", "type": "number" }, "Apr": { "format": "double", "type": "number" }, "OtrPrice": { "format": "double", "type": "number" }, "TotalAmountOfCharges": { "format": "double", "type": "number" }, "FinalPayment": { "format": "double", "type": "number" }, "Payments": { "type": "array", "items": { "$ref": "#/definitions/Payment" } }, "Fees": { "type": "array", "items": { "$ref": "#/definitions/DeprecatedFinanceFee" } }, "Type": { "type": "string" }, "Residual": { "format": "double", "type": "number" }, "ExcessMileageRate": { "format": "double", "type": "number" }, "DepositContributions": { "type": "array", "items": { "$ref": "#/definitions/DeprecatedDepositContribution" } }, "ContractLength": { "format": "int32", "type": "integer" }, "Lender": { "type": "string" }, "ChannelKey": { "type": "string" }, "HasError": { "type": "boolean" }, "Error": { "$ref": "#/definitions/ErrorResponse" }, "CalculatingDealerId": { "format": "int32", "type": "integer" }, "OrganisationReferences": { "type": "object", "additionalProperties": { "type": "string" } }, "ProductName": { "type": "string" } } }, "LegacyTermsAndConditionsResponse": { "type": "object", "properties": { "TermsAndConditions": { "type": "string" }, "HasTermsAndConditions": { "type": "boolean" }, "QuoteReference": { "type": "string" }, "HasError": { "type": "boolean" }, "Error": { "$ref": "#/definitions/ErrorResponse" } } }, "NewUpdatedItemRequest": { "type": "object", "properties": { "Credentials": { "$ref": "#/definitions/FinanceCredentials" }, "ItemSystemKey": { "type": "string" }, "ItemReference": { "type": "string" }, "ItemType": { "type": "string" } } }, "GetRolesResponse": { "type": "object", "properties": { "Roles": { "type": "array", "items": { "$ref": "#/definitions/RoleResponse" } }, "HasError": { "type": "boolean" }, "Errors": { "type": "array", "items": { "$ref": "#/definitions/ErrorResponse" } } } }, "RoleResponse": { "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "Name": { "type": "string" }, "Modules": { "type": "array", "items": { "$ref": "#/definitions/ModuleResponse" } } } }, "ModuleResponse": { "type": "object", "properties": { "TypeId": { "format": "int32", "type": "integer" }, "Name": { "type": "string" }, "DisplayName": { "type": "string" }, "IsEnabled": { "type": "boolean" }, "IsPublic": { "type": "boolean" }, "Description": { "type": "string" } } }, "GetRoleModuleTypesResponse": { "type": "object", "properties": { "ModuleTypes": { "type": "array", "items": { "$ref": "#/definitions/ModuleTypeResponse" } }, "HasError": { "type": "boolean" }, "Errors": { "type": "array", "items": { "$ref": "#/definitions/ErrorResponse" } } } }, "ModuleTypeResponse": { "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "Name": { "type": "string" }, "DisplayName": { "type": "string" } } }, "DeprecatedFinanceQuotationResult": { "type": "object", "properties": { "ProductKey": { "type": "string" }, "ProductType": { "type": "string" }, "ProductName": { "type": "string" }, "TermsName": { "type": "string" }, "HasError": { "type": "boolean" }, "Error": { "$ref": "#/definitions/DeprecatedError" }, "Notifications": { "$ref": "#/definitions/Notifications" }, "Quote": { "$ref": "#/definitions/DeprecatedFinanceQuote" }, "DisplayDetails": { "type": "array", "items": { "$ref": "#/definitions/DeprecatedDisplayDetail" } }, "JafDisplayDetails": { "type": "array", "items": { "$ref": "#/definitions/DeprecatedDisplayDetail" } }, "CommercialProductCode": { "type": "string" }, "FinancialProductCode": { "type": "string" } } }, "DeprecatedFinanceQuote": { "type": "object", "properties": { "CashPrice": { "format": "double", "type": "number" }, "RoadSideAssistance": { "format": "double", "type": "number" }, "CashDeposit": { "format": "double", "type": "number" }, "DealerDeposit": { "format": "double", "type": "number" }, "ManufacturerDeposit": { "format": "double", "type": "number" }, "CustomerSaving": { "format": "double", "type": "number" }, "PartExchangeOutstandingFinance": { "format": "double", "type": "number" }, "PartExchangeValuation": { "format": "double", "type": "number" }, "PartExchangeContribution": { "format": "double", "type": "number" }, "PartExchangeCashback": { "format": "double", "type": "number" }, "PartExchangeEquity": { "format": "double", "type": "number" }, "Balance": { "format": "double", "type": "number" }, "Term": { "format": "int32", "type": "integer" }, "RegularPayment": { "format": "double", "type": "number" }, "Apr": { "format": "double", "type": "number" }, "RateOfInterest": { "format": "double", "type": "number" }, "QuoteReference": { "type": "string" }, "AdditionalMonthlyCost": { "format": "double", "type": "number" }, "Deposit": { "format": "double", "type": "number" }, "QuoteLink": { "type": "string" }, "TotalAmountPayable": { "format": "double", "type": "number" }, "NumberOfRegularPayments": { "format": "int32", "type": "integer" }, "OptionalFinalPayment": { "format": "double", "type": "number" }, "ExcessMileageCharge": { "format": "double", "type": "number" }, "AnnualMileage": { "format": "int32", "type": "integer" }, "IsJustAddFuelProduct": { "type": "boolean" }, "MotorInsuranceMonthly": { "format": "double", "type": "number" }, "MotorInsuranceAnnual": { "format": "double", "type": "number" }, "MotorInsurance3Years": { "format": "double", "type": "number" }, "MonthlyMotorInsurancePremium": { "format": "double", "type": "number" }, "MonthlyJustAddFuelContributionIncludingRoadsideAssistanceAndServicePlan": { "format": "double", "type": "number" }, "PaymentSchedule": { "type": "array", "items": { "$ref": "#/definitions/DeprecatedPayment" } }, "AdditionalContributions": { "format": "double", "type": "number" }, "AdditionalPayments": { "type": "array", "items": { "$ref": "#/definitions/AdditionalPayment" } }, "MotorInsurance2Years": { "format": "double", "type": "number" } } }, "DeprecatedDisplayDetail": { "type": "object", "properties": { "Order": { "format": "int32", "type": "integer" }, "Label": { "type": "string" }, "DisplayValue": { "type": "string" }, "Value": { "type": "string" }, "HasNotification": { "type": "boolean" }, "Notification": { "type": "string" }, "HasStyling": { "type": "boolean" }, "Key": { "type": "string" } } }, "FinanceProductDetailsRequest": { "type": "object", "properties": { "Credentials": { "$ref": "#/definitions/FinanceCredentials" }, "Vehicle": { "$ref": "#/definitions/PsaVehicle" }, "Parameters": { "$ref": "#/definitions/PsaFinanceParameters" }, "Customer": { "$ref": "#/definitions/FinanceCustomer" } } }, "FinanceProductDetailsResponse": { "type": "object", "properties": { "HasError": { "type": "boolean" }, "Error": { "$ref": "#/definitions/Error" }, "Products": { "type": "array", "items": { "$ref": "#/definitions/DeprecatedPsaProduct" } } } }, "Error": { "type": "object", "properties": { "UserError": { "type": "string" }, "TechnicalError": { "type": "string" } } }, "DeprecatedPsaProduct": { "type": "object", "properties": { "ProductKey": { "type": "string" }, "Name": { "type": "string" }, "Ordinal": { "format": "int32", "type": "integer" }, "IsDefault": { "type": "boolean" }, "Terms": { "type": "array", "items": { "$ref": "#/definitions/Term" } }, "AnnualMileages": { "type": "array", "items": { "$ref": "#/definitions/Mileage" } }, "Deposit": { "$ref": "#/definitions/DepositWrapper" }, "DefaultPostCode": { "type": "string" } } }, "Term": { "type": "object", "properties": { "Value": { "format": "int32", "type": "integer" }, "Unity": { "type": "string" }, "IsDefault": { "type": "boolean" } } }, "Mileage": { "type": "object", "properties": { "Value": { "format": "int32", "type": "integer" }, "Unity": { "type": "string" }, "IsDefault": { "type": "boolean" } } }, "DepositWrapper": { "type": "object", "properties": { "Minimum": { "$ref": "#/definitions/Deposit" }, "Maximum": { "$ref": "#/definitions/Deposit" }, "Default": { "$ref": "#/definitions/Deposit" } } }, "Deposit": { "type": "object", "properties": { "Value": { "format": "double", "type": "number" }, "Type": { "type": "string" } } }, "FinanceQuotationPerOptionRequest": { "type": "object", "properties": { "Options": { "type": "array", "items": { "$ref": "#/definitions/PsaEquipmentOption" } }, "BaseVehicle": { "$ref": "#/definitions/PsaVehicle" }, "Credentials": { "$ref": "#/definitions/FinanceCredentials" }, "Customer": { "$ref": "#/definitions/FinanceCustomer" }, "Parameters": { "$ref": "#/definitions/PsaFinanceParameters" } } }, "DeprecatedFinanceForOptionsResponse": { "type": "object", "properties": { "BaseResult": { "$ref": "#/definitions/DeprecatedVehicleResult" }, "OptionResults": { "type": "array", "items": { "$ref": "#/definitions/OptionResult" } }, "HasError": { "type": "boolean" }, "Error": { "$ref": "#/definitions/DeprecatedError" } } }, "DeprecatedVehicleResult": { "type": "object", "properties": { "Id": { "type": "string" }, "FinanceQuotations": { "type": "array", "items": { "$ref": "#/definitions/DeprecatedFinanceQuotationResult" } }, "HasError": { "type": "boolean" }, "Error": { "$ref": "#/definitions/DeprecatedError" } } }, "OptionResult": { "type": "object", "properties": { "Code": { "type": "string" }, "RegularPayment": { "format": "double", "type": "number" }, "PriceAdjustment": { "format": "double", "type": "number" }, "HasError": { "type": "boolean" }, "Error": { "type": "string" } } }, "ProposalsForCustomerAccountResponse2": { "type": "object", "properties": { "NumberOfProposals": { "format": "int64", "type": "integer" }, "CurrentPage": { "format": "int32", "type": "integer" }, "NumberOfPages": { "format": "int32", "type": "integer" }, "Proposals": { "type": "array", "items": { "$ref": "#/definitions/LightweightProposal" } } } }, "LightweightProposal": { "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreatedAt": { "format": "date-time", "type": "string" }, "SubmittedAt": { "format": "date-time", "type": "string" }, "Status": { "type": "string" }, "Quote": { "$ref": "#/definitions/LightweightQuote" }, "Vehicle": { "$ref": "#/definitions/LightweightVehicle" } } }, "LightweightQuote": { "type": "object", "properties": { "ProductType": { "type": "string" }, "OrganisationName": { "type": "string" } } }, "LightweightVehicle": { "type": "object", "properties": { "ImageUrl": { "type": "string" }, "Make": { "type": "string" }, "Model": { "type": "string" }, "Trim": { "type": "string" } } }, "VapPackagesV2Response": { "type": "object", "properties": { "Packages": { "type": "array", "items": { "$ref": "#/definitions/VapApiPackageV2VapPackage" } }, "PageNumber": { "format": "int32", "type": "integer" }, "PageSize": { "format": "int32", "type": "integer" }, "TotalPages": { "format": "int32", "type": "integer" }, "TotalCount": { "format": "int32", "type": "integer" } } }, "VapApiPackageV2VapPackage": { "type": "object", "properties": { "Identifier": { "type": "string" }, "Name": { "type": "string" }, "OrganisationReferences": { "type": "array", "items": { "type": "string" } } } }, "VapPackageV2Response": { "type": "object", "properties": { "VapPackage": { "$ref": "#/definitions/OrganisationVapPackageWithVaps" } } }, "OrganisationVapPackageWithVaps": { "type": "object", "properties": { "Vaps": { "type": "array", "items": { "$ref": "#/definitions/OrganisationVap" } }, "Name": { "type": "string" }, "Reference": { "type": "string" } } }, "OrganisationVap": { "type": "object", "properties": { "Name": { "type": "string" }, "Type": { "enum": [ "Unknown", "GuaranteedAssetProtection", "ServicePlan", "Warranty", "TyreInsurance", "BreakdownAssistance", "CosmeticProtection", "Other", "LifeInsurance", "Maintenance", "Delivery", "VehicleInsurance", "LicenceProtection", "FinesInsurance", "CreditProtectionInsurance", "AdminFee", "Mot", "RentalInsurance", "RentalInsuranceLight", "AlloyInsurance", "CosmeticRepair", "PaintProtection", "PaymentProtectionInsurance", "Fuel", "Accessory" ], "type": "string" }, "TypeDisplayName": { "type": "string" }, "Value": { "type": "string" }, "ValueAsMoney": { "format": "double", "type": "number" }, "Key": { "type": "string" }, "IsDefault": { "type": "boolean" }, "ExternalIdentifier": { "type": "string" }, "CalculationType": { "enum": [ "Unknown", "RegularPaymentSpreadNonInterestBearing", "Financeable", "PSA_GAP", "PERCENTAGE_OF_ADVANCE", "PSA_DEATH_INSURANCE", "VapPaidForByDeposit", "RegularPaymentNonInterestBearing", "PercentageOfAdvancePlusInterestBearingFees", "PsaFinancialLossGuarantee", "FlatAmountPaidByMonthlyFinancePayment", "AdminFee", "DisplayOnly", "PercentageOfMonthlyPaymentIncludingVAT", "BandedFixedMonthlyServiceFee", "RegularPaymentNonInterestBearingIncludingInitialPayment", "FinancedSpainOpeningFee", "MercedesExternalVapCalculation", "VapCalculatedByLenderSystem", "PsaServicingAmountSpreadAcrossPayments", "StellantisRegularPaymentSpreadNonInterestBearing", "NovunaMaintenanceServicePackVap", "StellantisServiceVap", "StellantisFixedAmountInsuranceServiceVap", "StellantisFiscalPowerVap", "StellantisBrakeHorsePowerVap", "StellantisCreditInsuranceVap", "StellantisServiceVapIncludingDeposit", "NonInterestBearingServiceRental", "StellantisBrakeHorsePowerVapExcludingDeposit", "PaidByDepositOrPositiveEquity", "NovunaCorporateReliefVehicleVap", "MonthlyAmountSpreadNonInterestBearing", "MonthlyAmountSpreadInterestBearing", "NovunaCorporateMaintenanceVap", "NovunaCorporateTyresVap", "NovunaCorporateBreakdownVap", "TotalAmountSpreadInterestBearing", "PercentageOfMonthlyAmountSpreadNonInterestBearing", "PercentageOfMonthlyAmountSpreadInterestBearing", "PercentageOfTotalAmountSpreadNonInterestBearing", "PercentageOfTotalAmountSpreadInterestBearing" ], "type": "string" }, "AllowedProductFamilies": { "type": "array", "items": { "type": "string" } }, "Description": { "type": "string" }, "Exclusivity": { "enum": [ "None", "ExclusiveOnType" ], "type": "string" }, "IsRequired": { "type": "boolean" }, "IsPriceEditable": { "type": "boolean" }, "SortOrder": { "format": "int32", "type": "integer" }, "RuleGroups": { "type": "array", "items": { "$ref": "#/definitions/OrganisationVapRuleGroup" } } } }, "OrganisationVapRuleGroup": { "type": "object", "properties": { "Id": { "format": "int64", "type": "integer" }, "Name": { "type": "string" }, "Precedence": { "format": "int32", "type": "integer" }, "Rules": { "type": "array", "items": { "$ref": "#/definitions/OrganisationVapRule" } } } }, "OrganisationVapRule": { "type": "object", "properties": { "RuleType": { "enum": [ "Unknown", "ManufacturerFilter", "VehicleModelFilter", "DistinctAnnualMileages", "DistinctAnnualMileagesKm", "MaximumVehicleInceptionMileage", "TermRangeValidator", "VehicleTerminalAgeValidator", "VapValueOverride", "FuelTypesInclusion", "FinanceExternalIdentifierInclusion", "FinanceAdvanceValidator", "AnnualMileageBetween", "AnnualMileageBetweenKm", "CustomerEntityInclusion", "VapExternalIdentifierOverride", "VehicleTypeVapFilter", "ProductFamilyInclusionFilter", "InceptionMileageBetween", "InceptionMileageBetweenKm", "VehicleInceptionAgeRangeValidator", "ValueDoesNotIncludeVat", "MinimumRegularPayment", "MaximumRegularPayment", "VatExempt", "VapCalculationFormulaOverride", "SchemeReferenceInclusion" ], "type": "string" }, "RuleTypeId": { "format": "int32", "type": "integer" }, "RuleValue": { "type": "string" }, "IsCondition": { "type": "boolean" }, "ValidationRuleType": { "type": "string" } } }, "VapCalculationTypesV2Response": { "type": "object", "properties": { "CalculationTypes": { "type": "array", "items": { "$ref": "#/definitions/VapCalculationTypeV2" } } } }, "VapCalculationTypeV2": { "type": "object", "properties": { "Key": { "enum": [ "Unknown", "RegularPaymentSpreadNonInterestBearing", "Financeable", "PSA_GAP", "PERCENTAGE_OF_ADVANCE", "PSA_DEATH_INSURANCE", "VapPaidForByDeposit", "RegularPaymentNonInterestBearing", "PercentageOfAdvancePlusInterestBearingFees", "PsaFinancialLossGuarantee", "FlatAmountPaidByMonthlyFinancePayment", "AdminFee", "DisplayOnly", "PercentageOfMonthlyPaymentIncludingVAT", "BandedFixedMonthlyServiceFee", "RegularPaymentNonInterestBearingIncludingInitialPayment", "FinancedSpainOpeningFee", "MercedesExternalVapCalculation", "VapCalculatedByLenderSystem", "PsaServicingAmountSpreadAcrossPayments", "StellantisRegularPaymentSpreadNonInterestBearing", "NovunaMaintenanceServicePackVap", "StellantisServiceVap", "StellantisFixedAmountInsuranceServiceVap", "StellantisFiscalPowerVap", "StellantisBrakeHorsePowerVap", "StellantisCreditInsuranceVap", "StellantisServiceVapIncludingDeposit", "NonInterestBearingServiceRental", "StellantisBrakeHorsePowerVapExcludingDeposit", "PaidByDepositOrPositiveEquity", "NovunaCorporateReliefVehicleVap", "MonthlyAmountSpreadNonInterestBearing", "MonthlyAmountSpreadInterestBearing", "NovunaCorporateMaintenanceVap", "NovunaCorporateTyresVap", "NovunaCorporateBreakdownVap", "TotalAmountSpreadInterestBearing", "PercentageOfMonthlyAmountSpreadNonInterestBearing", "PercentageOfMonthlyAmountSpreadInterestBearing", "PercentageOfTotalAmountSpreadNonInterestBearing", "PercentageOfTotalAmountSpreadInterestBearing" ], "type": "string" }, "Name": { "type": "string" }, "Description": { "type": "string" }, "Fields": { "type": "array", "items": { "$ref": "#/definitions/VapCalculationTypeField" } } } }, "VapCalculationTypeField": { "type": "object", "properties": { "Name": { "type": "string" }, "Type": { "type": "string" }, "Options": { "type": "array", "items": { "$ref": "#/definitions/VapCalculationTypeFieldOption" } } } }, "VapCalculationTypeFieldOption": { "type": "object", "properties": { "Value": { "format": "int32", "type": "integer" }, "DisplayName": { "type": "string" } } }, "AdminOrganisationSearchRequest": { "required": [ "Query" ], "type": "object", "properties": { "Query": { "type": "string" }, "WorkspaceReference": { "type": "string" }, "PageNumber": { "format": "int32", "type": "integer" }, "ResultsPerPage": { "format": "int32", "type": "integer" }, "Filters": { "$ref": "#/definitions/AdminOrganisationFilters" } } }, "AdminOrganisationFilters": { "type": "object", "properties": { "OrganisationTypeKey": { "format": "int32", "type": "integer" } } }, "AdminOrganisationSearchResponse": { "type": "object", "properties": { "TotalResults": { "format": "int32", "type": "integer" }, "TotalActiveResults": { "format": "int32", "type": "integer" }, "TotalPages": { "format": "int32", "type": "integer" }, "Retailers": { "type": "array", "items": { "$ref": "#/definitions/OrganisationSearchResult" } }, "Organisations": { "type": "array", "items": { "$ref": "#/definitions/OrganisationSearchResult" } } } }, "OrganisationSearchResult": { "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "Name": { "type": "string" }, "Reference": { "type": "string" }, "App": { "$ref": "#/definitions/WorkspaceApiOverviewModel" }, "Apps": { "type": "array", "items": { "$ref": "#/definitions/WorkspaceApiOverviewModel" } }, "Active": { "type": "boolean" }, "OrganisationReference": { "type": "string" }, "ParentOrganisation": { "$ref": "#/definitions/ResultParentOrganisation" }, "FcaNumber": { "type": "string" }, "Address": { "$ref": "#/definitions/OrganisationAddress" }, "Email": { "type": "string" }, "Telephone": { "type": "string" } } }, "WorkspaceApiOverviewModel": { "type": "object", "properties": { "Reference": { "type": "string" }, "Key": { "type": "string" }, "Description": { "type": "string" }, "LogoUrl": { "type": "string" }, "DisplayName": { "type": "string" }, "WorkspaceType": { "enum": [ "Unknown", "RetailerPointOfSale", "FleetPointOfSale", "LenderPointOfSale" ], "type": "string" } } }, "ResultParentOrganisation": { "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "Name": { "type": "string" } } }, "PresentDigitalRetailStore": { "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Authentication": { "$ref": "#/definitions/PresentedAuthentication" }, "Theme": { "$ref": "#/definitions/PresentedTheme" }, "Organisation": { "$ref": "#/definitions/PresentedOrganisation" }, "Locales": { "$ref": "#/definitions/PresentedLocales" }, "Domain": { "$ref": "#/definitions/PresentedDomain" }, "Pages": { "$ref": "#/definitions/PresentedPages" }, "Features": { "$ref": "#/definitions/PresentedFeatures" } } }, "PresentedAuthentication": { "type": "object", "properties": { "ApiKey": { "type": "string" } } }, "PresentedTheme": { "type": "object", "properties": { "Key": { "$ref": "#/definitions/PresentedThemeKey" }, "Variant": { "$ref": "#/definitions/PresentedThemeVariant" } } }, "PresentedOrganisation": { "type": "object", "properties": { "Details": { "$ref": "#/definitions/OrganisationResponse" } } }, "PresentedLocales": { "type": "object", "properties": { "Default": { "$ref": "#/definitions/PresentedLocale" }, "Available": { "type": "array", "items": { "$ref": "#/definitions/PresentedLocale" } } } }, "PresentedDomain": { "type": "object", "properties": { "Redirect": { "$ref": "#/definitions/PresentedDomainRedirect" } } }, "PresentedPages": { "type": "object", "properties": { "LandingPage": { "$ref": "#/definitions/PresentedLandingPageConfiguration" }, "VehicleSearchPages": { "$ref": "#/definitions/PresentedVehicleSearchPagesConfiguration" }, "ContentPages": { "$ref": "#/definitions/PresentedContentPagesConfiguration" } } }, "PresentedFeatures": { "type": "object", "properties": { "Cookies": { "$ref": "#/definitions/PresentedCookies" }, "Tracking": { "$ref": "#/definitions/PresentedTracking" }, "Chat": { "$ref": "#/definitions/PresentedChat" }, "VehicleImagery": { "$ref": "#/definitions/PresentedVehicleImagery" }, "Finance": { "$ref": "#/definitions/PresentedFinanceConfiguration" }, "PartExchange": { "$ref": "#/definitions/PresentedVehiclePartExchange" }, "Location": { "$ref": "#/definitions/PresentedLocation" }, "ExternalLinks": { "$ref": "#/definitions/PresentedExternalLinks" } } }, "PresentedThemeKey": { "type": "object", "properties": { "Value": { "type": "string" } } }, "PresentedThemeVariant": { "type": "object", "properties": { "Value": { "type": "string" }, "Name": { "type": "string" }, "Css": { "$ref": "#/definitions/PresentedThemeVariantCss" }, "Logo": { "$ref": "#/definitions/PresentedThemeVariantLogo" }, "Favicon": { "$ref": "#/definitions/PresentedThemeVariantFavicon" }, "Videos": { "$ref": "#/definitions/PresentedThemeVariantVideos" } } }, "PresentedLocale": { "type": "object", "properties": { "Value": { "type": "string" }, "LanguageCode": { "type": "string" }, "CountryCode": { "type": "string" }, "Description": { "type": "string" }, "NativeDescription": { "type": "string" }, "Information": { "$ref": "#/definitions/PresentedLocaleInformation" } } }, "PresentedDomainRedirect": { "type": "object", "properties": { "Url": { "type": "string" } } }, "PresentedLandingPageConfiguration": { "type": "object", "properties": { "Content": { "$ref": "#/definitions/PresentedPageContent" } } }, "PresentedVehicleSearchPagesConfiguration": { "type": "object", "properties": { "Values": { "type": "array", "items": { "$ref": "#/definitions/PresentedVehicleSearchPageConfiguration" } } } }, "PresentedContentPagesConfiguration": { "type": "object", "properties": { "Values": { "type": "array", "items": { "$ref": "#/definitions/PresentedContentPageConfiguration" } } } }, "PresentedCookies": { "type": "object", "properties": { "Provider": { "$ref": "#/definitions/PresentedCookiesProvider" } } }, "PresentedTracking": { "type": "object", "properties": { "GoogleAnalyticsCode": { "type": "string" }, "GoogleTagManagerCode": { "type": "string" } } }, "PresentedChat": { "type": "object", "properties": { "Provider": { "$ref": "#/definitions/PresentedChatProvider" } } }, "PresentedVehicleImagery": { "type": "object", "properties": { "AspectRatio": { "type": "string" }, "Provider": { "$ref": "#/definitions/PresentedVehicleImageryProvider" } } }, "PresentedFinanceConfiguration": { "type": "object", "properties": { "IsDefault": { "type": "boolean" }, "RequiresPersonalisation": { "type": "boolean" }, "RequiresItemisation": { "type": "boolean" } } }, "PresentedVehiclePartExchange": { "type": "object", "properties": { "Provider": { "$ref": "#/definitions/PresentedVehiclePartExchangeProvider" } } }, "PresentedLocation": { "type": "object", "properties": { "Provider": { "$ref": "#/definitions/PresentedLocationProvider" }, "Distance": { "$ref": "#/definitions/PresentedLocationDistance" }, "RequireLocation": { "type": "boolean" } } }, "PresentedExternalLinks": { "type": "object", "properties": { "Vehicle": { "type": "boolean" } } }, "PresentedThemeVariantCss": { "type": "object", "properties": { "Url": { "type": "string" }, "Variables": { "type": "string" } } }, "PresentedThemeVariantLogo": { "type": "object", "properties": { "Url": { "type": "string" }, "HeaderUrl": { "type": "string" }, "NavbarUrl": { "type": "string" } } }, "PresentedThemeVariantFavicon": { "type": "object", "properties": { "Url": { "type": "string" } } }, "PresentedThemeVariantVideos": { "type": "object", "properties": { "Style": { "type": "string" }, "Links": { "type": "array", "items": { "$ref": "#/definitions/PresentedVideoLink" } } } }, "PresentedLocaleInformation": { "type": "object", "properties": { "CurrencySymbol": { "type": "string" }, "MileageDisplayName": { "type": "string" }, "DurationDisplayName": { "type": "string" } } }, "PresentedPageContent": { "type": "object", "properties": { "Title": { "type": "string" }, "Description": { "type": "string" } } }, "PresentedVehicleSearchPageConfiguration": { "type": "object", "properties": { "IsDefault": { "type": "boolean" }, "Slug": { "$ref": "#/definitions/PresentedPageSlug" }, "Content": { "$ref": "#/definitions/PresentedPageContent" } } }, "PresentedContentPageConfiguration": { "type": "object", "properties": { "Slug": { "$ref": "#/definitions/PresentedPageSlug" }, "Content": { "$ref": "#/definitions/PresentedPageContent" } } }, "PresentedCookiesProvider": { "type": "object", "properties": { "Type": { "enum": [ "Unknown", "Codeweavers", "OneTrust" ], "type": "string" }, "Script": { "$ref": "#/definitions/PresentedProviderScript" } } }, "PresentedChatProvider": { "type": "object", "properties": { "Type": { "enum": [ "Unknown", "LivePerson" ], "type": "string" }, "Script": { "$ref": "#/definitions/PresentedProviderScript" } } }, "PresentedVehicleImageryProvider": { "type": "object", "properties": { "Type": { "enum": [ "Unknown", "AutosOnShow", "ImaginStudio" ], "type": "string" }, "Script": { "$ref": "#/definitions/PresentedProviderScript" }, "Vehicles": { "$ref": "#/definitions/PresentedVehicleImageryProviderVehicles" } } }, "PresentedVehiclePartExchangeProvider": { "type": "object", "properties": { "Vehicles": { "$ref": "#/definitions/PresentedVehiclePartExchangeProviderVehicles" } } }, "PresentedLocationProvider": { "type": "object", "properties": { "Script": { "$ref": "#/definitions/PresentedProviderScript" } } }, "PresentedLocationDistance": { "type": "object", "properties": { "Options": { "type": "array", "items": { "$ref": "#/definitions/PresentedLocationDistanceOption" } } } }, "PresentedVideoLink": { "type": "object", "properties": { "Name": { "type": "string" }, "Url": { "type": "string" }, "ThumbnailUrl": { "type": "string" } } }, "PresentedPageSlug": { "type": "object", "properties": { "Value": { "type": "string" } } }, "PresentedProviderScript": { "type": "object", "properties": { "Url": { "type": "string" } } }, "PresentedVehicleImageryProviderVehicles": { "type": "object", "properties": { "LookupBy": { "enum": [ "Unknown", "Vrm", "Vin" ], "type": "string" } } }, "PresentedVehiclePartExchangeProviderVehicles": { "type": "object", "properties": { "LookupBy": { "enum": [ "Selection", "Vrm" ], "type": "string" }, "LookupFor": { "enum": [ "Unknown", "Cap", "Glass", "Codeweavers", "Ids", "Ivs", "Psa", "CapLcv", "Glasses", "Tfs", "PsaComcar", "Autobiz", "Brego" ], "type": "string" } } }, "PresentedLocationDistanceOption": { "type": "object", "properties": { "Display": { "type": "string" }, "Value": { "format": "int32", "type": "integer" } } }, "PresentDigitalRetailStoreActionAvailabilities": { "type": "object", "properties": { "Checkout": { "$ref": "#/definitions/CheckActionAvailabilityResponse", "description": "Should be used to determine if Checkout is setup on the store and can their for be presented as a feature." }, "VehicleAlerts": { "$ref": "#/definitions/CheckActionAvailabilityResponse", "description": "Should be used to determine if Vehicle Alerts is setup on the store and can their for be presented as a feature." }, "Enquiry": { "$ref": "#/definitions/CheckActionAvailabilityResponse", "description": "Should be used to determine if Enquiry is setup on the store and can their for be presented as a feature." }, "PartExchange": { "$ref": "#/definitions/CheckActionAvailabilityResponse", "description": "Should be used to determine if Part Exchange is setup on the store and can their for be presented as a feature." } } }, "PresentDigitalRetailStoreSiteMap": { "type": "object", "properties": { "LandingPage": { "$ref": "#/definitions/PresentedLandingPage" }, "ContentPages": { "$ref": "#/definitions/PresentedContentPages" }, "VehicleSearchPages": { "$ref": "#/definitions/PresentedVehicleSearchPages" }, "VehicleDetailsPages": { "$ref": "#/definitions/PresentedVehicleDetailsPages" } } }, "PresentedLandingPage": { "type": "object", "properties": { "Locales": { "$ref": "#/definitions/PresentedLocales" } } }, "PresentedContentPages": { "type": "object", "properties": { "Values": { "type": "array", "items": { "$ref": "#/definitions/PresentedContentPage" } } } }, "PresentedVehicleSearchPages": { "type": "object", "properties": { "Values": { "type": "array", "items": { "$ref": "#/definitions/PresentedVehicleSearchPage" } } } }, "PresentedVehicleDetailsPages": { "type": "object", "properties": { "Values": { "type": "array", "items": { "$ref": "#/definitions/PresentedVehicleDetailsPage" } } } }, "PresentedContentPage": { "type": "object", "properties": { "Slug": { "$ref": "#/definitions/PresentedPageSlug" }, "Locales": { "$ref": "#/definitions/PresentedLocales" } } }, "PresentedVehicleSearchPage": { "type": "object", "properties": { "Slug": { "$ref": "#/definitions/PresentedPageSlug" }, "Locales": { "$ref": "#/definitions/PresentedLocales" } } }, "PresentedVehicleDetailsPage": { "type": "object", "properties": { "Slug": { "$ref": "#/definitions/PresentedPageSlug" }, "Vehicle": { "$ref": "#/definitions/PresentedPageVehicle" }, "Locales": { "$ref": "#/definitions/PresentedLocales" } } }, "PresentedPageVehicle": { "type": "object", "properties": { "Value": { "type": "string" } } }, "PresentDigitalRetailStoreRobotsFile": { "type": "object", "properties": { "AllowIndexing": { "type": "boolean" } } }, "PresentDigitalRetailStoreLandingPage": { "type": "object", "properties": { "Finance": { "$ref": "#/definitions/PresentedFinance" }, "Vehicles": { "$ref": "#/definitions/PresentedVehicles" }, "Content": { "$ref": "#/definitions/PresentedLandingPageContent" } } }, "PresentedFinance": { "type": "object", "properties": { "Defaults": { "$ref": "#/definitions/FinanceProductParametersResponse" } } }, "PresentedVehicles": { "type": "object", "properties": { "Count": { "format": "int32", "type": "integer" }, "Filters": { "$ref": "#/definitions/PresentedVehiclesFilters" } } }, "PresentedLandingPageContent": { "type": "object", "properties": { "Tiles": { "type": "array", "items": { "$ref": "#/definitions/PresentedLandingPageContentTile" } }, "Banner": { "$ref": "#/definitions/DigitalRetailStoreLandingPageBanner" } } }, "FinanceProductParametersResponse": { "type": "object", "properties": { "CombinedProducts": { "$ref": "#/definitions/Product" }, "Products": { "type": "array", "items": { "$ref": "#/definitions/Product" } } } }, "PresentedVehiclesFilters": { "type": "object", "properties": { "Options": { "$ref": "#/definitions/PresentedVehiclesFiltersOptions" } } }, "PresentedLandingPageContentTile": { "required": [ "Title", "Description", "Image" ], "type": "object", "properties": { "Title": { "type": "string" }, "Description": { "type": "string" }, "Image": { "$ref": "#/definitions/Image" }, "Link": { "$ref": "#/definitions/PresentedDigitalRetailStoreLink" } } }, "DigitalRetailStoreLandingPageBanner": { "required": [ "Image" ], "type": "object", "properties": { "Image": { "$ref": "#/definitions/Image" } } }, "Product": { "type": "object", "properties": { "HasError": { "type": "boolean" }, "Error": { "$ref": "#/definitions/ErrorResponse" }, "Id": { "type": "string" }, "Key": { "type": "string" }, "FamilyKey": { "type": "string" }, "FamilyName": { "type": "string" }, "Name": { "type": "string" }, "Description": { "type": "string" }, "Lender": { "type": "string" }, "Type": { "type": "string" }, "IsDefault": { "description": "Indicates the product that has been selected to be shown or highlighted first. To be used if not showing all products at once.", "type": "boolean" }, "IsResidualValueBased": { "type": "boolean" }, "UsageOnly": { "type": "boolean" }, "IsOnlyForBusinessUse": { "type": "boolean" }, "AdvanceRental": { "$ref": "#/definitions/AdvanceRentalBounds" }, "Deposit": { "$ref": "#/definitions/DepositBounds" }, "Term": { "$ref": "#/definitions/TermBounds" }, "AnnualMileage": { "$ref": "#/definitions/AnnualMileageBounds" }, "Payment": { "$ref": "#/definitions/PaymentBounds" }, "ManualResidual": { "$ref": "#/definitions/ManualResidualBounds" }, "Age": { "$ref": "#/definitions/AgeParameters" }, "PostCode": { "$ref": "#/definitions/PostCodeParameters" }, "PartExchange": { "$ref": "#/definitions/PartExchangeParameters" }, "MaintenanceProvider": { "$ref": "#/definitions/MaintenanceProviderParameters" }, "ValueAddedProducts": { "type": "array", "items": { "$ref": "#/definitions/ValueAddedProductsParameters" } }, "CustomerSelectedTiers": { "$ref": "#/definitions/CustomerSelectedCreditTiers" }, "Yield": { "$ref": "#/definitions/SelloutFinanceDefaultsResponse" }, "Apr": { "$ref": "#/definitions/SelloutFinanceDefaultsResponse" }, "FlatRate": { "$ref": "#/definitions/SelloutFinanceDefaultsResponse" }, "AllRatesFixed": { "type": "boolean" }, "Entities": { "type": "array", "items": { "type": "string" } }, "AllowMonthlyPaymentSearch": { "type": "boolean" }, "Compliance": { "$ref": "#/definitions/ComplianceFinanceDefaultsResponse" } } }, "PresentedVehiclesFiltersOptions": { "type": "object", "properties": { "Values": { "type": "array", "items": { "$ref": "#/definitions/PresentedVehiclesFiltersOption" } } } }, "PresentedDigitalRetailStoreLink": { "type": "object", "properties": { "Slug": { "$ref": "#/definitions/PresentedPageSlug" } } }, "AdvanceRentalBounds": { "type": "object", "properties": { "Locale": { "$ref": "#/definitions/LocaleDisplayValue" }, "IsRequired": { "type": "boolean" }, "Default": { "format": "int32", "type": "integer" }, "Values": { "type": "array", "items": { "format": "int32", "type": "integer" } }, "OrderNo": { "format": "int32", "type": "integer" } } }, "DepositBounds": { "type": "object", "properties": { "Locale": { "$ref": "#/definitions/LocaleDisplayValue" }, "IsRequired": { "type": "boolean" }, "Default": { "format": "double", "type": "number" }, "Minimum": { "format": "double", "type": "number" }, "Maximum": { "format": "double", "type": "number" }, "OrderNo": { "format": "int32", "type": "integer" }, "MaximumAsPercentageOfOtr": { "format": "double", "type": "number" }, "MinimumAsPercentageOfOtr": { "format": "double", "type": "number" }, "DefaultAsPercentageOfOtr": { "format": "double", "type": "number" } } }, "TermBounds": { "type": "object", "properties": { "Locale": { "$ref": "#/definitions/LocaleDisplayValue" }, "IsRequired": { "type": "boolean" }, "Default": { "format": "int32", "type": "integer" }, "Values": { "type": "array", "items": { "format": "int32", "type": "integer" } }, "OrderNo": { "format": "int32", "type": "integer" } } }, "AnnualMileageBounds": { "type": "object", "properties": { "Locale": { "$ref": "#/definitions/LocaleDisplayValue" }, "IsRequired": { "type": "boolean" }, "Default": { "format": "int32", "type": "integer" }, "Values": { "type": "array", "items": { "format": "int32", "type": "integer" } }, "OrderNo": { "format": "int32", "type": "integer" } } }, "PaymentBounds": { "type": "object", "properties": { "Locale": { "$ref": "#/definitions/LocaleDisplayValue" }, "Default": { "format": "double", "type": "number" }, "Minimum": { "format": "double", "type": "number" }, "Maximum": { "format": "double", "type": "number" }, "IsRequired": { "type": "boolean" }, "OrderNo": { "format": "int32", "type": "integer" } } }, "ManualResidualBounds": { "type": "object", "properties": { "Locale": { "$ref": "#/definitions/LocaleDisplayValue" }, "Default": { "format": "double", "type": "number" }, "Minimum": { "format": "double", "type": "number" }, "Maximum": { "format": "double", "type": "number" }, "IsRequired": { "type": "boolean" }, "OrderNo": { "format": "int32", "type": "integer" } } }, "AgeParameters": { "type": "object", "properties": { "Values": { "type": "array", "items": { "format": "int32", "type": "integer" } }, "IsRequired": { "type": "boolean" }, "OrderNo": { "format": "int32", "type": "integer" } } }, "PostCodeParameters": { "type": "object", "properties": { "IsRequired": { "type": "boolean" }, "OrderNo": { "format": "int32", "type": "integer" } } }, "PartExchangeParameters": { "type": "object", "properties": { "IsPermitted": { "type": "boolean" }, "OrderNo": { "format": "int32", "type": "integer" } } }, "MaintenanceProviderParameters": { "type": "object", "properties": { "IsRequired": { "type": "boolean" }, "Default": { "type": "string" }, "Values": { "type": "array", "items": { "$ref": "#/definitions/MaintenanceProviderOption" } }, "OrderNo": { "format": "int32", "type": "integer" } } }, "ValueAddedProductsParameters": { "type": "object", "properties": { "Key": { "type": "string" }, "Name": { "type": "string" }, "IsDefault": { "type": "boolean" }, "Type": { "enum": [ "Unknown", "GuaranteedAssetProtection", "ServicePlan", "Warranty", "TyreInsurance", "BreakdownAssistance", "CosmeticProtection", "Other", "LifeInsurance", "Maintenance", "Delivery", "VehicleInsurance", "LicenceProtection", "FinesInsurance", "CreditProtectionInsurance", "AdminFee", "Mot", "RentalInsurance", "RentalInsuranceLight", "AlloyInsurance", "CosmeticRepair", "PaintProtection", "PaymentProtectionInsurance", "Fuel", "Accessory" ], "type": "string" }, "MaxTerm": { "format": "int32", "type": "integer" }, "MinTerm": { "format": "int32", "type": "integer" }, "ExternalIdentifier": { "type": "string" }, "IsRequired": { "type": "boolean" }, "Price": { "$ref": "#/definitions/ValueAddedProductsPriceParameters" }, "VatExempt": { "type": "boolean" }, "MaxTerminalAge": { "format": "int32", "type": "integer" } } }, "SelloutFinanceDefaultsResponse": { "type": "object", "properties": { "Default": { "format": "double", "type": "number" }, "Minimum": { "format": "double", "type": "number" }, "Maximum": { "format": "double", "type": "number" }, "Rates": { "type": "array", "items": { "format": "double", "type": "number" } } } }, "ComplianceFinanceDefaultsResponse": { "type": "object", "properties": { "Banner": { "$ref": "#/definitions/ComplianceBannerFinanceDefaultsResponse" } } }, "PresentedVehiclesFiltersOption": { "type": "object", "properties": { "DisplayValue": { "description": "This value will contain the translated facet value and should be used for display on the integrating site.", "type": "string" }, "Value": { "description": "This value will contain our view of the facet and should be used to send back into our services when a user selects the facet.", "type": "string" }, "DisplayCount": { "description": "This value will contain the translated facet count value and should be used for display on the integrating site.", "type": "string" }, "Count": { "format": "int32", "description": "This value will contain the count of vehicles which match the facet.", "type": "integer" }, "Image": { "$ref": "#/definitions/Image", "description": "The image which represents the facet. If returned as null it means we have not currently set the image for this facet, please get in contact with us if you require an image to be assigned." } } }, "LocaleDisplayValue": { "type": "object", "properties": { "DisplayValue": { "type": "string" } } }, "MaintenanceProviderOption": { "type": "object", "properties": { "Value": { "type": "string" }, "Description": { "type": "string" }, "Key": { "type": "string" } } }, "ValueAddedProductsPriceParameters": { "type": "object", "properties": { "IsPriceEditable": { "type": "boolean" }, "DefaultPrice": { "format": "double", "type": "number" }, "MinPrice": { "format": "double", "type": "number" }, "MaxPrice": { "format": "double", "type": "number" } } }, "ComplianceBannerFinanceDefaultsResponse": { "type": "object", "properties": { "Image": { "$ref": "#/definitions/MultiSizedImage" } } }, "MultiSizedImage": { "type": "object", "properties": { "Urls": { "$ref": "#/definitions/MultiSizedImageUrls" }, "Description": { "type": "string" }, "AltText": { "type": "string" } } }, "MultiSizedImageUrls": { "type": "object", "properties": { "Small": { "type": "string" }, "Medium": { "type": "string" }, "Large": { "type": "string" }, "ExtraLarge": { "type": "string" } } }, "PresentDigitalRetailStoreVehicleSearchPage": { "type": "object", "properties": { "Finance": { "$ref": "#/definitions/PresentedFinance" }, "Content": { "$ref": "#/definitions/PresentedVehicleSearchPageContent" } } }, "PresentedVehicleSearchPageContent": { "type": "object", "properties": { "Banner": { "$ref": "#/definitions/PresentedVehicleSearchPageContentBanner" } } }, "PresentedVehicleSearchPageContentBanner": { "required": [ "Image", "Title" ], "type": "object", "properties": { "Image": { "$ref": "#/definitions/Image" }, "Title": { "type": "string" }, "Description": { "type": "string" }, "Link": { "$ref": "#/definitions/PresentedDigitalRetailStoreLink" } } }, "PresentDigitalRetailStoreVehicleDetailsPage": { "type": "object", "properties": { "Vehicle": { "$ref": "#/definitions/PresentedVehicle" }, "Finance": { "$ref": "#/definitions/PresentedFinance" }, "Content": { "$ref": "#/definitions/PresentedContent" } } }, "PresentedVehicle": { "type": "object", "properties": { "Details": { "$ref": "#/definitions/Vehicle" }, "EnvironmentalData": { "$ref": "#/definitions/VehicleEnvironmentalDataResponse" }, "StandardEquipment": { "type": "array", "items": { "$ref": "#/definitions/StandardEquipmentItem" } }, "TechnicalDetails": { "type": "array", "items": { "$ref": "#/definitions/TechicalDetailsItem" } } } }, "PresentedContent": { "type": "object", "properties": { "ApprovedUsedInformation": { "$ref": "#/definitions/PresentDigitalRetailStoreApprovedUsedConfiguration" } } }, "VehicleEnvironmentalDataResponse": { "type": "object", "properties": { "IsPreliminary": { "type": "boolean" }, "Fuel": { "$ref": "#/definitions/FuelData" }, "Battery": { "$ref": "#/definitions/BatteryData" }, "Tyres": { "$ref": "#/definitions/TyresData" } } }, "StandardEquipmentItem": { "type": "object", "properties": { "Identifier": { "type": "string" }, "Name": { "type": "string" }, "Description": { "type": "string" }, "Category": { "type": "string" } } }, "TechicalDetailsItem": { "type": "object", "properties": { "Description": { "type": "string" }, "Value": { "type": "string" }, "Category": { "type": "string" } } }, "PresentDigitalRetailStoreApprovedUsedConfiguration": { "type": "object", "properties": { "Title": { "type": "string" }, "Information": { "$ref": "#/definitions/PresentDigitalRetailStoreRow" } } }, "PresentDigitalRetailStoreRow": { "required": [ "Fields" ], "type": "object", "properties": { "Fields": { "$ref": "#/definitions/PresentDigitalRetailStoreFields" } } }, "PresentDigitalRetailStoreFields": { "required": [ "Values" ], "type": "object", "properties": { "Values": { "type": "array", "items": { "$ref": "#/definitions/DigitalRetailStoreContentPageField" } } } }, "DigitalRetailStoreContentPageField": { "required": [ "Type" ], "type": "object", "properties": { "Value": { "type": "string" }, "Type": { "$ref": "#/definitions/DigitalRetailStoreContentPageFieldType" } } }, "DigitalRetailStoreContentPageFieldType": { "required": [ "Value" ], "type": "object", "properties": { "Value": { "enum": [ "Unknown", "Text", "Image", "BannerImage", "Header", "VehiclesCarousel", "Html", "OrganisationMap" ], "type": "string" } } }, "PresentDigitalRetailStoreVehicleDetailsPageActionAvailabilitiesRequest": { "type": "object", "properties": { "QuoteReference": { "type": "string" } } }, "PresentDigitalRetailStoreVehicleDetailsPageActionAvailabilities": { "type": "object", "properties": { "Checkout": { "$ref": "#/definitions/CheckActionAvailabilityResponse", "description": "Should be used to determine if a CTA can be shown on the Vehicle Details Page, which would allow the customer to navigate into the Checkout journey." }, "Reserve": { "$ref": "#/definitions/CheckActionAvailabilityResponse", "description": "Should be used to determine if a CTA can be shown on the Vehicle Details Page, which would allow the customer to navigate into the Reserve journey." }, "RateForRisk": { "$ref": "#/definitions/CheckActionAvailabilityResponse", "description": "Should be used to determine if a CTA can be shown on the Vehicle Details Page, which would allow the customer to navigate into the Rate for Risk journey." }, "PartExchange": { "$ref": "#/definitions/CheckActionAvailabilityResponse", "description": "Should be used to determine if a CTA can be shown on the Vehicle Details Page, which would allow the customer to navigate into the Part Exchange journey." }, "VehicleAccessories": { "$ref": "#/definitions/CheckActionAvailabilityResponse", "description": "Should be used to determine if FE should call the vehicle accessories APIs and display the vehicle accessories section on the Vehicle Details Page." } } }, "PresentDigitalRetailStoreHeaderConfiguration": { "type": "object", "properties": { "Header": { "$ref": "#/definitions/PresentedDigitalRetailHeaderContent" } } }, "PresentedDigitalRetailHeaderContent": { "type": "object", "properties": { "LogoLink": { "$ref": "#/definitions/PresentedDigitalRetailStoreNavigationLink" }, "NavigationLinks": { "type": "array", "items": { "$ref": "#/definitions/PresentedDigitalRetailStoreHeaderNavigationLink" } }, "SocialMediaLinks": { "type": "array", "items": { "$ref": "#/definitions/PresentedDigitalRetailStoreHeaderSocialMediaLink" } } } }, "PresentedDigitalRetailStoreNavigationLink": { "type": "object", "properties": { "Href": { "type": "string" }, "Target": { "type": "string" } } }, "PresentedDigitalRetailStoreHeaderNavigationLink": { "type": "object", "properties": { "Title": { "type": "string" }, "Description": { "type": "string" }, "Link": { "$ref": "#/definitions/PresentedDigitalRetailStoreNavigationLink" }, "Links": { "type": "array", "items": { "$ref": "#/definitions/PresentedDigitalRetailStoreHeaderNavigationLink" } } } }, "PresentedDigitalRetailStoreHeaderSocialMediaLink": { "type": "object", "properties": { "Type": { "enum": [ "Facebook", "Instagram", "Twitter", "Youtube", "Pinterest", "LinkedIn", "Blogger", "Threads" ], "type": "string" }, "Link": { "$ref": "#/definitions/PresentedDigitalRetailStoreNavigationLink" } } }, "PresentDigitalRetailStoreFooterConfiguration": { "type": "object", "properties": { "Footer": { "$ref": "#/definitions/PresentedDigitalRetailFooterContent" } } }, "PresentedDigitalRetailFooterContent": { "type": "object", "properties": { "NavigationLinks": { "type": "array", "items": { "$ref": "#/definitions/PresentedDigitalRetailStoreFooterNavigationLink" } }, "SocialMediaLinks": { "type": "array", "items": { "$ref": "#/definitions/PresentedDigitalRetailStoreFooterSocialMediaLink" } } } }, "PresentedDigitalRetailStoreFooterNavigationLink": { "type": "object", "properties": { "Title": { "type": "string" }, "Description": { "type": "string" }, "Link": { "$ref": "#/definitions/PresentedDigitalRetailStoreNavigationLink" }, "Links": { "type": "array", "items": { "$ref": "#/definitions/PresentedDigitalRetailStoreFooterNavigationLink" } } } }, "PresentedDigitalRetailStoreFooterSocialMediaLink": { "type": "object", "properties": { "Type": { "enum": [ "Facebook", "Instagram", "Twitter", "Youtube", "Pinterest", "LinkedIn", "Blogger", "Threads" ], "type": "string" }, "Link": { "$ref": "#/definitions/PresentedDigitalRetailStoreNavigationLink" } } }, "PresentDigitalRetailStoreContentPage": { "required": [ "Fields", "Rows" ], "type": "object", "properties": { "Fields": { "$ref": "#/definitions/PresentDigitalRetailStoreFields" }, "Rows": { "$ref": "#/definitions/PresentDigitalRetailStoreRows" } } }, "PresentDigitalRetailStoreRows": { "required": [ "Values" ], "type": "object", "properties": { "Values": { "type": "array", "items": { "$ref": "#/definitions/PresentDigitalRetailStoreRow" } } } }, "PresentDigitalRetailStoreContentAreas": { "type": "object", "properties": { "ContentAreas": { "type": "array", "items": { "$ref": "#/definitions/PresentedDigitalRetailStoreContentArea" } }, "Position": { "enum": [ "Unknown", "Bottom", "Middle" ], "type": "string" } } }, "PresentedDigitalRetailStoreContentArea": { "type": "object", "properties": { "Rows": { "type": "array", "items": { "$ref": "#/definitions/PresentDigitalRetailStoreContentRow" } } } }, "PresentDigitalRetailStoreContentRow": { "required": [ "Fields" ], "type": "object", "properties": { "Fields": { "type": "array", "items": { "$ref": "#/definitions/DigitalRetailStoreContentPageField" } } } }, "RetrieveStoreBuilderPagesResponse": { "type": "object", "properties": { "Pages": { "type": "array", "items": { "$ref": "#/definitions/StoreBuilderPageSlim" } } } }, "StoreBuilderPageSlim": { "required": [ "Reference", "Slug", "Title" ], "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Slug": { "type": "string" }, "Title": { "type": "string" } } }, "RetrieveStoreBuilderPageResponse": { "type": "object", "properties": { "Page": { "$ref": "#/definitions/StoreBuilderPage" } } }, "StoreBuilderPage": { "required": [ "StoreReference", "Slug", "Title", "Configs" ], "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "TemplateReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "StoreReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Slug": { "type": "string" }, "Title": { "type": "string" }, "Configs": { "type": "array", "items": { "$ref": "#/definitions/PageConfiguration" } } } }, "PageConfiguration": { "required": [ "Id", "Component" ], "type": "object", "properties": { "Id": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Component": { "type": "string" }, "Properties": { "type": "object", "additionalProperties": { "type": "string" } }, "Children": { "type": "array", "items": { "$ref": "#/definitions/PageConfiguration" } } } }, "RetrieveDigitalRetailStoreSearchPageLocationConfigurationResponse": { "type": "object", "properties": { "Configuration": { "$ref": "#/definitions/DigitalRetailStoreSearchPageLocationConfiguration" } } }, "DigitalRetailStoreSearchPageLocationConfiguration": { "required": [ "RequireLocation" ], "type": "object", "properties": { "RequireLocation": { "type": "boolean" } } }, "RetrieveDigitalRetailStoreFinancialDisclaimerResponse": { "type": "object", "properties": { "HasDisclaimer": { "type": "boolean" }, "Disclaimer": { "type": "string" } } }, "RetrieveDigitalRetailStoreSlugSearchSetsResponse": { "type": "object", "properties": { "Sets": { "type": "array", "items": { "$ref": "#/definitions/DigitalRetailStoreSlugSearchSet" } } } }, "DigitalRetailStoreSlugSearchSet": { "required": [ "Value" ], "type": "object", "properties": { "Name": { "type": "string" }, "Value": { "enum": [ "Stock", "CodeweaversDerivatives", "CapDerivatives", "CapLcvDerivatives" ], "type": "string" } } }, "RetrieveDigitalRetailStoreSlugGroupTypesResponse": { "type": "object", "properties": { "Types": { "type": "array", "items": { "$ref": "#/definitions/DigitalRetailStoreSlugGroupType" } } } }, "DigitalRetailStoreSlugGroupType": { "required": [ "Value" ], "type": "object", "properties": { "Name": { "type": "string" }, "Value": { "enum": [ "None", "Model", "SimilarVehicles", "SameVehiclesSamePrice", "SameAs", "Retailer" ], "type": "string" } } }, "RetrieveDigitalRetailStoreSlugRuleFilterTypesResponse": { "type": "object", "properties": { "Types": { "type": "array", "items": { "$ref": "#/definitions/DigitalRetailStoreSlugRuleFilterType" } } } }, "DigitalRetailStoreSlugRuleFilterType": { "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Name": { "type": "string" }, "AllowMultiple": { "type": "boolean" }, "FieldType": { "enum": [ "Unknown", "Text", "Checkbox", "Radio", "Select", "Number" ], "type": "string" }, "Options": { "type": "array", "items": { "$ref": "#/definitions/DigitalRetailStoreSlugRuleFilterOption" } } } }, "DigitalRetailStoreSlugRuleFilterOption": { "type": "object", "properties": { "Name": { "type": "string" }, "Value": { "type": "string" } } }, "RetrieveDigitalRetailStoreMarketingFeatureTypesResponse": { "type": "object", "properties": { "MarketingFeatures": { "type": "array", "items": { "$ref": "#/definitions/MarketingFeatureType" } } } }, "MarketingFeatureType": { "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Name": { "type": "string" } } }, "RetrieveDigitalRetailStoreAvailableAccessoriesProvidersResponse": { "type": "object", "properties": { "Providers": { "type": "array", "items": { "$ref": "#/definitions/AccessoriesProvider" } } } }, "AccessoriesProvider": { "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Name": { "type": "string" } } }, "RetrieveDigitalRetailStoreProductTypesResponse": { "type": "object", "properties": { "Types": { "type": "array", "items": { "$ref": "#/definitions/DigitalRetailStoreProductType" } } } }, "DigitalRetailStoreProductType": { "required": [ "Reference" ], "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Name": { "type": "string" }, "Description": { "type": "string" }, "Url": { "$ref": "#/definitions/DigitalRetailStoreDomainUrl" } } }, "DigitalRetailStoreDomainUrl": { "type": "object", "properties": { "Value": { "type": "string" } } }, "SearchDigitalRetailStoresRequest": { "required": [ "PageNumber", "PageSize" ], "type": "object", "properties": { "Query": { "type": "string" }, "SubscriptionTypes": { "type": "array", "items": { "enum": [ "None", "Trial", "Internal", "Production" ], "type": "string" } }, "PageNumber": { "format": "int32", "type": "integer" }, "PageSize": { "format": "int32", "maximum": 25, "minimum": 1, "type": "integer" }, "OrganisationIdentifier": { "$ref": "#/definitions/OrganisationIdentifier", "description": "This determines the organisation that the request will be run as. This changes the authentication context to be for this organisation." }, "SortBy": { "enum": [ "Unknown", "NameAscending", "NameDescending", "SubscriptionTypeThenNameAscending", "SubscriptionTypeThenNameDescending", "CreatedAtAscending", "CreatedAtDescending", "AccessedAtAscending", "AccessedAtDescending" ], "type": "string" } } }, "SearchDigitalRetailStoresResponse": { "type": "object", "properties": { "Results": { "type": "array", "items": { "$ref": "#/definitions/DigitalRetailStoreResponse" } }, "TotalResults": { "format": "int32", "type": "integer" }, "TotalPages": { "format": "int32", "type": "integer" }, "CurrentPage": { "format": "int32", "type": "integer" } } }, "DigitalRetailStoreResponse": { "required": [ "Reference", "Name", "AccessedAt", "CreatedAt", "Domain", "Subscription", "Products" ], "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Name": { "type": "string" }, "AccessedAt": { "format": "date-time", "type": "string" }, "CreatedAt": { "format": "date-time", "type": "string" }, "Domain": { "$ref": "#/definitions/DigitalRetailStoreDomain" }, "Subscription": { "$ref": "#/definitions/DigitalRetailStoreSubscriptionResponse" }, "Upgrade": { "$ref": "#/definitions/DigitalRetailStoreUpgradeResponse" }, "Products": { "$ref": "#/definitions/DigitalRetailStoreProducts" } } }, "DigitalRetailStoreDomain": { "required": [ "Name", "AllowIndexing" ], "type": "object", "properties": { "Name": { "type": "string" }, "AllowIndexing": { "type": "boolean" }, "Type": { "enum": [ "Unknown", "Microsite", "Redirect" ], "type": "string" }, "Urls": { "$ref": "#/definitions/DigitalRetailStoreDomainUrls" }, "DefaultSlug": { "type": "string" } } }, "DigitalRetailStoreSubscriptionResponse": { "required": [ "Type", "Active", "CreatedAt" ], "type": "object", "properties": { "Type": { "enum": [ "None", "Trial", "Internal", "Production" ], "type": "string" }, "Active": { "type": "boolean" }, "CreatedAt": { "format": "date-time", "type": "string" }, "Expiry": { "$ref": "#/definitions/DigitalRetailStoreSubscriptionExpiryResponse" } } }, "DigitalRetailStoreUpgradeResponse": { "type": "object", "properties": { "TicketId": { "format": "int32", "type": "integer" } } }, "DigitalRetailStoreProducts": { "required": [ "Enabled" ], "type": "object", "properties": { "Enabled": { "type": "array", "items": { "$ref": "#/definitions/DigitalRetailStoreProduct" } } } }, "DigitalRetailStoreDomainUrls": { "type": "object", "properties": { "Redirect": { "$ref": "#/definitions/DigitalRetailStoreDomainUrl" }, "Preview": { "$ref": "#/definitions/DigitalRetailStoreDomainUrl" } } }, "DigitalRetailStoreSubscriptionExpiryResponse": { "required": [ "ExpiresAt", "NotifiedAt" ], "type": "object", "properties": { "ExpiresAt": { "format": "date-time", "type": "string" }, "NotifiedAt": { "format": "date-time", "type": "string" } } }, "DigitalRetailStoreProduct": { "required": [ "Reference", "Type" ], "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Type": { "$ref": "#/definitions/DigitalRetailStoreProductType" } } }, "RetrieveDigitalRetailStoreResponse": { "required": [ "Store", "Permissions" ], "type": "object", "properties": { "Store": { "$ref": "#/definitions/DigitalRetailStoreResponse" }, "Permissions": { "$ref": "#/definitions/DigitalRetailStorePermissionsResponse" } } }, "DigitalRetailStorePermissionsResponse": { "required": [ "CanRead", "CanWrite" ], "type": "object", "properties": { "CanRead": { "type": "boolean" }, "CanWrite": { "type": "boolean" } } }, "DeleteDigitalRetailStoreResponse": { "type": "object", "properties": {} }, "UpdateDigitalRetailStoreRequest": { "required": [ "Store" ], "type": "object", "properties": { "Store": { "$ref": "#/definitions/DigitalRetailStoreRequest" } } }, "DigitalRetailStoreRequest": { "required": [ "Name", "Domain" ], "type": "object", "properties": { "Name": { "type": "string" }, "Domain": { "$ref": "#/definitions/DigitalRetailStoreDomain" }, "Products": { "$ref": "#/definitions/DigitalRetailStoreProducts" } } }, "UpdateDigitalRetailStoreResponse": { "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } }, "CreateDigitalRetailStoreRequest": { "required": [ "Store" ], "type": "object", "properties": { "Store": { "$ref": "#/definitions/DigitalRetailStoreRequest" }, "OrganisationIdentifier": { "$ref": "#/definitions/OrganisationIdentifier", "description": "This determines the organisation that the request will be run as. This changes the authentication context to be for this organisation." } } }, "CreateDigitalRetailStoreResponse": { "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } }, "SearchDigitalRetailStoreAuditsRequest": { "required": [ "PageNumber", "PageSize" ], "type": "object", "properties": { "PageNumber": { "format": "int32", "type": "integer" }, "PageSize": { "format": "int32", "maximum": 25, "minimum": 1, "type": "integer" } } }, "SearchDigitalRetailStoreAuditsResponse": { "type": "object", "properties": { "Results": { "type": "array", "items": { "$ref": "#/definitions/DigitalRetailStoreAuditResult" } }, "TotalResults": { "format": "int32", "type": "integer" }, "TotalPages": { "format": "int32", "type": "integer" }, "CurrentPage": { "format": "int32", "type": "integer" } } }, "DigitalRetailStoreAuditResult": { "type": "object", "properties": { "AppliedAt": { "format": "date-time", "type": "string" }, "User": { "$ref": "#/definitions/UserSummaryResponse" } } }, "SearchDigitalRetailStoreSlugsRequest": { "required": [ "PageNumber", "PageSize" ], "type": "object", "properties": { "Query": { "type": "string" }, "PageNumber": { "format": "int32", "type": "integer" }, "PageSize": { "format": "int32", "maximum": 25, "minimum": 1, "type": "integer" } } }, "SearchDigitalRetailStoreSlugsResponse": { "type": "object", "properties": { "Results": { "type": "array", "items": { "$ref": "#/definitions/DigitalRetailStoreSlugResult" } }, "TotalResults": { "format": "int32", "type": "integer" }, "TotalPages": { "format": "int32", "type": "integer" }, "CurrentPage": { "format": "int32", "type": "integer" } } }, "DigitalRetailStoreSlugResult": { "required": [ "Reference", "Value", "Default" ], "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Value": { "type": "string" }, "Default": { "type": "boolean" } } }, "SearchDigitalRetailStoreSlugsCountResponse": { "type": "object", "properties": { "TotalResults": { "format": "int32", "type": "integer" } } }, "RetrieveDigitalRetailStoreSlugResponse": { "required": [ "Slug" ], "type": "object", "properties": { "Slug": { "$ref": "#/definitions/DigitalRetailStoreSlugResponse" } } }, "DigitalRetailStoreSlugResponse": { "required": [ "Reference", "Value", "Default", "Urls", "SearchSet", "GroupType", "Content" ], "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Value": { "type": "string" }, "Default": { "type": "boolean" }, "Urls": { "$ref": "#/definitions/DigitalRetailStoreSlugUrls" }, "SearchSet": { "$ref": "#/definitions/DigitalRetailStoreSlugSearchSet" }, "GroupType": { "$ref": "#/definitions/DigitalRetailStoreSlugGroupType" }, "Filters": { "type": "array", "items": { "$ref": "#/definitions/DigitalRetailStoreSlugRuleFilterResponse" } }, "Content": { "$ref": "#/definitions/DigitalRetailStoreSlugContentByLocales" } } }, "DigitalRetailStoreSlugUrls": { "required": [ "Preview" ], "type": "object", "properties": { "Preview": { "$ref": "#/definitions/DigitalRetailStoreSlugUrl" } } }, "DigitalRetailStoreSlugRuleFilterResponse": { "required": [ "Type", "Option" ], "type": "object", "properties": { "Type": { "$ref": "#/definitions/DigitalRetailStoreSlugRuleFilterType" }, "Option": { "$ref": "#/definitions/DigitalRetailStoreSlugRuleFilterOption" } } }, "DigitalRetailStoreSlugContentByLocales": { "required": [ "Locales" ], "type": "object", "properties": { "Locales": { "type": "array", "items": { "$ref": "#/definitions/DigitalRetailStoreSlugContentByLocale" } } } }, "DigitalRetailStoreSlugUrl": { "required": [ "Value" ], "type": "object", "properties": { "Value": { "type": "string" } } }, "DigitalRetailStoreSlugContentByLocale": { "required": [ "Locale", "SearchEngineOptimisation" ], "type": "object", "properties": { "Locale": { "$ref": "#/definitions/LocaleData" }, "SearchEngineOptimisation": { "$ref": "#/definitions/DigitalRetailStoreSlugSearchEngineOptimisation" }, "Banner": { "$ref": "#/definitions/DigitalRetailStoreSlugContentBanner" } } }, "LocaleData": { "required": [ "Value" ], "type": "object", "properties": { "Value": { "type": "string" }, "LanguageCode": { "type": "string" }, "Alpha2Code": { "type": "string" }, "Description": { "type": "string" } } }, "DigitalRetailStoreSlugSearchEngineOptimisation": { "required": [ "Title" ], "type": "object", "properties": { "Title": { "type": "string" }, "Description": { "type": "string" } } }, "DigitalRetailStoreSlugContentBanner": { "required": [ "Image", "Title" ], "type": "object", "properties": { "Image": { "$ref": "#/definitions/Image" }, "Title": { "type": "string" }, "Description": { "type": "string" }, "ContentPage": { "$ref": "#/definitions/DigitalRetailStoreSlugContentPage" } } }, "DigitalRetailStoreSlugContentPage": { "required": [ "Reference" ], "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } }, "UpdateDigitalRetailStoreSlugRequest": { "required": [ "Slug" ], "type": "object", "properties": { "Slug": { "$ref": "#/definitions/DigitalRetailStoreSlugRequest" } } }, "DigitalRetailStoreSlugRequest": { "required": [ "Value", "SearchSet", "GroupType", "Content" ], "type": "object", "properties": { "Value": { "type": "string" }, "SearchSet": { "$ref": "#/definitions/DigitalRetailStoreSlugSearchSet" }, "GroupType": { "$ref": "#/definitions/DigitalRetailStoreSlugGroupType" }, "Filters": { "type": "array", "items": { "$ref": "#/definitions/DigitalRetailStoreSlugRuleFilter" } }, "Content": { "$ref": "#/definitions/DigitalRetailStoreSlugContentByLocales" } } }, "DigitalRetailStoreSlugRuleFilter": { "required": [ "Type", "Option" ], "type": "object", "properties": { "Type": { "$ref": "#/definitions/DigitalRetailStoreSlugRuleFilterType" }, "Option": { "$ref": "#/definitions/DigitalRetailStoreSlugRuleFilterOption" } } }, "UpdateDigitalRetailStoreSlugResponse": { "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } }, "DeleteDigitalRetailStoreSlugResponse": { "type": "object", "properties": {} }, "CreateDigitalRetailStoreSlugRequest": { "required": [ "Slug" ], "type": "object", "properties": { "Slug": { "$ref": "#/definitions/DigitalRetailStoreSlugRequest" }, "OrganisationIdentifier": { "$ref": "#/definitions/OrganisationIdentifier", "description": "This determines the organisation that the request will be run as. This changes the authentication context to be for this organisation." } } }, "CreateDigitalRetailStoreSlugResponse": { "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } }, "SetDefaultDigitalRetailStoreSlugResponse": { "type": "object", "properties": {} }, "RetrieveDigitalRetailStoreFacetCategoriesResponse": { "required": [ "Categories" ], "type": "object", "properties": { "Categories": { "type": "array", "items": { "$ref": "#/definitions/DigitalRetailStoreFacetCategory" } } } }, "DigitalRetailStoreFacetCategory": { "required": [ "Type", "Enabled" ], "type": "object", "properties": { "Type": { "$ref": "#/definitions/DigitalRetailStoreFacetCategoryType" }, "Enabled": { "type": "boolean" }, "Order": { "format": "int32", "type": "integer" } } }, "DigitalRetailStoreFacetCategoryType": { "required": [ "Reference", "Name", "FieldType" ], "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Name": { "type": "string" }, "FieldType": { "enum": [ "Unknown", "Checkbox", "Select" ], "type": "string" } } }, "UpdateDigitalRetailStoreFacetCategoriesRequest": { "required": [ "FacetCategories" ], "type": "object", "properties": { "FacetCategories": { "type": "array", "items": { "$ref": "#/definitions/UpdateDigitalRetailStoreFacetCategory" } } } }, "UpdateDigitalRetailStoreFacetCategory": { "required": [ "Enabled", "Type" ], "type": "object", "properties": { "Enabled": { "type": "boolean" }, "Order": { "format": "int32", "type": "integer" }, "Type": { "$ref": "#/definitions/DigitalRetailStoreFacetCategoryType" } } }, "UpdateDigitalRetailStoreFacetCategoriesResponse": { "type": "object", "properties": {} }, "RetrieveDigitalRetailStoreFacetCategoryAvailableOptionsResponse": { "required": [ "Options" ], "type": "object", "properties": { "Options": { "type": "array", "items": { "$ref": "#/definitions/DigitalRetailerStoreFacetCategoryAvailableOption" } } } }, "DigitalRetailerStoreFacetCategoryAvailableOption": { "required": [ "Value" ], "type": "object", "properties": { "Value": { "type": "string" } } }, "RetrieveDigitalRetailStoreFacetCategoryResponse": { "required": [ "FacetCategory" ], "type": "object", "properties": { "FacetCategory": { "$ref": "#/definitions/RetrieveDigitalRetailStoreFacetCategory" } } }, "RetrieveDigitalRetailStoreFacetCategory": { "required": [ "Type", "Options", "Enabled" ], "type": "object", "properties": { "Type": { "$ref": "#/definitions/DigitalRetailStoreFacetCategoryType" }, "Options": { "type": "array", "items": { "$ref": "#/definitions/DigitalRetailerStoreFacetCategoryOption" } }, "Enabled": { "type": "boolean" } } }, "DigitalRetailerStoreFacetCategoryOption": { "required": [ "Value", "Order", "Featured" ], "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Value": { "type": "string" }, "Order": { "format": "int32", "type": "integer" }, "Featured": { "type": "boolean" }, "Image": { "$ref": "#/definitions/Image" }, "ThumbnailImage": { "$ref": "#/definitions/Image" } } }, "CreateOrUpdateDigitalRetailStoreFacetCategoryRequest": { "required": [ "FacetCategory" ], "type": "object", "properties": { "FacetCategory": { "$ref": "#/definitions/CreateOrUpdateDigitalRetailStoreFacetCategory" }, "OrganisationIdentifier": { "$ref": "#/definitions/OrganisationIdentifier", "description": "This determines the organisation that the request will be run as. This changes the authentication context to be for this organisation." } } }, "CreateOrUpdateDigitalRetailStoreFacetCategory": { "required": [ "Options", "Enabled" ], "type": "object", "properties": { "Options": { "type": "array", "items": { "$ref": "#/definitions/DigitalRetailerStoreFacetCategoryOption" } }, "Enabled": { "type": "boolean" } } }, "CreateOrUpdateDigitalRetailStoreFacetCategoryResponse": { "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } }, "RetrieveDigitalRetailStoreLandingPageResponse": { "type": "object", "properties": { "LandingPage": { "$ref": "#/definitions/DigitalRetailStoreLandingPage" } } }, "DigitalRetailStoreLandingPage": { "required": [ "Tiles" ], "type": "object", "properties": { "Tiles": { "type": "array", "items": { "$ref": "#/definitions/DigitalRetailStoreLandingPageTile" } }, "Banner": { "$ref": "#/definitions/DigitalRetailStoreLandingPageBanner" } } }, "DigitalRetailStoreLandingPageTile": { "required": [ "Title", "Description", "Image", "Locale" ], "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Title": { "type": "string" }, "Description": { "type": "string" }, "Image": { "$ref": "#/definitions/Image" }, "Locale": { "$ref": "#/definitions/LocaleData" }, "ContentPage": { "$ref": "#/definitions/DigitalRetailStoreLandingPageContentPage" } } }, "DigitalRetailStoreLandingPageContentPage": { "required": [ "Reference" ], "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } }, "UpdateDigitalRetailStoreLandingPageRequest": { "required": [ "LandingPage" ], "type": "object", "properties": { "LandingPage": { "$ref": "#/definitions/DigitalRetailStoreLandingPage" } } }, "UpdateDigitalRetailStoreLandingPageResponse": { "type": "object", "properties": {} }, "CreateDigitalRetailStoreImageResponse": { "type": "object", "properties": { "Image": { "$ref": "#/definitions/Image" } } }, "RetrieveDigitalRetailStoreMarketingFeaturesForVehicleSearchResponse": { "type": "object", "properties": { "MarketingFeatures": { "type": "array", "items": { "$ref": "#/definitions/DigitalRetailStoreMarketingFeatureForVehicleSearch" } } } }, "DigitalRetailStoreMarketingFeatureForVehicleSearch": { "type": "object", "properties": { "Type": { "$ref": "#/definitions/MarketingFeatureType" }, "AlwaysShowField": { "type": "boolean" } } }, "UpdateDigitalRetailStoreMarketingFeaturesForSearchRequest": { "required": [ "MarketingFeatures" ], "type": "object", "properties": { "MarketingFeatures": { "type": "array", "items": { "$ref": "#/definitions/DigitalRetailStoreMarketingFeatureForSearch" } } } }, "DigitalRetailStoreMarketingFeatureForSearch": { "type": "object", "properties": { "Type": { "$ref": "#/definitions/MarketingFeatureType" }, "AlwaysShowField": { "type": "boolean" } } }, "UpdateDigitalRetailStoreMarketingFeaturesResponse": { "type": "object", "properties": {} }, "RetrieveDigitalRetailStoreMarketingFeaturesForVehicleLookupResponse": { "type": "object", "properties": { "MarketingFeatures": { "type": "array", "items": { "$ref": "#/definitions/DigitalRetailStoreMarketingFeatureForVehicleLookup" } } } }, "DigitalRetailStoreMarketingFeatureForVehicleLookup": { "type": "object", "properties": { "Type": { "$ref": "#/definitions/MarketingFeatureType" }, "AlwaysShowField": { "type": "boolean" } } }, "UpdateDigitalRetailStoreMarketingFeaturesForLookupRequest": { "required": [ "MarketingFeatures" ], "type": "object", "properties": { "MarketingFeatures": { "type": "array", "items": { "$ref": "#/definitions/DigitalRetailStoreMarketingFeatureForLookup" } } } }, "DigitalRetailStoreMarketingFeatureForLookup": { "type": "object", "properties": { "Type": { "$ref": "#/definitions/MarketingFeatureType" }, "AlwaysShowField": { "type": "boolean" } } }, "UpdateDigitalRetailStoreSubscriptionRequest": { "type": "object", "properties": { "Subscription": { "$ref": "#/definitions/DigitalRetailStoreSubscriptionRequest" } } }, "DigitalRetailStoreSubscriptionRequest": { "required": [ "Type" ], "type": "object", "properties": { "Type": { "enum": [ "None", "Trial", "Internal", "Production" ], "type": "string" }, "Expiry": { "$ref": "#/definitions/DigitalRetailStoreSubscriptionExpiryRequest" } } }, "DigitalRetailStoreSubscriptionExpiryRequest": { "required": [ "ExpiresAt" ], "type": "object", "properties": { "ExpiresAt": { "format": "date-time", "type": "string" } } }, "UpdateDigitalRetailStoreMonitoringRequest": { "required": [ "Monitoring" ], "type": "object", "properties": { "Monitoring": { "$ref": "#/definitions/DigitalRetailStoreMonitoring" } } }, "DigitalRetailStoreMonitoring": { "required": [ "Monitors" ], "type": "object", "properties": { "Monitors": { "type": "array", "items": { "$ref": "#/definitions/DigitalRetailStoreMonitor" } } } }, "DigitalRetailStoreMonitor": { "required": [ "Enabled", "Type" ], "type": "object", "properties": { "Enabled": { "type": "boolean" }, "NotifiedAt": { "format": "date-time", "type": "string" }, "Type": { "$ref": "#/definitions/DigitalRetailStoreMonitorType" } } }, "DigitalRetailStoreMonitorType": { "required": [ "Reference", "Name", "Value" ], "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Name": { "type": "string" }, "Value": { "enum": [ "Unknown", "VehicleImports" ], "type": "string" } } }, "UpdateDigitalRetailStoreMonitoringResponse": { "type": "object", "properties": {} }, "RetrieveDigitalRetailStoreMonitoringResponse": { "required": [ "Monitoring" ], "type": "object", "properties": { "Monitoring": { "$ref": "#/definitions/DigitalRetailStoreMonitoring" } } }, "GetDigitalStoreStatisticsResponse": { "type": "object", "properties": { "TotalNumberOfOrganisations": { "format": "int32", "type": "integer" }, "TotalNumberOfStores": { "format": "int32", "type": "integer" }, "OrganisationCountsByCountry": { "type": "array", "items": { "$ref": "#/definitions/RetailerCountForCountry" } }, "StoreCountsBySubscriptionType": { "type": "array", "items": { "$ref": "#/definitions/StoreCountForSubscriptionType" } } } }, "RetailerCountForCountry": { "type": "object", "properties": { "Country": { "$ref": "#/definitions/OrganisationAddressCountry" }, "NumberOfRetailers": { "format": "int32", "type": "integer" } } }, "StoreCountForSubscriptionType": { "type": "object", "properties": { "SubscriptionType": { "enum": [ "None", "Trial", "Internal", "Production" ], "type": "string" }, "NumberOfStores": { "format": "int32", "type": "integer" } } }, "RetrieveDigitalRetailStoreVehicleAccessoriesConfigurationResponse": { "type": "object", "properties": { "Configuration": { "$ref": "#/definitions/DigitalRetailStoreVehicleAccessoriesConfiguration" } } }, "DigitalRetailStoreVehicleAccessoriesConfiguration": { "required": [ "Provider", "Active", "AuthenticationToken" ], "type": "object", "properties": { "Provider": { "$ref": "#/definitions/AccessoriesProvider" }, "Active": { "type": "boolean" }, "AuthenticationToken": { "type": "string" }, "Disclaimer": { "type": "string" } } }, "UpdateDigitalRetailStoreVehicleAccessoriesConfigurationRequest": { "required": [ "Configuration" ], "type": "object", "properties": { "Configuration": { "$ref": "#/definitions/DigitalRetailStoreVehicleAccessoriesConfiguration" } } }, "UpdateDigitalRetailStoreVehicleAccessoriesConfigurationResponse": { "type": "object", "properties": {} }, "DeleteDigitalRetailStoreVehicleAccessoriesConfigurationResponse": { "type": "object", "properties": {} }, "ValidateDigitalRetailStoreVehicleAccessoriesConfigurationRequest": { "required": [ "Configuration" ], "type": "object", "properties": { "Configuration": { "$ref": "#/definitions/DigitalRetailStoreVehicleAccessoriesConfiguration" } } }, "ValidateDigitalRetailStoreVehicleAccessoriesConfigurationResponse": { "type": "object", "properties": { "IsConfigurationValid": { "type": "boolean" } } }, "RetrieveDigitalRetailStoreHeaderConfigurationResponse": { "required": [ "Headers" ], "type": "object", "properties": { "Headers": { "type": "array", "items": { "$ref": "#/definitions/DigitalRetailStoreHeaderConfiguration" } } } }, "DigitalRetailStoreHeaderConfiguration": { "required": [ "Locale" ], "type": "object", "properties": { "NavigationLinks": { "type": "array", "items": { "$ref": "#/definitions/DigitalRetailStoreHeaderNavigationLink" } }, "LogoLink": { "$ref": "#/definitions/DigitalRetailStoreNavigationLink" }, "Locale": { "$ref": "#/definitions/LocaleData" } } }, "DigitalRetailStoreHeaderNavigationLink": { "required": [ "Title" ], "type": "object", "properties": { "Title": { "type": "string" }, "Link": { "$ref": "#/definitions/DigitalRetailStoreNavigationLink" }, "Links": { "type": "array", "items": { "$ref": "#/definitions/DigitalRetailStoreHeaderNavigationLink" } } } }, "DigitalRetailStoreNavigationLink": { "required": [ "Href", "Target" ], "type": "object", "properties": { "Href": { "type": "string" }, "Target": { "type": "string" } } }, "UpdateDigitalRetailStoreHeaderConfigurationRequest": { "required": [ "Headers" ], "type": "object", "properties": { "Headers": { "type": "array", "items": { "$ref": "#/definitions/DigitalRetailStoreHeaderConfiguration" } } } }, "UpdateDigitalRetailStoreHeaderConfigurationResponse": { "type": "object", "properties": {} }, "RetrieveDigitalRetailStoreFooterConfigurationResponse": { "type": "object", "properties": { "Footers": { "type": "array", "items": { "$ref": "#/definitions/DigitalRetailStoreFooterConfiguration" } } } }, "DigitalRetailStoreFooterConfiguration": { "type": "object", "properties": { "NavigationLinks": { "type": "array", "items": { "$ref": "#/definitions/DigitalRetailStoreFooterNavigationLink" } }, "Locale": { "$ref": "#/definitions/LocaleData" } } }, "DigitalRetailStoreFooterNavigationLink": { "type": "object", "properties": { "Title": { "type": "string" }, "Link": { "$ref": "#/definitions/DigitalRetailStoreNavigationLink" }, "Links": { "type": "array", "items": { "$ref": "#/definitions/DigitalRetailStoreFooterNavigationLink" } } } }, "UpdateDigitalRetailStoreFooterConfigurationRequest": { "required": [ "Footers" ], "type": "object", "properties": { "Footers": { "type": "array", "items": { "$ref": "#/definitions/DigitalRetailStoreFooterConfiguration" } } } }, "UpdateDigitalRetailStoreFooterConfigurationResponse": { "type": "object", "properties": {} }, "RetrieveDigitalRetailStoreContentPagesResponse": { "type": "object", "properties": { "Pages": { "type": "array", "items": { "$ref": "#/definitions/RetrieveDigitalRetailStoreContentPageResult" } } } }, "RetrieveDigitalRetailStoreContentPageResult": { "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Slug": { "type": "string" }, "Locale": { "$ref": "#/definitions/LocaleData" } } }, "UpdateDigitalRetailStoreContentPageRequest": { "required": [ "Page" ], "type": "object", "properties": { "Page": { "$ref": "#/definitions/DigitalRetailStoreContentPageRequest" } } }, "DigitalRetailStoreContentPageRequest": { "required": [ "Slug", "Locale", "Fields", "Rows", "SearchEngineOptimisation" ], "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Slug": { "type": "string" }, "Locale": { "$ref": "#/definitions/LocaleData" }, "Fields": { "type": "array", "items": { "$ref": "#/definitions/DigitalRetailStoreContentPageField" } }, "Rows": { "type": "array", "items": { "$ref": "#/definitions/DigitalRetailStoreContentPageRow" } }, "SearchEngineOptimisation": { "$ref": "#/definitions/DigitalRetailStoreContentPageSearchEngineOptimisation" } } }, "DigitalRetailStoreContentPageRow": { "required": [ "Fields" ], "type": "object", "properties": { "Fields": { "type": "array", "items": { "$ref": "#/definitions/DigitalRetailStoreContentPageField" } } } }, "DigitalRetailStoreContentPageSearchEngineOptimisation": { "required": [ "Title" ], "type": "object", "properties": { "Title": { "type": "string" }, "Description": { "type": "string" } } }, "CreateOrUpdateDigitalRetailStoreContentPageResponse": { "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } }, "RetrieveDigitalRetailStoreContentPageResponse": { "type": "object", "properties": { "Page": { "$ref": "#/definitions/DigitalRetailStoreContentPageResponse" } } }, "DigitalRetailStoreContentPageResponse": { "required": [ "Slug", "Locale", "Urls", "Fields", "Rows", "SearchEngineOptimisation" ], "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Slug": { "type": "string" }, "Locale": { "$ref": "#/definitions/LocaleData" }, "Urls": { "$ref": "#/definitions/DigitalRetailStoreContentPageUrls" }, "Fields": { "type": "array", "items": { "$ref": "#/definitions/DigitalRetailStoreContentPageField" } }, "Rows": { "type": "array", "items": { "$ref": "#/definitions/DigitalRetailStoreContentPageRow" } }, "SearchEngineOptimisation": { "$ref": "#/definitions/DigitalRetailStoreContentPageSearchEngineOptimisation" } } }, "DigitalRetailStoreContentPageUrls": { "required": [ "Preview" ], "type": "object", "properties": { "Preview": { "$ref": "#/definitions/DigitalRetailStoreContentPageUrl" } } }, "DigitalRetailStoreContentPageUrl": { "required": [ "Value" ], "type": "object", "properties": { "Value": { "type": "string" } } }, "DeleteDigitalRetailStoreContentPageResponse": { "type": "object", "properties": {} }, "RetrieveDigitalRetailStoreApprovedUsedConfigurationsResponse": { "type": "object", "properties": { "Configurations": { "type": "array", "items": { "$ref": "#/definitions/DigitalRetailStoreApprovedUsedConfigurationResponse" } }, "IsEnabled": { "type": "boolean" } } }, "DigitalRetailStoreApprovedUsedConfigurationResponse": { "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Title": { "type": "string" }, "Information": { "$ref": "#/definitions/PresentDigitalRetailStoreRow" }, "Locale": { "$ref": "#/definitions/LocaleData" } } }, "UpdateDigitalRetailStoreApprovedUsedConfigurationRequest": { "required": [ "Configurations", "IsEnabled" ], "type": "object", "properties": { "Configurations": { "type": "array", "items": { "$ref": "#/definitions/DigitalRetailStoreApprovedUsedConfigurationRequest" } }, "IsEnabled": { "type": "boolean" } } }, "DigitalRetailStoreApprovedUsedConfigurationRequest": { "required": [ "Information", "Locale" ], "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Title": { "type": "string" }, "Information": { "$ref": "#/definitions/PresentDigitalRetailStoreRow" }, "Locale": { "$ref": "#/definitions/LocaleData" } } }, "UpdateDigitalRetailStoreApprovedUsedConfigurationResponse": { "type": "object", "properties": {} }, "RetrieveDigitalRetailStoreContentAreasConfigurationResponse": { "type": "object", "properties": { "Configurations": { "type": "array", "items": { "$ref": "#/definitions/RetrieveDigitalRetailStoreContentAreaConfiguration" } } } }, "RetrieveDigitalRetailStoreContentAreaConfiguration": { "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Title": { "type": "string" }, "ContentArea": { "$ref": "#/definitions/PresentedDigitalRetailStoreContentArea" }, "Locale": { "$ref": "#/definitions/LocaleData" } } }, "UpdateDigitalRetailStoreContentAreasConfigurationRequest": { "required": [ "Configurations" ], "type": "object", "properties": { "Configurations": { "type": "array", "items": { "$ref": "#/definitions/DigitalRetailStoreContentAreasConfigurationRequest" } } } }, "DigitalRetailStoreContentAreasConfigurationRequest": { "required": [ "ContentArea", "Locale" ], "type": "object", "properties": { "ContentReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "ContentArea": { "$ref": "#/definitions/PresentedDigitalRetailStoreContentArea" }, "Locale": { "$ref": "#/definitions/LocaleData" }, "Title": { "type": "string" }, "IsEnabled": { "type": "boolean" }, "Position": { "enum": [ "Unknown", "Bottom", "Middle" ], "type": "string" } } }, "UpdateDigitalRetailStoreContentAreasConfigurationResponse": { "type": "object", "properties": {} }, "RetrieveDigitalRetailStoreContentAreaConfigurationResponse": { "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "ContentArea": { "$ref": "#/definitions/PresentedDigitalRetailStoreContentArea" }, "Locale": { "$ref": "#/definitions/LocaleData" }, "Title": { "type": "string" }, "IsEnabled": { "type": "boolean" }, "Position": { "enum": [ "Unknown", "Bottom", "Middle" ], "type": "string" } } }, "CreateOrUpdateDigitalRetailStoreContentAreaConfigurationRequest": { "required": [ "Configuration" ], "type": "object", "properties": { "Configuration": { "$ref": "#/definitions/DigitalRetailStoreContentAreasConfigurationRequest" } } }, "CreateOrUpdateDigitalRetailStoreContentAreaConfigurationResponse": { "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } }, "UpdateDigitalRetailStoreDefaultSlugForRetailerResponse": { "type": "object", "properties": {} }, "ValidateGeolocationProviderCredentialsResponse": { "type": "object", "properties": {} }, "UpdateDigitalRetailStoreSearchPageLocationConfigurationRequest": { "type": "object", "properties": { "Configuration": { "$ref": "#/definitions/DigitalRetailStoreSearchPageLocationConfiguration" } } }, "UpdateDigitalRetailStoreSearchPageLocationConfigurationResponse": { "type": "object", "properties": { "Configuration": { "$ref": "#/definitions/DigitalRetailStoreSearchPageLocationConfiguration" } } }, "RetrieveDigitalRetailStoreDetailsPageLocationConfigurationResponse": { "type": "object", "properties": { "Configuration": { "$ref": "#/definitions/DigitalRetailStoreDetailsPageConfiguration" } } }, "DigitalRetailStoreDetailsPageConfiguration": { "required": [ "HasExternalVehicleLink" ], "type": "object", "properties": { "HasExternalVehicleLink": { "type": "boolean" } } }, "UpdateDigitalRetailStoreDetailsPageConfigurationRequest": { "type": "object", "properties": { "Configuration": { "$ref": "#/definitions/DigitalRetailStoreDetailsPageConfiguration" } } }, "UpdateDigitalRetailStoreDetailsPageConfigurationResponse": { "type": "object", "properties": { "Configuration": { "$ref": "#/definitions/DigitalRetailStoreDetailsPageConfiguration" } } }, "CreateOrUpdateDigitalRetailStoresStoreBuilderPageRequest": { "required": [ "Page" ], "type": "object", "properties": { "Page": { "$ref": "#/definitions/StoreBuilderPage" } } }, "CreateOrUpdateDigitalRetailStoresStoreBuilderPageResponse": { "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } }, "DeleteDigitalRetailStoreStoreBuilderPageResponse": { "type": "object", "properties": {} }, "RetrieveDigitalRetailStoreMaintenanceWindowsResponse": { "type": "object", "properties": { "MaintenanceWindows": { "type": "array", "items": { "$ref": "#/definitions/RetrievedMaintenanceWindow" } } } }, "RetrievedMaintenanceWindow": { "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "StartAt": { "format": "date-time", "type": "string" }, "EndAt": { "format": "date-time", "type": "string" }, "Reason": { "type": "string" }, "UserMessage": { "type": "string" }, "ProductTypes": { "type": "array", "items": { "$ref": "#/definitions/RetrievedMaintenanceWindowProductType" } }, "IsActive": { "type": "boolean" }, "IsDeleted": { "type": "boolean" } } }, "RetrievedMaintenanceWindowProductType": { "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Name": { "type": "string" } } }, "CreateDigitalRetailStoreMaintenanceWindowRequest": { "type": "object", "properties": { "StartAt": { "format": "date-time", "type": "string" }, "EndAt": { "format": "date-time", "type": "string" }, "Reason": { "type": "string" }, "UserMessage": { "type": "string" }, "ProductTypeReferences": { "type": "array", "items": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } } }, "CreateDigitalRetailStoreMaintenanceWindowResponse": { "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } }, "UpdateDigitalRetailStoreMaintenanceWindowRequest": { "type": "object", "properties": { "MaintenanceWindowReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "StartAt": { "format": "date-time", "type": "string" }, "EndAt": { "format": "date-time", "type": "string" }, "Reason": { "type": "string" }, "UserMessage": { "type": "string" }, "ProductTypeReferences": { "type": "array", "items": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } } }, "UpdateDigitalRetailStoreMaintenanceWindowResponse": { "type": "object", "properties": {} }, "DeleteDigitalRetailStoreMaintenanceWindowResponse": { "type": "object", "properties": {} }, "RetrieveDigitalRetailStoreMaintenanceWindowResponse": { "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "StartAt": { "format": "date-time", "type": "string" }, "EndAt": { "format": "date-time", "type": "string" }, "Reason": { "type": "string" }, "UserMessage": { "type": "string" }, "ProductTypes": { "type": "array", "items": { "$ref": "#/definitions/MaintenanceWindowProductType" } }, "Audits": { "type": "array", "items": { "$ref": "#/definitions/MaintenanceWindowAudit" } } } }, "MaintenanceWindowProductType": { "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Name": { "type": "string" } } }, "MaintenanceWindowAudit": { "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "OccurredAt": { "format": "date-time", "type": "string" }, "Type": { "type": "string" }, "UserReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Before": { "type": "string" }, "After": { "type": "string" }, "UserFullName": { "type": "string" }, "UserEmail": { "type": "string" } } }, "RetrieveDigitalRetailStoreActiveMaintenanceWindowsResponse": { "type": "object", "properties": { "MaintenanceWindows": { "type": "array", "items": { "$ref": "#/definitions/ActiveMaintenanceWindow" } } } }, "ActiveMaintenanceWindow": { "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "StartAt": { "format": "date-time", "type": "string" }, "EndAt": { "format": "date-time", "type": "string" }, "Reason": { "type": "string" }, "UserMessage": { "type": "string" }, "ProductTypes": { "type": "array", "items": { "$ref": "#/definitions/ActiveMaintenanceWindowProductType" } } } }, "ActiveMaintenanceWindowProductType": { "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } }, "RetrieveDigitalRetailStoreOrganisationResponse": { "type": "object", "properties": { "Retailer": { "$ref": "#/definitions/RetailerSummary" }, "Domain": { "$ref": "#/definitions/DigitalRetailStoreDomain" }, "Journeys": { "$ref": "#/definitions/DigitalRetailStoreOrganisationJourneys" } } }, "RetailerSummary": { "type": "object", "properties": { "Name": { "type": "string" }, "Reference": { "type": "string" }, "OrganisationReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Address": { "$ref": "#/definitions/RetailerAddress" }, "Contacts": { "type": "array", "items": { "$ref": "#/definitions/RetailerContact" } }, "ExternalReferences": { "type": "array", "items": { "$ref": "#/definitions/RetailerReference" } }, "Outlets": { "type": "array", "items": { "$ref": "#/definitions/RetailerOutlet" } }, "Website": { "type": "string" } } }, "DigitalRetailStoreOrganisationJourneys": { "type": "object", "properties": { "Checkout": { "$ref": "#/definitions/DigitalRetailStoreOrganisationJourney" } } }, "RetailerAddress": { "required": [ "NameNumber", "Line1", "TownCity", "Country" ], "type": "object", "properties": { "NameNumber": { "type": "string" }, "Line1": { "type": "string" }, "Line2": { "type": "string" }, "Line3": { "type": "string" }, "TownCity": { "type": "string" }, "County": { "type": "string" }, "Postcode": { "type": "string" }, "Country": { "$ref": "#/definitions/RetailerAddressCountry" }, "Location": { "$ref": "#/definitions/RetailerAddressLocation" } } }, "RetailerContact": { "type": "object", "properties": { "IsPrimary": { "type": "boolean" }, "Value": { "type": "string" }, "Type": { "enum": [ "Telephone", "Email" ], "type": "string" } } }, "RetailerReference": { "type": "object", "properties": { "Value": { "type": "string" }, "Type": { "enum": [ "Unknown" ], "type": "string" } } }, "RetailerOutlet": { "type": "object", "properties": { "Name": { "type": "string" }, "Reference": { "type": "string" } } }, "DigitalRetailStoreOrganisationJourney": { "type": "object", "properties": { "Name": { "type": "string" }, "IsEnabled": { "type": "boolean" }, "IsAvailable": { "type": "boolean" } } }, "RetailerAddressCountry": { "required": [ "Description" ], "type": "object", "properties": { "Description": { "type": "string" } } }, "RetailerAddressLocation": { "type": "object", "properties": { "Latitude": { "format": "double", "type": "number" }, "Longitude": { "format": "double", "type": "number" } } }, "UpdateDigitalRetailStoreOrganisationRequest": { "required": [ "Domain" ], "type": "object", "properties": { "Domain": { "$ref": "#/definitions/DigitalRetailStoreDomain" }, "Journeys": { "$ref": "#/definitions/DigitalRetailStoreOrganisationJourneys" } } }, "UpdateDigitalRetailStoreOrganisationResponse": { "type": "object", "properties": {} }, "DeleteDigitalRetailStoreOrganisationResponse": { "type": "object", "properties": {} }, "SearchDigitalRetailStoreOrganisationsRequest": { "required": [ "PageNumber", "PageSize" ], "type": "object", "properties": { "Query": { "type": "string" }, "PageNumber": { "format": "int32", "type": "integer" }, "PageSize": { "format": "int32", "maximum": 25, "minimum": 1, "type": "integer" } } }, "SearchDigitalRetailStoreOrganisationsCountResponse": { "type": "object", "properties": { "TotalResults": { "format": "int32", "type": "integer" } } }, "SearchDigitalRetailStoreOrganisationsResponse": { "type": "object", "properties": { "Results": { "type": "array", "items": { "$ref": "#/definitions/AssociatedOrganisationDigitalRetailStoreResult" } }, "TotalResults": { "format": "int32", "type": "integer" }, "TotalPages": { "format": "int32", "type": "integer" }, "CurrentPage": { "format": "int32", "type": "integer" } } }, "AssociatedOrganisationDigitalRetailStoreResult": { "type": "object", "properties": { "Retailer": { "$ref": "#/definitions/RetailerSummary" }, "Domain": { "$ref": "#/definitions/DigitalRetailStoreDomain" } } }, "RetrieveDigitalRetailStoreHandoverResponse": { "type": "object", "properties": { "Delivery": { "$ref": "#/definitions/DigitalRetailStoreDelivery" }, "Collection": { "$ref": "#/definitions/DigitalRetailStoreCollection" } } }, "DigitalRetailStoreDelivery": { "type": "object", "properties": { "IsEnabled": { "type": "boolean" }, "Formula": { "$ref": "#/definitions/DigitalRetailStoreDeliveryFormula" }, "Window": { "$ref": "#/definitions/DigitalRetailStoreDeliveryWindow" } } }, "DigitalRetailStoreCollection": { "type": "object", "properties": { "IsEnabled": { "type": "boolean" }, "CollectionPoints": { "type": "array", "items": { "$ref": "#/definitions/DigitalRetailStoreCollectionPoint" } } } }, "DigitalRetailStoreDeliveryFormula": { "type": "object", "properties": { "Type": { "enum": [ "Unknown", "Unavailable", "FlatFee", "Tiered", "Scaled", "ScaledWithFlatOffset" ], "type": "string" }, "FlatFee": { "format": "double", "type": "number" }, "Scaling": { "$ref": "#/definitions/OrganisationScalingDeliveryFeeDetails" }, "Tiering": { "$ref": "#/definitions/OrganisationTieringDeliveryFeeDetails" }, "ScalingWithFlatOffset": { "$ref": "#/definitions/OrganisationScalingWithFlatOffsetDeliveryFeeDetails" }, "DistanceUnit": { "enum": [ "Miles", "Kilometres", "Mil" ], "type": "string" }, "MaximumDistance": { "format": "double", "type": "number" } } }, "DigitalRetailStoreDeliveryWindow": { "type": "object", "properties": { "AllowsDeliveryDateSelection": { "type": "boolean" }, "MinimumLeadTimeDays": { "format": "int32", "type": "integer" }, "NumberOfSelectableDates": { "format": "int32", "type": "integer" }, "SelectableDays": { "enum": [ "Unknown", "Weekdays", "WeekdaysPlusSaturdays", "AllDays" ], "type": "string" } } }, "DigitalRetailStoreCollectionPoint": { "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Name": { "type": "string" }, "Price": { "format": "double", "type": "number" }, "Marketing": { "$ref": "#/definitions/DigitalRetailStoreCollectionPointMarketing" }, "Retailer": { "$ref": "#/definitions/RetailerSummary" } } }, "OrganisationScalingDeliveryFeeDetails": { "type": "object", "properties": { "BaseFee": { "format": "double", "type": "number" }, "FeePerDistanceUnit": { "format": "double", "type": "number" } } }, "OrganisationTieringDeliveryFeeDetails": { "type": "object", "properties": { "MaximumFee": { "format": "double", "type": "number" }, "Tiers": { "type": "array", "items": { "$ref": "#/definitions/OrganisationDeliveryTier" } } } }, "OrganisationScalingWithFlatOffsetDeliveryFeeDetails": { "type": "object", "properties": { "BaseFee": { "format": "double", "type": "number" }, "MaximumDistanceForBaseFee": { "format": "double", "type": "number" }, "FeePerDistanceUnitPastBaseFeeDistance": { "format": "double", "type": "number" } } }, "DigitalRetailStoreCollectionPointMarketing": { "type": "object", "properties": { "Description": { "type": "string" } } }, "OrganisationDeliveryTier": { "type": "object", "properties": { "MaximumDistance": { "format": "double", "type": "number" }, "Fee": { "format": "double", "type": "number" } } }, "UpdateDigitalRetailStoreHandoverRequest": { "type": "object", "properties": { "Delivery": { "$ref": "#/definitions/DigitalRetailStoreDelivery" }, "Collection": { "$ref": "#/definitions/DigitalRetailStoreCollection" } } }, "UpdateDigitalRetailStoreHandoverResponse": { "type": "object", "properties": {} }, "UpdateDigitalRetailStoreDeliveryFormulaRequest": { "type": "object", "properties": { "DeliveryFormula": { "$ref": "#/definitions/DigitalRetailStoreDeliveryFormula" } } }, "UpdateDigitalRetailStoreDeliveryFormulaResponse": { "type": "object", "properties": {} }, "UpdateDigitalRetailStoreDeliveryFormulaForAssociatedOrganisationsResponse": { "type": "object", "properties": {} }, "UpdateDigitalRetailStoreDeliveryWindowRequest": { "type": "object", "properties": { "DeliveryWindow": { "$ref": "#/definitions/DigitalRetailStoreDeliveryWindow" } } }, "UpdateDigitalRetailStoreDeliveryWindowResponse": { "type": "object", "properties": {} }, "UpdateDigitalRetailStoreDeliveryWindowForAssociatedOrganisationsResponse": { "type": "object", "properties": {} }, "UpdateDigitalRetailStoreCollectionPointRequest": { "type": "object", "properties": { "CollectionPoint": { "$ref": "#/definitions/DigitalRetailStoreCollectionPoint" } } }, "CreateDigitalRetailStoreCollectionPointResponse": { "type": "object", "properties": {} }, "DeleteDigitalRetailStoreCollectionPointResponse": { "type": "object", "properties": {} }, "CreateDovetailDataRequest": { "type": "object", "properties": { "Title": { "type": "string" }, "Content": { "type": "string" }, "ProjectId": { "type": "string" } } }, "GetVehicleTestDrivesResponse": { "type": "object", "properties": { "VehicleTestDrives": { "type": "array", "items": { "$ref": "#/definitions/VehicleTestDriveItem" } }, "Pagination": { "$ref": "#/definitions/IPaginationResponse" } } }, "VehicleTestDriveItem": { "type": "object", "properties": { "VehicleReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "DateRequested": { "format": "date-time", "type": "string" }, "Manufacturer": { "type": "string" }, "Derivative": { "type": "string" }, "Model": { "type": "string" }, "ImageUrl": { "type": "string" } } }, "GetEntityTypesResponse": { "type": "object", "properties": { "EntityTypes": { "type": "array", "items": { "$ref": "#/definitions/PrivacyPolicyEntityType" } } } }, "PrivacyPolicyEntityType": { "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "Name": { "type": "string" } } }, "EquityParityResponse": { "type": "object", "properties": { "VehicleReference": { "type": "string" }, "FirstPositiveEquityParity": { "$ref": "#/definitions/EquityParityPoint" }, "EquityParityPoints": { "type": "array", "items": { "$ref": "#/definitions/EquityParityPoint" } } } }, "EquityParityPoint": { "type": "object", "properties": { "Month": { "format": "int32", "type": "integer" }, "Date": { "type": "string" }, "RemainingBalance": { "format": "double", "type": "number" }, "ValueOfVehicle": { "format": "double", "type": "number" }, "Equity": { "format": "double", "type": "number" } } }, "EquityParityLandingPageResponse": { "type": "object", "properties": { "Proposals": { "type": "array", "items": { "$ref": "#/definitions/EquityParityIndividualProposalResponse" } } } }, "EquityParityIndividualProposalResponse": { "type": "object", "properties": { "ProposalGuidIdentifier": { "type": "string" }, "ProposalIntIdentifier": { "format": "int32", "type": "integer" }, "ClaimInformation": { "$ref": "#/definitions/SearchProposalClaimInformation" }, "Customer": { "$ref": "#/definitions/SearchProposalApplicant" }, "EquityParity": { "$ref": "#/definitions/EquityParityResponse" }, "PositiveEquityState": { "type": "string" }, "LoanProgress": { "format": "int32", "type": "integer" }, "CurrentMonth": { "format": "int32", "type": "integer" }, "MonthlyPayment": { "format": "double", "type": "number" } } }, "SearchProposalClaimInformation": { "type": "object", "properties": { "IsClaimed": { "type": "boolean", "readOnly": true }, "ClaimedState": { "enum": [ "Unclaimed", "ClaimedByOther", "ClaimedByMe" ], "type": "string", "readOnly": true }, "Name": { "type": "string", "readOnly": true } } }, "SearchProposalApplicant": { "type": "object", "properties": { "CreditRating": { "$ref": "#/definitions/SearchProposalCreditRating" }, "DisplayValue": { "type": "string" }, "Forename": { "type": "string" }, "Surname": { "type": "string" }, "Id": { "type": "string" }, "EmailAddress": { "type": "string" }, "PhoneNumber": { "type": "string" }, "MobileNumber": { "type": "string" } } }, "SearchProposalCreditRating": { "type": "object", "properties": { "Score": { "type": "string", "readOnly": true }, "DisplayValue": { "type": "string", "readOnly": true }, "Tier": { "type": "string", "readOnly": true } } }, "FcpLegacyFinanceSearchResponse": { "type": "object", "properties": { "Results": { "type": "array", "items": { "$ref": "#/definitions/FcpLegacyFinanceCampaignSearchResult" } } } }, "FcpLegacyFinanceCampaignSearchResult": { "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "Name": { "type": "string" }, "Meta": { "type": "string" }, "Type": { "type": "string" }, "Active": { "type": "boolean" } } }, "FcpLegacyVehicleLookupResponse": { "type": "object", "properties": { "VehicleData": { "$ref": "#/definitions/FcpLegacyPhysicalVehicleResponse" }, "StockLocationOrganisations": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/definitions/FcpLegacyStockLocationOrganisation" } } } } }, "FcpLegacyPhysicalVehicleResponse": { "description": "A Services-owned projection of {VehicleData.Api.VehicleDetails.PhysicalVehicleResponse}\r\ncontaining only the fields rendered by the FCP vehicle-lookup tools page. Keeps the public wire\r\ncontract decoupled from the upstream VehicleData type so additions upstream do not silently\r\nbecome part of this Services endpoint's contract.", "type": "object", "properties": { "Physical": { "$ref": "#/definitions/FcpLegacyVehicleDetails" }, "Specification": { "$ref": "#/definitions/FcpLegacyDerivativeDetails" }, "Identifiers": { "type": "object", "additionalProperties": { "type": "string" } }, "Valuations": { "type": "array", "items": { "$ref": "#/definitions/FcpLegacyValuation" } }, "VehicleReference": { "type": "string" }, "Identifier": { "type": "string" }, "IdentifierType": { "type": "string" }, "LookupTime": { "format": "date-time", "type": "string" }, "DebugString": { "type": "string" }, "RequestedImageLink": { "type": "string" }, "VehicleHash": { "type": "string" }, "EligibleForFullSalesTaxRelief": { "type": "boolean" }, "RequireQuoteExcludingSalesTax": { "type": "boolean" }, "CalculationTime": { "format": "date-time", "type": "string" } } }, "FcpLegacyStockLocationOrganisation": { "type": "object", "properties": { "LegacyDealerId": { "format": "int32", "type": "integer" }, "TradingName": { "type": "string" } } }, "FcpLegacyVehicleDetails": { "type": "object", "properties": { "Colour": { "type": "string" }, "DealerVehicleLink": { "type": "string" }, "SourceStockId": { "type": "string" }, "StockDate": { "format": "date-time", "type": "string" }, "DealerStockId": { "type": "string" }, "LastUpdated": { "format": "date-time", "type": "string" }, "Equipment": { "type": "array", "items": { "$ref": "#/definitions/FcpLegacyEquipmentOption" } }, "Vin": { "type": "string" }, "Source": { "type": "string" }, "CustomerReservedDate": { "format": "date-time", "type": "string" }, "CodeweaversIdentifier": { "type": "string" }, "StockLocations": { "type": "array", "items": { "type": "string" } }, "CostBreakdown": { "$ref": "#/definitions/FcpLegacyCostBreakdown" }, "RetailerStockLocation": { "type": "string" }, "CurrentMileage": { "$ref": "#/definitions/FcpLegacyMileage" }, "Emissions": { "format": "int32", "type": "integer" }, "Registration": { "$ref": "#/definitions/FcpLegacyVehicleRegistration" }, "ManufacturerRecommendedRetailPrice": { "format": "double", "type": "number" }, "DateOfManufacture": { "format": "date-time", "type": "string" }, "ModelYear": { "format": "int32", "type": "integer" }, "IsFranchiseApproved": { "type": "boolean" }, "VatStatus": { "type": "string" }, "Provider": { "type": "string" }, "Status": { "type": "string" }, "FundingStatus": { "type": "string" }, "CurrentOwnerRegistrationDate": { "format": "date-time", "type": "string" }, "FactoryOrderNumber": { "type": "string" }, "NumberOfRegisteredOwners": { "format": "int32", "type": "integer" }, "FranchiseApprovedProgramme": { "type": "string" }, "TaxClass": { "type": "string" }, "RemoveAllSystemDiscounts": { "type": "boolean" }, "VatPercentage": { "format": "double", "type": "number" }, "InteriorDescription": { "type": "string" } } }, "FcpLegacyDerivativeDetails": { "type": "object", "properties": { "Keywords": { "type": "array", "items": { "type": "string" } }, "VatReclaimable": { "type": "boolean" }, "FuelType": { "type": "string" }, "FuelTypeEnum": { "type": "string" }, "Doors": { "format": "int32", "type": "integer" }, "Emissions": { "format": "int32", "type": "integer" }, "DiscontinuedDate": { "format": "date-time", "type": "string" }, "IntroducedDate": { "format": "date-time", "type": "string" }, "InsuranceGroup": { "type": "string" }, "InsuranceGroupRating": { "format": "int32", "type": "integer" }, "BodyStyle": { "type": "string" }, "Transmission": { "type": "string" }, "TransmissionEnum": { "type": "string" }, "EngineSize": { "format": "int32", "type": "integer" }, "Model": { "type": "string" }, "ModelYear": { "type": "string" }, "Variant": { "type": "string" }, "Derivative": { "type": "string" }, "Description": { "type": "string" }, "Manufacturer": { "type": "string" }, "ManufacturerEnum": { "type": "string" }, "P11DExemptPrice": { "format": "double", "type": "number" }, "P11DValue": { "format": "double", "type": "number" }, "ManufacturerDelivery": { "format": "double", "type": "number" }, "SubsequentRoadFundLicence": { "format": "double", "type": "number" }, "SixMonthsSubsequentRoadFundLicence": { "format": "double", "type": "number" }, "GovernmentGrantCategory": { "type": "string" }, "MilesPerGallon": { "format": "double", "type": "number" }, "Seats": { "format": "int32", "type": "integer" }, "BootCapacity": { "format": "int32", "type": "integer" }, "Drive": { "type": "string" }, "DriveEnum": { "type": "string" }, "ZeroTo60": { "format": "double", "type": "number" }, "Identifier": { "type": "string" }, "IdentifierType": { "type": "string" }, "IsRde2Compliant": { "type": "boolean" }, "VehicleTypeEnum": { "type": "string" }, "FiscalPower": { "format": "int32", "type": "integer" }, "IsTreatedAsACarWhenCalculatingRoadFundLicence": { "type": "boolean" }, "DataSet": { "type": "string" }, "EnginePowerValue": { "format": "int32", "type": "integer" }, "EnginePowerUnit": { "type": "string" } } }, "FcpLegacyValuation": { "type": "object", "properties": { "Name": { "type": "string" }, "Value": { "format": "double", "type": "number" } } }, "FcpLegacyEquipmentOption": { "type": "object", "properties": { "Identifier": { "type": "string" }, "CapIdentifier": { "format": "int32", "type": "integer" }, "Description": { "type": "string" }, "Price": { "format": "double", "type": "number" }, "IsStandard": { "type": "boolean" }, "Category": { "type": "string" }, "PackCode": { "type": "string" } } }, "FcpLegacyCostBreakdown": { "type": "object", "properties": { "BasePrice": { "format": "double", "type": "number" }, "RoadFundLicence": { "format": "double", "type": "number" }, "Delivery": { "format": "double", "type": "number" }, "RegistrationFee": { "format": "double", "type": "number" }, "Discount": { "format": "double", "type": "number" }, "EquipmentOptionsTotal": { "format": "double", "type": "number" }, "OnTheRoadPrice": { "format": "double", "type": "number" }, "Accessories": { "format": "double", "type": "number" }, "ValueAddedProductsTotal": { "format": "double", "type": "number" }, "BrandDiscount": { "format": "double", "type": "number" }, "RetailerDiscount": { "format": "double", "type": "number" }, "GovernmentGrant": { "format": "double", "type": "number" }, "Plates": { "format": "double", "type": "number" }, "GovernmentCharge": { "format": "double", "type": "number" } } }, "FcpLegacyMileage": { "type": "object", "properties": { "Value": { "format": "int32", "type": "integer" }, "Unit": { "type": "string" } } }, "FcpLegacyVehicleRegistration": { "type": "object", "properties": { "RegistrationNumber": { "type": "string" }, "DateRegisteredWithDvla": { "format": "date-time", "type": "string" }, "CountryCode": { "type": "string" } } }, "FcpLegacyExpireVrmResponse": { "type": "object", "properties": { "Message": { "type": "string" } } }, "FcpLegacyReserveStatusResponse": { "type": "object", "properties": { "Results": { "type": "array", "items": { "$ref": "#/definitions/FcpLegacyReserveStatusResult" } } } }, "FcpLegacyReserveStatusResult": { "type": "object", "properties": { "Identifier": { "type": "string" }, "Found": { "type": "boolean" }, "Status": { "type": "string" } } }, "FcpLegacyUnreserveStockRequest": { "required": [ "Identifiers" ], "type": "object", "properties": { "Identifiers": { "type": "array", "items": { "type": "string" } } } }, "FcpLegacyUnreserveStockResponse": { "type": "object", "properties": { "Results": { "type": "array", "items": { "$ref": "#/definitions/FcpLegacyUnreserveStockResult" } } } }, "FcpLegacyUnreserveStockResult": { "type": "object", "properties": { "Identifier": { "type": "string" }, "Unreserved": { "type": "boolean" } } }, "FcpLegacyDeleteStockResponse": { "type": "object", "properties": { "Message": { "type": "string" } } }, "FcpLegacySecurityGetResponse": { "type": "object", "properties": { "PasswordSecurityRules": { "type": "array", "items": { "$ref": "#/definitions/FcpLegacyPasswordSecurityRule" } }, "PasswordRetryRule": { "$ref": "#/definitions/FcpLegacyPasswordRetryRule" } } }, "FcpLegacyPasswordSecurityRule": { "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "Message": { "type": "string" }, "Regex": { "type": "string" } } }, "FcpLegacyPasswordRetryRule": { "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "Attempts": { "format": "int32", "type": "integer" } } }, "FcpLegacySecuritySaveRuleRequest": { "required": [ "Message", "Regex" ], "type": "object", "properties": { "Message": { "type": "string" }, "Regex": { "type": "string" } } }, "FcpLegacySecuritySaveRuleResponse": { "type": "object", "properties": { "Message": { "type": "string" } } }, "FcpLegacySecurityUpdateRuleRequest": { "required": [ "Id", "Message", "Regex" ], "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "Message": { "type": "string" }, "Regex": { "type": "string" } } }, "FcpLegacySecurityUpdateRuleResponse": { "type": "object", "properties": { "Message": { "type": "string" } } }, "FcpLegacySecurityUpdateRetryRuleRequest": { "required": [ "Id", "Attempts" ], "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "Attempts": { "format": "int32", "type": "integer" } } }, "FcpLegacySecurityUpdateRetryRuleResponse": { "type": "object", "properties": { "Message": { "type": "string" } } }, "FcpLegacySecurityDeleteRuleRequest": { "required": [ "Id" ], "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" } } }, "FcpLegacySecurityDeleteRuleResponse": { "type": "object", "properties": { "Message": { "type": "string" } } }, "FcpLegacyResidualConfigurationGetOptionsResponse": { "type": "object", "properties": { "DataProviders": { "type": "array", "items": { "$ref": "#/definitions/FcpLegacyResidualConfigurationDataProvider" } }, "ManualResidualProviders": { "type": "array", "items": { "$ref": "#/definitions/FcpLegacyResidualConfigurationManualResidualProvider" } } } }, "FcpLegacyResidualConfigurationDataProvider": { "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "Name": { "type": "string" } } }, "FcpLegacyResidualConfigurationManualResidualProvider": { "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "Name": { "type": "string" } } }, "FcpLegacyResidualConfigurationGetResponse": { "type": "object", "properties": { "Id": { "type": "string" }, "Name": { "type": "string" }, "DataProviderId": { "format": "int32", "type": "integer" }, "ManualResidualId": { "format": "int32", "type": "integer" }, "IsVisible": { "type": "boolean" }, "IsEditable": { "type": "boolean" }, "DisplayText": { "type": "string" }, "ExternalKey": { "type": "string" }, "Products": { "type": "array", "items": { "$ref": "#/definitions/FcpLegacyResidualConfigurationProduct" } } } }, "FcpLegacyResidualConfigurationProduct": { "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "Name": { "type": "string" } } }, "FcpLegacyResidualConfigurationGetProductsResponse": { "type": "object", "properties": { "Products": { "type": "array", "items": { "$ref": "#/definitions/FcpLegacyResidualConfigurationProduct" } } } }, "FcpLegacyResidualConfigurationCreateRequest": { "required": [ "Name", "DataProviderId", "ExternalKey" ], "type": "object", "properties": { "Name": { "type": "string" }, "DataProviderId": { "format": "int32", "type": "integer" }, "ExternalKey": { "type": "string" }, "ManualResidualId": { "format": "int32", "type": "integer" }, "IsVisible": { "type": "boolean" }, "IsEditable": { "type": "boolean" }, "DisplayText": { "type": "string" } } }, "FcpLegacyResidualConfigurationCreateResponse": { "type": "object", "properties": { "Id": { "type": "string" } } }, "FcpLegacyResidualConfigurationUpdateRequest": { "required": [ "Name", "DataProviderId", "ExternalKey" ], "type": "object", "properties": { "Name": { "type": "string" }, "DataProviderId": { "format": "int32", "type": "integer" }, "ExternalKey": { "type": "string" }, "ManualResidualId": { "format": "int32", "type": "integer" }, "IsVisible": { "type": "boolean" }, "IsEditable": { "type": "boolean" }, "DisplayText": { "type": "string" } } }, "FcpLegacyResidualConfigurationUpdateResponse": { "type": "object", "properties": { "Id": { "type": "string" } } }, "RootDocumentArrayResponse": { "type": "object", "properties": { "File": { "format": "byte", "type": "string", "readOnly": true }, "FileName": { "type": "string", "readOnly": true }, "MediaType": { "type": "string", "readOnly": true } } }, "RetailerInvoiceEventsOperationsGetResponse": { "type": "object", "properties": { "Operations": { "type": "array", "items": { "type": "string" } } } }, "FcpLegacyQuoteLookupResponse": { "type": "object", "properties": { "QuoteReference": { "type": "string" }, "RawQuote": { "type": "string" }, "RawVehicle": { "type": "string" }, "Vehicle": { "$ref": "#/definitions/FcpLegacyQuoteLookupVehicle" }, "Product": { "$ref": "#/definitions/FcpLegacyQuoteLookupProduct" }, "Quote": { "$ref": "#/definitions/FcpLegacyQuoteLookupQuote" }, "RequestParameters": { "$ref": "#/definitions/FcpLegacyQuoteLookupRequestParameters" }, "Details": { "$ref": "#/definitions/FcpLegacyQuoteLookupDetails" }, "Dealers": { "$ref": "#/definitions/FcpLegacyQuoteLookupDealers" }, "AdditionalQuote": { "$ref": "#/definitions/FcpLegacyQuoteLookupAdditionalQuote" }, "ControlPanelSystemUrl": { "type": "string" } } }, "FcpLegacyQuoteLookupVehicle": { "type": "object", "properties": { "RegistrationNumber": { "type": "string" }, "ImageLink": { "type": "string" }, "DealerStockId": { "type": "string" }, "DealerLink": { "type": "string" }, "VehicleRequestId": { "type": "string" }, "VehicleCurrentMileage": { "type": "string" }, "VehicleCurrentMileageUnit": { "type": "string" }, "VehicleDateOfRegistration": { "type": "string" }, "VehicleIsNew": { "type": "string" }, "VehicleIdentifier": { "type": "string" }, "VehicleIdentifierType": { "type": "string" }, "IsVatQualifying": { "type": "string" }, "VehicleType": { "type": "string" }, "CashPrice": { "type": "string" }, "ResidualValue": { "type": "string" }, "P11D": { "format": "double", "type": "number" }, "VehicleDescription": { "type": "string" }, "CodeweaversStockId": { "type": "string" } } }, "FcpLegacyQuoteLookupProduct": { "type": "object", "properties": { "DealerName": { "type": "string" }, "ProductName": { "type": "string" }, "ProductKey": { "type": "string" }, "RequestedSelloutValue": { "type": "string" }, "RequestedSelloutType": { "type": "string" }, "FinanceTermsId": { "format": "int32", "type": "integer" } } }, "FcpLegacyQuoteLookupQuote": { "type": "object", "properties": { "QuoteReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "OfferCode": { "type": "string" }, "AnnualMileage": { "type": "string" }, "ContractMileage": { "type": "string" }, "Apr": { "type": "string" }, "Balance": { "type": "string" }, "ProductKey": { "type": "string" }, "CustomerRate": { "type": "string" }, "Deposit": { "type": "string" }, "CashDeposit": { "type": "string" }, "Settlement": { "type": "string" }, "PartExchange": { "type": "string" }, "DocumentationFee": { "type": "string" }, "ExcessMileageRate": { "type": "string" }, "FinalPayment": { "type": "string" }, "FirstPayment": { "type": "string" }, "NumberOfRegularPayments": { "format": "int32", "type": "integer" }, "OptionToPurchaseFee": { "type": "string" }, "RegularPayment": { "type": "string" }, "TotalRegularPayment": { "type": "string" }, "VatExclusiveRegularPayment": { "type": "string" }, "VatExclusiveTotalRegularPayment": { "type": "string" }, "ResidualValue": { "type": "string" }, "Term": { "type": "string" }, "TotalAmountPayable": { "type": "string" }, "RateOfInterest": { "type": "string" }, "IsRepresentativeQuote": { "type": "boolean" }, "Commission": { "type": "string" }, "Dic": { "type": "string" }, "BaseRate": { "type": "string" }, "Fees": { "type": "array", "items": { "$ref": "#/definitions/FcpLegacyQuoteFee" } }, "NumberOfAdvancedRentals": { "type": "string" }, "CalculatingDealerId": { "format": "int32", "type": "integer" }, "CostBreakdown": { "$ref": "#/definitions/FcpLegacyQuoteLookupCostBreakdown" }, "CommissionBreakdown": { "type": "array", "items": { "$ref": "#/definitions/Commission" } }, "Contributions": { "$ref": "#/definitions/FcpLegacyQuoteLookupContributions" }, "VatRate": { "type": "string" }, "TotalDeposit": { "type": "string" } } }, "FcpLegacyQuoteLookupRequestParameters": { "type": "object", "properties": { "Deposit": { "type": "string" }, "DepositType": { "type": "string" }, "AnnualMileage": { "type": "string" }, "Term": { "type": "string" } } }, "FcpLegacyQuoteLookupDetails": { "type": "object", "properties": { "BasePrice": { "$ref": "#/definitions/FcpLegacyQuoteLookupVatBreakdown" }, "Accessories": { "$ref": "#/definitions/FcpLegacyQuoteLookupVatBreakdown" }, "DealerDiscounts": { "type": "array", "items": { "$ref": "#/definitions/FcpLegacyQuoteLookupDealerDiscount" } }, "VehiclePrice": { "$ref": "#/definitions/FcpLegacyQuoteLookupVatBreakdown" }, "Options": { "$ref": "#/definitions/FcpLegacyQuoteLookupVatBreakdown" }, "Delivery": { "$ref": "#/definitions/FcpLegacyQuoteLookupVatBreakdown" }, "RoadFundLicence": { "type": "string" }, "RegistrationFee": { "type": "string" }, "Otr": { "$ref": "#/definitions/FcpLegacyQuoteLookupVatBreakdown" }, "Mrp": { "type": "string" }, "VolumeRelatedBonus": { "type": "string" }, "PaymentProfile": { "type": "string" }, "AdminFee": { "type": "string" } } }, "FcpLegacyQuoteLookupDealers": { "type": "object", "properties": { "OrganisationName": { "type": "string" }, "UserName": { "type": "string" } } }, "FcpLegacyQuoteLookupAdditionalQuote": { "type": "object", "properties": { "Apr": { "type": "string" }, "Balance": { "type": "string" }, "CashDeposit": { "type": "string" }, "ExcessMileageRate": { "type": "string" }, "RegularPayment": { "type": "string" }, "Term": { "type": "string" } } }, "FcpLegacyQuoteFee": { "type": "object", "properties": { "Amount": { "format": "double", "type": "number" }, "TotalAmount": { "format": "double", "type": "number" }, "Profile": { "type": "string" }, "Type": { "type": "string" }, "ExternalIdentifier": { "type": "string" }, "Source": { "enum": [ "Product", "RequestOverride", "ValueAddedProduct", "Offer" ], "type": "string" } } }, "FcpLegacyQuoteLookupCostBreakdown": { "type": "object", "properties": { "RoadFundLicence": { "format": "double", "type": "number" }, "Accessories": { "format": "double", "type": "number" }, "RegistrationFee": { "format": "double", "type": "number" }, "BasePrice": { "format": "double", "type": "number" }, "Delivery": { "format": "double", "type": "number" } } }, "Commission": { "type": "object", "properties": { "Type": { "type": "string" }, "Amount": { "format": "double", "type": "number" } } }, "FcpLegacyQuoteLookupContributions": { "type": "object", "properties": { "DepositContributions": { "type": "array", "items": { "$ref": "#/definitions/FcpLegacyQuoteDepositContribution" } }, "DealerMargin": { "format": "double", "type": "number" }, "ManufacturerBonus": { "format": "double", "type": "number" } } }, "FcpLegacyQuoteLookupVatBreakdown": { "type": "object", "properties": { "Inclusive": { "type": "string" }, "Exclusive": { "type": "string" }, "Vat": { "type": "string" } } }, "FcpLegacyQuoteLookupDealerDiscount": { "type": "object", "properties": { "Inclusive": { "type": "string" }, "Exclusive": { "type": "string" }, "Vat": { "type": "string" }, "Description": { "type": "string" } } }, "FcpLegacyQuoteDepositContribution": { "type": "object", "properties": { "Amount": { "format": "double", "type": "number" }, "Type": { "type": "string" }, "Description": { "type": "string" }, "ExternalIdentifier": { "type": "string" } } }, "FcpLegacyGetEntityRestrictionsResponse": { "type": "object", "properties": { "ProductId": { "format": "int32", "type": "integer" }, "ProductName": { "type": "string" }, "Entities": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/definitions/FcpLegacyEntityRestriction" } } } } }, "FcpLegacyEntityRestriction": { "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "DisplayText": { "type": "string" }, "Description": { "type": "string" }, "Selected": { "type": "boolean" }, "FullName": { "type": "string" } } }, "FcpLegacyUpdateEnabledEntitiesRequest": { "type": "object", "properties": { "ProductId": { "format": "int32", "type": "integer" }, "EntityIds": { "type": "array", "items": { "format": "int32", "type": "integer" } } } }, "FcpLegacyUpdateEnabledEntitiesResponse": { "type": "object", "properties": { "Message": { "type": "string" } } }, "FcpLegacyGetProcessingRulesResponse": { "type": "object", "properties": { "ProductId": { "format": "int32", "type": "integer" }, "ProductName": { "type": "string" }, "TermId": { "type": "string" }, "CurrentRules": { "type": "array", "items": { "$ref": "#/definitions/FcpLegacyCurrentRule" } }, "AvailableRules": { "type": "array", "items": { "$ref": "#/definitions/FcpLegacyAvailableRule" } } } }, "FcpLegacyCurrentRule": { "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "ValidationType": { "type": "string" }, "ValidationTypeId": { "format": "int32", "type": "integer" }, "Value": { "type": "string" } } }, "FcpLegacyAvailableRule": { "type": "object", "properties": { "Id": { "type": "string" }, "Type": { "type": "string" }, "Name": { "type": "string" }, "RuleProperties": { "$ref": "#/definitions/FcpLegacyRuleProperties" } } }, "FcpLegacyRuleProperties": { "type": "object", "properties": { "Description": { "type": "string" }, "ValidationRule": { "type": "string" }, "ValidationMessage": { "type": "string" }, "IsCondition": { "type": "boolean" }, "AllowMultiple": { "type": "boolean" }, "IsAvailableForTerms": { "type": "boolean" }, "IsAvailableForProduct": { "type": "boolean" }, "IsAvailableForChannel": { "type": "boolean" } } }, "FcpLegacyAddProcessingRuleRequest": { "required": [ "ProductId", "RuleTypeId", "ValidationType" ], "type": "object", "properties": { "ProductId": { "format": "int32", "type": "integer" }, "RuleTypeId": { "format": "int32", "type": "integer" }, "Value": { "type": "string" }, "ValidationType": { "type": "string" } } }, "FcpLegacyAddProcessingRuleResponse": { "type": "object", "properties": { "Message": { "type": "string" } } }, "FcpLegacyRemoveProcessingRuleRequest": { "required": [ "ProductId", "RuleId" ], "type": "object", "properties": { "ProductId": { "format": "int32", "type": "integer" }, "RuleId": { "format": "int32", "type": "integer" } } }, "FcpLegacyRemoveProcessingRuleResponse": { "type": "object", "properties": { "CurrentRules": { "type": "array", "items": { "$ref": "#/definitions/FcpLegacyCurrentRule" } } } }, "FcpLegacyGetRulePropertiesResponse": { "type": "object", "properties": { "RuleId": { "format": "int32", "type": "integer" }, "RuleName": { "type": "string" }, "Description": { "type": "string" }, "RuleType": { "type": "string" } } }, "FcpLegacyManualResidualsGetProvidersResponse": { "type": "object", "properties": { "Providers": { "type": "array", "items": { "$ref": "#/definitions/FcpLegacyManualResidualProvider" } } } }, "FcpLegacyManualResidualProvider": { "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "Name": { "type": "string" } } }, "FcpLegacyManualResidualsCreateProviderRequest": { "required": [ "DataProviderName" ], "type": "object", "properties": { "DataProviderName": { "type": "string" } } }, "FcpLegacyManualResidualsSaveResponse": { "type": "object", "properties": { "ManualResidualId": { "format": "int32", "type": "integer" } } }, "FcpLegacyManualResidualsGetProviderResponse": { "type": "object", "properties": { "ResidualPoints": { "type": "array", "items": { "$ref": "#/definitions/FcpLegacyResidualPointsModel" } } } }, "FcpLegacyResidualPointsModel": { "type": "object", "properties": { "VehicleIdentifier": { "type": "string" }, "VehicleIsNew": { "type": "boolean" }, "ResidualPoints": { "type": "array", "items": { "$ref": "#/definitions/FcpLegacyResidualPoint" } } } }, "FcpLegacyResidualPoint": { "type": "object", "properties": { "Term": { "format": "int32", "type": "integer" }, "Mileage": { "format": "int32", "type": "integer" }, "Residual": { "format": "double", "type": "number" }, "Year": { "format": "int32", "type": "integer" }, "Month": { "format": "int32", "type": "integer" } } }, "FcpLegacyManualResidualsUpdateProviderRequest": { "required": [ "DataProviderId", "DataProviderName" ], "type": "object", "properties": { "DataProviderId": { "format": "int32", "type": "integer" }, "DataProviderName": { "type": "string" }, "ResidualsForIdentifier": { "type": "array", "items": { "$ref": "#/definitions/FcpLegacyResidualForIdentifierRequest" } } } }, "FcpLegacyResidualForIdentifierRequest": { "type": "object", "properties": { "VehicleIdentifier": { "type": "string" }, "VehicleIsNew": { "type": "boolean" }, "ResidualPoints": { "type": "array", "items": { "$ref": "#/definitions/FcpLegacyResidualPointRequest" } } } }, "FcpLegacyResidualPointRequest": { "type": "object", "properties": { "Term": { "format": "int32", "type": "integer" }, "Mileage": { "format": "int32", "type": "integer" }, "Residual": { "format": "double", "type": "number" }, "Year": { "format": "int32", "type": "integer" }, "Month": { "format": "int32", "type": "integer" } } }, "FcpLegacyInvoicingReportRequest": { "required": [ "ReportType", "From" ], "type": "object", "properties": { "ReportType": { "type": "string" }, "From": { "format": "date-time", "type": "string" }, "To": { "format": "date-time", "type": "string" } } }, "FcpLegacyInvoicingReportResponse": { "type": "object", "properties": { "Group": { "type": "string" }, "Report": { "type": "string" }, "From": { "format": "date-time", "type": "string" }, "To": { "format": "date-time", "type": "string" }, "TotalCalcs": { "format": "int64", "type": "integer" }, "UniqueVehiclesOnGroup": { "format": "int64", "type": "integer" }, "DealerCount": { "format": "int32", "type": "integer" }, "CsvRaw": { "type": "string" }, "DealerReportData": { "type": "array", "items": { "$ref": "#/definitions/FcpLegacyInvoicingReportDataItem" } } } }, "FcpLegacyInvoicingReportDataItem": { "type": "object", "properties": { "DealerName": { "type": "string" }, "AssociatedKey": { "type": "string" }, "Id": { "type": "string" }, "Calculations": { "format": "int64", "type": "integer" }, "VehiclesUsingGroup": { "format": "int64", "type": "integer" }, "Month": { "format": "int32", "type": "integer" }, "Year": { "format": "int32", "type": "integer" }, "IsActive": { "type": "boolean" }, "Vrm": { "type": "string" } } }, "FcpLegacyInvoicingExportRequest": { "required": [ "CsvRaw", "From", "To" ], "type": "object", "properties": { "CsvRaw": { "type": "string" }, "From": { "format": "date-time", "type": "string" }, "To": { "format": "date-time", "type": "string" } } }, "FcpLegacyAvailableFilesResponse": { "type": "object", "properties": { "Files": { "type": "array", "items": { "$ref": "#/definitions/ImportFile" } } } }, "ImportFile": { "type": "object", "properties": { "FileKey": { "type": "string" }, "Versions": { "type": "array", "items": { "$ref": "#/definitions/ImportFileVersion" } } } }, "ImportFileVersion": { "type": "object", "properties": { "Id": { "type": "string" }, "Date": { "format": "date-time", "type": "string" }, "User": { "$ref": "#/definitions/User" }, "PublicationDate": { "format": "date-time", "type": "string" }, "FileName": { "type": "string" } } }, "User": { "type": "object", "properties": { "Name": { "type": "string" }, "Email": { "type": "string" }, "Id": { "type": "string" }, "Reference": { "type": "string" } } }, "FcpLegacyToggleAllRuleGroupsResponse": { "type": "object", "properties": { "Message": { "type": "string" } } }, "FcpLegacyFeeDefaultsResponse": { "type": "object", "properties": { "Id": { "type": "string" }, "FeeProfileId": { "format": "int32", "type": "integer" }, "FeeProfileName": { "type": "string" }, "FeeTypeId": { "format": "int32", "type": "integer" }, "FeeTypeName": { "type": "string" } } }, "FcpLegacyProcessingRuleTypesResponse": { "type": "object", "properties": { "PersistentKey": { "format": "int32", "type": "integer" }, "AllRules": { "type": "array", "items": { "$ref": "#/definitions/FcpLegacyProcessingRuleTypeItem" } } } }, "FcpLegacyProcessingRuleTypeItem": { "type": "object", "properties": { "Id": { "type": "string" }, "Name": { "type": "string" }, "Type": { "type": "string" }, "RuleProperties": { "$ref": "#/definitions/FcpLegacyProcessingRuleTypeProperties" } } }, "FcpLegacyProcessingRuleTypeProperties": { "type": "object", "properties": { "Description": { "type": "string" }, "ValidationRule": { "type": "string" }, "ValidationMessage": { "type": "string" }, "IsCondition": { "type": "boolean" }, "AllowMultiple": { "type": "boolean" }, "IsAvailableForTerms": { "type": "boolean" }, "IsAvailableForProduct": { "type": "boolean" }, "IsAvailableForChannel": { "type": "boolean" } } }, "FcpLegacyFinanceTermsNewGetResponse": { "type": "object", "properties": { "TermId": { "format": "int32", "type": "integer" }, "CampaignId": { "format": "int32", "type": "integer" }, "SystemKey": { "type": "string" }, "Dealers": { "type": "array", "items": { "$ref": "#/definitions/FcpLegacyFinanceTermsNewDealer" } } } }, "FcpLegacyFinanceTermsNewDealer": { "type": "object", "properties": { "Name": { "type": "string" }, "ApiKey": { "type": "string" } } }, "FcpLegacyFinanceProductSearchResponse": { "type": "object", "properties": { "Results": { "type": "array", "items": { "$ref": "#/definitions/FcpLegacyFinanceProductSearchResult" } } } }, "FcpLegacyFinanceProductSearchResult": { "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "Description": { "type": "string" }, "DisplayName": { "type": "string" }, "LenderName": { "type": "string" }, "Active": { "type": "boolean" } } }, "FcpLegacyFinanceProductSaveRequest": { "required": [ "Description", "DisplayName" ], "type": "object", "properties": { "Description": { "type": "string" }, "DisplayName": { "type": "string" }, "Lender": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "ProductFamilyId": { "format": "int32", "type": "integer" }, "RateOfInterest": { "enum": [ "CustomerRate", "Yield", "Aer", "AnnualRate", "FlatRate" ], "type": "string" }, "RateType": { "enum": [ "Unknown", "FlatRate", "Yield", "Apr" ], "type": "string" }, "CommissionFormulaId": { "format": "int32", "type": "integer" }, "CommissionPackageId": { "format": "int32", "type": "integer" }, "ResidualConfigurationId": { "format": "int32", "type": "integer" }, "CombineTermCapping": { "type": "boolean" }, "Active": { "type": "boolean" }, "VehicleDataSetId": { "enum": [ "UNKNOWN", "CAP", "GLASSES", "IDS", "IVS", "PSA", "TFS", "CAPLCV", "CODEWEAVERS", "AUTOBIZ", "BREGO", "LastElement" ], "type": "string" }, "WebServiceTypeKey": { "type": "string" }, "TermsAndConditionsTemplateId": { "type": "string" }, "FinanceApplicationIntegrationReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } }, "FcpLegacyFinanceProductSaveResponse": { "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" } } }, "FcpLegacyFinanceProductGetResponse": { "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "Description": { "type": "string" }, "DisplayName": { "type": "string" }, "LenderName": { "type": "string" }, "LenderReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "ProductFamilyId": { "format": "int32", "type": "integer" }, "WebServiceTypeKey": { "type": "string" }, "RateOfInterest": { "enum": [ "CustomerRate", "Yield", "Aer", "AnnualRate", "FlatRate" ], "type": "string" }, "RateType": { "enum": [ "Unknown", "FlatRate", "Yield", "Apr" ], "type": "string" }, "ResidualConfigurationId": { "format": "int32", "type": "integer" }, "CommissionFormulaId": { "format": "int32", "type": "integer" }, "CommissionPackageId": { "format": "int32", "type": "integer" }, "CombineTermCapping": { "type": "boolean" }, "Active": { "type": "boolean" }, "VehicleDataSetId": { "enum": [ "UNKNOWN", "CAP", "GLASSES", "IDS", "IVS", "PSA", "TFS", "CAPLCV", "CODEWEAVERS", "AUTOBIZ", "BREGO", "LastElement" ], "type": "string" }, "TermsAndConditionsTemplateId": { "type": "string" }, "FinanceApplicationIntegrationReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "SystemKey": { "type": "string" }, "IsCodeweaversStaff": { "type": "boolean" }, "AttachedDealerCount": { "format": "int32", "type": "integer" }, "ProductRules": { "type": "array", "items": { "$ref": "#/definitions/FcpLegacyProductRule" } } } }, "FcpLegacyProductRule": { "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "Name": { "type": "string" } } }, "FcpLegacyFinanceProductOptionsResponse": { "type": "object", "properties": { "ResidualConfigurations": { "type": "array", "items": { "$ref": "#/definitions/FcpLegacySelectItem" } }, "ProductFamilies": { "type": "array", "items": { "$ref": "#/definitions/FcpLegacySelectItem" } }, "Lenders": { "type": "array", "items": { "$ref": "#/definitions/FcpLegacySelectItem" } }, "RateTypes": { "type": "array", "items": { "$ref": "#/definitions/FcpLegacySelectItem" } }, "RateOfInterestTypes": { "type": "array", "items": { "$ref": "#/definitions/FcpLegacySelectItem" } }, "CommissionCalculatorTypes": { "type": "array", "items": { "$ref": "#/definitions/FcpLegacySelectItem" } }, "FinanceApplicationIntegrations": { "type": "array", "items": { "$ref": "#/definitions/FcpLegacySelectItem" } }, "ProductRuleTypes": { "type": "array", "items": { "$ref": "#/definitions/FcpLegacySelectItem" } }, "VehicleDataSets": { "type": "array", "items": { "$ref": "#/definitions/FcpLegacySelectItem" } }, "CommissionPackages": { "type": "array", "items": { "$ref": "#/definitions/FcpLegacySelectItem" } } } }, "FcpLegacySelectItem": { "type": "object", "properties": { "Value": { "type": "string" }, "Text": { "type": "string" } } }, "FcpLegacyFinanceProductCopyRequest": { "required": [ "Description" ], "type": "object", "properties": { "Description": { "type": "string" }, "Lender": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "FinanceApplicationIntegrationReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } }, "FcpLegacyFinanceProductTermsTemplateResponse": { "type": "object", "properties": { "ProductId": { "format": "int32", "type": "integer" }, "MinimumBalance": { "format": "double", "type": "number" }, "MaximumBalance": { "format": "double", "type": "number" }, "MinimumTerm": { "format": "int32", "type": "integer" }, "MaximumTerm": { "format": "int32", "type": "integer" }, "MinimumVehicleAge": { "format": "int32", "type": "integer" }, "MaximumVehicleAge": { "format": "int32", "type": "integer" }, "QuoteValid": { "format": "int32", "type": "integer" }, "FiguresValid": { "format": "int32", "type": "integer" }, "ExternalIdentifier": { "type": "string" }, "Fees": { "type": "array", "items": { "$ref": "#/definitions/FcpLegacyFee" } }, "FeeProfiles": { "type": "array", "items": { "$ref": "#/definitions/FcpLegacyFeeProfile" } }, "FeeTypes": { "type": "array", "items": { "$ref": "#/definitions/FcpLegacySelectItem" } } } }, "FcpLegacyFee": { "type": "object", "properties": { "FeeId": { "format": "int32", "type": "integer" }, "Value": { "format": "double", "type": "number" }, "TypeId": { "enum": [ "Invalid", "Admin", "Option", "Margin", "Overhead", "BrokerVRB", "EarlyTerminationWaiver" ], "type": "string" }, "ProfileId": { "format": "int32", "type": "integer" } } }, "FcpLegacyFeeProfile": { "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "Name": { "type": "string" } } }, "FcpLegacyFinanceProductUpdateTermsTemplateRequest": { "type": "object", "properties": { "MinimumBalance": { "format": "double", "type": "number" }, "MaximumBalance": { "format": "double", "type": "number" }, "MinimumTerm": { "format": "int32", "type": "integer" }, "MaximumTerm": { "format": "int32", "type": "integer" }, "MinimumVehicleAge": { "format": "int32", "type": "integer" }, "MaximumVehicleAge": { "format": "int32", "type": "integer" }, "QuoteValid": { "format": "int32", "type": "integer" }, "FiguresValid": { "format": "int32", "type": "integer" }, "ExternalIdentifier": { "type": "string" }, "Fees": { "type": "array", "items": { "$ref": "#/definitions/FcpLegacyUpdateFee" } } } }, "FcpLegacyUpdateFee": { "type": "object", "properties": { "FeeId": { "format": "int32", "type": "integer" }, "Value": { "format": "double", "type": "number" }, "TypeId": { "enum": [ "Invalid", "Admin", "Option", "Margin", "Overhead", "BrokerVRB", "EarlyTerminationWaiver" ], "type": "string" }, "ProfileId": { "format": "int32", "type": "integer" } } }, "FcpLegacyFinanceProductAddRuleRequest": { "type": "object", "properties": { "RuleTypeId": { "format": "int32", "type": "integer" } } }, "FcpLegacyFinanceProductRulesResponse": { "type": "object", "properties": { "Rules": { "type": "array", "items": { "$ref": "#/definitions/FcpLegacyProductRule" } } } }, "FcpLegacyFinanceProductCampaignsResponse": { "type": "object", "properties": { "ProductId": { "format": "int32", "type": "integer" }, "LenderProductName": { "type": "string" }, "Campaigns": { "type": "array", "items": { "$ref": "#/definitions/FcpLegacyFinanceProductCampaign" } } } }, "FcpLegacyFinanceProductCampaign": { "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "Name": { "type": "string" }, "Active": { "type": "boolean" }, "SetupDate": { "format": "date-time", "type": "string" } } }, "FcpLegacyFinanceProductDealersResponse": { "type": "object", "properties": { "ProductId": { "format": "int32", "type": "integer" }, "ProductDescription": { "type": "string" }, "Dealers": { "type": "array", "items": { "$ref": "#/definitions/FcpLegacyFinanceProductDealer" } } } }, "FcpLegacyFinanceProductDealer": { "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "Name": { "type": "string" }, "Active": { "type": "boolean" } } }, "FcpLegacyFileUploadResponse": { "type": "object", "properties": { "Message": { "type": "string" }, "Successful": { "type": "boolean" }, "Files": { "type": "array", "items": { "$ref": "#/definitions/FcpLegacyFileValidationResult" } } } }, "FcpLegacyFileValidationResult": { "type": "object", "properties": { "Key": { "type": "string" }, "NumberOfLinesParsed": { "format": "int32", "type": "integer" }, "Errors": { "type": "array", "items": { "$ref": "#/definitions/FcpLegacyValidationError" } } } }, "FcpLegacyValidationError": { "type": "object", "properties": { "LineNumber": { "format": "int32", "type": "integer" }, "ColumnNumber": { "format": "int32", "type": "integer" }, "ColumnName": { "type": "string" }, "ActualValue": { "type": "string" }, "ErrorMessage": { "type": "string" }, "ExampleValue": { "type": "string" } } }, "FcpLegacyStoredFilesResponse": { "type": "object", "properties": { "Files": { "type": "array", "items": { "$ref": "#/definitions/FcpLegacyStoredFileInformation" } } } }, "FcpLegacyStoredFileInformation": { "type": "object", "properties": { "Version": { "format": "int32", "type": "integer" }, "PublicationDate": { "format": "date-time", "type": "string" }, "IsCurrentlyActiveFile": { "type": "boolean" }, "UploadDate": { "format": "date-time", "type": "string" }, "UploaderUserId": { "type": "string" } } }, "FcpLegacySetActiveVersionRequest": { "required": [ "NewActiveVersion", "ResidualDataset" ], "type": "object", "properties": { "NewActiveVersion": { "format": "int32", "type": "integer" }, "ResidualDataset": { "type": "string" } } }, "FcpLegacyFileDeleteResponse": { "type": "object", "properties": { "Message": { "type": "string" }, "Successful": { "type": "boolean" } } }, "FcpLegacyDeleteStoredFilesRequest": { "required": [ "Versions", "ResidualDataset" ], "type": "object", "properties": { "Versions": { "type": "array", "items": { "format": "int32", "type": "integer" } }, "ResidualDataset": { "type": "string" } } }, "FcpLegacyDealerSearchRequest": { "type": "object", "properties": { "Query": { "type": "string" }, "Branch": { "type": "string" }, "Page": { "format": "int32", "type": "integer" } } }, "FcpLegacyDealerSearchResponse": { "type": "object", "properties": { "SearchQuery": { "type": "string" }, "SearchResults": { "$ref": "#/definitions/FcpLegacyDealerSearchResults" }, "Branches": { "type": "array", "items": { "$ref": "#/definitions/FcpLegacyDealerBranch" } }, "HasSearchError": { "type": "boolean" }, "ErrorMessage": { "type": "string" } } }, "FcpLegacyDealerSearchResults": { "type": "object", "properties": { "Dealers": { "type": "array", "items": { "$ref": "#/definitions/FcpLegacyDealerSearchItem" } }, "Pagination": { "$ref": "#/definitions/FcpLegacyDealerSearchPagination" } } }, "FcpLegacyDealerBranch": { "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "Name": { "type": "string" } } }, "FcpLegacyDealerSearchItem": { "type": "object", "properties": { "Id": { "type": "string" }, "Name": { "type": "string" }, "Introducer": { "type": "string" }, "IsActive": { "type": "boolean" }, "HasWebserviceMappings": { "type": "boolean" }, "HasOutboundWebServices": { "type": "boolean" }, "DealerReference": { "type": "string" }, "ParentOrganisationName": { "type": "string" } } }, "FcpLegacyDealerSearchPagination": { "type": "object", "properties": { "PageNumber": { "format": "int32", "type": "integer" }, "PageSize": { "format": "int32", "type": "integer" }, "TotalResults": { "format": "int32", "type": "integer" } } }, "FcpLegacyUpdatePrecedenceRequest": { "type": "object", "properties": { "Items": { "type": "array", "items": { "$ref": "#/definitions/FinanceTermsPrecedence" } } } }, "FinanceTermsPrecedence": { "type": "object", "properties": { "TermsId": { "format": "int32", "type": "integer" }, "Precedence": { "format": "int32", "type": "integer" } } }, "FcpLegacyUpdatePrecedenceResponse": { "type": "object", "properties": { "Message": { "type": "string" } } }, "FcpLegacyDealerContactSearchRequest": { "type": "object", "properties": { "SearchKey": { "type": "string" }, "SearchWebservice": { "type": "boolean" } } }, "FcpLegacyDealerContactSearchResponse": { "type": "object", "properties": { "Results": { "type": "array", "items": { "$ref": "#/definitions/FcpLegacyDealerContactSearchResult" } }, "HasError": { "type": "boolean" }, "Error": { "$ref": "#/definitions/ErrorResponse" }, "Message": { "type": "string" } } }, "FcpLegacyDealerContactSearchResult": { "type": "object", "properties": { "UserReference": { "type": "string" }, "Username": { "type": "string" }, "Active": { "type": "boolean" }, "PrimaryDealer": { "$ref": "#/definitions/FcpLegacyDealerContactPrimaryDealer" }, "LastLogin": { "format": "date-time", "type": "string" }, "LoginCount": { "format": "int64", "type": "integer" }, "Role": { "type": "string" }, "VerifiedEmail": { "type": "boolean" } } }, "FcpLegacyDealerContactPrimaryDealer": { "type": "object", "properties": { "Name": { "type": "string" }, "Id": { "format": "int32", "type": "integer" } } }, "FcpLegacyCopyFinanceIndexResponse": { "type": "object", "properties": { "Username": { "type": "string" }, "System": { "type": "string" }, "Systems": { "type": "array", "items": { "type": "string" } }, "Environment": { "$ref": "#/definitions/FcpLegacyCopyFinanceEnvironment" }, "AvailableEnvironments": { "type": "array", "items": { "$ref": "#/definitions/FcpLegacyCopyFinanceEnvironment" } } } }, "FcpLegacyCopyFinanceEnvironment": { "type": "object", "properties": { "Name": { "type": "string" }, "Url": { "type": "string" } } }, "FcpLegacyContentSearchResponse": { "type": "object", "properties": { "TemplateResults": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "format": "int32", "type": "integer" } } }, "ResultTemplates": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } }, "FcpLegacyCampaignSearchResponse": { "type": "object", "properties": { "SystemKey": { "type": "string" }, "Results": { "type": "array", "items": { "$ref": "#/definitions/FcpLegacyCampaignSearchResult" } } } }, "FcpLegacyCampaignSearchResult": { "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "Name": { "type": "string" }, "SetupDate": { "format": "date-time", "type": "string" }, "Active": { "type": "boolean" } } }, "FcpLegacyCampaignCreateRequest": { "required": [ "Name" ], "type": "object", "properties": { "Name": { "type": "string" }, "Active": { "type": "boolean" } } }, "FcpLegacyCampaignSaveResponse": { "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "Name": { "type": "string" }, "SetupDate": { "format": "date-time", "type": "string" }, "Active": { "type": "boolean" } } }, "FcpLegacyCampaignGetResponse": { "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "Name": { "type": "string" }, "SetupDate": { "format": "date-time", "type": "string" }, "Active": { "type": "boolean" }, "SystemKey": { "type": "string" }, "Import": { "$ref": "#/definitions/FcpLegacyCampaignImport" }, "Groups": { "type": "array", "items": { "$ref": "#/definitions/FcpLegacyTermGroup" } }, "LinkedDealers": { "type": "array", "items": { "$ref": "#/definitions/FcpLegacyCampaignDealer" } } } }, "FcpLegacyCampaignImport": { "type": "object", "properties": { "Id": { "format": "int64", "type": "integer" }, "Key": { "type": "string" } } }, "FcpLegacyTermGroup": { "type": "object", "properties": { "CampaignId": { "format": "int32", "type": "integer" }, "GroupId": { "format": "int32", "type": "integer" }, "GroupName": { "type": "string" }, "GroupPrecedence": { "format": "int32", "type": "integer" }, "MappingCount": { "format": "int32", "type": "integer" }, "Products": { "type": "array", "items": { "$ref": "#/definitions/FcpLegacyCampaignTerm" } } } }, "FcpLegacyCampaignDealer": { "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "Name": { "type": "string" }, "ApiKey": { "type": "string" }, "Active": { "type": "boolean" } } }, "FcpLegacyCampaignTerm": { "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "CampaignId": { "format": "int32", "type": "integer" }, "GroupId": { "format": "int32", "type": "integer" }, "ProductId": { "format": "int32", "type": "integer" }, "CampaignName": { "type": "string" }, "ProductName": { "type": "string" }, "LenderName": { "type": "string" }, "InternalDescription": { "type": "string" }, "Active": { "type": "boolean" }, "AllRuleGroupsDisabled": { "type": "boolean" }, "Precedence": { "format": "int32", "type": "integer" }, "ValidFrom": { "format": "date-time", "type": "string" }, "ValidTo": { "format": "date-time", "type": "string" }, "ValidRuleGroupsForCurrentDate": { "type": "boolean" } } }, "FcpLegacyCampaignUpdateRequest": { "required": [ "Name" ], "type": "object", "properties": { "Name": { "type": "string" }, "Active": { "type": "boolean" }, "SetupDate": { "format": "date-time", "type": "string" } } }, "FcpLegacyCampaignDealersResponse": { "type": "object", "properties": { "CampaignId": { "format": "int32", "type": "integer" }, "CampaignName": { "type": "string" }, "Dealers": { "type": "array", "items": { "$ref": "#/definitions/FcpLegacyCampaignDealer" } } } }, "FcpLegacyCampaignCalculateResponse": { "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "Name": { "type": "string" }, "SetupDate": { "format": "date-time", "type": "string" }, "Active": { "type": "boolean" }, "SystemKey": { "type": "string" }, "Groups": { "type": "array", "items": { "$ref": "#/definitions/FcpLegacyTermGroup" } }, "LinkedDealers": { "type": "array", "items": { "$ref": "#/definitions/FcpLegacyCampaignDealer" } } } }, "FcpLegacyCampaignMappingsResponse": { "type": "object", "properties": { "ChannelMappings": { "type": "array", "items": { "$ref": "#/definitions/FcpLegacyCampaignChannelMapping" } } } }, "FcpLegacyCampaignChannelMapping": { "type": "object", "properties": { "DealerId": { "format": "int32", "type": "integer" }, "DealerName": { "type": "string" }, "ChannelKey": { "type": "string" }, "MappingId": { "format": "int32", "type": "integer" }, "Key": { "type": "string" }, "SelloutRate": { "type": "string" }, "ValidDateTime": { "type": "string" } } }, "FcpLegacyCampaignAddTermsToGroupRequest": { "required": [ "TermIds" ], "type": "object", "properties": { "TermIds": { "type": "array", "items": { "format": "int32", "type": "integer" } } } }, "FcpLegacyCampaignBoolResponse": { "type": "object", "properties": { "Success": { "type": "boolean" } } }, "FcpLegacyCampaignCreateGroupRequest": { "required": [ "GroupName" ], "type": "object", "properties": { "GroupName": { "type": "string" }, "TermIds": { "type": "array", "items": { "format": "int32", "type": "integer" } } } }, "FcpLegacyCampaignCreateGroupResponse": { "type": "object", "properties": { "GroupId": { "format": "int32", "type": "integer" }, "GroupName": { "type": "string" }, "CampaignId": { "format": "int32", "type": "integer" } } }, "FcpLegacyCampaignMoveGroupRequest": { "required": [ "CampaignId", "MoveUp" ], "type": "object", "properties": { "CampaignId": { "format": "int32", "type": "integer" }, "MoveUp": { "type": "boolean" } } }, "FcpLegacyCampaignUpdateGroupNameRequest": { "required": [ "Name" ], "type": "object", "properties": { "Name": { "type": "string" } } }, "FcpLegacyCampaignDeleteGroupsRequest": { "required": [ "GroupIds" ], "type": "object", "properties": { "GroupIds": { "type": "array", "items": { "format": "int32", "type": "integer" } } } }, "FcpLegacyCampaignAvailableGroupsResponse": { "type": "object", "properties": { "Groups": { "type": "array", "items": { "$ref": "#/definitions/FcpLegacyCampaignAvailableGroup" } } } }, "FcpLegacyCampaignAvailableGroup": { "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "Name": { "type": "string" } } }, "FcpLegacyCampaignSaveTermRequest": { "required": [ "ProductId", "TermName" ], "type": "object", "properties": { "ProductId": { "format": "int32", "type": "integer" }, "TermName": { "type": "string" } } }, "FcpLegacyCampaignSaveTermResponse": { "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "CampaignId": { "format": "int32", "type": "integer" }, "ProductId": { "format": "int32", "type": "integer" }, "CampaignName": { "type": "string" }, "ProductName": { "type": "string" }, "LenderName": { "type": "string" }, "Active": { "type": "boolean" }, "Precedence": { "format": "int32", "type": "integer" } } }, "FcpLegacyValidateProductLenderResponse": { "type": "object", "properties": { "IsInvalid": { "type": "boolean" }, "Message": { "type": "string" } } }, "FcpLegacyProductAutoCompleteResponse": { "type": "object", "properties": { "Results": { "type": "array", "items": { "$ref": "#/definitions/FcpLegacyAutoCompleteResult" } } } }, "FcpLegacyAutoCompleteResult": { "type": "object", "properties": { "Id": { "type": "string" }, "Label": { "type": "string" }, "Value": { "type": "string" }, "Description": { "type": "string" } } }, "FcpLegacyBrandingGetResponse": { "type": "object", "properties": { "Brandings": { "type": "array", "items": { "$ref": "#/definitions/FcpLegacyBrandingListItem" } }, "VideoStyles": { "type": "array", "items": { "$ref": "#/definitions/FcpLegacyBrandingListItem" } }, "TemplateStyles": { "type": "array", "items": { "$ref": "#/definitions/FcpLegacyBrandingListItem" } }, "LessBrandSystem": { "type": "string" } } }, "FcpLegacyBrandingListItem": { "type": "object", "properties": { "Text": { "type": "string" }, "Value": { "type": "string" } } }, "FcpLegacyBrandingCreateOrUpdateRequest": { "required": [ "DisplayName" ], "type": "object", "properties": { "BrandingName": { "type": "string" }, "DisplayName": { "type": "string" }, "VideoStyle": { "type": "string" }, "TemplateStyle": { "type": "string" }, "StyleProperties": { "type": "object", "additionalProperties": { "type": "string" } }, "Images": { "type": "array", "items": { "enum": [ "Logo", "BackgroundImage", "Favicon", "PartExchangeBackgroundImage" ], "type": "string" } } } }, "FcpLegacyBrandingMessageResponse": { "type": "object", "properties": { "BrandingId": { "type": "string" }, "Message": { "type": "string" } } }, "FcpLegacyGetBrandingResponse": { "type": "object", "properties": { "Name": { "type": "string" }, "Logo": { "type": "string" }, "Images": { "type": "array", "items": { "$ref": "#/definitions/FcpLegacyBrandingImage" } }, "StyleProperties": { "type": "array", "items": { "$ref": "#/definitions/KeyValuePair[String,String]" } }, "SelectedVideoStyle": { "type": "string" }, "SelectedTemplateStyle": { "type": "string" }, "PreviewLinks": { "type": "array", "items": { "$ref": "#/definitions/FcpLegacyBrandingPreviewLink" } } } }, "FcpLegacyBrandingImage": { "type": "object", "properties": { "Type": { "type": "string" }, "Url": { "type": "string" } } }, "FcpLegacyBrandingPreviewLink": { "type": "object", "properties": { "Label": { "type": "string" }, "Href": { "type": "string" } } }, "FcpLegacyUploadBrandingCssRequest": { "required": [ "Content" ], "type": "object", "properties": { "Content": { "type": "string" } } }, "FcpLegacyUploadBrandingImageRequest": { "required": [ "Type", "FileBytes" ], "type": "object", "properties": { "Type": { "enum": [ "Logo", "BackgroundImage", "Favicon", "PartExchangeBackgroundImage" ], "type": "string" }, "FileBytes": { "format": "byte", "type": "string" } } }, "FinanceTypesResponse": { "type": "object", "properties": { "Types": { "type": "array", "items": { "$ref": "#/definitions/FinanceTypeResponse" } } } }, "FinanceTypeResponse": { "type": "object", "properties": { "Id": { "type": "string" }, "Name": { "type": "string" }, "Abbreviation": { "type": "string" } } }, "CreateFinanceTermRequest": { "type": "object", "properties": { "Name": { "type": "string" }, "CampaignId": { "format": "int32", "type": "integer" }, "TermGroupId": { "format": "int32", "type": "integer" }, "ProductId": { "format": "int32", "type": "integer" } } }, "CreateFinanceTermResponse": { "type": "object", "properties": { "TermId": { "format": "int32", "type": "integer" } } }, "EditFinanceTermRequest": { "type": "object", "properties": { "ProductId": { "format": "int32", "type": "integer" }, "TermParameters": { "$ref": "#/definitions/TermParameters" } } }, "TermParameters": { "type": "object", "properties": { "Active": { "type": "boolean" }, "DefaultParameters": { "$ref": "#/definitions/DefaultParameters" }, "ValidTo": { "format": "date-time", "type": "string" }, "ValidFrom": { "format": "date-time", "type": "string" }, "ExternalIdentifier": { "type": "string" }, "Name": { "type": "string" }, "FiguresValid": { "format": "int32", "type": "integer" }, "QuoteValid": { "format": "int32", "type": "integer" }, "Precedence": { "format": "int32", "type": "integer" }, "InternalDescription": { "type": "string" }, "TermGroupId": { "format": "int32", "type": "integer" }, "TermsAndConditionsName": { "type": "string" } } }, "DefaultParameters": { "type": "object", "properties": { "Term": { "format": "int32", "type": "integer" }, "AnnualMileage": { "format": "int32", "type": "integer" }, "Deposit": { "format": "double", "type": "number" }, "DepositType": { "type": "string" } } }, "EditFinanceTermResponse": { "type": "object", "properties": { "NewTermId": { "format": "int32", "type": "integer" } } }, "TermGroupMetadataRequest": { "type": "object", "properties": { "TermGroups": { "type": "array", "items": { "$ref": "#/definitions/TermGroup" } } } }, "TermGroup": { "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "SystemId": { "format": "int32", "type": "integer" } } }, "TermGroupMetadataResponse": { "type": "object", "properties": { "TermGroupMetadataItems": { "type": "array", "items": { "$ref": "#/definitions/TermGroupMetadata" } } } }, "TermGroupMetadata": { "type": "object", "properties": { "TermGroupId": { "format": "int32", "type": "integer" }, "TermGroupName": { "type": "string" }, "CampaignId": { "format": "int32", "type": "integer" }, "CampaignName": { "type": "string" }, "CampaignIsActive": { "type": "boolean" }, "SystemId": { "format": "int32", "type": "integer" }, "HasActiveFinance": { "type": "boolean" }, "HasInDateFinance": { "type": "boolean" } } }, "CreateFinanceTermGroupRequest": { "type": "object", "properties": { "CampaignId": { "format": "int32", "type": "integer" }, "Name": { "type": "string" }, "Precedence": { "format": "int32", "type": "integer" } } }, "CreateFinanceTermGroupResponse": { "type": "object", "properties": { "TermGroupId": { "format": "int32", "type": "integer" } } }, "UpdateFinanceTermGroupRequest": { "type": "object", "properties": { "Name": { "type": "string" }, "Precedence": { "format": "int32", "type": "integer" }, "TermPrecedences": { "type": "array", "items": { "$ref": "#/definitions/TermPrecedence" } } } }, "TermPrecedence": { "type": "object", "properties": { "TermId": { "format": "int32", "type": "integer" }, "Precedence": { "format": "int32", "type": "integer" } } }, "UpdateFinanceTermGroupResponse": { "type": "object", "properties": {} }, "FinanceSearchRequest": { "required": [ "Customer", "Filters" ], "type": "object", "properties": { "Customer": { "$ref": "#/definitions/CustomerDetails" }, "Filters": { "$ref": "#/definitions/Filters" }, "Page": { "format": "int32", "maximum": 10000, "minimum": 1, "type": "integer" }, "ResultsPerPage": { "format": "int32", "maximum": 100000, "minimum": 1, "type": "integer" }, "SortBy": { "enum": [ "Unknown", "AsRequested", "RegularPaymentDescending", "RegularPaymentAscending", "Distance", "PriceDescending", "PriceAscending", "Relevance", "LastUpdatedDescending", "LastUpdatedAscending", "MileageDescending", "MileageAscending" ], "type": "string" }, "PartExchangeReference": { "description": "Uses the latest active offer for the part exchange and apply equity in finance calculations", "type": "string" }, "OrganisationIdentifier": { "$ref": "#/definitions/OrganisationIdentifier", "description": "This determines the dealer that the finance search request will be run as. This changes the authentication context to be for this dealer." } } }, "CustomerDetails": { "type": "object", "properties": { "Reference": { "type": "string" }, "Age": { "format": "int32", "type": "integer" }, "PostCode": { "type": "string" }, "Entity": { "type": "string" } } }, "Filters": { "required": [ "Finance" ], "type": "object", "properties": { "Vehicle": { "$ref": "#/definitions/VehicleFilter" }, "Finance": { "$ref": "#/definitions/FinanceFilter" } } }, "VehicleFilter": { "type": "object", "properties": { "Query": { "type": "string" }, "IncludeBuildToOrder": { "type": "boolean" }, "IncludeVehiclesInStock": { "type": "boolean" }, "IncludeNationalStock": { "type": "boolean" }, "IncludeGroupStock": { "type": "boolean" }, "IncludeReservedVehicles": { "type": "boolean" }, "VehicleType": { "enum": [ "Unknown", "Car", "Lcv", "Bike", "Other", "NonVehicleAsset" ], "type": "string" }, "BuildToOrderDataSet": { "enum": [ "Unknown", "Cap", "Glass", "Codeweavers", "Ids", "Ivs", "Psa", "CapLcv", "Glasses", "Tfs", "PsaComcar", "Autobiz", "Brego" ], "type": "string" }, "IncludeVehiclesWithStatuses": { "type": "array", "items": { "enum": [ "Unknown", "PreOwned", "Preregistered", "Demonstrator", "New", "BuildToOrder" ], "type": "string" } }, "IncludeVehiclesWithFundingStatuses": { "type": "array", "items": { "enum": [ "Unknown", "Paid", "Consigned", "UnConsigned" ], "type": "string" } }, "StockIdentifiersType": { "description": "This sets the type of identifiers that are used in the property StockIdentifiers", "enum": [ "Unknown", "CodeweaversStockIdentifier", "ExternalVehicleId", "Vrm", "Vin", "Titre" ], "type": "string" }, "StockIdentifiers": { "description": "Limits the vehicles searched to only the stock with the requested stock vehicle identifiers.", "type": "array", "items": { "type": "string" } }, "AllowedManufacturers": { "type": "array", "items": { "type": "string" } }, "SelectedFacets": { "$ref": "#/definitions/SelectedFacets", "description": "If using the vehicle search facets service then the options selected by the customer should be supplied within here." }, "VehicleGroupType": { "description": "When using the search by vehicle group service this enables you to customise how vehicles are grouped", "enum": [ "None", "Model", "SimilarVehicles", "SameVehiclesSamePrice", "SameAs", "Retailer", "Trim" ], "type": "string" }, "VehicleGroupId": { "type": "string" } } }, "FinanceFilter": { "type": "object", "properties": { "ReturnFailedQuotes": { "type": "boolean" }, "Keys": { "description": "Only calculate finance on the requested products using mapping keys set-up in Codeweavers system.", "type": "array", "items": { "type": "string" } }, "FamilyKeys": { "description": "Only calculate finance on the requested product families using family keys set-up in Codeweavers system.", "type": "array", "items": { "type": "string" } }, "Term": { "format": "int32", "maximum": 120, "minimum": 0, "type": "integer" }, "MinimumPayment": { "format": "double", "description": "Should be populated by the customer. Should not be defaulted by the integrating system.", "type": "number" }, "MaximumPayment": { "format": "double", "description": "Should be populated by the customer. Should not be defaulted by the integrating system.", "type": "number" }, "AnnualMileage": { "format": "int32", "maximum": 100000, "minimum": 1000, "type": "integer" }, "AnnualMileageUnit": { "enum": [ "Miles", "Kilometres", "Mil" ], "type": "string" }, "Deposit": { "format": "double", "type": "number" }, "DepositType": { "enum": [ "Unknown", "Amount", "Percentage", "AdvancePayments" ], "type": "string" }, "CustomerSelectedCreditTier": { "enum": [ "Unknown", "BelowAverage", "Fair", "Good", "VeryGood", "Excellent" ], "type": "string" }, "OverrideRetailerFinanceWithRequestedOrganisation": { "description": "Force the calculations to use the requesting organisation's finance instead of the vehicle's retailer finance", "type": "boolean" }, "DeliveryDate": { "format": "date-time", "type": "string" }, "IsOnlyForBusinessUse": { "description": "Can be used to filer the finance to those products designed for business vehicles. Setting this to false will return only finance for private individuals", "type": "boolean" } } }, "SelectedFacets": { "type": "object", "properties": { "States": { "type": "array", "items": { "type": "string" } }, "Manufacturers": { "type": "array", "items": { "type": "string" } }, "Models": { "type": "array", "items": { "type": "string" } }, "Variants": { "type": "array", "items": { "type": "string" } }, "Doors": { "type": "array", "items": { "type": "string" } }, "Seats": { "type": "array", "items": { "type": "string" } }, "Drivetrains": { "type": "array", "items": { "type": "string" } }, "Fuel": { "type": "array", "items": { "type": "string" } }, "Transmission": { "type": "array", "items": { "type": "string" } }, "Colours": { "type": "array", "items": { "type": "string" } }, "BodyStyles": { "type": "array", "items": { "type": "string" } }, "CustomBodyStyles": { "type": "array", "items": { "type": "string" } }, "Options": { "type": "array", "items": { "type": "string" } }, "FranchiseApproved": { "type": "string" }, "InsuranceGroupsBelow": { "description": "Insurance groups from 1 to 50 excluding the security letter", "type": "string" }, "MileagesBelow": { "type": "string" }, "MileagesAbove": { "type": "string" }, "EnginesBelow": { "description": "Engines measured in litres ie 1.4", "type": "string" }, "EnginesAbove": { "description": "Engines measured in litres ie 1.4", "type": "string" }, "BootCapacitiesAbove": { "type": "string" }, "AgesBelow": { "description": "Measured in years", "type": "string" }, "AgesAbove": { "description": "Measured in years", "type": "string" }, "RegistrationYearBelow": { "description": "Measured in years", "type": "string" }, "RegistrationYearAbove": { "description": "Measured in years", "type": "string" }, "AccelerationsBelow": { "description": "Measured in seconds from 0 to 60 mph", "type": "string" }, "OnTheRoadPriceBelow": { "description": "The vehicle price including the first year RFL and registration fee", "type": "string" }, "OnTheRoadPriceAbove": { "description": "The price of the vehicle if new including the first year RFL and registration fee", "type": "string" }, "LastUpdated": { "description": "Vehicles recently added into stock within the specified time frame (Day, Week, Month)", "type": "string" }, "EnginePowerAbove": { "description": "Engine power measured in bhp ie 150 bhp", "type": "string" }, "EnginePowerBelow": { "description": "Engine power measured in bhp ie 150 bhp", "type": "string" }, "BatteryCapacityAbove": { "description": "Battery Capacity measured in kWh i.e. 64", "type": "string" }, "BatteryRangeAbove": { "type": "string" }, "FuelConsumptionAbove": { "description": "Fuel Consumption Above measured in MPG", "type": "string" }, "EmissionsBelow": { "description": "CO2 (WLTP) Emissions measured in g/km", "type": "string" }, "ModelYearAbove": { "description": "Model years above including selected ie 2024", "type": "string" }, "ModelYearBelow": { "description": "Model years below including selected ie 2024", "type": "string" }, "SafetyRatingAbove": { "description": "Minimum safety rating (if supported by dataset e.g. CAP -> NCAP, range 0-5)", "type": "string" }, "BatteryHealthAbove": { "description": "Minimum Battery Health Percentage (range 80-100 in 5% increments) (if supported by dataset)", "type": "string" } } }, "FinanceSearchResult": { "type": "object", "properties": { "TotalResults": { "format": "int32", "type": "integer" }, "VehiclesSearched": { "format": "int32", "type": "integer" }, "TotalPages": { "format": "int32", "type": "integer" }, "Page": { "format": "int32", "type": "integer" }, "MinimumPayment": { "format": "double", "type": "number" }, "MaximumPayment": { "format": "double", "type": "number" }, "Results": { "type": "array", "items": { "$ref": "#/definitions/FinanceSearchVehicle" } } } }, "FinanceSearchVehicle": { "type": "object", "properties": { "Id": { "type": "string" }, "RegularPayment": { "format": "double", "type": "number" } } }, "ResidualsResponse": { "type": "object", "properties": { "Results": { "type": "array", "items": { "$ref": "#/definitions/ResidualsConfigurationsResult" } } } }, "ResidualsConfigurationsResult": { "type": "object", "properties": { "Id": { "type": "string" }, "Key": { "type": "string" }, "Name": { "type": "string" } } }, "GetFinanceProductResponse": { "type": "object", "properties": { "ProductOverview": { "$ref": "#/definitions/FinanceProductOverview" } } }, "FinanceProductOverview": { "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "LenderId": { "format": "int32", "type": "integer" }, "LenderReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Name": { "type": "string" }, "ProductFamilyId": { "format": "int32", "type": "integer" }, "QuoteValid": { "format": "int32", "type": "integer" }, "FiguresValid": { "format": "int32", "type": "integer" }, "IsActive": { "type": "boolean" }, "CalculatingRate": { "enum": [ "Unknown", "FlatRate", "Yield", "Apr" ], "type": "string" }, "DisplayRate": { "enum": [ "CustomerRate", "Yield", "Aer", "AnnualRate", "FlatRate" ], "type": "string" }, "VehicleDataSetId": { "format": "int32", "type": "integer" }, "ExternalIdentifier": { "type": "string" }, "WebServiceOutId": { "format": "int32", "type": "integer" }, "TermsAndConditionName": { "type": "string" }, "ResidualConfigurationId": { "format": "int32", "type": "integer" }, "CalculatorId": { "format": "int32", "type": "integer" }, "CommissionPackageId": { "format": "int32", "type": "integer" }, "CommissionPackagePublicIdentifier": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "ValidationRules": { "type": "array", "items": { "$ref": "#/definitions/ValidationRuleOverview" } }, "ProfileRules": { "type": "array", "items": { "$ref": "#/definitions/ProfileRuleOverview" } }, "Entities": { "type": "array", "items": { "$ref": "#/definitions/EntityOverview" } }, "WebServiceOutReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } }, "ValidationRuleOverview": { "type": "object", "properties": { "RuleTypeId": { "format": "int32", "type": "integer" }, "Value": { "type": "string" } } }, "ProfileRuleOverview": { "type": "object", "properties": { "RuleTypeId": { "format": "int32", "type": "integer" } } }, "EntityOverview": { "type": "object", "properties": { "EntityId": { "format": "int32", "type": "integer" } } }, "UpdateFinanceProductRequest": { "type": "object", "properties": { "Product": { "$ref": "#/definitions/FinanceProductOverview" }, "RuleValuesAsJson": { "type": "boolean" } } }, "UpdateFinanceProductResponse": { "type": "object", "properties": { "ProductOverview": { "$ref": "#/definitions/FinanceProductOverview" } } }, "GetProductEntitiesResponse": { "type": "object", "properties": { "ProductEntities": { "type": "array", "items": { "$ref": "#/definitions/ProductEntity" } } } }, "ProductEntity": { "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "Name": { "type": "string" }, "DisplayText": { "type": "string" }, "IsBusiness": { "type": "boolean" } } }, "UpdateEnabledProductEntitiesRequest": { "type": "object", "properties": { "EntityIds": { "type": "array", "items": { "format": "int32", "type": "integer" } } } }, "UpdateEnabledProductEntitiesResponse": { "type": "object", "properties": {} }, "GetCommissionCalculatorFormulaeResponse": { "type": "object", "properties": { "CommissionCalculatorFormulae": { "type": "array", "items": { "$ref": "#/definitions/CommissionCalculatorFormula" } } } }, "CommissionCalculatorFormula": { "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "Name": { "type": "string" }, "DisplayName": { "type": "string" } } }, "GetServicesAdditionalFundedProductOverrideResultResponse": { "type": "object", "properties": { "AdditionalFundedProductOverrides": { "type": "array", "items": { "$ref": "#/definitions/ServicesAdditionalFundedProductOverride" } } } }, "ServicesAdditionalFundedProductOverride": { "type": "object", "properties": { "AdditionalFundedProductType": { "type": "string" }, "CalculationType": { "enum": [ "Unknown", "RegularPaymentSpreadNonInterestBearing", "Financeable", "PSA_GAP", "PERCENTAGE_OF_ADVANCE", "PSA_DEATH_INSURANCE", "VapPaidForByDeposit", "RegularPaymentNonInterestBearing", "PercentageOfAdvancePlusInterestBearingFees", "PsaFinancialLossGuarantee", "FlatAmountPaidByMonthlyFinancePayment", "AdminFee", "DisplayOnly", "PercentageOfMonthlyPaymentIncludingVAT", "BandedFixedMonthlyServiceFee", "RegularPaymentNonInterestBearingIncludingInitialPayment", "FinancedSpainOpeningFee", "MercedesExternalVapCalculation", "VapCalculatedByLenderSystem", "PsaServicingAmountSpreadAcrossPayments", "StellantisRegularPaymentSpreadNonInterestBearing", "NovunaMaintenanceServicePackVap", "StellantisServiceVap", "StellantisFixedAmountInsuranceServiceVap", "StellantisFiscalPowerVap", "StellantisBrakeHorsePowerVap", "StellantisCreditInsuranceVap", "StellantisServiceVapIncludingDeposit", "NonInterestBearingServiceRental", "StellantisBrakeHorsePowerVapExcludingDeposit", "PaidByDepositOrPositiveEquity", "NovunaCorporateReliefVehicleVap", "MonthlyAmountSpreadNonInterestBearing", "MonthlyAmountSpreadInterestBearing", "NovunaCorporateMaintenanceVap", "NovunaCorporateTyresVap", "NovunaCorporateBreakdownVap", "TotalAmountSpreadInterestBearing", "PercentageOfMonthlyAmountSpreadNonInterestBearing", "PercentageOfMonthlyAmountSpreadInterestBearing", "PercentageOfTotalAmountSpreadNonInterestBearing", "PercentageOfTotalAmountSpreadInterestBearing" ], "type": "string" }, "ProductId": { "format": "int32", "type": "integer" }, "SystemId": { "format": "int32", "type": "integer" }, "Id": { "format": "int64", "type": "integer" } } }, "ServicesSaveAdditionalFundedProductOverrideRequest": { "type": "object", "properties": { "AdditionalFundedProductType": { "type": "string" }, "CalculationFormula": { "enum": [ "Unknown", "RegularPaymentSpreadNonInterestBearing", "Financeable", "PSA_GAP", "PERCENTAGE_OF_ADVANCE", "PSA_DEATH_INSURANCE", "VapPaidForByDeposit", "RegularPaymentNonInterestBearing", "PercentageOfAdvancePlusInterestBearingFees", "PsaFinancialLossGuarantee", "FlatAmountPaidByMonthlyFinancePayment", "AdminFee", "DisplayOnly", "PercentageOfMonthlyPaymentIncludingVAT", "BandedFixedMonthlyServiceFee", "RegularPaymentNonInterestBearingIncludingInitialPayment", "FinancedSpainOpeningFee", "MercedesExternalVapCalculation", "VapCalculatedByLenderSystem", "PsaServicingAmountSpreadAcrossPayments", "StellantisRegularPaymentSpreadNonInterestBearing", "NovunaMaintenanceServicePackVap", "StellantisServiceVap", "StellantisFixedAmountInsuranceServiceVap", "StellantisFiscalPowerVap", "StellantisBrakeHorsePowerVap", "StellantisCreditInsuranceVap", "StellantisServiceVapIncludingDeposit", "NonInterestBearingServiceRental", "StellantisBrakeHorsePowerVapExcludingDeposit", "PaidByDepositOrPositiveEquity", "NovunaCorporateReliefVehicleVap", "MonthlyAmountSpreadNonInterestBearing", "MonthlyAmountSpreadInterestBearing", "NovunaCorporateMaintenanceVap", "NovunaCorporateTyresVap", "NovunaCorporateBreakdownVap", "TotalAmountSpreadInterestBearing", "PercentageOfMonthlyAmountSpreadNonInterestBearing", "PercentageOfMonthlyAmountSpreadInterestBearing", "PercentageOfTotalAmountSpreadNonInterestBearing", "PercentageOfTotalAmountSpreadInterestBearing" ], "type": "string" } } }, "ServicesSaveAdditionalFundedProductOverrideResponse": { "type": "object", "properties": { "AdditionalFundedProductType": { "type": "string" }, "CalculationType": { "enum": [ "Unknown", "RegularPaymentSpreadNonInterestBearing", "Financeable", "PSA_GAP", "PERCENTAGE_OF_ADVANCE", "PSA_DEATH_INSURANCE", "VapPaidForByDeposit", "RegularPaymentNonInterestBearing", "PercentageOfAdvancePlusInterestBearingFees", "PsaFinancialLossGuarantee", "FlatAmountPaidByMonthlyFinancePayment", "AdminFee", "DisplayOnly", "PercentageOfMonthlyPaymentIncludingVAT", "BandedFixedMonthlyServiceFee", "RegularPaymentNonInterestBearingIncludingInitialPayment", "FinancedSpainOpeningFee", "MercedesExternalVapCalculation", "VapCalculatedByLenderSystem", "PsaServicingAmountSpreadAcrossPayments", "StellantisRegularPaymentSpreadNonInterestBearing", "NovunaMaintenanceServicePackVap", "StellantisServiceVap", "StellantisFixedAmountInsuranceServiceVap", "StellantisFiscalPowerVap", "StellantisBrakeHorsePowerVap", "StellantisCreditInsuranceVap", "StellantisServiceVapIncludingDeposit", "NonInterestBearingServiceRental", "StellantisBrakeHorsePowerVapExcludingDeposit", "PaidByDepositOrPositiveEquity", "NovunaCorporateReliefVehicleVap", "MonthlyAmountSpreadNonInterestBearing", "MonthlyAmountSpreadInterestBearing", "NovunaCorporateMaintenanceVap", "NovunaCorporateTyresVap", "NovunaCorporateBreakdownVap", "TotalAmountSpreadInterestBearing", "PercentageOfMonthlyAmountSpreadNonInterestBearing", "PercentageOfMonthlyAmountSpreadInterestBearing", "PercentageOfTotalAmountSpreadNonInterestBearing", "PercentageOfTotalAmountSpreadInterestBearing" ], "type": "string" }, "ProductId": { "format": "int32", "type": "integer" }, "SystemId": { "format": "int32", "type": "integer" }, "Id": { "format": "int64", "type": "integer" } } }, "ServicesRemoveAdditionalFundedProductByIdResponse": { "type": "object", "properties": {} }, "GetAllLocalisedTermsAndConditionsResponse": { "type": "object", "properties": { "TermsAndConditions": { "type": "object", "additionalProperties": { "$ref": "#/definitions/TermAndCondition" } }, "ProductId": { "format": "int32", "type": "integer" } } }, "TermAndCondition": { "type": "object", "properties": { "TemplateKey": { "type": "string" } } }, "CreateFinanceLocalisedTermsAndConditionsRequest": { "type": "object", "properties": { "TemplateName": { "type": "string" }, "TemplateKey": { "type": "string" }, "Locale": { "type": "string" } } }, "CreateFinanceLocalisedTermsAndConditionsResponse": { "type": "object", "properties": {} }, "RemoveFinanceLocalisedTermsAndConditionsRequest": { "type": "object", "properties": { "TemplateKey": { "type": "string" }, "Locale": { "type": "string" } } }, "RemoveFinanceLocalisedTermsAndConditionsResponse": { "type": "object", "properties": {} }, "UpdateFinanceLocalisedTermsAndConditionsRequest": { "type": "object", "properties": { "TemplateKey": { "type": "string" }, "Locale": { "type": "string" } } }, "UpdateFinanceLocalisedTermsAndConditionsResponse": { "type": "object", "properties": {} }, "FinancePackageMetaDataResponse": { "type": "object", "properties": { "Package": { "$ref": "#/definitions/FinancePackageMetaData" } } }, "FinancePackageMetaData": { "type": "object", "properties": { "Name": { "type": "string" }, "Id": { "format": "int32", "type": "integer" }, "SystemId": { "format": "int32", "type": "integer" } } }, "FinancePackageTermGroupResponse": { "type": "object", "properties": { "TermGroup": { "$ref": "#/definitions/TermGroupMetaData" } } }, "TermGroupMetaData": { "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "Name": { "type": "string" }, "ProductFamily": { "type": "string" } } }, "ActiveFinancePackagesWithTermGroupResponse": { "type": "object", "properties": { "Packages": { "type": "array", "items": { "$ref": "#/definitions/FinancePackageWithTermGroups" } } } }, "FinancePackageWithTermGroups": { "type": "object", "properties": { "CampaignId": { "format": "int32", "type": "integer" }, "CampaignName": { "type": "string" }, "TermGroups": { "type": "array", "items": { "$ref": "#/definitions/TermGroupMetaData" } }, "SetupDate": { "format": "date-time", "type": "string" }, "Active": { "type": "boolean" }, "ExternalIdentifier": { "type": "string" }, "SystemId": { "format": "int32", "type": "integer" } } }, "CreateFinancePackageRequest": { "type": "object", "properties": { "Name": { "type": "string" }, "Active": { "type": "boolean" } } }, "CreateFinancePackageResponse": { "type": "object", "properties": { "FinancePackage": { "$ref": "#/definitions/FinancePackageMetaData" } } }, "UpdateFinancePackageRequest": { "type": "object", "properties": { "Name": { "type": "string" }, "Active": { "type": "boolean" } } }, "UpdateFinancePackageResponse": { "type": "object", "properties": {} }, "GetFinancePackageWithTermsResponse": { "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "Name": { "type": "string" }, "TermGroups": { "type": "array", "items": { "$ref": "#/definitions/TermGroupOverview" } }, "SetupDate": { "format": "date-time", "type": "string" }, "IsActive": { "type": "boolean" }, "SystemId": { "format": "int32", "type": "integer" } } }, "TermGroupOverview": { "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "Name": { "type": "string" }, "Precedence": { "format": "int32", "type": "integer" }, "Terms": { "type": "array", "items": { "$ref": "#/definitions/TermOverview" } } } }, "TermOverview": { "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "Name": { "type": "string" }, "IsActive": { "type": "boolean" }, "Precedence": { "format": "int32", "type": "integer" } } }, "GetFinanceOverviewResponse": { "type": "object", "properties": { "Organisations": { "type": "array", "items": { "$ref": "#/definitions/GetFinanceOverviewOrganisation" } } } }, "GetFinanceOverviewOrganisation": { "type": "object", "properties": { "TradingName": { "type": "string" }, "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "LegacyDealerId": { "format": "int32", "type": "integer" }, "Channels": { "type": "array", "items": { "$ref": "#/definitions/GetFinanceOverviewChannel" } }, "Campaigns": { "type": "array", "items": { "$ref": "#/definitions/GetFinanceOverviewCampaign" } }, "TermGroups": { "type": "array", "items": { "$ref": "#/definitions/GetFinanceOverviewTermGroup" } } } }, "GetFinanceOverviewChannel": { "type": "object", "properties": { "Name": { "type": "string" }, "DisplayName": { "type": "string" }, "ChannelKeys": { "type": "array", "items": { "$ref": "#/definitions/GetFinanceOverviewChannelKey" } } } }, "GetFinanceOverviewCampaign": { "type": "object", "properties": { "Name": { "type": "string" }, "Id": { "format": "int32", "type": "integer" }, "TermGroups": { "type": "array", "items": { "$ref": "#/definitions/GetFinanceOverviewTermGroupIdentifier" } } } }, "GetFinanceOverviewTermGroup": { "type": "object", "properties": { "Name": { "type": "string" }, "Id": { "format": "int32", "type": "integer" }, "Terms": { "type": "array", "items": { "$ref": "#/definitions/GetFinanceOverviewTerm" } }, "SystemId": { "format": "int32", "type": "integer" } } }, "GetFinanceOverviewChannelKey": { "type": "object", "properties": { "Key": { "type": "string" }, "DisplayName": { "type": "string" }, "TermGroupIdentifiers": { "type": "array", "items": { "$ref": "#/definitions/GetFinanceOverviewTermGroupIdentifier" } } } }, "GetFinanceOverviewTermGroupIdentifier": { "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "SystemId": { "format": "int32", "type": "integer" } } }, "GetFinanceOverviewTerm": { "type": "object", "properties": { "Name": { "type": "string" }, "Id": { "format": "int32", "type": "integer" }, "Product": { "$ref": "#/definitions/GetFinanceOverviewProduct" }, "MinApr": { "format": "double", "type": "number" }, "MaxApr": { "format": "double", "type": "number" }, "MinBaseRate": { "format": "double", "type": "number" }, "MaxBaseRate": { "format": "double", "type": "number" } } }, "GetFinanceOverviewProduct": { "type": "object", "properties": { "DisplayName": { "type": "string" }, "ProductFamilyName": { "type": "string" }, "Lender": { "$ref": "#/definitions/GetFinanceOverviewLender" }, "Id": { "format": "int32", "type": "integer" } } }, "GetFinanceOverviewLender": { "type": "object", "properties": { "Name": { "type": "string" } } }, "FeeOptionsResponse": { "type": "object", "properties": { "Fees": { "type": "array", "items": { "$ref": "#/definitions/FeeOption" } } } }, "FeeOption": { "type": "object", "properties": { "Type": { "type": "string" }, "Profile": { "type": "string" }, "ExternalIdentifier": { "type": "string" }, "SupportsCalculateToRental": { "type": "boolean" }, "ValueType": { "enum": [ "Amount", "Percentage" ], "type": "string" } } }, "CalculateFeeValueRequest": { "type": "object", "properties": { "TargetPayment": { "format": "double", "type": "number" }, "QuoteReferenceWithoutFee": { "type": "string" }, "Fee": { "$ref": "#/definitions/FeeDetails" }, "TargetPaymentIsVatEx": { "type": "boolean" }, "IsVatExCalculation": { "type": "boolean" } } }, "FeeDetails": { "type": "object", "properties": { "Profile": { "type": "string" }, "Type": { "type": "string" }, "ExternalIdentifier": { "type": "string" } } }, "FeeResponse": { "type": "object", "properties": { "Fee": { "$ref": "#/definitions/FeeElement" } } }, "GetExternalCalculationProviders": { "type": "object", "properties": {} }, "GetExternalCalculationParametersResponse": { "type": "object", "properties": { "JsonSchema": { "type": "string" } } }, "ValidateExternalCalculationParametersRequest": { "type": "object", "properties": { "ParametersAsJson": { "type": "string" } } }, "ValidateExternalCalculationParametersResponse": { "type": "object", "properties": { "ParametersValid": { "type": "boolean" }, "ValidationMessage": { "type": "string" } } }, "FinanceProductParametersRequest": { "type": "object", "properties": { "Channel": { "$ref": "#/definitions/ChannelType" }, "Parameters": { "$ref": "#/definitions/FinanceParametersForDefaults" }, "Filters": { "$ref": "#/definitions/FinanceFiltersForDefaults" }, "BuildToOrderVehicle": { "$ref": "#/definitions/BuildToOrderVehicle" }, "PhysicalVehicleIdentifier": { "$ref": "#/definitions/PhysicalVehicleIdentifier" }, "PhysicalVehicle": { "$ref": "#/definitions/PhysicalVehicle" }, "VehicleSpecification": { "$ref": "#/definitions/VehicleSpecification" }, "VehicleReference": { "$ref": "#/definitions/VehicleReference" }, "OrganisationIdentifier": { "$ref": "#/definitions/OrganisationIdentifier", "description": "This determines the organisation that the request will be run as. This changes the authentication context to be for this organisation." }, "Customer": { "$ref": "#/definitions/CustomerDetails" }, "PromoCode": { "type": "string" } } }, "FinanceParametersForDefaults": { "type": "object", "properties": { "CalculationTime": { "format": "date-time", "type": "string" }, "CashValuesAreVatExclusive": { "type": "boolean" }, "Accessories": { "description": "A collection of accessories that will be included", "type": "array", "items": { "$ref": "#/definitions/Accessory" } }, "IncludeAllPromotionalFinance": { "type": "boolean" }, "ProductIdentifiers": { "description": "If specified, only return products which have a Key in this list (Like [\"GROUPID_1234\", \"GROUPID_3456\"])", "type": "array", "items": { "type": "string" } } } }, "FinanceFiltersForDefaults": { "type": "object", "properties": { "Manufacturer": { "description": "Only finance parameters available for the requested manufacturer will be returned.", "type": "string" } } }, "BuildToOrderVehicle": { "description": "Represents a vehicle that has not yet been built but configured", "required": [ "Type", "Identifier", "IdentifierType" ], "type": "object", "properties": { "Type": { "enum": [ "Unknown", "Car", "Lcv", "Bike", "Other", "NonVehicleAsset" ], "type": "string" }, "Identifier": { "type": "string" }, "IdentifierType": { "enum": [ "Unknown", "CapCarShortCode", "CapLcvShortCode", "CapBikeShortCode", "CapLongCode", "Glass", "Titre", "Ids", "CodeweaversDerivativeIdentifier", "CodeweaversStockIdentifier", "Ivs", "ExternalVehicleId", "Vrm", "Vin", "Vid", "BmvsCode", "KeeId", "JLR5000Code", "FcaConfiguratorSlug", "VolvoCode", "JlrComboCode", "AutoTraderDerivativeIdentifier", "FreeText", "TeslaDescription", "BaumusterCode", "TribalDerivativeIdentifier", "SkodaCode", "SeatCode", "VolkswagenCode", "AudiCode", "CazanaId", "Jato", "Mpv", "SubaruCode", "Infocar", "VolvoConfigurationCode", "TriumphCode", "Blvd", "AutobizVersionId", "AutoVistaNatCode", "BregoDerivativeIdentifier" ], "type": "string" }, "OnTheRoadPrice": { "format": "double", "description": "This is required if the CostBreakdown is not supplied and you want to override the MRRP", "maximum": 2147483647, "minimum": 0, "type": "number" }, "PricingIncludesGovernmentGrant": { "description": "set this to true if the vehicle price already includes the government grant for electric vehicles", "type": "boolean" }, "CostBreakdown": { "$ref": "#/definitions/CostBreakdown", "description": "Required if OnTheRoadPrice is not supplied and you want to override the MRRP" }, "SelectedOptions": { "description": "Identifies the options that have been selected for the vehicle", "type": "array", "items": { "$ref": "#/definitions/EquipmentOption" } }, "EnvironmentalData": { "$ref": "#/definitions/EnvironmentalData", "description": "Identifies the environmental data for the vehicle" }, "VatStatus": { "enum": [ "Unknown", "NotPaid", "FullyPaid", "Margin", "StandardVatAsDeposit" ], "type": "string" } } }, "PhysicalVehicleIdentifier": { "description": "A unique identifier to a specific vehicle that has been built", "required": [ "Identifier", "Type" ], "type": "object", "properties": { "Identifier": { "type": "string" }, "Type": { "enum": [ "Unknown", "CodeweaversStockIdentifier", "ExternalVehicleId", "Vrm", "Vin", "Titre" ], "type": "string" } } }, "EquipmentOption": { "required": [ "Code", "Price" ], "type": "object", "properties": { "Code": { "type": "string" }, "CodeType": { "enum": [ "Primary", "Cap" ], "type": "string" }, "Price": { "format": "double", "type": "number" }, "Discount": { "$ref": "#/definitions/OptionDiscount" } } }, "GetCommissionPackageResponse": { "type": "object", "properties": { "CommissionPackage": { "$ref": "#/definitions/CommissionPackageModel" } } }, "CommissionPackageModel": { "type": "object", "properties": { "Name": { "type": "string" }, "LenderReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Groups": { "type": "array", "items": { "$ref": "#/definitions/CommissionPackageGroup" } }, "PublicIdentifier": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } }, "CommissionPackageGroup": { "type": "object", "properties": { "Precedence": { "format": "int32", "type": "integer" }, "FilterSets": { "type": "array", "items": { "$ref": "#/definitions/CommissionPackageRuleSet" } }, "ActionSet": { "$ref": "#/definitions/CommissionPackageRuleSet" } } }, "CommissionPackageRuleSet": { "type": "object", "properties": { "Rules": { "type": "array", "items": { "$ref": "#/definitions/CommissionPackageRule" } } } }, "CommissionPackageRule": { "type": "object", "properties": { "RuleTypeId": { "format": "int32", "type": "integer" }, "Value": { "type": "string" } } }, "GetCommissionPackageAuditResponse": { "type": "object", "properties": { "Versions": { "type": "array", "items": { "$ref": "#/definitions/CommissionPackageVersion" } } } }, "CommissionPackageVersion": { "type": "object", "properties": { "Message": { "type": "string" }, "DeletedAt": { "format": "date-time", "type": "string" }, "UserReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Username": { "type": "string" } } }, "CreateCommissionPackageRequest": { "type": "object", "properties": { "CommissionPackage": { "$ref": "#/definitions/CommissionPackageModel" } } }, "CreateCommissionPackageResponse": { "type": "object", "properties": { "PublicIdentifier": { "type": "string" } } }, "UpdateCommissionPackageRequest": { "type": "object", "properties": { "CommissionPackage": { "$ref": "#/definitions/CommissionPackageModel" }, "AuditMessage": { "type": "string" } } }, "UpdateCommissionPackageResponse": { "type": "object", "properties": {} }, "GetCommissionRuleTypesResponse": { "type": "object", "properties": { "RuleTypes": { "type": "array", "items": { "$ref": "#/definitions/CommissionRuleType" } } } }, "CommissionRuleType": { "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "Name": { "type": "string" }, "IsAction": { "type": "boolean" }, "ValueType": { "type": "string" } } }, "GetCommissionPackagesForLenderResponse": { "type": "object", "properties": { "CommissionPackages": { "type": "array", "items": { "$ref": "#/definitions/CommissionPackageModel" } } } }, "GetProductsLinkedToCommissionPackageResponse": { "type": "object", "properties": { "LinkedProducts": { "type": "array", "items": { "$ref": "#/definitions/LinkedProduct" } } } }, "LinkedProduct": { "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "Name": { "type": "string" }, "Active": { "type": "boolean" } } }, "CalculateResidualRequest": { "description": "A request to calculate a residual for a supplied list of vehicles", "required": [ "VehicleRequests" ], "type": "object", "properties": { "VehicleRequests": { "type": "array", "items": { "$ref": "#/definitions/ResidualCalculationVehicleRequest" } } } }, "ResidualCalculationVehicleRequest": { "description": "Represents a single vehicle to calculate finance on, requires Parameters and one of BuildToOrderVehicle, PhysicalVehicleIdentifier, PhysicalVehicle.", "required": [ "Id", "Parameters" ], "type": "object", "properties": { "Id": { "type": "string" }, "Parameters": { "$ref": "#/definitions/ResidualParameters" }, "FuelType": { "type": "string" }, "BuildToOrderVehicle": { "$ref": "#/definitions/BuildToOrderVehicle" }, "PhysicalVehicleIdentifier": { "$ref": "#/definitions/PhysicalVehicleIdentifier" }, "PhysicalVehicle": { "$ref": "#/definitions/PhysicalVehicle" } } }, "ResidualParameters": { "required": [ "Term", "AnnualMileage", "Key" ], "type": "object", "properties": { "Term": { "format": "int32", "type": "integer" }, "AnnualMileage": { "format": "int32", "type": "integer" }, "Key": { "type": "string" }, "AnnualMileageUnit": { "enum": [ "Miles", "Kilometres", "Mil" ], "type": "string" }, "CountryCode": { "type": "string" }, "CalculationDate": { "format": "date-time", "type": "string" }, "OrganisationReference": { "$ref": "#/definitions/OrganisationIdentifier" }, "ProductIdentifier": { "type": "string" }, "FranchiseOverride": { "type": "string" } } }, "ResidualResponse": { "type": "object", "properties": { "VehicleResults": { "type": "array", "items": { "$ref": "#/definitions/VehicleResidualResult" } } } }, "VehicleResidualResult": { "type": "object", "properties": { "HasError": { "type": "boolean" }, "Error": { "$ref": "#/definitions/ErrorResponse" }, "Id": { "type": "string" }, "Residual": { "format": "double", "type": "number" }, "ExcessMileageRate": { "format": "double", "type": "number" }, "UnderMileageRate": { "format": "double", "type": "number" }, "ChangeEvents": { "type": "array", "items": { "type": "string" } } } }, "FinanceCalculateForOptionsRequest": { "required": [ "Parameters", "AvailableOptions", "Vehicle" ], "type": "object", "properties": { "Customer": { "$ref": "#/definitions/CustomerDetails" }, "Parameters": { "$ref": "#/definitions/FinanceParameters" }, "AvailableOptions": { "type": "array", "items": { "$ref": "#/definitions/AvailableOption" } }, "Vehicle": { "$ref": "#/definitions/BuildToOrderVehicle" }, "VehicleSpecification": { "$ref": "#/definitions/VehicleSpecification" } } }, "FinanceParameters": { "type": "object", "properties": { "Term": { "format": "int32", "type": "integer" }, "CashDeposit": { "format": "double", "type": "number" }, "RegularPayment": { "format": "double", "type": "number" }, "DepositType": { "enum": [ "Unknown", "Amount", "Percentage", "AdvancePayments" ], "type": "string" }, "PaymentProfile": { "enum": [ "Unknown", "SpreadRental", "TerminalPause" ], "type": "string" }, "AnnualMileage": { "format": "int32", "type": "integer" }, "AnnualMileageUnit": { "enum": [ "Miles", "Kilometres", "Mil" ], "type": "string" }, "ProductKey": { "description": "Optionally specify a product key. The service will return all product keys if not used", "type": "string" }, "CalculationType": { "enum": [ "Unknown", "ToRegularPayment", "ToTerm", "ToCashDeposit" ], "type": "string" }, "PartExchangeReference": { "description": "Uses the latest active part exchange", "type": "string" }, "PartExchangeOfferReference": { "description": "Uses the latest active offer for the part exchange", "type": "string" }, "DeliveryDate": { "format": "date-time", "type": "string" }, "IsPersonalisedQuote": { "type": "boolean" }, "ValueAddedProducts": { "description": "Usually additional products funded by the lender e.g GAP, Warranty, Cosmetic Protection", "type": "array", "items": { "$ref": "#/definitions/ValueAddedProduct" } }, "AddTelematics": { "type": "boolean" }, "OfferReference": { "type": "string" }, "Sellout": { "$ref": "#/definitions/Sellout" }, "Discounts": { "type": "array", "items": { "$ref": "#/definitions/Discount" } }, "DepositContributions": { "$ref": "#/definitions/DepositContributions", "description": "Deposit contributions are added to the customer deposit reducing the amount financed" }, "OrganisationIdentifier": { "$ref": "#/definitions/OrganisationIdentifier" }, "Channel": { "$ref": "#/definitions/ChannelType", "description": "Channel keys control the finance returned for different integrations. e.g. website vs DMS" }, "MaintenanceProvider": { "type": "string" }, "Accessories": { "description": "Normally dealer fitted options. The price for accessories set here does not affect the OTR price automatically", "type": "array", "items": { "$ref": "#/definitions/Accessory" } }, "CashValuesAreVatExclusive": { "description": "Normally used on LCVs to separate VAT. Defaults to false", "type": "boolean" }, "CustomerSelectedCreditTier": { "enum": [ "Unknown", "BelowAverage", "Fair", "Good", "VeryGood", "Excellent" ], "type": "string" }, "IncludeNoFinanceOption": { "type": "boolean" }, "ManualResidual": { "format": "double", "type": "number" }, "ManualResidualAsPercentage": { "type": "boolean" }, "FinanceProductFamilyKeys": { "description": "Possible values: \"HP\", \"PCP\", \"LP\", \"CH\", \"PCH\", \"CP\" \"CS\"", "type": "array", "items": { "type": "string" } }, "IsForBusinessUse": { "type": "boolean" }, "Eligibility": { "$ref": "#/definitions/EligibilityParameters", "description": "A rate for risk reference to retrieve personalised quotes" }, "CalculateAsLenderPanel": { "description": "When true, returns all rate for risk quotes", "type": "boolean" }, "PromoCode": { "type": "string" }, "IncludeAllPromotionalFinance": { "type": "boolean" }, "ExcessMileageRate": { "format": "double", "type": "number" }, "SchemeReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "PayVehicleVatWithDeposit": { "type": "boolean" } } }, "AvailableOption": { "required": [ "Id" ], "type": "object", "properties": { "Id": { "type": "string" }, "Options": { "type": "array", "items": { "$ref": "#/definitions/EquipmentOption" } } } }, "Sellout": { "required": [ "Type", "Value" ], "type": "object", "properties": { "Type": { "enum": [ "Apr", "CustomerRate", "Commission", "RateSpread", "Aer" ], "type": "string" }, "Value": { "format": "double", "type": "number" } } }, "Discount": { "type": "object", "properties": { "Description": { "type": "string" }, "Type": { "type": "string" }, "Value": { "type": "string" } } }, "DepositContributions": { "type": "object", "properties": { "Retailer": { "$ref": "#/definitions/DepositContribution" }, "Lender": { "$ref": "#/definitions/DepositContribution" }, "Manufacturer": { "$ref": "#/definitions/DepositContribution" }, "LenderLoyalty": { "$ref": "#/definitions/DepositContribution" } } }, "DepositContribution": { "type": "object", "properties": { "Amount": { "format": "double", "type": "number" } } }, "CalculateForOptionsResponse": { "type": "object", "properties": { "CurrentFinance": { "$ref": "#/definitions/FinanceDetails" }, "OptionResults": { "type": "array", "items": { "$ref": "#/definitions/OptionResult" } } } }, "GetVapPackageAuditResponse": { "type": "object", "properties": { "VapPackageAudits": { "type": "array", "items": { "$ref": "#/definitions/VapPackageAudit" } }, "Page": { "format": "int32", "type": "integer" }, "ResultsPerPage": { "format": "int32", "type": "integer" }, "TotalPages": { "format": "int32", "type": "integer" }, "TotalResults": { "format": "int32", "type": "integer" } } }, "VapPackageAudit": { "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "CreatedAt": { "format": "date-time", "type": "string" }, "Referer": { "type": "string" }, "VapPackageJsonBlob": { "type": "string" }, "AuditUser": { "$ref": "#/definitions/VapAuditUser" }, "System": { "$ref": "#/definitions/VapAuditSystem" } } }, "VapAuditUser": { "type": "object", "properties": { "UserReference": { "type": "string" }, "EmailAddress": { "type": "string" } } }, "VapAuditSystem": { "type": "object", "properties": { "SystemId": { "format": "int32", "type": "integer" }, "SystemDescription": { "type": "string" } } }, "GetVapPackageAuditDetailsResponse": { "type": "object", "properties": { "VapAuditDetails": { "type": "string" } } }, "GetVapPackageAuditOverviewResponse": { "type": "object", "properties": { "VapPackageAudits": { "type": "array", "items": { "$ref": "#/definitions/VapPackageAudit" } } } }, "GetCampaignAndTermGroupAuditsResponse": { "type": "object", "properties": { "CampaignAudits": { "type": "array", "items": { "$ref": "#/definitions/CampaignAudit" } }, "TermGroupAudits": { "type": "array", "items": { "$ref": "#/definitions/TermGroupAudit" } } } }, "CampaignAudit": { "type": "object", "properties": { "OccurredAt": { "format": "date-time", "type": "string" }, "UserName": { "type": "string" }, "EventType": { "type": "string" }, "PreviousValue": { "type": "string" }, "CurrentValue": { "type": "string" } } }, "TermGroupAudit": { "type": "object", "properties": { "OccurredAt": { "format": "date-time", "type": "string" }, "UserName": { "type": "string" }, "EventType": { "type": "string" }, "PreviousValue": { "type": "string" }, "CurrentValue": { "type": "string" }, "TermGroupId": { "format": "int32", "type": "integer" }, "TermGroupName": { "type": "string" } } }, "GetAdditionalFundedProductOverrideAuditsResponse": { "type": "object", "properties": { "Audits": { "type": "array", "items": { "$ref": "#/definitions/AdditionalFundedProductOverrideAudit" } } } }, "AdditionalFundedProductOverrideAudit": { "type": "object", "properties": { "OccurredAt": { "format": "date-time", "type": "string" }, "UserName": { "type": "string" }, "EventType": { "type": "string" }, "PreviousValue": { "type": "string" }, "CurrentValue": { "type": "string" } } }, "FinanceQuoteLenderResponse": { "type": "object", "properties": { "Lender": { "$ref": "#/definitions/FinanceQuoteLenderDetails" } } }, "FinanceQuoteLenderDetails": { "type": "object", "properties": { "Reference": { "type": "string" }, "Name": { "type": "string" }, "Address": { "$ref": "#/definitions/OrganisationAddress" }, "Contacts": { "type": "array", "items": { "$ref": "#/definitions/PersonContact" } }, "LogoUrl": { "type": "string" }, "ProposalJourney": { "$ref": "#/definitions/FinanceQuoteLenderJourney" } } }, "FinanceQuoteLenderJourney": { "type": "object", "properties": { "Name": { "type": "string" }, "Reference": { "type": "string" } } }, "FinanceQuoteDefaultsResponse": { "type": "object", "properties": { "Product": { "$ref": "#/definitions/Product" } } }, "FinanceQuoteRecalculationRequest": { "required": [ "Parameters" ], "type": "object", "properties": { "Parameters": { "$ref": "#/definitions/FinanceParameters" }, "RecalculateContributions": { "type": "boolean" }, "RecalculatePartExchange": { "type": "boolean" }, "RecalculateValueAddedProducts": { "type": "boolean" }, "ProposalReference": { "type": "string" }, "Customer": { "$ref": "#/definitions/CustomerDetails" }, "VehicleReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "DisplayType": { "enum": [ "Unknown", "Customer", "Retailer", "OffersAdmin", "Lender" ], "type": "string" } } }, "DisplayDetailsResponse": { "type": "object", "properties": { "Blocks": { "type": "array", "items": { "$ref": "#/definitions/DisplayBlock" } }, "Finance": { "$ref": "#/definitions/FinanceDetails" } } }, "DisplayBlock": { "type": "object", "properties": { "Details": { "type": "array", "items": { "$ref": "#/definitions/DisplayDetail" } }, "ContentText": { "type": "string" } } }, "DisplayDetail": { "type": "object", "properties": { "Label": { "description": "The label of the field to display next to the value", "type": "string" }, "DisplayValue": { "description": "The formatted value to directly display on the website e.g. £10,000.00", "type": "string" }, "Value": { "description": "Value without formatting applied e.g. 10000.00", "type": "string" }, "Key": { "description": "Unique code for value", "type": "string" }, "Notifications": { "description": "Highlighted descriptions to be shown to the customer e.g. A deposit enhancement has been applied to your quote.", "type": "array", "items": { "type": "string" } }, "Tooltip": { "description": "A brief description about what the value is", "type": "string" }, "IsHeadline": { "description": "Determines if the field has been highlighted to be used as a headline", "type": "boolean" }, "SubDetails": { "description": "Values that are withing this value", "type": "array", "items": { "$ref": "#/definitions/DisplayDetail" } } } }, "QuoteSendEmailRequest": { "required": [ "Email" ], "type": "object", "properties": { "Email": { "type": "string" } } }, "FinanceQuoteCommissionsResponse": { "type": "object", "properties": { "RetailerCommission": { "format": "double", "type": "number" }, "RetailerVolumeBonusPercentage": { "format": "double", "type": "number" }, "CommissionNature": { "type": "string" } } }, "TermsAndConditionsResponse": { "type": "object", "properties": { "TermsAndConditions": { "type": "string" } } }, "ProposalEntitiesResponse": { "type": "object", "properties": { "Entities": { "type": "array", "items": { "$ref": "#/definitions/EntityType" } } } }, "EntityType": { "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "Type": { "enum": [ "Unknown", "OtherCorporate", "Association", "Corporate", "LimitedCompany", "LimitedLiabilityPartnership", "LocalAuthority", "NHSTrust", "Partnership", "PLC", "PrivateIndividual", "RegisteredCharity", "School", "SelfEmployed", "SoleTrader", "PrivateLimitedCompany", "GovernmentOrganisation", "UnlimitedCompany", "ForeignCompany", "RoyalCharter", "SmallPartnership", "LargePartnership", "EducationalOrganisation", "PrivateCompanyLimitedbyShares", "DesignatedActivityCompany", "DesignatedActivityCompanyLimitedbyGuarantee", "CompanyLimitedbyGuarantee", "SingleMemberCompany", "IndustrialAndProvidentSociety", "FriendlySociety", "TradeUnion", "Specialfund", "UndertakingsforCollectiveInvestmentInTransferableSecurities", "EuropeanEconomicInterestGroupings", "SocietasEuropaea", "OtherLegalFormROI", "OtherLegalForm", "OtherNonLegalForm", "OtherNonIncorporated" ], "type": "string" }, "Name": { "type": "string" }, "DisplayText": { "type": "string" }, "IsSelectable": { "type": "boolean" }, "RequiresCalculation": { "type": "boolean" } } }, "CreatePackageRequest": { "type": "object", "properties": { "Package": { "$ref": "#/definitions/PackageSummary" } } }, "PackageSummary": { "type": "object", "properties": { "Name": { "type": "string" } } }, "CreatePackageResponse": { "type": "object", "properties": { "PackageId": { "format": "int32", "type": "integer" } } }, "DeletePackageResponse": { "type": "object", "properties": {} }, "GetPackageByIdResponse": { "type": "object", "properties": { "Package": { "$ref": "#/definitions/FinanceDisplayPackage" } } }, "FinanceDisplayPackage": { "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "Name": { "type": "string" }, "Templates": { "type": "array", "items": { "$ref": "#/definitions/FinanceDisplayTemplateSummary" } } } }, "FinanceDisplayTemplateSummary": { "type": "object", "properties": { "Id": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Name": { "type": "string" }, "Product": { "type": "string" }, "Locale": { "type": "string" }, "IsEnabled": { "type": "boolean" }, "DisplayTypes": { "type": "array", "items": { "enum": [ "Unknown", "Customer", "Retailer", "OffersAdmin", "Lender" ], "type": "string" } } } }, "SearchPackagesByNameRequest": { "type": "object", "properties": { "Query": { "type": "string" } } }, "SearchPackagesByNameResponse": { "type": "object", "properties": { "Packages": { "type": "array", "items": { "$ref": "#/definitions/FinanceDisplayPackageSummary" } } } }, "FinanceDisplayPackageSummary": { "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "Name": { "type": "string" } } }, "GetFieldTypesResponse": { "type": "object", "properties": { "FieldTypes": { "type": "array", "items": { "type": "string" } } } }, "GetDisplayTypesResponse": { "type": "object", "properties": { "DisplayTypes": { "type": "array", "items": { "$ref": "#/definitions/DisplayType" } } } }, "DisplayType": { "type": "object", "properties": { "Value": { "format": "int32", "type": "integer" }, "Name": { "type": "string" }, "DisplayName": { "type": "string" } } }, "GetOrganisationsLinkedToPackageResponse": { "type": "object", "properties": { "PackageId": { "format": "int32", "type": "integer" }, "Organisations": { "type": "array", "items": { "$ref": "#/definitions/Organisation" } } } }, "Organisation": { "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "Name": { "type": "string" } } }, "SaveTemplateRequest": { "type": "object", "properties": { "Template": { "$ref": "#/definitions/FinanceDisplayTemplate" } } }, "FinanceDisplayTemplate": { "type": "object", "properties": { "Id": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Name": { "type": "string" }, "Product": { "type": "string" }, "Locale": { "type": "string" }, "IsEnabled": { "type": "boolean" }, "IsDeleted": { "type": "boolean" }, "DisplayTypes": { "type": "array", "items": { "enum": [ "Unknown", "Customer", "Retailer", "OffersAdmin", "Lender" ], "type": "string" } }, "Blocks": { "type": "array", "items": { "$ref": "#/definitions/FinanceDisplayBlock" } }, "Reason": { "type": "string" }, "Revisions": { "type": "array", "items": { "$ref": "#/definitions/FinanceDisplayTemplateRevision" } } } }, "FinanceDisplayBlock": { "type": "object", "properties": { "Reference": { "type": "string" }, "Fields": { "type": "array", "items": { "$ref": "#/definitions/FinanceDisplayField" } } } }, "FinanceDisplayTemplateRevision": { "type": "object", "properties": { "TemplateReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "UserReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Username": { "type": "string" }, "Reason": { "type": "string" }, "DeletedAt": { "format": "date-time", "type": "string" } } }, "FinanceDisplayField": { "type": "object", "properties": { "Type": { "type": "string" }, "Label": { "type": "string" }, "Tooltip": { "type": "string" }, "Order": { "format": "int32", "type": "integer" }, "AdditionalConfiguration": { "type": "string" }, "IsHeadlineField": { "type": "boolean" }, "Blocks": { "type": "array", "items": { "$ref": "#/definitions/FinanceDisplayBlock" } }, "DisplayBehaviour": { "enum": [ "Unknown", "Fixed", "Variable" ], "type": "string" } } }, "SaveTemplateResponse": { "type": "object", "properties": { "TemplateId": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } }, "GetTemplatebyIdResponse": { "type": "object", "properties": { "Template": { "$ref": "#/definitions/FinanceDisplayTemplate" } } }, "DeleteTemplateResponse": { "type": "object", "properties": {} }, "CalculateForDisplayRequest": { "description": "A request to calculate finance for a collection of vehicles that will return displayable content.", "required": [ "VehicleRequests" ], "type": "object", "properties": { "VehicleRequests": { "type": "array", "items": { "$ref": "#/definitions/FinanceCalculationVehicleRequest" } }, "Customer": { "$ref": "#/definitions/CustomerDetails" }, "TemplateDisplayType": { "enum": [ "Unknown", "Customer", "Retailer", "OffersAdmin", "Lender" ], "type": "string" } } }, "FinanceCalculationVehicleRequest": { "description": "Represents a single vehicle to calculate finance on, requires Parameters and one of BuildToOrderVehicle, PhysicalVehicleIdentifier, PhysicalVehicle.", "required": [ "Id", "Parameters" ], "type": "object", "properties": { "Id": { "description": "This Id is your unique identifier returned in the response for each vehicleRequest object", "type": "string" }, "Parameters": { "$ref": "#/definitions/FinanceParameters" }, "VehicleSpecification": { "$ref": "#/definitions/VehicleSpecification" }, "BuildToOrderVehicle": { "$ref": "#/definitions/BuildToOrderVehicle" }, "PhysicalVehicleIdentifier": { "$ref": "#/definitions/PhysicalVehicleIdentifier" }, "PhysicalVehicle": { "$ref": "#/definitions/PhysicalVehicle" }, "Images": { "type": "array", "items": { "$ref": "#/definitions/Image" } }, "VehicleReference": { "$ref": "#/definitions/VehicleReference" } } }, "CalculateForDisplayResponse": { "type": "object", "properties": { "Vehicles": { "type": "array", "items": { "$ref": "#/definitions/VehicleResult" } } } }, "VehicleResult": { "type": "object", "properties": { "Id": { "type": "string" }, "HasError": { "type": "boolean" }, "Error": { "$ref": "#/definitions/ErrorResponse" }, "FinanceQuotations": { "type": "array", "items": { "$ref": "#/definitions/FinanceQuotationDisplayDetails" } } } }, "FinanceQuotationDisplayDetails": { "type": "object", "properties": { "HasError": { "type": "boolean" }, "Error": { "$ref": "#/definitions/ErrorResponse" }, "Finance": { "$ref": "#/definitions/FinanceDetails" }, "Blocks": { "type": "array", "items": { "$ref": "#/definitions/DisplayBlock" } } } }, "FinanceApplicationStatusResponse": { "type": "object", "properties": { "DestinationName": { "type": "string" }, "Status": { "type": "string" }, "LastSubmissionTime": { "format": "date-time", "type": "string" }, "AgreementNumber": { "type": "string" }, "StatusDisplayValue": { "type": "string" }, "FormChangesSinceLastSubmission": { "$ref": "#/definitions/ChangesSinceLastSubmission" }, "QuoteChangesSinceLastSubmission": { "$ref": "#/definitions/ChangesSinceLastSubmission" }, "HasBeenSubmitted": { "type": "boolean" }, "ChangesAllowed": { "description": "If true then documents, esigns and id checks can be updated as required.\r\nIf false then no changes to the proposal or it's associated content should be modified.", "type": "boolean" } } }, "ChangesSinceLastSubmission": { "type": "object", "properties": { "HasChanged": { "type": "boolean" }, "Changes": { "type": "array", "items": { "$ref": "#/definitions/ChangeSinceLastSubmission" } } } }, "ChangeSinceLastSubmission": { "type": "object", "properties": { "Type": { "type": "string" }, "Field": { "type": "string" }, "PreviousValue": { "type": "string" }, "NewValue": { "type": "string" }, "Path": { "type": "array", "items": { "$ref": "#/definitions/ChangedSection" } } } }, "ChangedSection": { "type": "object", "properties": { "Name": { "type": "string" } } }, "GetProofsResponse": { "type": "object", "properties": { "Proofs": { "type": "array", "items": { "$ref": "#/definitions/Proof" } } } }, "Proof": { "type": "object", "properties": { "Name": { "type": "string" }, "Description": { "type": "string" }, "Status": { "type": "string" }, "Reference": { "type": "string" }, "DownloadLink": { "type": "string" }, "FileExtension": { "type": "string" }, "ProofType": { "type": "string" } } }, "UploadProofResponse": { "type": "object", "properties": {} }, "GetLenderFeaturesResponse": { "type": "object", "properties": { "LenderFeatures": { "$ref": "#/definitions/LenderFeatures" } } }, "LenderFeatures": { "type": "object", "properties": { "DeliveryAuthorisation": { "$ref": "#/definitions/LenderFeature" }, "LenderResubmission": { "$ref": "#/definitions/LenderFeature" }, "AdditionalInformationRequest": { "$ref": "#/definitions/LenderFeature" }, "MakeLiveWithoutCompletedOrderCapture": { "$ref": "#/definitions/LenderFeature" }, "ApproveOrUpdatePayoutDetails": { "$ref": "#/definitions/LenderFeature" }, "RejectPayoutDetails": { "$ref": "#/definitions/LenderFeature" }, "ReviewCreditUpliftRequest": { "$ref": "#/definitions/LenderFeature" }, "UltimateBeneficialOwners": { "$ref": "#/definitions/LenderFeature" } } }, "LenderFeature": { "type": "object", "properties": { "Supported": { "type": "boolean" }, "Available": { "type": "boolean" }, "DisplayText": { "type": "string" }, "AvailableOptions": { "type": "array", "items": { "$ref": "#/definitions/LenderFeatureAvailableOption" } } } }, "LenderFeatureAvailableOption": { "type": "object", "properties": { "Value": { "type": "string" }, "DisplayText": { "type": "string" } } }, "TriggerIdentityVerificationResponse": { "type": "object", "properties": {} }, "GetFinanceApplicationCurrentIdentityVerificationResponse": { "type": "object", "properties": { "Provider": { "type": "string" }, "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Status": { "type": "string" }, "IsCompleted": { "type": "boolean" }, "Url": { "type": "string" }, "DisplayProvider": { "type": "string" }, "CurrentStatus": { "$ref": "#/definitions/IdentificationVerificationStatus" } } }, "IdentificationVerificationStatus": { "type": "object", "properties": { "ExternalStatus": { "type": "string" }, "Status": { "type": "string" }, "DisplayName": { "type": "string" }, "Note": { "type": "string" } } }, "ESignResponse": { "type": "object", "properties": { "Esigns": { "type": "array", "items": { "$ref": "#/definitions/ESignDetails" } } } }, "ESignDetails": { "type": "object", "properties": { "Url": { "type": "string" }, "UrlType": { "type": "string" }, "Name": { "type": "string" }, "StatusDetails": { "$ref": "#/definitions/ESignStatus" }, "Reference": { "type": "string" }, "SupportsInStoreSigning": { "type": "boolean" }, "SupportsRemoteSigning": { "type": "boolean" } } }, "ESignStatus": { "type": "object", "properties": { "DisplayName": { "type": "string" }, "Type": { "type": "string" } } }, "DocumentsResponse": { "type": "object", "properties": { "Documents": { "type": "array", "items": { "$ref": "#/definitions/Document" } }, "AllowDocumentGeneration": { "type": "boolean" }, "ShowVinVrmEntry": { "type": "boolean" } } }, "Document": { "type": "object", "properties": { "Type": { "type": "string" }, "Description": { "type": "string" }, "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "DocumentAddedAt": { "format": "date-time", "type": "string" }, "DownloadLink": { "type": "string" }, "IsESignCompatible": { "type": "boolean" }, "IsCustomerSignable": { "type": "boolean" }, "IsRetailerSignable": { "type": "boolean" }, "SigningStatus": { "enum": [ "Unknown", "Unsigned", "Signed", "Partial" ], "type": "string" }, "RequiredActions": { "type": "array", "items": { "enum": [ "Unknown", "ReadInFull" ], "type": "string" } }, "Applicants": { "type": "array", "items": { "$ref": "#/definitions/DocumentApplicant" } }, "CounterSigningStatus": { "enum": [ "Unknown", "Unsigned", "Signed", "Partial" ], "type": "string" }, "ApplicantSigningStatus": { "enum": [ "Unknown", "Unsigned", "Signed", "Partial" ], "type": "string" } } }, "DocumentApplicant": { "type": "object", "properties": { "ApplicantReference": { "type": "string" }, "Actions": { "type": "array", "items": { "$ref": "#/definitions/ApplicantAction" } }, "SigningStatus": { "enum": [ "Unknown", "Unsigned", "Signed", "Partial" ], "type": "string" }, "ApplicantName": { "type": "string" } } }, "ApplicantAction": { "type": "object", "properties": { "ActionType": { "enum": [ "Unknown", "ReadInFull" ], "type": "string" }, "IsRequired": { "type": "boolean" }, "IsCompleted": { "type": "boolean" } } }, "AdditionalInformationRequest": { "type": "object", "properties": { "Title": { "type": "string" }, "Description": { "type": "string" }, "SnoozeProposalFromWorkQueueUntil": { "format": "date-time", "type": "string" } } }, "AdditionalInformationRequestResponse": { "type": "object", "properties": {} }, "SaveOrUpdateFinanceApplicationIntegrationRequest": { "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Url": { "type": "string" }, "Name": { "type": "string" }, "StringIdentifier": { "type": "string" }, "Type": { "format": "int32", "type": "integer" }, "Environment": { "type": "string" }, "DestinationReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Parameters": { "type": "array", "items": { "$ref": "#/definitions/IntegrationParameter" } } } }, "IntegrationParameter": { "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Key": { "type": "string" }, "Value": { "type": "string" }, "Description": { "type": "string" }, "IsOverridable": { "type": "boolean" } } }, "GetLenderWorkQueuesResponse": { "type": "object", "properties": { "WorkQueues": { "type": "array", "items": { "$ref": "#/definitions/LenderWorkQueue" } } } }, "LenderWorkQueue": { "type": "object", "properties": { "Reference": { "type": "string" }, "Name": { "type": "string" }, "TotalResults": { "format": "int32", "type": "integer" } } }, "LenderWorkQueueItemsByWorkQueueIdRequest": { "type": "object", "properties": { "WorkQueueReference": { "type": "string" }, "Page": { "format": "int32", "type": "integer" }, "ResultsPerPage": { "format": "int32", "type": "integer" }, "Filters": { "$ref": "#/definitions/LenderWorkQueueItemsByWorkQueueIdRequestFilters" }, "SortBy": { "enum": [ "OldestFirst", "NotSnoozedThenOldestFirst" ], "type": "string" } } }, "LenderWorkQueueItemsByWorkQueueIdRequestFilters": { "type": "object", "properties": { "Snoozed": { "enum": [ "NotSnoozed", "All" ], "type": "string" } } }, "LenderWorkQueueItemsByWorkQueueIdResponse": { "type": "object", "properties": { "ItemSummaries": { "type": "array", "items": { "$ref": "#/definitions/WorkQueueLenderProposalSummary" } }, "Page": { "format": "int32", "type": "integer" }, "ResultsPerPage": { "format": "int32", "type": "integer" }, "TotalPages": { "format": "int32", "type": "integer" }, "TotalResults": { "format": "int32", "type": "integer" }, "SortBy": { "enum": [ "OldestFirst", "NotSnoozedThenOldestFirst" ], "type": "string" } } }, "WorkQueueLenderProposalSummary": { "type": "object", "properties": { "LenderProposal": { "$ref": "#/definitions/LenderProposalSummaryV2" }, "AddedToQueue": { "format": "date-time", "type": "string" } } }, "LenderProposalSummaryV2": { "type": "object", "properties": { "LenderProposalReference": { "type": "string" }, "ProposalReference": { "type": "string" }, "LenderProposalSubmittedAt": { "format": "date-time", "type": "string" }, "ProposalCreatedAt": { "format": "date-time", "type": "string" }, "LenderProposalStatus": { "type": "string" }, "RetailerTradingName": { "type": "string" }, "FinanceProduct": { "type": "string" }, "Source": { "type": "string" }, "AssignedRetailerUser": { "$ref": "#/definitions/LenderProposalSummaryUser" }, "ProposalId": { "format": "int32", "type": "integer" }, "ExternalLenderReference": { "type": "string" }, "PrimaryApplicant": { "$ref": "#/definitions/LenderProposalSummaryApplicant" }, "AssignedLenderUser": { "$ref": "#/definitions/LenderProposalSummaryUser" }, "ProposalOriginEntries": { "type": "array", "items": { "$ref": "#/definitions/ProposalOriginEntry" } } } }, "LenderProposalSummaryUser": { "type": "object", "properties": { "Reference": { "type": "string" }, "Forename": { "type": "string" }, "Surname": { "type": "string" } } }, "LenderProposalSummaryApplicant": { "type": "object", "properties": { "Name": { "type": "string" }, "ApplicantType": { "format": "int32", "type": "integer" } } }, "ProposalOriginEntry": { "type": "object", "properties": { "Type": { "enum": [ "Unknown", "Source", "Medium", "Campaign", "Term", "Content" ], "type": "string" }, "Value": { "type": "string" }, "DisplayValue": { "type": "string" } } }, "SnoozeWorkQueueItemRequest": { "type": "object", "properties": { "SnoozeUntil": { "format": "date-time", "type": "string" } } }, "GetWorkQueueItemDetailsResponse": { "type": "object", "properties": { "WorkQueueReference": { "type": "string" }, "SnoozedUntil": { "format": "date-time", "type": "string" } } }, "UpdateUltimateBeneficialOwnerRequest": { "type": "object", "properties": { "UltimateBeneficialOwners": { "type": "array", "items": { "$ref": "#/definitions/UltimateBeneficialOwner" } } } }, "UltimateBeneficialOwner": { "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "ExternalIdentifier": { "type": "string" }, "Title": { "type": "string" }, "Name": { "type": "string" }, "DateOfBirth": { "type": "string" }, "Address": { "type": "string" }, "Nationality": { "type": "string" }, "LexisNexisMatchFound": { "type": "string" } } }, "UltimateBeneficialOwnersResponse": { "type": "object", "properties": { "UltimateBeneficialOwners": { "type": "array", "items": { "$ref": "#/definitions/UltimateBeneficialOwner" } } } }, "FinanceApplicationSubmissionsSearchRequest": { "required": [ "Page", "ResultsPerPage" ], "type": "object", "properties": { "Page": { "format": "int32", "maximum": 2147483647, "minimum": 1, "type": "integer" }, "ResultsPerPage": { "format": "int32", "maximum": 100, "minimum": 1, "type": "integer" }, "OrderBy": { "enum": [ "Unknown", "Ascending", "Descending" ], "type": "string" }, "Filters": { "$ref": "#/definitions/TimelineFilters" } } }, "TimelineFilters": { "type": "object", "properties": { "AuditEventType": { "enum": [ "AppendQuote", "ProposalFormDetails", "TaskDocumentPrint", "LenderPayoutSubmission", "ActiveQuoteSet", "UnderwriterResponse", "ProposalEntity", "DuplicateQuote", "UnderwritingSubmission", "ProposalTransfer", "Document", "EsignDocumentSubmissionToLender", "KnowledgeBasedAuthentication", "StatusUpdate", "CreateProposal", "ESign", "LenderProposalSynchronizationCheck", "LenderProposalSynchronized", "SoftSearch", "DmsSubmission", "ProposalWebhook", "PersonalInformationUpdate", "OrderCompletion", "ExternalCall", "Note", "PartExchange", "IdentityCheck", "RemoteApply", "Payment", "RetailerDocument", "CustomerDocument", "ManualStatusOverride", "LenderProposalStatusPush", "FraudCheckStatusPush", "NotTakenUp", "HardCreditCheckSynchronizationCheck", "HardCreditCheckSynchronized", "LenderDocumentSynchronizationCheck", "LenderDocumentSynchronized", "PostApplyAction", "EligibilityRateForRisk", "AssignedUser", "LenderProposalAssignedUser", "LenderProposalUnassignedUser", "LenderProposalUpdateAssignedUser", "ProposalTaskInteraction", "FraudCheckNewPhaseSubmission", "DecisionInPrincipleSubmission", "UpdateUltimateBeneficialOwnersDetails", "CustomerEmail", "RetailerEmail", "LenderWorkQueueItemEvent", "LenderWorkQueueSnoozeEvent", "PolicyConsent", "FormSubmitted", "InvoiceExtract", "ContractExtract", "IdentityCheckStatusUpdate", "IdentityCheckDocumentDownload", "Debug_StatusChange", "Debug_Note", "Debug_AdditionalData", "Debug_ProposalTask" ], "type": "string" } } }, "FinanceApplicationTimelineResponse": { "type": "object", "properties": { "Events": { "type": "array", "items": { "$ref": "#/definitions/TimelineEvent" } }, "Page": { "format": "int32", "type": "integer" }, "ResultsPerPage": { "format": "int32", "type": "integer" }, "TotalPages": { "format": "int32", "type": "integer" }, "TotalResults": { "format": "int32", "type": "integer" } } }, "TimelineEvent": { "type": "object", "properties": { "Description": { "type": "string" }, "Details": { "type": "object", "additionalProperties": { "type": "string" } }, "AuditEventType": { "enum": [ "AppendQuote", "ProposalFormDetails", "TaskDocumentPrint", "LenderPayoutSubmission", "ActiveQuoteSet", "UnderwriterResponse", "ProposalEntity", "DuplicateQuote", "UnderwritingSubmission", "ProposalTransfer", "Document", "EsignDocumentSubmissionToLender", "KnowledgeBasedAuthentication", "StatusUpdate", "CreateProposal", "ESign", "LenderProposalSynchronizationCheck", "LenderProposalSynchronized", "SoftSearch", "DmsSubmission", "ProposalWebhook", "PersonalInformationUpdate", "OrderCompletion", "ExternalCall", "Note", "PartExchange", "IdentityCheck", "RemoteApply", "Payment", "RetailerDocument", "CustomerDocument", "ManualStatusOverride", "LenderProposalStatusPush", "FraudCheckStatusPush", "NotTakenUp", "HardCreditCheckSynchronizationCheck", "HardCreditCheckSynchronized", "LenderDocumentSynchronizationCheck", "LenderDocumentSynchronized", "PostApplyAction", "EligibilityRateForRisk", "AssignedUser", "LenderProposalAssignedUser", "LenderProposalUnassignedUser", "LenderProposalUpdateAssignedUser", "ProposalTaskInteraction", "FraudCheckNewPhaseSubmission", "DecisionInPrincipleSubmission", "UpdateUltimateBeneficialOwnersDetails", "CustomerEmail", "RetailerEmail", "LenderWorkQueueItemEvent", "LenderWorkQueueSnoozeEvent", "PolicyConsent", "FormSubmitted", "InvoiceExtract", "ContractExtract", "IdentityCheckStatusUpdate", "IdentityCheckDocumentDownload", "Debug_StatusChange", "Debug_Note", "Debug_AdditionalData", "Debug_ProposalTask" ], "type": "string" }, "Time": { "format": "date-time", "type": "string" }, "UserReference": { "type": "string" }, "UserFullName": { "type": "string" }, "Success": { "type": "boolean" }, "Children": { "type": "array", "items": { "$ref": "#/definitions/TimelineChildEvent" } }, "Category": { "type": "string" } } }, "TimelineChildEvent": { "type": "object", "properties": { "Description": { "type": "string" }, "Details": { "type": "object", "additionalProperties": { "type": "string" } }, "Time": { "format": "date-time", "type": "string" }, "Success": { "type": "boolean" }, "Children": { "type": "array", "items": { "$ref": "#/definitions/TimelineChildEvent" } }, "Category": { "type": "string" } } }, "SearchForLenderProposalsRequest": { "type": "object", "properties": { "Page": { "format": "int32", "type": "integer" }, "ResultsPerPage": { "format": "int32", "type": "integer" }, "Statuses": { "type": "array", "items": { "type": "string" } }, "Query": { "type": "string" } } }, "SearchForLenderProposalsResponse": { "type": "object", "properties": { "LenderProposalSummaries": { "type": "array", "items": { "$ref": "#/definitions/LenderProposalSummary" } }, "LenderProposalSummariesV2": { "type": "array", "items": { "$ref": "#/definitions/LenderProposalSummaryV2" } }, "Page": { "format": "int32", "type": "integer" }, "ResultsPerPage": { "format": "int32", "type": "integer" }, "TotalPages": { "format": "int32", "type": "integer" }, "TotalResults": { "format": "int32", "type": "integer" } } }, "LenderProposalSummary": { "type": "object", "properties": { "LenderProposalReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "LenderReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "ProposalReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "LenderProposalSubmittedAt": { "format": "date-time", "type": "string" }, "ProposalCreatedAt": { "format": "date-time", "type": "string" }, "CurrentLenderProposalStatus": { "type": "string" }, "ExternalLenderReference": { "type": "string" }, "Organisation": { "type": "string" }, "FinanceProduct": { "type": "string" }, "Source": { "type": "string" }, "LenderProposalApplicant": { "$ref": "#/definitions/LenderProposalApplicant" }, "AssignedUnderwriter": { "$ref": "#/definitions/AssignedUnderwriter" }, "AssignedBroker": { "$ref": "#/definitions/AssignedBroker" }, "ProposalId": { "format": "int32", "type": "integer" }, "BusinessApplicantTradingName": { "type": "string" }, "ProposalEntityType": { "type": "string" }, "ProposalOriginEntries": { "type": "array", "items": { "$ref": "#/definitions/ProposalOriginEntry" } } } }, "LenderProposalApplicant": { "type": "object", "properties": { "Forename": { "type": "string" }, "Surname": { "type": "string" } } }, "AssignedUnderwriter": { "type": "object", "properties": { "UserReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Forename": { "type": "string" }, "Surname": { "type": "string" }, "Role": { "type": "string" } } }, "AssignedBroker": { "type": "object", "properties": { "UserReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Forename": { "type": "string" }, "Surname": { "type": "string" } } }, "GetLenderProofSupportedFileExtensionsResponse": { "type": "object", "properties": { "AcceptAnyFileExtension": { "type": "boolean" }, "SupportedFileExtensions": { "type": "array", "items": { "type": "string" } } } }, "BeginOnfidoIdentityVerificationResponse": { "type": "object", "properties": { "Token": { "type": "string" }, "ApplicantId": { "type": "string" } } }, "GetOnfidoIdentityVerificationStatusResponse": { "type": "object", "properties": { "Status": { "type": "string" }, "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CurrentStatus": { "$ref": "#/definitions/IdentityVerificationStatus" } } }, "IdentityVerificationStatus": { "type": "object", "properties": { "ExternalStatus": { "type": "string" }, "Status": { "type": "string" }, "DisplayName": { "type": "string" }, "Note": { "type": "string" } } }, "CreateOnfidoIdentityCheckResponse": { "type": "object", "properties": {} }, "GetFinanceApplicationIdentityVerificationResponse": { "type": "object", "properties": { "Provider": { "type": "string" }, "Status": { "type": "string" }, "IsCompleted": { "type": "boolean" }, "DisplayProvider": { "type": "string" }, "IdentityIdentifier": { "type": "string" }, "UpdatedAt": { "format": "date-time", "type": "string" }, "ExpiresAt": { "format": "date-time", "type": "string" } } }, "GetFinanceApplicationIdentityVerificationProviderResponse": { "type": "object", "properties": { "Provider": { "type": "string" } } }, "GetFinanceApplicationExternalPortalsResponse": { "type": "object", "properties": { "ExternalPortals": { "type": "array", "items": { "$ref": "#/definitions/ExternalPortal" } } } }, "ExternalPortal": { "type": "object", "properties": { "Name": { "type": "string" }, "DisplayName": { "type": "string" }, "IsLinkEnabled": { "type": "boolean" } } }, "NavigateToFinanceApplicationExternalPortalResponse": { "type": "object", "properties": { "ExternalPortalUrl": { "type": "string" } } }, "RetrieveESignUrlFromReferenceResponse": { "type": "object", "properties": { "ESignUrl": { "type": "string" } } }, "RetrieveESignDocumentsForResponse": { "type": "object", "properties": { "Documents": { "type": "array", "items": { "$ref": "#/definitions/ESignDocumentForSigning" } } } }, "ESignDocumentForSigning": { "type": "object", "properties": { "SigningUrl": { "type": "string" }, "SigningStatus": { "enum": [ "Unknown", "Unsigned", "Signed", "Partial" ], "type": "string" }, "ClientId": { "type": "string" }, "IsTestMode": { "type": "boolean" } } }, "SendDocumentToCustomerRequest": { "type": "object", "properties": { "ESignJourney": { "enum": [ "Unknown", "RemoteSign", "SignOnPremise" ], "type": "string" } } }, "SendDocumentToCustomerResponse": { "type": "object", "properties": {} }, "LenderProposalDetailsResponse": { "type": "object", "properties": { "Proposal": { "$ref": "#/definitions/ProposalDetailsResponse" }, "LenderProposalDecisions": { "type": "array", "items": { "$ref": "#/definitions/Decision" } }, "ApplicantsCreditSearchData": { "type": "array", "items": { "$ref": "#/definitions/ApplicantCreditSearchData" } }, "OrganisationsCreditSearchData": { "type": "array", "items": { "$ref": "#/definitions/OrganisationCreditSearchData" } }, "LenderApplicationIdentifier": { "type": "string" }, "LenderStringIdentifier": { "type": "string" }, "CreditLimit": { "format": "double", "type": "number" }, "HunterScoreResponse": { "$ref": "#/definitions/HunterScoreResponse" }, "LenderFeatures": { "$ref": "#/definitions/LenderFeatures" } } }, "Decision": { "type": "object", "properties": { "CreditSearchDataFields": { "type": "array", "items": { "$ref": "#/definitions/LenderCreditSearchDataField" } } } }, "ApplicantCreditSearchData": { "type": "object", "properties": { "CreditSearchDataFields": { "type": "array", "items": { "$ref": "#/definitions/LenderCreditSearchDataField" } }, "ApplicantReference": { "type": "string" } } }, "OrganisationCreditSearchData": { "type": "object", "properties": { "CreditSearchDataFields": { "type": "array", "items": { "$ref": "#/definitions/LenderCreditSearchDataField" } } } }, "HunterScoreResponse": { "type": "object", "properties": { "HunterRiskScore": { "type": "string" }, "HunterRuleCount": { "type": "string" }, "HunterErrorResponse": { "type": "string" }, "HunterRiskGrading": { "type": "string" } } }, "LenderCreditSearchDataField": { "type": "object", "properties": { "DisplayName": { "type": "string" }, "Value": { "type": "string" }, "Description": { "type": "string" }, "Section": { "type": "string" } } }, "DeliveryAuthorisationResponse": { "type": "object", "properties": { "LenderProposalReference": { "type": "string" } } }, "GetFinanceApplicationCapabilitiesResponse": { "type": "object", "properties": { "Capabilities": { "type": "array", "items": { "$ref": "#/definitions/Capability" } } } }, "Capability": { "type": "object", "properties": { "Identifier": { "type": "string" }, "DisplayName": { "type": "string" } } }, "AssignLenderProposalToUserRequest": { "type": "object", "properties": { "UserToAssignToApplication": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } }, "AssignLenderProposalToUserResponse": { "type": "object", "properties": { "AssignedLenderProposal": { "$ref": "#/definitions/AssignedLenderProposalOverview" } } }, "AssignedLenderProposalOverview": { "type": "object", "properties": { "LenderProposalReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "UserReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Forename": { "type": "string" }, "Surname": { "type": "string" }, "AssignedAt": { "format": "date-time", "type": "string" }, "Status": { "type": "string" }, "CreatedAt": { "format": "date-time", "type": "string" }, "AgreementNumber": { "type": "string" }, "ProposalReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "ApplicantForename": { "type": "string" }, "ApplicantSurname": { "type": "string" }, "BusinessDisplayName": { "type": "string" } } }, "UpdateAssignedUserForLenderProposalResponse": { "type": "object", "properties": { "AssignedLenderProposal": { "$ref": "#/definitions/AssignedLenderProposalOverview" } } }, "UnassignLenderProposalFromUserResponse": { "type": "object", "properties": {} }, "LenderProposalAssignationAuditedEventsResponse": { "type": "object", "properties": { "LenderProposalReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Events": { "type": "array", "items": { "$ref": "#/definitions/AssignedLenderProposalEvent" } } } }, "AssignedLenderProposalEvent": { "type": "object", "properties": { "OccurredAt": { "format": "date-time", "type": "string" }, "UserReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Forename": { "type": "string" }, "Surname": { "type": "string" }, "Event": { "type": "string" }, "AffectedUser": { "$ref": "#/definitions/SubjectUser" } } }, "SubjectUser": { "type": "object", "properties": { "UserReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Forename": { "type": "string" }, "Surname": { "type": "string" } } }, "FinanceApplicationAssetUpdateRequest": { "type": "object", "properties": { "Vin": { "type": "string" }, "Vrm": { "type": "string" } } }, "ProposalResponse": { "type": "object", "properties": { "Proposal": { "$ref": "#/definitions/ProposalDetails" } } }, "ProposalDetails": { "type": "object", "properties": { "Description": { "type": "string" }, "ShortReference": { "type": "string" }, "CreatedAt": { "format": "date-time", "type": "string" }, "Status": { "enum": [ "Proposed", "WaitingFurtherInformation", "Approved", "ConditionallyApproved", "Referred", "SubmissionFailed", "CompletedDeal", "NotTakenUp", "Quote", "SystemIntermediate", "UnableToAssist", "AwaitingResubmission", "BrokerAccepted", "BrokerNTU", "BrokerPaidOut", "BrokerProcessingPayout", "BrokerReqFurtherInfo", "Cancelled", "ReferredToBroker", "ReferredToUnderwriter", "Reproposed", "AwaitingDocuments", "PendingPayout", "RejectedAtPayout", "DeliveryAuthorised", "UnrecoverableError", "MadeLiveInQuery", "DocumentPackApproved", "AwaitingDeliveryAuthorisation" ], "type": "string" }, "Entity": { "enum": [ "Unknown", "OtherCorporate", "Association", "Corporate", "LimitedCompany", "LimitedLiabilityPartnership", "LocalAuthority", "NHSTrust", "Partnership", "PLC", "PrivateIndividual", "RegisteredCharity", "School", "SelfEmployed", "SoleTrader", "PrivateLimitedCompany", "GovernmentOrganisation", "UnlimitedCompany", "ForeignCompany", "RoyalCharter", "SmallPartnership", "LargePartnership", "EducationalOrganisation", "PrivateCompanyLimitedbyShares", "DesignatedActivityCompany", "DesignatedActivityCompanyLimitedbyGuarantee", "CompanyLimitedbyGuarantee", "SingleMemberCompany", "IndustrialAndProvidentSociety", "FriendlySociety", "TradeUnion", "Specialfund", "UndertakingsforCollectiveInvestmentInTransferableSecurities", "EuropeanEconomicInterestGroupings", "SocietasEuropaea", "OtherLegalFormROI", "OtherLegalForm", "OtherNonLegalForm", "OtherNonIncorporated" ], "type": "string" }, "Applicants": { "type": "array", "items": { "$ref": "#/definitions/Applicant" } }, "Business": { "$ref": "#/definitions/Business" }, "BankDetails": { "$ref": "#/definitions/BankDetails" }, "OriginalReferrer": { "type": "string" }, "Affordability": { "$ref": "#/definitions/Affordability" }, "Origins": { "description": "If UTM parameters were set, they will be returned here", "type": "array", "items": { "$ref": "#/definitions/ProposalOrigin" } }, "SourceApplication": { "description": "Possible values: \"Apply\", \"Check\", \"Reserve\", \"PartExchange\", \"WEB\"", "type": "string" } } }, "Applicant": { "type": "object", "properties": { "Title": { "type": "string" }, "Forename": { "type": "string" }, "Middlename": { "type": "string" }, "Surname": { "type": "string" }, "DateOfBirth": { "format": "date-time", "type": "string" }, "Dependents": { "format": "int32", "type": "integer" }, "TelephoneNumber": { "type": "string" }, "MobileNumber": { "type": "string" }, "EmailAddress": { "type": "string" }, "AddressHistory": { "type": "array", "items": { "$ref": "#/definitions/ApplicantAddress" } }, "EmploymentHistory": { "type": "array", "items": { "$ref": "#/definitions/Employment" } }, "Gender": { "enum": [ "Unknown", "Male", "Female", "NonBinary", "Unspecified" ], "type": "string" }, "MaritalStatus": { "enum": [ "Unknown", "Single", "Married", "Divorced", "Widowed", "Separated", "Cohabiting", "LivingWithPartner", "CivilPartnership" ], "type": "string" }, "Identifications": { "type": "array", "items": { "$ref": "#/definitions/Identification" } }, "HighNetWorth": { "type": "boolean" }, "PurchasingForBusinessUse": { "type": "boolean" }, "Nationality": { "$ref": "#/definitions/Nationality" } } }, "Business": { "type": "object", "properties": { "RegisteredName": { "type": "string" }, "TelephoneNumber": { "type": "string" }, "FaxNumber": { "type": "string" }, "NumberOfPartners": { "format": "int32", "type": "integer" }, "BusinessOwners": { "type": "array", "items": { "$ref": "#/definitions/ProposalBusinessOwner" } }, "TradingName": { "type": "string" }, "AddressHistory": { "type": "array", "items": { "$ref": "#/definitions/ProposalBusinessAddress" } }, "DateEstablished": { "format": "date-time", "type": "string" }, "CompanyRegistrationNumber": { "type": "string" }, "VatNumber": { "type": "string" }, "Email": { "type": "string" }, "Type": { "type": "string" } } }, "BankDetails": { "type": "object", "properties": { "BankName": { "type": "string" }, "Branch": { "type": "string" }, "Address": { "type": "string" }, "Sortcode": { "type": "string" }, "AccountNumber": { "type": "string" }, "AccountType": { "enum": [ "Unknown", "Current", "Deposit", "Other", "Postal", "TBA" ], "type": "string" }, "AccountName": { "type": "string" }, "YearsAtBank": { "format": "int32", "type": "integer" }, "Iban": { "type": "string" } } }, "Affordability": { "type": "object", "properties": { "GrossAnnualSalary": { "format": "double", "type": "number" }, "ReplacementLoan": { "type": "boolean" }, "OptionalIncome": { "format": "double", "type": "number" }, "AdditionalIncome": { "format": "double", "type": "number" }, "MonthlyMortgage": { "format": "double", "type": "number" }, "OtherMonthlyExpenditure": { "format": "double", "type": "number" }, "SecuredLoans": { "format": "double", "type": "number" }, "UnsecuredLoans": { "format": "double", "type": "number" }, "TypicalNetIncomeMonthly": { "format": "double", "type": "number" } } }, "ProposalOrigin": { "type": "object", "properties": { "Type": { "enum": [ "Unknown", "Source", "Medium", "Campaign", "Term", "Content" ], "type": "string" }, "Value": { "type": "string" } } }, "ApplicantAddress": { "type": "object", "properties": { "Tenure": { "enum": [ "Unknown", "Owned", "CouncilTenant", "FurnishedTenant", "LivingWithParents", "UnfurnishedTenant", "Other", "LivingWithPartner", "Tenant", "Homeowner", "OwnerFreehold", "OwnerLeasehold", "Mortgaged", "HousingAssociation", "Lodger", "OwnerShareTransfer", "LivingAbroad" ], "type": "string" }, "YearsAtAddress": { "format": "int32", "type": "integer" }, "MonthsAtAddress": { "format": "int32", "type": "integer" }, "Address": { "$ref": "#/definitions/Address" } } }, "Employment": { "type": "object", "properties": { "CompanyName": { "type": "string" }, "Occupation": { "type": "string" }, "OccupationBasis": { "enum": [ "Unknown", "FullTime", "PartTime", "SelfEmployedFullTime", "SelfEmployedPartTime", "Temporary", "Retired", "Unemployed", "Other", "Permanent", "Contractor", "OwnBusiness", "Student", "WorkingAbroad", "ZeroHoursContract" ], "type": "string" }, "OccupationCategory": { "type": "string" }, "YearsWithEmployer": { "format": "int32", "type": "integer" }, "MonthsWithEmployer": { "format": "int32", "type": "integer" }, "Telephone": { "type": "string" }, "Address": { "$ref": "#/definitions/Address" }, "GrossAnnualSalary": { "format": "double", "type": "number" } } }, "Identification": { "type": "object", "properties": { "Reference": { "type": "string" }, "Type": { "enum": [ "Unknown", "FullDrivingLicence", "ProvisionalDrivingLicence", "IndividualTaxNumber" ], "type": "string" } } }, "Nationality": { "type": "object", "properties": { "Description": { "type": "string" }, "Alpha2Code": { "type": "string" }, "Alpha3Code": { "type": "string" }, "NumericCode": { "type": "string" } } }, "ProposalBusinessOwner": { "type": "object", "properties": { "BusinessOwnerDetails": { "$ref": "#/definitions/BusinessOwnerDetails" }, "AddressHistory": { "type": "array", "items": { "$ref": "#/definitions/ApplicantAddress" } } } }, "ProposalBusinessAddress": { "type": "object", "properties": { "Tenure": { "enum": [ "Unknown", "OwnedOutright", "OwnedMortgaged", "Leased", "Licenced" ], "type": "string" }, "YearsAtAddress": { "format": "int32", "type": "integer" }, "MonthsAtAddress": { "format": "int32", "type": "integer" }, "Address": { "$ref": "#/definitions/Address" } } }, "Address": { "type": "object", "properties": { "HouseNumber": { "type": "string" }, "HouseName": { "type": "string" }, "AddressLine1": { "type": "string" }, "AddressLine2": { "type": "string" }, "AddressLine3": { "type": "string" }, "Town": { "type": "string" }, "Postcode": { "type": "string" }, "County": { "type": "string" } } }, "BusinessOwnerDetails": { "type": "object", "properties": { "Title": { "type": "string" }, "Forename": { "type": "string" }, "Surname": { "type": "string" }, "MiddleName": { "type": "string" }, "HomeTelephone": { "type": "string" }, "MobileTelephone": { "type": "string" }, "Email": { "type": "string" }, "DateOfBirth": { "format": "date-time", "type": "string" }, "Gender": { "type": "string" }, "MaritalStatus": { "type": "string" }, "Dependants": { "format": "int32", "type": "integer" }, "PreviousSurname": { "type": "string" } } }, "FinancePackageOverviewRequest": { "type": "object", "properties": { "Credentials": { "$ref": "#/definitions/FinanceCredentials" } } }, "GetFinanceProductAuditLogResponse": { "type": "object", "properties": { "AuditLog": { "type": "array", "items": { "$ref": "#/definitions/FinanceProductAuditModel" } } } }, "FinanceProductAuditModel": { "type": "object", "properties": { "UserName": { "type": "string" }, "Blob": { "type": "string" }, "OccurredAt": { "format": "date-time", "type": "string" } } }, "GetProductFamiliesResponse": { "type": "object", "properties": { "ProductFamilies": { "type": "array", "items": { "$ref": "#/definitions/ProductFamily" } } } }, "ProductFamily": { "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "Name": { "type": "string" } } }, "SearchLenderProductsResponse": { "type": "object", "properties": { "Results": { "type": "array", "items": { "$ref": "#/definitions/LenderProductSearchResult" } } } }, "LenderProductSearchResult": { "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "Description": { "type": "string" }, "DisplayName": { "type": "string" }, "LenderName": { "type": "string" }, "IsActive": { "type": "boolean" } } }, "GetFleetAgreementStatusesResponse": { "type": "object", "properties": { "Statuses": { "type": "array", "items": { "$ref": "#/definitions/FleetAgreementStatus" } } } }, "FleetAgreementStatus": { "type": "object", "properties": { "Name": { "type": "string" }, "DisplayName": { "type": "string" }, "StatusType": { "enum": [ "Unknown", "RequiresAction", "Success", "Failed" ], "type": "string" }, "Description": { "type": "string" } } }, "CreateFleetAgreementRequest": { "type": "object", "properties": { "FleetCode": { "type": "string" } } }, "CreateFleetAgreementResponse": { "type": "object", "properties": { "Reference": { "type": "string" } } }, "GetFleetAgreementByFleetCodeRequest": { "type": "object", "properties": { "FleetCode": { "type": "string" } } }, "GetFleetAgreementByFleetCodeResponse": { "type": "object", "properties": { "Reference": { "type": "string" }, "FleetCode": { "type": "string" }, "OrganisationReference": { "type": "string" }, "CreatedAt": { "format": "date-time", "type": "string" } } }, "SearchFleetAgreementsRequest": { "type": "object", "properties": { "SearchText": { "type": "string" } } }, "SearchFleetAgreementsResponse": { "type": "object", "properties": { "FleetAgreements": { "type": "array", "items": { "$ref": "#/definitions/FleetAgreement" } } } }, "FleetAgreement": { "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "FleetCode": { "type": "string" }, "OrganisationReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreatedAt": { "format": "date-time", "type": "string" } } }, "GetProposalsByFleetAgreementReferenceResponse": { "type": "object", "properties": { "Proposals": { "type": "array", "items": { "$ref": "#/definitions/ProposalSummaryForFleetAgreement" } } } }, "ProposalSummaryForFleetAgreement": { "type": "object", "properties": { "ProposalReference": { "type": "string" }, "QuoteReference": { "type": "string" }, "ScheduleReference": { "type": "string" }, "ProposalId": { "format": "int32", "type": "integer" }, "Status": { "enum": [ "PendingApproval", "AwaitingVehicleDetails", "AwaitingDocuments", "PendingDocuments", "AwaitingFinalisation", "PendingFinalisation", "CompletedDeal", "RejectedAtPayout", "Rejected" ], "type": "string" } } }, "CreateFleetAgreementScheduleRequest": { "type": "object", "properties": { "ProposalReferences": { "type": "array", "items": { "type": "string" } } } }, "CreateFleetAgreementScheduleResponse": { "type": "object", "properties": { "ScheduleReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } }, "GetFleetAgreementSchedulesResponse": { "type": "object", "properties": { "Schedules": { "type": "array", "items": { "$ref": "#/definitions/FleetAgreementSchedule" } } } }, "FleetAgreementSchedule": { "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreatedAt": { "format": "date-time", "type": "string" } } }, "GetFleetAgreementScheduleDocumentsResponse": { "type": "object", "properties": { "Documents": { "type": "array", "items": { "$ref": "#/definitions/FleetAgreementScheduleDocument" } }, "DocumentSetCreatedAt": { "format": "date-time", "type": "string" }, "ESignLink": { "type": "string" } } }, "FleetAgreementScheduleDocument": { "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Description": { "type": "string" }, "FileName": { "type": "string" }, "CreatedAt": { "format": "date-time", "type": "string" } } }, "GenerateFleetAgreementScheduleDocumentsResponse": { "type": "object", "properties": {} }, "CreateCustomerPolicyRequest": { "type": "object", "properties": { "OrganisationReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } }, "CreateCustomerPolicyResponse": { "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } }, "CustomerPolicySearchRequest": { "type": "object", "properties": { "Page": { "format": "int32", "type": "integer" }, "ResultsPerPage": { "format": "int32", "type": "integer" }, "Query": { "type": "string" } } }, "CustomerPolicySearchResponse": { "type": "object", "properties": { "CustomerPolicySearchSummaries": { "type": "array", "items": { "$ref": "#/definitions/CustomerPolicySearchSummary" } }, "Paging": { "$ref": "#/definitions/Pagination" } } }, "CustomerPolicySearchSummary": { "type": "object", "properties": { "Name": { "type": "string" }, "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CustomerOrganisationReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } }, "UpdateCustomerVehicleRestrictionsRequest": { "type": "object", "properties": { "VehicleRestrictions": { "$ref": "#/definitions/VehicleRestrictionsRequest" } } }, "VehicleRestrictionsRequest": { "type": "object", "properties": { "AllowedFuelTypes": { "$ref": "#/definitions/StringListValueType" }, "AllowedTransmissionTypes": { "$ref": "#/definitions/StringListValueType" }, "AllowedBodyStyles": { "$ref": "#/definitions/StringListValueType" }, "AllowedModels": { "$ref": "#/definitions/StringListValueType" }, "AllowedManufacturers": { "$ref": "#/definitions/StringListValueType" }, "AllowedDerivatives": { "$ref": "#/definitions/StringListValueType" }, "AllowedVehicleTypes": { "$ref": "#/definitions/StringListValueType" }, "AllowedComplexManufacturers": { "$ref": "#/definitions/ComplexManufacturersValueType" }, "MinimumNumberOfSeats": { "$ref": "#/definitions/IntValueType" }, "MaximumNumberOfSeats": { "$ref": "#/definitions/IntValueType" }, "MinimumEvRange": { "$ref": "#/definitions/IntValueType" }, "MaximumCo2EmissionRate": { "$ref": "#/definitions/IntValueType" }, "MaximumEngineSize": { "$ref": "#/definitions/DecimalValueType" }, "MaximumP11DValue": { "$ref": "#/definitions/DecimalValueType" }, "MinimumNumberOfDoors": { "$ref": "#/definitions/IntValueType" }, "MaximumInsuranceGroup": { "$ref": "#/definitions/IntValueType" }, "MinimumSafetyRating": { "$ref": "#/definitions/IntValueType" } } }, "StringListValueType": { "type": "object", "properties": { "Value": { "type": "array", "items": { "type": "string" } } } }, "ComplexManufacturersValueType": { "type": "object", "properties": { "Manufacturers": { "type": "array", "items": { "$ref": "#/definitions/ManufacturerItem" } } } }, "IntValueType": { "type": "object", "properties": { "Value": { "format": "int32", "type": "integer" }, "Unit": { "type": "string" } } }, "DecimalValueType": { "type": "object", "properties": { "Value": { "format": "double", "type": "number" }, "Unit": { "type": "string" } } }, "ManufacturerItem": { "type": "object", "properties": { "Value": { "type": "string" }, "Models": { "type": "array", "items": { "$ref": "#/definitions/ModelItem" } } } }, "ModelItem": { "type": "object", "properties": { "Value": { "type": "string" }, "DerivativeIdentifiers": { "type": "array", "items": { "$ref": "#/definitions/DerivativeIdentifierItem" } } } }, "DerivativeIdentifierItem": { "type": "object", "properties": { "Value": { "type": "string" } } }, "GetCustomerPolicyResponse": { "type": "object", "properties": { "CustomerPolicy": { "$ref": "#/definitions/CustomerPolicy" } } }, "CustomerPolicy": { "type": "object", "properties": { "Schemes": { "type": "array", "items": { "$ref": "#/definitions/Scheme" } }, "CustomerOrganisationReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } }, "Scheme": { "type": "object", "properties": { "Name": { "type": "string" }, "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "VehicleRestrictions": { "$ref": "#/definitions/VehicleRestrictionsResponse" }, "DriverQuote": { "$ref": "#/definitions/DriverQuote" }, "Bands": { "type": "array", "items": { "$ref": "#/definitions/Band" } }, "VehicleDataSet": { "enum": [ "Unknown", "Cap", "Glass", "Codeweavers", "Ids", "Ivs", "Psa", "CapLcv", "Glasses", "Tfs", "PsaComcar", "Autobiz", "Brego" ], "type": "string" }, "WholeLifeCost": { "$ref": "#/definitions/WholeLifeCostScheme" }, "SalarySacrifice": { "$ref": "#/definitions/SalarySacrifice" }, "Type": { "$ref": "#/definitions/SchemeType" }, "Finance": { "$ref": "#/definitions/SchemeFinance" }, "FinanceDisplayTemplate": { "$ref": "#/definitions/PolicyFinanceDisplayTemplate" }, "SchemeVaps": { "type": "array", "items": { "$ref": "#/definitions/SchemeVap" } } } }, "VehicleRestrictionsResponse": { "type": "object", "properties": { "AllowedFuelTypes": { "$ref": "#/definitions/StringListWithOptionsValueType" }, "AllowedTransmissionTypes": { "$ref": "#/definitions/StringListWithOptionsValueType" }, "AllowedBodyStyles": { "$ref": "#/definitions/StringListWithOptionsValueType" }, "AllowedModels": { "$ref": "#/definitions/StringListWithOptionsValueType" }, "AllowedManufacturers": { "$ref": "#/definitions/StringListWithOptionsValueType" }, "AllowedDerivatives": { "$ref": "#/definitions/StringListWithOptionsValueType" }, "AllowedVehicleTypes": { "$ref": "#/definitions/StringListWithOptionsValueType" }, "AllowedComplexManufacturers": { "$ref": "#/definitions/ComplexManufacturersValueType" }, "MinimumNumberOfSeats": { "$ref": "#/definitions/IntValueType" }, "MaximumNumberOfSeats": { "$ref": "#/definitions/IntValueType" }, "MinimumEvRange": { "$ref": "#/definitions/IntValueType" }, "MaximumCo2EmissionRate": { "$ref": "#/definitions/IntValueType" }, "MaximumEngineSize": { "$ref": "#/definitions/DecimalValueType" }, "MaximumP11DValue": { "$ref": "#/definitions/DecimalValueType" }, "MinimumNumberOfDoors": { "$ref": "#/definitions/IntValueType" }, "MaximumInsuranceGroup": { "$ref": "#/definitions/IntValueType" }, "MinimumSafetyRating": { "$ref": "#/definitions/IntValueType" } } }, "DriverQuote": { "type": "object", "properties": { "AnnualMileagesAndTerms": { "type": "array", "items": { "$ref": "#/definitions/AnnualMileageAndTerms" } }, "AnnualMileageAndTermRanges": { "$ref": "#/definitions/AnnualMileageAndTermRanges" }, "CostToDriverRentalType": { "enum": [ "Unknown", "NetRental", "GrossRentalDisallowedVat", "WholeLifeCostRental", "NetSalarySacrifice", "GrossSalarySacrifice" ], "type": "string" } } }, "Band": { "type": "object", "properties": { "Name": { "type": "string" }, "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "VehicleRestrictions": { "$ref": "#/definitions/VehicleRestrictionsResponse" }, "WholeLifeCost": { "$ref": "#/definitions/WholeLifeCostBand" }, "DriverQuote": { "$ref": "#/definitions/DriverQuote" }, "Finance": { "$ref": "#/definitions/BandFinance" }, "FinanceDisplayTemplate": { "$ref": "#/definitions/PolicyFinanceDisplayTemplate" } } }, "WholeLifeCostScheme": { "type": "object", "properties": { "IncludeFinanceRental": { "type": "boolean" }, "IncludeServiceRental": { "type": "boolean" }, "IncludeFuelRate": { "type": "boolean" }, "IncludeInsurance": { "type": "boolean" }, "IncludeLeaseRentalRestriction": { "type": "boolean" }, "IncludeNationalInsuranceLiability": { "type": "boolean" }, "IncludeDisallowedVat": { "type": "boolean" }, "VatRecoveryRate": { "format": "double", "type": "number" }, "BusinessMileagePercentage": { "format": "double", "type": "number" }, "FuelRateReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "IncludeOutOfRentalAdditionalMonthlyCosts": { "type": "boolean" } } }, "SalarySacrifice": { "type": "object", "properties": { "ShareNationalInsuranceLiability": { "type": "boolean" }, "NationalInsuranceSavingPercentage": { "format": "double", "type": "number" }, "VatRecoveryRate": { "format": "double", "type": "number" } } }, "SchemeType": { "type": "object", "properties": { "Value": { "type": "string" }, "DisplayValue": { "type": "string" }, "ProductFamilyKey": { "type": "string" } } }, "SchemeFinance": { "type": "object", "properties": { "ProductId": { "format": "int32", "type": "integer" }, "Unit": { "type": "string" }, "OutOfRentalAdditionalMonthlyCosts": { "type": "array", "items": { "$ref": "#/definitions/OutOfRentalAdditionalMonthlyCost" } }, "ResidualOverlay": { "format": "double", "type": "number" } } }, "PolicyFinanceDisplayTemplate": { "type": "object", "properties": { "Blocks": { "type": "array", "items": { "$ref": "#/definitions/FinanceDisplayBlock" } }, "Reason": { "type": "string" } } }, "SchemeVap": { "type": "object", "properties": { "VapTemplateReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "VapFields": { "type": "array", "items": { "$ref": "#/definitions/SchemeVapFields" } } } }, "StringListWithOptionsValueType": { "type": "object", "properties": { "Value": { "type": "array", "items": { "type": "string" } }, "Options": { "type": "array", "items": { "$ref": "#/definitions/StringListOptions" } } } }, "AnnualMileageAndTerms": { "type": "object", "properties": { "AnnualMileage": { "format": "int32", "type": "integer" }, "Terms": { "type": "array", "items": { "format": "int32", "type": "integer" } } } }, "AnnualMileageAndTermRanges": { "type": "object", "properties": { "AnnualMileageMinimum": { "format": "int32", "type": "integer" }, "AnnualMileageMaximum": { "format": "int32", "type": "integer" }, "TermMinimum": { "format": "int32", "type": "integer" }, "TermMaximum": { "format": "int32", "type": "integer" } } }, "WholeLifeCostBand": { "type": "object", "properties": { "BusinessMileagePercentage": { "format": "double", "type": "number" }, "FuelRateReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } }, "BandFinance": { "type": "object", "properties": { "OutOfRentalAdditionalMonthlyCosts": { "type": "array", "items": { "$ref": "#/definitions/OutOfRentalAdditionalMonthlyCost" } }, "Unit": { "type": "string" } } }, "OutOfRentalAdditionalMonthlyCost": { "type": "object", "properties": { "Label": { "type": "string" }, "Value": { "format": "double", "type": "number" } } }, "SchemeVapFields": { "type": "object", "properties": { "VehicleType": { "enum": [ "Unknown", "Car", "Lcv", "Bike", "Other", "NonVehicleAsset", "Hgv", "LastElement" ], "type": "string" }, "Fields": { "type": "object", "additionalProperties": { "type": "string" } } } }, "StringListOptions": { "type": "object", "properties": { "Value": { "type": "string", "readOnly": true }, "DisplayValue": { "type": "string", "readOnly": true } } }, "GetCustomerPolicyAvailableDataSetsResponse": { "type": "object", "properties": { "AvailableVehicleDataSets": { "type": "array", "items": { "$ref": "#/definitions/AvailableVehicleDataSet" } } } }, "AvailableVehicleDataSet": { "type": "object", "properties": { "Value": { "type": "string" }, "DisplayValue": { "type": "string" } } }, "GetSchemeTypesResponse": { "type": "object", "properties": { "SchemeTypes": { "type": "array", "items": { "$ref": "#/definitions/SchemeType" } } } }, "GetPolicyTimelineResponse": { "type": "object", "properties": { "Events": { "type": "array", "items": { "$ref": "#/definitions/PolicyEvents" } }, "NextCursor": { "type": "string" }, "PreviousCursor": { "type": "string" } } }, "PolicyEvents": { "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "EventType": { "type": "string" }, "OccurredAt": { "format": "date-time", "type": "string" }, "Data": { "type": "string" }, "Version": { "format": "int64", "type": "integer" }, "State": { "$ref": "#/definitions/CustomerPolicy" }, "UserReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Username": { "type": "string" } } }, "GetTimelineEventTypesResponse": { "type": "object", "properties": { "EventTypes": { "type": "array", "items": { "type": "string" } } } }, "CreateSchemeRequest": { "type": "object", "properties": { "Scheme": { "$ref": "#/definitions/CreateScheme" } } }, "CreateScheme": { "type": "object", "properties": { "Name": { "type": "string" }, "VehicleDataSet": { "enum": [ "Unknown", "Cap", "Glass", "Codeweavers", "Ids", "Ivs", "Psa", "CapLcv", "Glasses", "Tfs", "PsaComcar", "Autobiz", "Brego" ], "type": "string" }, "SchemeType": { "enum": [ "Unknown", "CompanyCar", "SalarySacrifice" ], "type": "string" }, "Finance": { "$ref": "#/definitions/SchemeFinance" } } }, "CreateSchemeResponse": { "type": "object", "properties": { "Scheme": { "$ref": "#/definitions/CreatedScheme" } } }, "CreatedScheme": { "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } }, "GetSchemeResponse": { "type": "object", "properties": { "Scheme": { "$ref": "#/definitions/Scheme" } } }, "UpdateSchemeRequest": { "type": "object", "properties": { "Scheme": { "$ref": "#/definitions/UpdateScheme" } } }, "UpdateScheme": { "type": "object", "properties": { "Name": { "type": "string" } } }, "UpdateSchemeResponse": { "type": "object", "properties": { "Scheme": { "$ref": "#/definitions/UpdatedScheme" } } }, "UpdatedScheme": { "type": "object", "properties": { "Name": { "type": "string" }, "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } }, "UpdateSchemeVehicleRestrictionsRequest": { "type": "object", "properties": { "VehicleRestrictions": { "$ref": "#/definitions/VehicleRestrictionsRequest" } } }, "UpdateSchemeDriverQuoteRequest": { "type": "object", "properties": { "DriverQuote": { "$ref": "#/definitions/DriverQuote" } } }, "UpdateSchemeWholeLifeCostSettings": { "type": "object", "properties": { "Settings": { "$ref": "#/definitions/WholeLifeCostScheme" } } }, "UpdateSchemeSalarySacrificeSettings": { "type": "object", "properties": { "Settings": { "$ref": "#/definitions/SalarySacrifice" } } }, "UpdateSchemeFinance": { "type": "object", "properties": { "Finance": { "$ref": "#/definitions/SchemeFinance" } } }, "GetCostToDriverRentalTypeResponse": { "type": "object", "properties": { "CostToDriverRentalType": { "type": "array", "items": { "$ref": "#/definitions/CostToDriverRentalType" } } } }, "CostToDriverRentalType": { "type": "object", "properties": { "Value": { "type": "string" }, "DisplayValue": { "type": "string" } } }, "UpdateSchemeVapsRequest": { "type": "object", "properties": { "SchemeVaps": { "type": "array", "items": { "$ref": "#/definitions/SchemeVap" } } } }, "UpdateSchemeFinanceDisplayTemplateRequest": { "type": "object", "properties": { "Template": { "$ref": "#/definitions/PolicyFinanceDisplayTemplate" } } }, "SchemesResponse": { "type": "object", "properties": { "Schemes": { "type": "array", "items": { "$ref": "#/definitions/SchemeSummary" } } } }, "SchemeSummary": { "type": "object", "properties": { "Name": { "type": "string" }, "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Description": { "type": "string" }, "Type": { "$ref": "#/definitions/SchemeType" } } }, "AssignBandToDriverRequest": { "type": "object", "properties": { "BandReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "SchemeReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "PolicyReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } }, "PaginatedDriverSearchRequest": { "type": "object", "properties": { "Page": { "format": "int32", "maximum": 2147483647, "minimum": 1, "type": "integer" }, "ResultsPerPage": { "format": "int32", "maximum": 100, "minimum": 1, "type": "integer" }, "Query": { "type": "string" } } }, "PaginatedDriverSearchResponse": { "type": "object", "properties": { "Drivers": { "type": "array", "items": { "$ref": "#/definitions/DriverSummary" } }, "Paging": { "$ref": "#/definitions/Pagination" } } }, "DriverSummary": { "type": "object", "properties": { "Name": { "type": "string" }, "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Schemes": { "type": "array", "items": { "$ref": "#/definitions/DriverSchemeSummary" } } } }, "DriverSchemeSummary": { "type": "object", "properties": { "Name": { "type": "string" }, "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Band": { "$ref": "#/definitions/DriverBandSummary" } } }, "DriverBandSummary": { "type": "object", "properties": { "Name": { "type": "string" }, "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } }, "AssignDriversToBandRequest": { "type": "object", "properties": { "SchemeReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "PolicyReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "UserReferences": { "type": "array", "items": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } } }, "UnassignDriversFromBandRequest": { "type": "object", "properties": { "UserReferences": { "type": "array", "items": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } } }, "UpdateBandFinanceDisplayTemplateRequest": { "type": "object", "properties": { "Template": { "$ref": "#/definitions/PolicyFinanceDisplayTemplate" } } }, "CreateBandRequest": { "type": "object", "properties": { "Band": { "$ref": "#/definitions/CreateBand" } } }, "CreateBand": { "type": "object", "properties": { "Name": { "type": "string" } } }, "CreateBandResponse": { "type": "object", "properties": { "Band": { "$ref": "#/definitions/CreatedBand" } } }, "CreatedBand": { "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } }, "GetBandResponse": { "type": "object", "properties": { "Band": { "$ref": "#/definitions/Band" } } }, "UpdateBandRequest": { "type": "object", "properties": { "Band": { "$ref": "#/definitions/UpdateBand" } } }, "UpdateBand": { "type": "object", "properties": { "Name": { "type": "string" } } }, "UpdateBandResponse": { "type": "object", "properties": { "Band": { "$ref": "#/definitions/UpdatedBand" } } }, "UpdatedBand": { "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Name": { "type": "string" } } }, "UpdateBandVehicleRestrictionsRequest": { "type": "object", "properties": { "VehicleRestrictions": { "$ref": "#/definitions/VehicleRestrictionsRequest" } } }, "UpdateBandWholeLifeCostSettings": { "type": "object", "properties": { "Settings": { "$ref": "#/definitions/WholeLifeCostBand" } } }, "UpdateBandDriverQuoteRequest": { "type": "object", "properties": { "DriverQuote": { "$ref": "#/definitions/DriverQuote" } } }, "UpdateBandFinanceRequest": { "type": "object", "properties": { "Finance": { "$ref": "#/definitions/BandFinance" } } }, "RetrieveFordMappingsResponse": { "type": "object", "properties": { "Mappings": { "type": "array", "items": { "$ref": "#/definitions/FordMapping" } }, "FordDescriptions": { "type": "array", "items": { "type": "string" } }, "UnusedFordDescriptions": { "type": "array", "items": { "type": "string" } } } }, "FordMapping": { "type": "object", "properties": { "FordDescription": { "type": "string" }, "CapShortCode": { "format": "int32", "type": "integer" }, "Derivative": { "type": "string" }, "Model": { "type": "string" }, "ModelYear": { "type": "string" }, "PotentialFordDescription": { "$ref": "#/definitions/PotentialFordMapping" } } }, "PotentialFordMapping": { "type": "object", "properties": { "PotentialMatch": { "type": "string" }, "HasPotentialMatch": { "type": "boolean" } } }, "SaveFordMappingRequest": { "type": "object", "properties": { "FordMapping": { "$ref": "#/definitions/FordMapping" } } }, "SaveFordMappingResponse": { "type": "object", "properties": { "Message": { "type": "string" } } }, "FormsResponse": { "type": "object", "properties": { "Forms": { "type": "array", "items": { "$ref": "#/definitions/Form" } } } }, "Form": { "type": "object", "properties": { "Reference": { "type": "string" }, "Description": { "type": "string" } } }, "ApiForm": { "type": "object", "properties": { "Sections": { "type": "array", "items": { "$ref": "#/definitions/Section" } }, "Reason": { "type": "string" } } }, "Section": { "type": "object", "properties": { "Fields": { "type": "array", "items": { "$ref": "#/definitions/Field" } }, "Key": { "type": "string" }, "PrimaryLabel": { "type": "string" }, "SecondaryLabel": { "type": "string" }, "HeaderType": { "type": "string" }, "Navigability": { "type": "string" }, "ApplicantType": { "enum": [ "Unknown", "Primary", "Secondary", "Both" ], "type": "string" } } }, "Field": { "type": "object", "properties": { "Key": { "type": "string" }, "Label": { "type": "string" }, "ApplicantType": { "enum": [ "Unknown", "Primary", "Secondary", "Both" ], "type": "string" }, "Tooltip": { "type": "string" }, "IsRequired": { "type": "boolean" }, "Validation": { "type": "array", "items": { "$ref": "#/definitions/FieldValidation" } }, "Options": { "type": "array", "items": { "$ref": "#/definitions/FieldOption" } }, "TooltipPrompt": { "type": "string" }, "ElementType": { "type": "string" } } }, "FieldValidation": { "type": "object", "properties": { "ErrorMessage": { "type": "string" }, "Value": { "type": "string" }, "Type": { "type": "string" } } }, "FieldOption": { "type": "object", "properties": { "Key": { "type": "string" }, "Description": { "type": "string" } } }, "FormOptions": { "type": "object", "properties": { "Options": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/definitions/Option" } } }, "Sections": { "type": "array", "items": { "type": "string" } }, "FieldsBySection": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } }, "Option": { "type": "object", "properties": { "Key": { "type": "string" }, "Description": { "type": "string" } } }, "ApiFormAudit": { "type": "object", "properties": { "Versions": { "type": "array", "items": { "$ref": "#/definitions/Version" } } } }, "Version": { "type": "object", "properties": { "Id": { "type": "string" }, "UserReference": { "type": "string" }, "Reason": { "type": "string" }, "CreatedAt": { "format": "date-time", "type": "string" }, "DeletedAt": { "format": "date-time", "type": "string" } } }, "ApiFormDifferences": { "type": "object", "properties": { "Differences": { "type": "array", "items": { "type": "string" } } } }, "FormTypes": { "type": "object", "properties": { "Types": { "type": "array", "items": { "type": "string" } } } }, "FormElementTypes": { "type": "object", "properties": { "ElementTypes": { "type": "array", "items": { "$ref": "#/definitions/ElementType" } } } }, "ElementType": { "type": "object", "properties": { "Key": { "type": "string" }, "Description": { "type": "string" } } }, "FourSquareCalculateDepositRequest": { "type": "object", "properties": { "ValueAddedProducts": { "type": "array", "items": { "format": "double", "type": "number" } }, "Accessories": { "type": "array", "items": { "format": "double", "type": "number" } }, "EquipmentOptions": { "type": "array", "items": { "format": "double", "type": "number" } }, "Settlement": { "format": "double", "type": "number" }, "CustomerDeposit": { "format": "double", "type": "number" }, "PartExchange": { "format": "double", "type": "number" }, "FinanceableOtr": { "format": "double", "type": "number" } } }, "FourSquareCalculateDepositResponse": { "type": "object", "properties": { "AmountToFinance": { "format": "double", "type": "number" } } }, "FuelTypesResponse": { "type": "object", "properties": { "FuelTypes": { "type": "array", "items": { "$ref": "#/definitions/FuelTypeItem" } } } }, "FuelTypeItem": { "type": "object", "properties": { "DisplayName": { "type": "string" }, "FuelType": { "enum": [ "Petrol", "Diesel", "Lpg", "Ev", "Phev", "DieselPhev", "Fcev" ], "type": "string" }, "HasZeroCc": { "type": "boolean" } } }, "FuelRatesListResponse": { "type": "object", "properties": { "FuelRates": { "type": "array", "items": { "$ref": "#/definitions/FuelRateListItemResponse" } } } }, "FuelRateListItemResponse": { "required": [ "Name", "Type" ], "type": "object", "properties": { "LenderReference": { "type": "string" }, "Name": { "type": "string" }, "Type": { "enum": [ "Banded", "PercentageOfMpg", "Fixed" ], "type": "string" }, "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } }, "CreateFuelRateRequest": { "required": [ "Name", "Type" ], "type": "object", "properties": { "LenderReference": { "type": "string" }, "Name": { "type": "string" }, "Type": { "enum": [ "Banded", "PercentageOfMpg", "Fixed" ], "type": "string" } } }, "FuelRateResponse": { "required": [ "Name", "Type" ], "type": "object", "properties": { "LenderReference": { "type": "string" }, "Name": { "type": "string" }, "Type": { "enum": [ "Banded", "PercentageOfMpg", "Fixed" ], "type": "string" }, "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Periods": { "type": "array", "items": { "$ref": "#/definitions/FuelRatePeriodResponse" } } } }, "FuelRatePeriodResponse": { "required": [ "ValidFrom" ], "type": "object", "properties": { "Id": { "format": "int64", "type": "integer" }, "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "FuelRateReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "ValidFrom": { "format": "date-time", "type": "string" }, "ValidTo": { "format": "date-time", "type": "string" }, "IsDeleted": { "type": "boolean" }, "Entries": { "type": "array", "items": { "$ref": "#/definitions/FuelRateEntryResponse" } } } }, "FuelRateEntryResponse": { "required": [ "FuelType", "FuelTypeId", "Rate" ], "type": "object", "properties": { "FuelType": { "enum": [ "Petrol", "Diesel", "Lpg", "Ev", "Phev", "DieselPhev", "Fcev" ], "type": "string" }, "FuelTypeId": { "format": "int32", "type": "integer" }, "MinCc": { "format": "int32", "type": "integer" }, "MaxCc": { "format": "int32", "type": "integer" }, "Rate": { "format": "double", "type": "number" }, "IsDeleted": { "type": "boolean" }, "Adjustment": { "format": "double", "type": "number" } } }, "UpdateFuelRateRequest": { "required": [ "Name" ], "type": "object", "properties": { "LenderReference": { "type": "string" }, "Name": { "type": "string" } } }, "CreateFuelRatePeriodRequest": { "required": [ "ValidFrom" ], "type": "object", "properties": { "ValidFrom": { "format": "date-time", "type": "string" }, "ValidTo": { "format": "date-time", "type": "string" } } }, "UpdateFuelRatePeriodRequest": { "required": [ "ValidFrom" ], "type": "object", "properties": { "ValidFrom": { "format": "date-time", "type": "string" }, "ValidTo": { "format": "date-time", "type": "string" } } }, "UpsertFuelRateEntriesRequest": { "required": [ "Entries" ], "type": "object", "properties": { "Entries": { "type": "array", "items": { "$ref": "#/definitions/FuelRateEntryInput" } } } }, "FuelRateEntryInput": { "required": [ "FuelType", "Rate" ], "type": "object", "properties": { "Id": { "format": "int64", "type": "integer" }, "FuelType": { "enum": [ "Petrol", "Diesel", "Lpg", "Ev", "Phev", "DieselPhev", "Fcev" ], "type": "string" }, "MinCc": { "format": "int32", "type": "integer" }, "MaxCc": { "format": "int32", "type": "integer" }, "Rate": { "format": "double", "type": "number" }, "Adjustment": { "format": "double", "type": "number" } } }, "UpsertFuelRateEntriesResponse": { "type": "object", "properties": { "Entries": { "type": "array", "items": { "$ref": "#/definitions/FuelRateEntryResponse" } } } }, "FuelRateTableUsageResponse": { "type": "object", "properties": { "Policies": { "type": "array", "items": { "$ref": "#/definitions/FuelRateTableUsagePolicySummary" } }, "Products": { "type": "array", "items": { "$ref": "#/definitions/FuelRateTableUsageProductSummary" } } } }, "FuelRateTableUsagePolicySummary": { "type": "object", "properties": { "Name": { "type": "string" }, "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Schemes": { "type": "array", "items": { "$ref": "#/definitions/FuelRateTableUsageSchemeSummary" } } } }, "FuelRateTableUsageProductSummary": { "type": "object", "properties": { "Id": { "format": "int64", "type": "integer" }, "Name": { "type": "string" }, "IsActive": { "type": "boolean" } } }, "FuelRateTableUsageSchemeSummary": { "type": "object", "properties": { "Name": { "type": "string" }, "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "FuelRateSetAtSchemeLevel": { "type": "boolean" }, "Bands": { "type": "array", "items": { "$ref": "#/definitions/FuelRateTableUsageBandSummary" } } } }, "FuelRateTableUsageBandSummary": { "type": "object", "properties": { "Name": { "type": "string" }, "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "FuelRateSetAtBandLevel": { "type": "boolean" } } }, "InitialiseOrderRequest": { "type": "object", "properties": { "ApiKey": { "type": "string" }, "OrderReference": { "description": "If this value is omitted from the request a new Order will be created. If you are attempting to initialise an existing Order then a valid SessionToken will need to be provided.", "type": "string" }, "ProposalReference": { "description": "If this value is omitted from the request a new Order will be created. If you are attempting to upgrade a Proposal to an Order then a valid SessionToken will need to be provided.", "type": "string" }, "SessionToken": { "description": "If you are attempting to initialise an existing Order then a valid SessionToken will need to be provided to authorise access.", "type": "string" }, "QuoteReference": { "description": "The quote that will be appended to the order. Not necessary if providing a proposal reference.", "type": "string" }, "EntityType": { "enum": [ "Private individual", "Other corporate", "Limited company", "Partnership", "Self employed", "PLC", "Registered Charity", "Educational Organisation", "Private Individual / Self Employed", "Limited liability partnership", "deferred", "Sole Trader", "Small Partnership", "Large Partnership", "Industrial Provident", "Other Non Incorporated", "Agency" ], "type": "string" }, "OrganisationIdentifier": { "$ref": "#/definitions/OrganisationIdentifier", "description": "The organisation that the order will be created for. Not necessary if providing a proposal reference as the order will be on the same organisation as the proposal." }, "UtmParameters": { "$ref": "#/definitions/UtmParameters" } } }, "CheckoutJourneyInitialisationResponse": { "type": "object", "properties": { "SessionToken": { "type": "string" }, "OrderReference": { "type": "string" }, "Intents": { "$ref": "#/definitions/JourneyInitialisationIntents" }, "SessionExpiryDetails": { "$ref": "#/definitions/SessionExpiryDetails" } } }, "JourneyInitialisationIntents": { "type": "object", "properties": { "RequiresRetailerSelection": { "type": "boolean" }, "RequiresEntitySelection": { "type": "boolean" }, "RequiresChallengeVerification": { "type": "boolean" } } }, "SessionExpiryDetails": { "type": "object", "properties": { "ExpiresAt": { "format": "date-time", "type": "string" }, "ExpiresIn": { "format": "int64", "type": "integer" } } }, "InitialiseProposalRequest": { "type": "object", "properties": { "ApiKey": { "type": "string" }, "ProposalReference": { "description": "If this value is omitted from the request a new Proposal will be created. If you are attempting to initialise an existing Proposal then a valid SessionToken will need to be provided.", "type": "string" }, "SessionToken": { "description": "If you are attempting to initialise an existing Proposal then a valid SessionToken will need to be provided to authorise access.", "type": "string" }, "QuoteReference": { "description": "The quote that will be appended to the order. Not necessary if providing a proposal reference.", "type": "string" }, "EntityType": { "enum": [ "Private individual", "Other corporate", "Limited company", "Partnership", "Self employed", "PLC", "Registered Charity", "Educational Organisation", "Private Individual / Self Employed", "Limited liability partnership", "deferred", "Sole Trader", "Small Partnership", "Large Partnership", "Industrial Provident", "Other Non Incorporated", "Agency" ], "type": "string" }, "OrganisationIdentifier": { "$ref": "#/definitions/OrganisationIdentifier", "description": "The organisation that the order will be created for. Not necessary if providing a proposal reference as the order will be on the same organisation as the proposal." }, "UtmParameters": { "$ref": "#/definitions/UtmParameters" }, "SalesChannel": { "type": "string" } } }, "CommonJourneyInitialisationResponse": { "type": "object", "properties": { "SessionToken": { "type": "string" }, "ProposalReference": { "type": "string" }, "Intents": { "$ref": "#/definitions/JourneyInitialisationIntents" }, "SessionExpiryDetails": { "$ref": "#/definitions/SessionExpiryDetails" } } }, "InitialiseThirdPartyRequest": { "type": "object", "properties": { "ApiKey": { "type": "string" }, "UtmParameters": { "$ref": "#/definitions/UtmParameters" } } }, "ThirdPartyInitialisationResponse": { "type": "object", "properties": {} }, "SubmitHelpRequest": { "required": [ "Application", "Subject", "Priority", "Message" ], "type": "object", "properties": { "Application": { "type": "string" }, "Subject": { "type": "string" }, "Priority": { "type": "string" }, "Message": { "type": "string" } } }, "SubmitHelpResponse": { "type": "object", "properties": { "TicketReference": { "type": "string" } } }, "AcceptStripeIdentityWebhookRequest": { "type": "object", "properties": { "type": { "type": "string" }, "data": { "$ref": "#/definitions/StripeIdentityWebhookRequestData" } } }, "StripeIdentityWebhookRequestData": { "type": "object", "properties": { "object": { "$ref": "#/definitions/StripeIdentityWebhookRequestDataObject" } } }, "StripeIdentityWebhookRequestDataObject": { "type": "object", "properties": { "id": { "type": "string" }, "amount_paid": { "format": "double", "type": "number" }, "amount_remaining": { "format": "double", "type": "number" } } }, "AcceptStripeIdentityWebhookResponse": { "type": "object", "properties": {} }, "ImportValidationResponse": { "type": "object", "properties": { "ValidationSuccessful": { "type": "boolean" }, "FileKey": { "type": "string" }, "NumberOfLinesParsed": { "format": "int32", "type": "integer" }, "InvalidLines": { "type": "array", "items": { "$ref": "#/definitions/InvalidLine" } } } }, "InvalidLine": { "type": "object", "properties": { "LineNumber": { "format": "int32", "type": "integer" }, "ColumnNumber": { "format": "int32", "type": "integer" }, "ColumnName": { "type": "string" }, "ActualValue": { "type": "string" }, "ErrorMessage": { "type": "string" }, "ExampleValue": { "type": "string" } } }, "ImportDetailsResponse": { "type": "object", "properties": { "Import": { "$ref": "#/definitions/ImportDetails" } } }, "ImportDetails": { "type": "object", "properties": { "Id": { "format": "int64", "type": "integer" }, "Key": { "type": "string" } } }, "ImportsResponse": { "type": "object", "properties": { "ImportGroups": { "type": "array", "items": { "$ref": "#/definitions/ImportGroup" } } } }, "ImportGroup": { "type": "object", "properties": { "AllowFutureVersions": { "type": "boolean" }, "HasDemoUpload": { "type": "boolean" }, "Name": { "type": "string" }, "SaveOnly": { "type": "boolean" }, "FileImports": { "type": "array", "items": { "$ref": "#/definitions/FileImport" } } } }, "FileImport": { "type": "object", "properties": { "Name": { "type": "string" } } }, "UploadCorporateManufacturerSupportTermsResponse": { "type": "object", "properties": { "VersionId": { "format": "int64", "type": "integer" }, "HolderReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "ValidationReport": { "$ref": "#/definitions/CorporateManufacturerSupportTermsValidationReport" }, "Preview": { "$ref": "#/definitions/CorporateManufacturerSupportTermsPreview" }, "FileChecksum": { "type": "string" } } }, "CorporateManufacturerSupportTermsValidationReport": { "type": "object", "properties": { "HasErrors": { "type": "boolean" }, "Failures": { "type": "array", "items": { "$ref": "#/definitions/CorporateManufacturerSupportTermsValidationFailure" } } } }, "CorporateManufacturerSupportTermsPreview": { "type": "object", "properties": { "RowsByTier": { "type": "object", "additionalProperties": { "format": "int32", "type": "integer" } }, "RowsByDiscountType": { "type": "object", "additionalProperties": { "format": "int32", "type": "integer" } }, "AffectedPolicyCount": { "format": "int32", "type": "integer" }, "FirstTenAffected": { "type": "array", "items": { "$ref": "#/definitions/CorporateManufacturerSupportTermsAffectedPolicySample" } }, "SampleRules": { "type": "array", "items": { "$ref": "#/definitions/CorporateManufacturerSupportTermsAggregatedRuleSample" } } } }, "CorporateManufacturerSupportTermsValidationFailure": { "type": "object", "properties": { "Row": { "format": "int32", "type": "integer" }, "Field": { "type": "string" }, "Value": { "type": "string" }, "Reason": { "type": "string" } } }, "CorporateManufacturerSupportTermsAffectedPolicySample": { "type": "object", "properties": { "PolicyReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "PolicyName": { "type": "string" }, "SchemeName": { "type": "string" }, "SchemeType": { "type": "string" }, "RuleCount": { "format": "int32", "type": "integer" } } }, "CorporateManufacturerSupportTermsAggregatedRuleSample": { "type": "object", "properties": { "Tier": { "type": "string" }, "Reference": { "type": "string" }, "Manufacturer": { "type": "string" }, "CapLongCode": { "type": "string" }, "AggregatedValue": { "format": "double", "type": "number" }, "AggregatedPercentage": { "format": "double", "type": "number" }, "DiscountTypeApplied": { "type": "string" }, "FromDate": { "format": "date-time", "type": "string" }, "ToDate": { "format": "date-time", "type": "string" } } }, "ExtendLockRequest": { "type": "object", "properties": { "HolderReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } }, "ExtendLockResponse": { "type": "object", "properties": { "ExpiresAt": { "format": "date-time", "type": "string" } } }, "DiscardRequest": { "type": "object", "properties": { "HolderReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } }, "StagedImportActivationAcceptedResponse": { "type": "object", "properties": { "ExecutionArn": { "type": "string" }, "StatusUrl": { "type": "string" } } }, "ReplayActivationRequest": { "type": "object", "properties": { "Activation": { "$ref": "#/definitions/ActivateInternalResponse" } } }, "ActivateInternalResponse": { "type": "object", "properties": { "ActivatedAt": { "format": "date-time", "type": "string" }, "ImportRunReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "HolderReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "AffectedPolicies": { "type": "array", "items": { "$ref": "#/definitions/AffectedPolicy" } } } }, "AffectedPolicy": { "type": "object", "properties": { "PolicyReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "IdempotencyKey": { "type": "string" } } }, "StagedImportStatusResponse": { "type": "object", "properties": { "ExecutionStatus": { "type": "string" }, "VersionStatus": { "type": "string" }, "LastUpdatedAt": { "format": "date-time", "type": "string" }, "Error": { "type": "string" } } }, "StagedImportVersionResponse": { "type": "object", "properties": { "VersionId": { "format": "int64", "type": "integer" }, "Status": { "type": "string" }, "ImportKey": { "type": "string" }, "CreatedAt": { "format": "date-time", "type": "string" }, "CreatedBy": { "type": "string" }, "CreatedByUsername": { "type": "string" }, "ActivatedAt": { "format": "date-time", "type": "string" }, "FileChecksum": { "type": "string" }, "RowCount": { "format": "int32", "type": "integer" }, "SummaryJson": { "type": "string" } } }, "StagedImportVersionHistoryResponse": { "type": "object", "properties": { "Versions": { "type": "array", "items": { "$ref": "#/definitions/StagedImportVersionResponse" } } } }, "CsvDownloadResponse": { "type": "object", "properties": {} }, "UserInvites": { "type": "object", "properties": { "Email": { "type": "string" }, "Invites": { "type": "array", "items": { "$ref": "#/definitions/UserInvite" } } } }, "UserInvite": { "type": "object", "properties": { "OrganisationId": { "format": "int32", "type": "integer" }, "SystemId": { "format": "int32", "type": "integer" }, "Created": { "format": "date-time", "type": "string" } } }, "ResendStripeInvoiceEmailRequest": { "type": "object", "properties": {} }, "ResendStripeInvoiceEmailResponse": { "type": "object", "properties": {} }, "AcceptStripeWebhookRequest": { "type": "object", "properties": { "type": { "type": "string" }, "data": { "$ref": "#/definitions/StripeWebhookRequestData" } } }, "StripeWebhookRequestData": { "type": "object", "properties": { "object": { "$ref": "#/definitions/StripeWebhookRequestDataObject" } } }, "StripeWebhookRequestDataObject": { "type": "object", "properties": { "id": { "type": "string" }, "amount_paid": { "format": "double", "type": "number" }, "amount_remaining": { "format": "double", "type": "number" } } }, "AcceptStripeWebhookResponse": { "type": "object", "properties": {} }, "AddJourneyRequest": { "type": "object", "properties": { "Title": { "type": "string" } } }, "OrganisationForLenderResponse": { "type": "object", "properties": { "Organisations": { "type": "array", "items": { "$ref": "#/definitions/OrganisationForLender" } }, "Pagination": { "$ref": "#/definitions/Pagination" } } }, "OrganisationForLender": { "type": "object", "properties": { "OrganisationId": { "format": "int32", "type": "integer" }, "OrganisationName": { "type": "string" }, "Reference": { "$ref": "#/definitions/OrganisationIdentifier" } } }, "LenderLinkedReferenceTypesResponse": { "type": "object", "properties": { "LinkedReferenceTypes": { "type": "array", "items": { "format": "int64", "type": "integer" } } } }, "CreateLenderReferenceTypeRequest": { "type": "object", "properties": { "Name": { "type": "string" }, "AllowsCrossSystemFinance": { "type": "boolean" } } }, "CreateLenderReferenceTypeResponse": { "type": "object", "properties": {} }, "GetImportsForLenderResponse": { "type": "object", "properties": { "AvailableImports": { "type": "array", "items": { "$ref": "#/definitions/LenderImport" } } } }, "LenderImport": { "type": "object", "properties": { "ImportKey": { "type": "string" }, "ImportName": { "type": "string" }, "ImportDescription": { "type": "string" }, "ExpectedFileType": { "type": "string" }, "ContentType": { "type": "string" }, "AutomatedImport": { "type": "boolean" }, "AutomatedImportRunTime": { "type": "string" }, "Files": { "type": "array", "items": { "$ref": "#/definitions/LenderImportFile" } }, "SupportVersionControl": { "type": "boolean" }, "SupportValidation": { "type": "boolean" }, "SupportExport": { "type": "boolean" }, "ThirdPartyMonitorLink": { "$ref": "#/definitions/ThirdPartyMonitorLink" }, "RunType": { "type": "string" }, "IsStagedImport": { "type": "boolean" }, "ImportSettingDetails": { "type": "array", "items": { "$ref": "#/definitions/ImportSettingDetails" } } } }, "LenderImportFile": { "type": "object", "properties": { "FileType": { "type": "string" }, "FileName": { "type": "string" } } }, "ThirdPartyMonitorLink": { "type": "object", "properties": { "ThirdParty": { "enum": [ "DigitalUnit", "Audi", "VWFS", "VWManufacturer", "Equifax", "Alphabet", "BMWManufacturer", "BMWFS", "MercedesBenzManufacturer", "Motonovo", "Juice", "FCA", "LandRover", "Jaguar", "JLR", "LexAutolease", "Volvo", "Codeweavers", "PSA", "RCI", "Vauxhall", "PSAEurope", "Orchestrator", "Anchor", "BlackHorse", "PSAFinance", "V12", "Bentley", "FinanceIreland", "BnpParibas", "TFS", "AutoTrader", "RobinsAndDay", "OpelFinance", "OpelFinanceItaly", "OpelFinanceSpain", "OpelFinanceFrance", "Octane", "Santander", "AstonMartin", "Novuna", "Northridge", "Honda", "FcaUKImport", "Hyundai" ], "type": "string" }, "Category": { "type": "string" } } }, "ImportSettingDetails": { "type": "object", "properties": { "Type": { "enum": [ "Unknown", "SkipDuplicationCheck", "OverrideExistingData", "StartDate" ], "type": "string" }, "IsRequired": { "type": "boolean" }, "DisplayType": { "enum": [ "Unknown", "Text", "Bool", "DateTime" ], "type": "string" }, "DisplayName": { "type": "string" } } }, "ImportHistoryResponse": { "type": "object", "properties": { "History": { "type": "array", "items": { "$ref": "#/definitions/ImportRun" } } } }, "ImportRun": { "type": "object", "properties": { "StartTime": { "format": "date-time", "type": "string" }, "EndTime": { "format": "date-time", "type": "string" }, "Status": { "type": "string" }, "User": { "type": "string" }, "Id": { "format": "int64", "type": "integer" }, "HasArchivedFile": { "type": "boolean" }, "RunReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } }, "ThirdPartyLogSearchResponse": { "type": "object", "properties": { "Logs": { "type": "array", "items": { "$ref": "#/definitions/ThirdPartyLog" } } } }, "ThirdPartyLog": { "type": "object", "properties": { "Id": { "type": "string" }, "TimeStamp": { "format": "date-time", "type": "string" }, "Request": { "type": "string" }, "Response": { "type": "string" }, "Details": { "type": "string" }, "Level": { "enum": [ "Info", "Error" ], "type": "string" }, "Archived": { "type": "boolean" } } }, "LenderFinancePackageResponse": { "type": "object", "properties": { "FinancePackages": { "type": "array", "items": { "$ref": "#/definitions/LenderFinancePackage" } } } }, "LenderFinancePackage": { "type": "object", "properties": { "FinancePackageId": { "format": "int32", "type": "integer" }, "FinancePackageName": { "type": "string" }, "SetupDate": { "format": "date-time", "type": "string" }, "Active": { "type": "boolean" }, "ExternalIdentifier": { "type": "string" } } }, "GroupedLenderProposalStatusesResponse": { "type": "object", "properties": { "GroupedStatuses": { "type": "array", "items": { "$ref": "#/definitions/GroupedStatus" } } } }, "GroupedStatus": { "type": "object", "properties": { "GroupStatus": { "type": "string" }, "IsSelectedByDefault": { "type": "boolean" }, "Statuses": { "type": "array", "items": { "$ref": "#/definitions/LenderSpecificStatus" } } } }, "LenderSpecificStatus": { "type": "object", "properties": { "DisplayName": { "type": "string" }, "Value": { "type": "string" } } }, "ProductExplainerForLenderResponse": { "type": "object", "properties": { "Content": { "type": "string" }, "VideoLink": { "type": "string" } } }, "LenderExportRequest": { "type": "object", "properties": { "Filters": { "type": "array", "items": { "$ref": "#/definitions/Filter" } } } }, "Filter": { "type": "object", "properties": { "Key": { "type": "string" }, "Value": { "type": "string" } } }, "ExportInformationResponse": { "type": "object", "properties": { "ExportInformation": { "$ref": "#/definitions/AvailableLenderExportInformation" } } }, "AvailableLenderExportInformation": { "type": "object", "properties": { "ExportName": { "type": "string" }, "ExportFilters": { "type": "array", "items": { "type": "string" } } } }, "CreateLenderRequest": { "required": [ "Name", "JourneyReference" ], "type": "object", "properties": { "Name": { "type": "string" }, "Identifier": { "type": "string" }, "Logo": { "type": "string" }, "JourneyReference": { "type": "string" }, "OrganisationReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } }, "UpdateLenderRequest": { "required": [ "Name", "JourneyReference" ], "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "Name": { "type": "string" }, "Identifier": { "type": "string" }, "Logo": { "type": "string" }, "JourneyReference": { "type": "string" }, "OrganisationReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } }, "CampaignSearchResponse": { "type": "object", "properties": { "FinancePackages": { "type": "array", "items": { "$ref": "#/definitions/CampaignSearchResult" } }, "Pagination": { "$ref": "#/definitions/IPaginationResponse" } } }, "CampaignSearchResult": { "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "IsActive": { "type": "boolean" }, "DisplayName": { "type": "string" } } }, "GetAllLocalesResponse": { "type": "object", "properties": { "Locales": { "type": "array", "items": { "type": "string" } } } }, "BigQueryLogRequest": { "type": "object", "properties": { "AuthToken": { "type": "string" }, "Message": { "type": "string" } } }, "ClientSideLogRequest": { "required": [ "Application" ], "type": "object", "properties": { "Application": { "type": "string" }, "InstanceIdentifier": { "type": "string" }, "SessionIdentifier": { "type": "string" }, "LogBucketIdentifier": { "type": "string" }, "Client": { "$ref": "#/definitions/LogClientInformation" }, "Logs": { "type": "array", "items": { "$ref": "#/definitions/ClientSideLogInstance" } } } }, "LogClientInformation": { "type": "object", "properties": { "UserAgent": { "type": "string" }, "BuildVersion": { "type": "string" }, "FrameWork": { "type": "string" }, "Events": { "type": "array", "items": { "type": "string" } }, "Spec": { "$ref": "#/definitions/LogClientSpecMeta" }, "Location": { "$ref": "#/definitions/LogClientLocationMeta" }, "User": { "$ref": "#/definitions/LogClientUserMeta" }, "ApiRequestHistory": { "type": "array", "items": { "$ref": "#/definitions/LogClientApiCallHistory" } } } }, "ClientSideLogInstance": { "type": "object", "properties": { "RouteTemplate": { "type": "string" }, "Logger": { "type": "string" }, "Level": { "enum": [ "Fatal", "Error", "Warn", "Info", "Debug" ], "type": "string" }, "Message": { "type": "string" }, "Exception": { "type": "string" }, "ObjectDump": { "type": "object" } } }, "LogClientSpecMeta": { "type": "object", "properties": { "Name": { "type": "string" }, "Runner": { "type": "string" } } }, "LogClientLocationMeta": { "type": "object", "properties": { "Origin": { "type": "string" }, "InternalReferrer": { "type": "string" }, "ExternalReferrer": { "type": "string" } } }, "LogClientUserMeta": { "type": "object", "properties": { "Reference": { "type": "string" }, "Type": { "type": "string" }, "EnabledModules": { "type": "array", "items": { "type": "string" } }, "OrganisationName": { "type": "string" }, "OrganisationId": { "type": "string" } } }, "LogClientApiCallHistory": { "type": "object", "properties": { "Request": { "$ref": "#/definitions/LogClientApiCallHistoryRequest" }, "Response": { "$ref": "#/definitions/LogClientApiCallHistoryResponse" }, "StartTime": { "format": "date-time", "type": "string" }, "EndTime": { "format": "date-time", "type": "string" } } }, "LogClientApiCallHistoryRequest": { "type": "object", "properties": { "Path": { "type": "string" }, "Method": { "type": "string" }, "Headers": { "type": "object", "additionalProperties": { "type": "string" } }, "Body": { "type": "string" } } }, "LogClientApiCallHistoryResponse": { "type": "object", "properties": { "Body": { "type": "string" }, "StatusCode": { "format": "int32", "type": "integer" }, "Headers": { "type": "object", "additionalProperties": { "type": "string" } } } }, "RunscopeWebHookPayload": { "type": "object", "properties": { "test_id": { "type": "string" }, "test_name": { "type": "string" }, "test_run_id": { "type": "string" }, "team_id": { "type": "string" }, "team_name": { "type": "string" }, "environment_uuid": { "type": "string" }, "environment_name": { "type": "string" }, "bucket_name": { "type": "string" }, "bucket_key": { "type": "string" }, "test_url": { "type": "string" }, "test_run_url": { "type": "string" }, "trigger_url": { "type": "string" }, "result": { "type": "string" }, "started_at": { "format": "double", "type": "number" }, "finished_at": { "format": "double", "type": "number" }, "agent": { "type": "object" }, "agent_expired": { "type": "object" }, "region": { "type": "string" }, "region_name": { "type": "string" }, "initial_variables": { "$ref": "#/definitions/InitialVariables" }, "requests": { "type": "array", "items": { "$ref": "#/definitions/Request" } } } }, "InitialVariables": { "type": "object", "properties": {} }, "Request": { "type": "object", "properties": { "step_type": { "type": "string" }, "url": { "type": "string" }, "variables": { "$ref": "#/definitions/Variables2" }, "assertions": { "$ref": "#/definitions/Assertions" }, "scripts": { "$ref": "#/definitions/Scripts" }, "result": { "type": "string" }, "method": { "type": "string" }, "response_time_ms": { "format": "int32", "type": "integer" }, "response_size_bytes": { "format": "int32", "type": "integer" }, "response_status_code": { "format": "int32", "type": "integer" }, "note": { "type": "string" } } }, "Variables2": { "type": "object", "properties": { "fail": { "format": "int32", "type": "integer" }, "total": { "format": "int32", "type": "integer" }, "pass": { "format": "int32", "type": "integer" } } }, "Assertions": { "type": "object", "properties": { "fail": { "format": "int32", "type": "integer" }, "total": { "format": "int32", "type": "integer" }, "pass": { "format": "int32", "type": "integer" } } }, "Scripts": { "type": "object", "properties": { "fail": { "format": "int32", "type": "integer" }, "total": { "format": "int32", "type": "integer" }, "pass": { "format": "int32", "type": "integer" } } }, "SnowplowPayload": { "type": "object", "properties": { "application": { "type": "string" }, "message": { "type": "string" }, "logger": { "type": "string" }, "exception": { "type": "string" }, "object_dump": { "type": "object" } } }, "SecurityScanReportRequest": { "type": "object", "properties": { "QutteraReport": { "$ref": "#/definitions/QutteraScanReport" }, "AuthToken": { "type": "string" }, "Level": { "type": "string" } } }, "QutteraScanReport": { "type": "object", "properties": { "Report": { "$ref": "#/definitions/QutteraReport" }, "Error": { "format": "int32", "type": "integer" }, "Errorstr": { "type": "string" } } }, "QutteraReport": { "type": "object", "properties": { "Blacklist_Report": { "$ref": "#/definitions/QutteraBlacklistReport" }, "Blacklisted_Domains": { "type": "object", "additionalProperties": { "type": "string" } }, "Blacklisted_Domains_Count": { "format": "int32", "type": "integer" }, "Blacklisted_Iframes": { "type": "object", "additionalProperties": { "type": "string" } }, "Blacklisted_Iframes_Count": { "format": "int32", "type": "integer" }, "Blacklisted_Links": { "type": "object", "additionalProperties": { "type": "string" } }, "Blacklisted_Links_Count": { "format": "int32", "type": "integer" }, "Domains": { "type": "object", "additionalProperties": { "type": "string" } }, "DomainsCount": { "format": "int32", "type": "integer" }, "Files": { "type": "array", "items": { "$ref": "#/definitions/QutteraFile" } }, "Iframes": { "type": "object", "additionalProperties": { "type": "string" } }, "Iframes_Count": { "format": "int32", "type": "integer" }, "Links": { "type": "object", "additionalProperties": { "type": "string" } }, "Links_Count": { "format": "int32", "type": "integer" }, "Malicious_Files": { "format": "int32", "type": "integer" }, "Psuspicious_Files": { "format": "int32", "type": "integer" }, "Scanned_Content": { "format": "int32", "type": "integer" }, "Scanned_Files": { "format": "int32", "type": "integer" }, "State": { "type": "string" }, "Suspicious_Files": { "format": "int32", "type": "integer" }, "Time": { "format": "double", "type": "number" }, "Timestr": { "type": "string" }, "Type": { "type": "string" }, "Url": { "type": "string" } } }, "QutteraBlacklistReport": { "type": "object", "properties": { "Blacklist_Status": { "type": "string" }, "Providers": { "type": "array", "items": { "$ref": "#/definitions/QutteraProvider" } } } }, "QutteraFile": { "type": "object", "properties": { "Md5": { "type": "string" }, "_Severity": { "type": "string" }, "Details": { "type": "string" }, "Dump": { "type": "string" }, "DumpMd5": { "type": "string" }, "Endtime": { "type": "string" }, "Filename": { "type": "string" }, "Filesize": { "type": "string" }, "Filetype": { "type": "string" }, "Offset": { "type": "string" }, "Reason": { "type": "string" }, "Result": { "type": "string" }, "Scantime": { "type": "string" }, "Threat": { "type": "string" } } }, "QutteraProvider": { "type": "object", "properties": { "Name": { "type": "string" }, "Status": { "type": "string" }, "Time": { "type": "string" } } }, "MarketingUpdateListResponse": { "type": "object", "properties": { "Updates": { "type": "array", "items": { "$ref": "#/definitions/MarketingUpdateSummary" } }, "Pagination": { "$ref": "#/definitions/IPaginationResponse" } } }, "MarketingUpdateSummary": { "type": "object", "properties": { "Id": { "type": "string" }, "Title": { "type": "string" }, "Summary": { "type": "string" }, "ThumbnailUrl": { "type": "string" }, "Date": { "format": "date-time", "type": "string" }, "ExpirationDate": { "format": "date-time", "type": "string" }, "Tags": { "type": "array", "items": { "type": "string" } } } }, "MarketingNewUpdatesResponse": { "type": "object", "properties": { "IdList": { "type": "array", "items": { "type": "string" } }, "Articles": { "type": "array", "items": { "$ref": "#/definitions/MarketingUpdateSummary" } } } }, "MarketingGetListOfUpdatesRequest": { "type": "object", "properties": { "Page": { "format": "int32", "type": "integer" }, "ResultsPerPage": { "format": "int32", "type": "integer" }, "Tags": { "type": "array", "items": { "type": "string" } } } }, "MarketingGetSuggestedArticlesRequest": { "type": "object", "properties": { "Id": { "type": "string" }, "Tags": { "type": "array", "items": { "type": "string" } } } }, "MarketingSuggestedArticlesResponse": { "type": "object", "properties": { "Articles": { "type": "array", "items": { "$ref": "#/definitions/MarketingUpdateSummary" } } } }, "MarketingUpdateResponse": { "type": "object", "properties": { "Title": { "type": "string" }, "Content": { "type": "string" }, "BannerUrl": { "type": "string" }, "Date": { "format": "date-time", "type": "string" }, "Tags": { "type": "array", "items": { "type": "string" } }, "LastedEdited": { "format": "date-time", "type": "string" } } }, "MarketingDismissResponse": { "type": "object", "properties": {} }, "MarketingDismissedUpdatesResponse": { "type": "object", "properties": { "DismissedUpdateIds": { "type": "array", "items": { "type": "string" } } } }, "SessionMarketingPreferencesResponse": { "type": "object", "properties": { "MarketingPreferences": { "type": "array", "items": { "$ref": "#/definitions/MarketingPreference" } } } }, "UpdateModuleRequest": { "type": "object", "properties": { "DisplayName": { "type": "string" }, "Description": { "type": "string" }, "IsPublic": { "type": "boolean" } } }, "ModuleUsageRequest": { "type": "object", "properties": { "Page": { "format": "int32", "type": "integer" }, "ResultsPerPage": { "format": "int32", "type": "integer" } } }, "UpdateModuleAdditionalDataRequest": { "type": "object", "properties": { "FieldIds": { "type": "array", "items": { "format": "int32", "type": "integer" } } } }, "UpdateModuleAdditionalDataResponse": { "type": "object", "properties": {} }, "GetDayDetailsFromWatchTowerRequestModel": { "required": [ "Date", "UserReference" ], "type": "object", "properties": { "Date": { "type": "string" }, "UserReference": { "type": "string" } } }, "GetDayDetailsFromWatchTowerResponseModel": { "type": "object", "properties": { "List": { "type": "array", "items": { "$ref": "#/definitions/DayDetailsItem" } }, "Date": { "type": "string" } } }, "DayDetailsItem": { "type": "object", "properties": { "Endpoint": { "type": "string" }, "Hits": { "format": "int64", "type": "integer" } } }, "GetEndpointBreakdownFromWatchTowerRequestModel": { "required": [ "Date", "UserReference", "Endpoint" ], "type": "object", "properties": { "Date": { "type": "string" }, "UserReference": { "type": "string" }, "Endpoint": { "type": "string" } } }, "GetEndpointBreakdownFromWatchTowerResponseModel": { "type": "object", "properties": { "Averages": { "type": "array", "items": { "$ref": "#/definitions/AverageItem" } }, "StatusCodes": { "type": "array", "items": { "$ref": "#/definitions/StatusCodeItem" } } } }, "AverageItem": { "type": "object", "properties": { "Minute": { "format": "date-time", "type": "string" }, "Hits": { "format": "int64", "type": "integer" }, "Duration": { "format": "int64", "type": "integer" } } }, "StatusCodeItem": { "type": "object", "properties": { "Minute": { "format": "date-time", "type": "string" }, "StatusCode": { "format": "int32", "type": "integer" }, "Count": { "format": "int64", "type": "integer" } } }, "ApiAvailabilityMetricsRequest": { "required": [ "BucketId", "TestId" ], "type": "object", "properties": { "BucketId": { "type": "string" }, "TestId": { "type": "string" } } }, "ApiAvailabilityTestDetailsRequest": { "required": [ "BucketId" ], "type": "object", "properties": { "BucketId": { "type": "string" } } }, "RequestLoggingRequest": { "required": [ "MatchText", "UserReference" ], "type": "object", "properties": { "MatchText": { "type": "string" }, "UserReference": { "type": "string" }, "EnableRequestTracing": { "type": "boolean" }, "EnableSqlLogging": { "type": "boolean" } } }, "EnableRequestLoggingResponse": { "type": "object", "properties": { "LoggingIdentifier": { "type": "string" } } }, "RequestLoggingResponse": { "type": "object", "properties": { "Logs": { "type": "array", "items": { "$ref": "#/definitions/Log" } } } }, "Log": { "type": "object", "properties": { "Identifier": { "type": "string" }, "Request": { "type": "string" }, "Response": { "type": "string" }, "Headers": { "type": "object", "additionalProperties": { "type": "string" } }, "ResponseHeaders": { "type": "object", "additionalProperties": { "type": "string" } }, "Endpoint": { "type": "string" } } }, "ProposalSubmissionStatisticsRequest": { "type": "object", "properties": { "Filters": { "$ref": "#/definitions/ProposalSubmissionStatisticsFilters" } } }, "ProposalSubmissionStatisticsFilters": { "type": "object", "properties": { "Systems": { "type": "array", "items": { "type": "string" } }, "From": { "format": "date-time", "type": "string" } } }, "ProposalSubmissionStatisticsResponse": { "type": "object", "properties": { "Results": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "$ref": "#/definitions/ProposalsSubmittedPerWindow" } } } } }, "ProposalsSubmittedPerWindow": { "type": "object", "properties": { "Succeeded": { "type": "array", "items": { "format": "int64", "type": "integer" } }, "Failed": { "type": "array", "items": { "format": "int64", "type": "integer" } }, "Addressed": { "type": "array", "items": { "format": "int64", "type": "integer" } } } }, "OfferOverrideRequest": { "type": "object", "properties": { "Overrides": { "$ref": "#/definitions/OfferOverrides" }, "DisplayType": { "enum": [ "Unknown", "Customer", "Retailer", "OffersAdmin", "Lender" ], "type": "string" } } }, "OfferOverrides": { "type": "object", "properties": { "IsPersonalisedQuote": { "type": "boolean" }, "CostBreakdown": { "$ref": "#/definitions/CostBreakdown" } } }, "VehicleEquipmentOptionsResponse": { "type": "object", "properties": { "Categories": { "type": "array", "items": { "$ref": "#/definitions/EquipmentOptionCategory" } } } }, "EquipmentOptionCategory": { "type": "object", "properties": { "Name": { "type": "string" }, "SubCategories": { "type": "array", "items": { "$ref": "#/definitions/EquipmentOptionSubCategory" } } } }, "EquipmentOptionSubCategory": { "type": "object", "properties": { "Name": { "type": "string" }, "Options": { "type": "array", "items": { "$ref": "#/definitions/NewEquipmentOption" } } } }, "NewEquipmentOption": { "type": "object", "properties": { "Id": { "type": "string" }, "Name": { "type": "string" }, "Description": { "type": "string" }, "Image": { "$ref": "#/definitions/Image" }, "PriceIncludingSalesTax": { "format": "double", "type": "number" }, "PriceExcludingSalesTax": { "format": "double", "type": "number" }, "ListPriceIncludingSalesTax": { "format": "double", "type": "number" }, "ListPriceExcludingSalesTax": { "format": "double", "type": "number" }, "Discount": { "$ref": "#/definitions/EquipmentOptionDiscount" }, "IsStandard": { "type": "boolean" }, "IsPack": { "type": "boolean" }, "IsP11DExempt": { "type": "boolean" }, "IsSelectable": { "type": "boolean" }, "IsSelected": { "type": "boolean" }, "IsIncludedInOffer": { "type": "boolean" }, "CanBeRemoved": { "type": "boolean" }, "IncludedByOptionIdentifier": { "type": "string" }, "PrimaryColourHexCode": { "type": "string" } } }, "EquipmentOptionDiscount": { "type": "object", "properties": { "DiscountedAmountIncludingSalesTax": { "format": "double", "type": "number" }, "DiscountedAmountExcludingSalesTax": { "format": "double", "type": "number" }, "DiscountPercentageOfListPrice": { "format": "double", "type": "number" }, "Type": { "enum": [ "Unknown", "Amount", "Percentage" ], "type": "string" }, "Expiry": { "format": "date-time", "type": "string" } } }, "RequestEquipmentOptionDiscount": { "type": "object", "properties": { "DiscountAmount": { "format": "double", "type": "number" }, "DiscountPercentageOfListPrice": { "format": "double", "type": "number" }, "DiscountIncludesSalesTax": { "type": "boolean" }, "ListPrice": { "format": "double", "type": "number" } } }, "OfferEquipmentOptionsUpdateDiscountResponse": { "type": "object", "properties": { "EquipmentOption": { "$ref": "#/definitions/NewEquipmentOption" }, "Vehicle": { "$ref": "#/definitions/UpdatedVehicle" } } }, "UpdatedVehicle": { "type": "object", "properties": { "Reference": { "format": "uuid", "description": "A reference to this exact version of this vehicle at the point in time the lookup was done.", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } }, "OnboardingGuidesResponse": { "type": "object", "properties": { "Guides": { "type": "array", "items": { "$ref": "#/definitions/OnboardingGuide" } } } }, "OnboardingGuide": { "type": "object", "properties": { "Name": { "type": "string" }, "HasCompleted": { "type": "boolean" } } }, "CreateOrderRequest": { "type": "object", "properties": { "QuoteReference": { "description": "The quote that will be appended to the order. Not necessary if providing a proposal reference.", "type": "string" }, "PartExchangeReference": { "description": "The part exchange that will be appended to the order. Not necessary if providing a proposal reference.", "type": "string" }, "ProposalReference": { "description": "If provided, the order will be created using the data from the given proposal. If not provided, an order will be created from scratch.", "type": "string" }, "Organisation": { "$ref": "#/definitions/OrganisationIdentifier", "description": "The organisation that the order will be created for. Not necessary if providing a proposal reference as the order will be on the same organisation as the proposal." }, "Journey": { "description": "The journey that the created order will be placed on.", "enum": [ "Unknown", "Default", "VolvoECommerce", "CodeweaversDemonstration", "BlackHorseRemoteSign", "InternalSubmission", "CodeweaversCommerce" ], "type": "string" } } }, "CreateOrderResponse": { "type": "object", "properties": { "OrderReference": { "description": "The unique identifier of the created order. If created from a proposal this will be the same as the proposal's reference.", "type": "string" } } }, "DeleteOrderResponse": { "type": "object", "properties": { "OrderStatus": { "$ref": "#/definitions/OrderStatusResponse" } } }, "OrderStatusResponse": { "type": "object", "properties": { "Type": { "enum": [ "Unknown", "Deleted", "Cancelled", "Created", "Started", "AwaitingDelivery", "Completed", "VehicleOrderedByDealer", "Building", "Reserved", "WaitingForRetailer", "WaitingForCustomer", "QuoteChangedByDealer", "TakenOffline" ], "type": "string" }, "DisplayName": { "type": "string" }, "Description": { "type": "string" } } }, "ProposalCreateGuestSessionRequest": { "type": "object", "properties": { "SessionTransferTokenTTL": { "format": "int32", "description": "This value determines how long in seconds the token should live.\r\nIf omitted from the request, the session transfer TTL will default to 60 seconds.", "type": "integer" }, "OrganisationIdentifier": { "$ref": "#/definitions/OrganisationIdentifier", "description": "This determines the organisation that the request will be run as. This changes the authentication context to be for this organisation." } } }, "ProposalCreateGuestSessionResponse": { "type": "object", "properties": { "SessionToken": { "description": "This value identifies the session.\r\nThis is typically stored in a session cookie and passed to other authenticated Codeweavers APIs as a header.", "type": "string" }, "SessionTransferToken": { "description": "A session transfer token is a single use value used to securely transfer the session token from one client facing application to another.", "type": "string" } } }, "AppendQuoteToOrderRequest": { "type": "object", "properties": { "QuoteReference": { "type": "string" }, "PartExchangeReference": { "type": "string" } } }, "ValidateOrderQuoteAppendResponse": { "type": "object", "properties": { "QuoteIsValid": { "type": "boolean" }, "ErrorMessage": { "type": "string" } } }, "ConfirmOrderRequest": { "type": "object", "properties": { "QuoteReference": { "description": "The quote reference associated to an order", "type": "string" } } }, "ConfirmOrderResponse": { "type": "object", "properties": {} }, "OrderDeliveryAddressResponse": { "type": "object", "properties": { "Address": { "$ref": "#/definitions/DeliveryAddress" } } }, "DeliveryAddress": { "type": "object", "properties": { "Street": { "type": "string" }, "Locale1": { "type": "string" }, "Locale2": { "type": "string" }, "City": { "type": "string" }, "County": { "type": "string" }, "PostCode": { "type": "string" }, "Telephone": { "type": "string" } } }, "UpdateOrderDeliveryAddressRequest": { "type": "object", "properties": { "Address": { "$ref": "#/definitions/DeliveryAddress" } } }, "OrderJourneyValidationResponse": { "type": "object", "properties": { "Configuration": { "$ref": "#/definitions/OrderCheckoutConfiguration", "description": "Indicates whether the organisation has the minimal required setup for the commerce orders journey to be available." } } }, "OrderCheckoutConfiguration": { "description": "Contains information about commerce orders journey functionality that is available to the organisation.", "type": "object", "properties": { "IsPartExchangeEnabled": { "description": "Indicates whether the organisation has part exchange functionality in its commerce orders journey.", "type": "boolean" }, "AreVapsEnabled": { "description": "Indicates whether the organisation has value added products available in its commerce orders journey.", "type": "boolean" }, "AllowApplyBeforeReserve": { "description": "Indicates whether customers are allowed to apply for finance without first reserving their chosen vehicle.", "type": "boolean" }, "IsApplyEnabled": { "description": "Indicates whether customers are shown the apply form as part of the checkout journey.", "type": "boolean" }, "IsDeliveryAvailable": { "description": "Indicates whether the retailer supports delivering the vehicle to an address specified by the customer.", "type": "boolean" }, "IsCollectionAvailable": { "description": "Indicates whether the retailer supports the customer collecting the vehicle from the retailer's location.", "type": "boolean" }, "IsDeliveryDateSelectionEnabled": { "description": "Indicates whether the retailer supports allowing the customer to select a delivery date for their vehicle.", "type": "boolean" }, "IsReserveEnabled": { "description": "Indicates whether the retailer supports allowing the customer to reserve the vehicle.", "type": "boolean" } } }, "PaymentConfigurationResponse": { "type": "object", "properties": { "Provider": { "type": "string" }, "Url": { "type": "string" }, "PublicKey": { "type": "string" }, "ReservationAmount": { "format": "double", "type": "number" }, "AuthoriseOnly": { "type": "boolean" }, "IsPostcodeRequired": { "type": "boolean" }, "IsoCurrencyCode": { "type": "string" }, "AssociatedRetailerReference": { "type": "string" } } }, "UpdateOrderDeliveryHandoverTypeRequest": { "type": "object", "properties": { "HandoverType": { "enum": [ "NotSet", "ForDelivery", "ForCollection" ], "type": "string" } } }, "UpdateOrderDeliveryHandoverTypeResponse": { "type": "object", "properties": {} }, "GetFullHandoverDetailsResponse": { "type": "object", "properties": { "HandoverType": { "enum": [ "NotSet", "ForDelivery", "ForCollection" ], "type": "string" }, "IsDeliveryAvailable": { "type": "boolean" }, "IsCollectionAvailable": { "type": "boolean" }, "MinimumDeliveryFee": { "format": "double", "type": "number" }, "DeliveryDetails": { "$ref": "#/definitions/DeliveryDetails" }, "CollectionDetails": { "$ref": "#/definitions/CollectionDetails" }, "HandoverDateDetails": { "$ref": "#/definitions/HandoverDateDetails" }, "DeliveryFeeIsStatic": { "type": "boolean" }, "Formula": { "$ref": "#/definitions/DigitalRetailStoreDeliveryFormula" } } }, "DeliveryDetails": { "type": "object", "properties": { "Address": { "$ref": "#/definitions/DeliveryAddress" }, "Fee": { "format": "double", "type": "number" }, "Route": { "$ref": "#/definitions/DeliveryRoute" } } }, "CollectionDetails": { "type": "object", "properties": { "Address": { "$ref": "#/definitions/OrganisationAddress" }, "CollectionType": { "enum": [ "FromDealersAddress", "FromCollectionPoint" ], "type": "string" }, "CollectionPointDetails": { "$ref": "#/definitions/CollectionPointDetails" } } }, "HandoverDateDetails": { "type": "object", "properties": { "SelectedDate": { "$ref": "#/definitions/SelectedDeliveryDate" }, "AvailableDatesForSelection": { "type": "array", "items": { "format": "date-time", "type": "string" } } } }, "DeliveryRoute": { "type": "object", "properties": { "Distance": { "format": "double", "type": "number" }, "DistanceUnit": { "enum": [ "Miles", "Kilometres", "Mil" ], "type": "string" } } }, "CollectionPointDetails": { "type": "object", "properties": { "SelectedCollectionPoint": { "$ref": "#/definitions/CollectionPointWithReference" }, "AvailableCollectionPoints": { "type": "array", "items": { "$ref": "#/definitions/CollectionPointWithReference" } } } }, "SelectedDeliveryDate": { "type": "object", "properties": { "Date": { "format": "date-time", "type": "string" }, "IsConfirmedByRetailer": { "type": "boolean" } } }, "CollectionPointWithReference": { "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Name": { "type": "string" }, "Price": { "format": "double", "type": "number" }, "MarketingText": { "type": "string" }, "Address": { "$ref": "#/definitions/OrganisationAddress" } } }, "UpdateOrderHandoverDateRequest": { "required": [ "Date" ], "type": "object", "properties": { "Date": { "format": "date-time", "type": "string" }, "Type": { "enum": [ "Estimated", "Confirmed" ], "type": "string" } } }, "UpdateOrderHandoverDateResponse": { "type": "object", "properties": {} }, "UpdateOrderCollectionPointResponse": { "type": "object", "properties": {} }, "GetOrderInvoiceResponse": { "type": "object", "properties": { "InvoiceSections": { "type": "array", "items": { "$ref": "#/definitions/InvoiceSection" } }, "ManualInvoiceSection": { "$ref": "#/definitions/ManualInvoiceSection" }, "IsFinalised": { "type": "boolean" }, "TotalPrice": { "format": "double", "type": "number" }, "InvoiceReference": { "type": "string" }, "InvoicePdfUrl": { "type": "string" }, "Type": { "enum": [ "FullCashPayment", "CashDeposit" ], "type": "string" } } }, "InvoiceSection": { "type": "object", "properties": { "SectionName": { "type": "string" }, "InvoiceLines": { "type": "array", "items": { "$ref": "#/definitions/InvoiceLine" } }, "SectionPrice": { "format": "double", "type": "number" } } }, "ManualInvoiceSection": { "type": "object", "properties": { "ManualInvoiceLines": { "type": "array", "items": { "$ref": "#/definitions/ManualInvoiceLine" } }, "SectionPrice": { "format": "double", "type": "number" } } }, "InvoiceLine": { "type": "object", "properties": { "Description": { "type": "string" }, "Price": { "format": "double", "type": "number" } } }, "ManualInvoiceLine": { "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "InvoiceLine": { "$ref": "#/definitions/InvoiceLine" } } }, "AddInvoiceLineRequest": { "type": "object", "properties": { "Description": { "type": "string" }, "Price": { "format": "double", "type": "number" } } }, "AddInvoiceLineResponse": { "type": "object", "properties": { "InvoiceLineReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } }, "RemoveInvoiceLineResponse": { "type": "object", "properties": {} }, "FinaliseStripeInvoiceRequest": { "type": "object", "properties": {} }, "FinaliseStripeInvoiceResponse": { "type": "object", "properties": { "InvoiceReference": { "type": "string" }, "InvoicePdfUrl": { "type": "string" } } }, "GetStripeIdentityVerificationResponse": { "type": "object", "properties": { "IdentityReference": { "type": "string" }, "IdentityIdentifier": { "type": "string" }, "Status": { "type": "string" }, "StatusLabel": { "type": "string" }, "UpdatedAt": { "format": "date-time", "type": "string" }, "Provider": { "type": "string" }, "ExpiresAt": { "format": "date-time", "type": "string" }, "IsResendable": { "type": "boolean" } } }, "TriggerStripeIdentityVerificationRequest": { "type": "object", "properties": {} }, "TriggerStripeIdentityVerificationResponse": { "type": "object", "properties": { "IdentityReference": { "type": "string" }, "IdentityVerificationUrl": { "type": "string" } } }, "GetOrganisationNotesResponse": { "type": "object", "properties": { "Notes": { "type": "array", "items": { "$ref": "#/definitions/OrganisationsNote" } } } }, "OrganisationsNote": { "type": "object", "properties": { "CreatedAt": { "format": "date-time", "type": "string" }, "Content": { "type": "string" } } }, "AddOrganisationNoteRequest": { "type": "object", "properties": { "Note": { "type": "string" } } }, "AddOrganisationNoteResponse": { "type": "object", "properties": {} }, "GetIntegrationsResponse": { "type": "object", "properties": { "Categories": { "type": "array", "items": { "$ref": "#/definitions/IntegrationCategory" } } } }, "IntegrationCategory": { "type": "object", "properties": { "CategoryName": { "type": "string" }, "Providers": { "type": "array", "items": { "$ref": "#/definitions/IntegrationProvider" } } } }, "IntegrationProvider": { "type": "object", "properties": { "ProviderName": { "type": "string" }, "Fields": { "type": "array", "items": { "$ref": "#/definitions/IntegrationProviderField" } }, "Description": { "type": "string" } } }, "IntegrationProviderField": { "type": "object", "properties": { "Name": { "type": "string" }, "Type": { "type": "string" }, "Required": { "type": "boolean" } } }, "QuotesForOrganisationResponse": { "type": "object", "properties": { "Quotes": { "type": "array", "items": { "$ref": "#/definitions/OrganisationQuote" } } } }, "OrganisationQuote": { "type": "object", "properties": { "VehicleIdentifier": { "type": "string" }, "DateOfRegistration": { "type": "string" }, "Created": { "type": "string" }, "VehicleRequestId": { "type": "string" }, "CashPrice": { "type": "string" }, "QuoteReference": { "type": "string" }, "ProductKey": { "type": "string" }, "FinanceProductName": { "type": "string" }, "RegularPayment": { "type": "string" }, "ErrorMessage": { "type": "string" }, "HasError": { "type": "boolean" } } }, "OrganisationProposalIntegrationRequest": { "required": [ "IsActive", "Arguments", "Triggers" ], "type": "object", "properties": { "IsActive": { "type": "boolean" }, "Arguments": { "type": "array", "items": { "$ref": "#/definitions/OrganisationProposalIntegrationArgument" } }, "Triggers": { "type": "array", "items": { "$ref": "#/definitions/OrganisationProposalIntegrationTrigger" } } } }, "OrganisationProposalIntegrationArgument": { "required": [ "Key", "Value" ], "type": "object", "properties": { "Key": { "type": "string" }, "Value": { "type": "string" } } }, "OrganisationProposalIntegrationTrigger": { "required": [ "Key", "IsEnabled" ], "type": "object", "properties": { "Key": { "type": "string" }, "IsEnabled": { "type": "boolean" } } }, "ProposalIntegrationWithReference": { "type": "object", "properties": { "Reference": { "type": "string" }, "Url": { "type": "string" }, "DisplayName": { "type": "string" }, "Description": { "type": "string" }, "IntegrationKey": { "type": "string" }, "Triggers": { "type": "array", "items": { "$ref": "#/definitions/ProposalIntegrationTrigger" } }, "Parameters": { "type": "array", "items": { "$ref": "#/definitions/ProposalIntegrationParameter" } }, "EnquiryFormKey": { "type": "string" }, "RetailerSystemReference": { "type": "string" } } }, "ProposalIntegrationTrigger": { "required": [ "TriggerKey", "IsEnabledByDefault", "IsDefaultOverridable" ], "type": "object", "properties": { "TriggerKey": { "type": "string" }, "IsEnabledByDefault": { "type": "boolean" }, "IsDefaultOverridable": { "type": "boolean" } } }, "ProposalIntegrationParameter": { "required": [ "Key", "DisplayName", "Description", "DefaultValue", "IsDefaultOverridable" ], "type": "object", "properties": { "Key": { "type": "string" }, "DisplayName": { "type": "string" }, "Description": { "type": "string" }, "DefaultValue": { "type": "string" }, "IsDefaultOverridable": { "type": "boolean" } } }, "ListOrganisationsProposalIntegrationsResponse": { "type": "object", "properties": { "ProposalIntegrations": { "type": "array", "items": { "$ref": "#/definitions/OrganisationProposalIntegrationResponse" } } } }, "OrganisationProposalIntegrationResponse": { "type": "object", "properties": { "IsActive": { "type": "boolean" }, "Arguments": { "type": "array", "items": { "$ref": "#/definitions/OrganisationProposalIntegrationResponseArgument" } }, "Triggers": { "type": "array", "items": { "$ref": "#/definitions/OrganisationProposalIntegrationResponseTrigger" } }, "ProposalIntegrationReference": { "type": "string" } } }, "OrganisationProposalIntegrationResponseArgument": { "type": "object", "properties": { "Key": { "type": "string" }, "Value": { "type": "string" } } }, "OrganisationProposalIntegrationResponseTrigger": { "type": "object", "properties": { "Key": { "type": "string" }, "IsEnabled": { "type": "boolean" } } }, "RetrieveContentKeysResponse": { "type": "object", "properties": { "ContentKeys": { "type": "array", "items": { "$ref": "#/definitions/ContentKey" } } } }, "ContentKey": { "type": "object", "properties": { "Key": { "type": "string" }, "Tags": { "type": "array", "items": { "type": "string" } } } }, "VapPackagesResponse": { "type": "object", "properties": { "VapPackages": { "type": "array", "items": { "$ref": "#/definitions/OrganisationVapPackageWithVaps" } } } }, "FilterValueAddedProductPackageRequest": { "required": [ "Filters" ], "type": "object", "properties": { "Filters": { "$ref": "#/definitions/VapFilters" } } }, "VapFilters": { "type": "object", "properties": { "IncludeConsumer": { "type": "boolean" }, "IncludeNonConsumer": { "type": "boolean" } } }, "OrganisationConfigurationResponseVersion7": { "type": "object", "properties": { "LegacyDealerId": { "format": "int32", "type": "integer" }, "OrganisationReference": { "type": "string" }, "Configuration": { "$ref": "#/definitions/OrganisationStateConfigurationVersion7" } } }, "OrganisationStateConfigurationVersion7": { "type": "object", "properties": { "IsActive": { "type": "boolean" }, "Details": { "$ref": "#/definitions/OrganisationDetailsVersion7" }, "Settings": { "$ref": "#/definitions/OrganisationSettingsVersion7" }, "Invoicing": { "type": "array", "items": { "$ref": "#/definitions/OrganisationAdditionalDataVersion7" } }, "AdditionalData": { "type": "array", "items": { "$ref": "#/definitions/OrganisationAdditionalDataVersion7" } }, "FinancePackageIds": { "type": "array", "items": { "format": "int32", "type": "integer" } }, "Channels": { "type": "array", "items": { "$ref": "#/definitions/ChannelConfigurationVersion7" } }, "ModuleProductIds": { "type": "array", "items": { "format": "int32", "type": "integer" } }, "ModuleIds": { "type": "array", "items": { "format": "int32", "type": "integer" } }, "WorkspaceReferences": { "type": "array", "items": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } }, "References": { "type": "array", "items": { "$ref": "#/definitions/OrganisationReferencesVersion7" } }, "ValueAddedProductPackages": { "type": "array", "items": { "type": "string" } }, "Theme": { "$ref": "#/definitions/ThemeVersion7" }, "ShowroomConfiguration": { "$ref": "#/definitions/ConfigurationShowroomConfigurationVersion7" }, "WorkspaceKey": { "type": "string" } } }, "OrganisationDetailsVersion7": { "type": "object", "properties": { "TradingName": { "type": "string" }, "DisplayName": { "type": "string" }, "ParentOrganisationId": { "format": "int32", "type": "integer" }, "FranchiseId": { "format": "int32", "type": "integer" }, "TypeId": { "format": "int32", "type": "integer" }, "OrganisationTypeKey": { "format": "int32", "type": "integer" }, "FcaNumber": { "type": "string" }, "DealerNumber": { "type": "string" }, "VatNumber": { "type": "string" }, "CompanyRegistrationNumber": { "type": "string" }, "Address": { "$ref": "#/definitions/ConfigurationAddressVersion7" }, "Communication": { "$ref": "#/definitions/ConfigurationCommunicationVersion7" }, "SalesforceId": { "type": "string" } } }, "OrganisationSettingsVersion7": { "type": "object", "properties": { "AutoSubmitToLender": { "type": "boolean" }, "VehicleDisplayPreference": { "type": "string" } } }, "OrganisationAdditionalDataVersion7": { "type": "object", "properties": { "Id": { "type": "string" }, "Value": { "type": "string" }, "AdditionalInformation": { "type": "string" }, "IsPublic": { "type": "boolean" } } }, "ChannelConfigurationVersion7": { "type": "object", "properties": { "IsActive": { "type": "boolean" }, "UseFinanceTermGroups": { "type": "boolean" }, "Key": { "type": "string" }, "Mappings": { "type": "array", "items": { "$ref": "#/definitions/MappingConfigurationVersion7" } } } }, "OrganisationReferencesVersion7": { "type": "object", "properties": { "ReferenceType": { "type": "string" }, "Reference": { "type": "string" } } }, "ThemeVersion7": { "type": "object", "properties": { "ThemeKey": { "type": "string" }, "VariantKey": { "type": "string" }, "ContentSet": { "type": "string" } } }, "ConfigurationShowroomConfigurationVersion7": { "type": "object", "properties": { "Id": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "DuplicateQuote": { "type": "boolean" }, "Providers": { "type": "boolean" }, "PreApproval": { "type": "boolean" }, "UseKanbanBoard": { "type": "boolean" }, "Statistics": { "type": "boolean" }, "Quoting": { "type": "boolean" }, "Leads": { "type": "boolean" }, "Customers": { "type": "boolean" }, "Proposals": { "type": "boolean" }, "ShowroomReporting": { "type": "boolean" }, "ShowroomUserManagement": { "type": "boolean" }, "FourSquare": { "type": "boolean" }, "VehicleSuggestions": { "type": "boolean" }, "ProfileButton": { "type": "boolean" }, "PartExchangeRules": { "type": "boolean" }, "ExportCustomerInformation": { "type": "boolean" }, "ShowroomRemoteApply": { "type": "boolean" }, "FranchiseApprovedVehicleSelection": { "type": "boolean" }, "Orders": { "type": "boolean" }, "Payments": { "type": "boolean" }, "PersistVaps": { "type": "boolean" }, "Volvo": { "type": "boolean" }, "EnableCalculationEndpointStats": { "type": "boolean" }, "ShowEndpointHitsInCalculationStats": { "type": "boolean" }, "ShowroomAccess": { "type": "boolean" }, "Promotions": { "type": "boolean" }, "EnableNonMotorAsset": { "type": "boolean" }, "HideAprFromShowroomQuickQuote": { "type": "boolean" }, "EnableShowroomCommunication": { "type": "boolean" }, "EnableShowroomVaps": { "type": "boolean" }, "SrDisableCommissionOverride": { "type": "boolean" }, "WorkQueues": { "type": "boolean" } } }, "ConfigurationAddressVersion7": { "type": "object", "properties": { "NameNumber": { "type": "string" }, "Line1": { "type": "string" }, "Line2": { "type": "string" }, "Line3": { "type": "string" }, "Postcode": { "type": "string" }, "City": { "type": "string" }, "County": { "type": "string" }, "CountryId": { "format": "int32", "type": "integer" }, "Longitude": { "format": "double", "type": "number" }, "Latitude": { "format": "double", "type": "number" } } }, "ConfigurationCommunicationVersion7": { "type": "object", "properties": { "PhoneNumber": { "type": "string" }, "FaxNumber": { "type": "string" }, "EmailAddress": { "type": "string" }, "Website": { "type": "string" }, "OffersWebsite": { "type": "string" }, "RetailerUrl": { "type": "string" } } }, "MappingConfigurationVersion7": { "type": "object", "properties": { "Key": { "type": "string" }, "DisplayName": { "type": "string" }, "TermGroups": { "type": "array", "items": { "$ref": "#/definitions/TermGroupConfigurationVersion7" } } } }, "TermGroupConfigurationVersion7": { "type": "object", "properties": { "Rate": { "format": "double", "type": "number" }, "OverrideRate": { "type": "boolean" }, "RateType": { "enum": [ "Undefined", "Apr", "CustomerRate", "Commission", "RateSpread", "CommissionCashPricePercentage", "NoSellout", "CommissionBalancePercentage", "Aer", "Yield", "CommissionCashPricePercentageVatExclusive" ], "type": "string" }, "TermGroupId": { "format": "int32", "type": "integer" }, "SystemId": { "format": "int32", "type": "integer" }, "ValidFrom": { "format": "date-time", "type": "string" }, "ValidTo": { "format": "date-time", "type": "string" } } }, "OrganisationConfigurationRequestVersion7": { "type": "object", "properties": { "Reason": { "type": "string" }, "Configuration": { "$ref": "#/definitions/OrganisationStateConfigurationVersion7" } } }, "OrganisationConfigurationWithChangesResponseVersion7": { "type": "object", "properties": { "Configuration": { "$ref": "#/definitions/OrganisationStateConfigurationVersion7" }, "Changes": { "$ref": "#/definitions/AuditSection" }, "FailedChanges": { "$ref": "#/definitions/AuditSection" }, "Errors": { "type": "array", "items": { "$ref": "#/definitions/ErrorResponse" } } } }, "AuditSection": { "type": "object", "properties": { "Sections": { "type": "array", "items": { "$ref": "#/definitions/AuditSection" } }, "Changes": { "type": "array", "items": { "$ref": "#/definitions/AuditField" } }, "AbsolutePath": { "type": "string" }, "RelativePath": { "type": "string" }, "DisplayValue": { "type": "string" } } }, "AuditField": { "type": "object", "properties": { "AbsolutePath": { "type": "string" }, "DisplayValue": { "type": "string" }, "RelativePath": { "type": "string" } } }, "OrganisationConfigurationAuditResponse": { "type": "object", "properties": { "AuditTrail": { "type": "array", "items": { "$ref": "#/definitions/ConfigurationAuditEntry" } }, "UnauditedTrail": { "type": "array", "items": { "$ref": "#/definitions/ConfigurationUnauditedEntry" } } } }, "ConfigurationAuditEntry": { "type": "object", "properties": { "AppliedAt": { "format": "date-time", "type": "string" }, "Reference": { "type": "string" }, "Changes": { "type": "array", "items": { "$ref": "#/definitions/Change" } }, "UserReference": { "type": "string" }, "User": { "$ref": "#/definitions/ConfigurationAuditUser" }, "Reason": { "type": "string" }, "Audit": { "$ref": "#/definitions/AuditSection" } } }, "ConfigurationUnauditedEntry": { "type": "object", "properties": { "AppliedAfterAuditReference": { "type": "string" }, "AppliedBeforeAuditReference": { "type": "string" }, "Changes": { "type": "array", "items": { "$ref": "#/definitions/Change" } }, "Audit": { "$ref": "#/definitions/AuditSection" } } }, "Change": { "type": "object", "properties": { "Path": { "type": "string" }, "DisplayName": { "type": "string" }, "DisplayProperty": { "type": "string" } } }, "ConfigurationAuditUser": { "type": "object", "properties": { "FirstName": { "type": "string" }, "LastName": { "type": "string" }, "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Username": { "type": "string" } } }, "OrganisationConfigurationAuditDetailsResponseVersion7": { "type": "object", "properties": { "Before": { "$ref": "#/definitions/OrganisationStateConfigurationVersion7" }, "After": { "$ref": "#/definitions/OrganisationStateConfigurationVersion7" }, "Changes": { "$ref": "#/definitions/AuditSection" } } }, "OrganisationConfigurationOptionsResponse": { "type": "object", "properties": { "Franchises": { "type": "array", "items": { "$ref": "#/definitions/RetailerConfigurationOption" } }, "Branches": { "type": "array", "items": { "$ref": "#/definitions/RetailerConfigurationOption" } }, "OrganisationTypes": { "type": "array", "items": { "$ref": "#/definitions/RetailerConfigurationOption" } }, "Countries": { "type": "array", "items": { "$ref": "#/definitions/RetailerConfigurationCountryOption" } }, "ProductFamilies": { "type": "array", "items": { "$ref": "#/definitions/RetailerConfigurationOption" } }, "AdditionalDataTypes": { "type": "array", "items": { "$ref": "#/definitions/RetailerAdditionalDataOptions" } }, "RandomAdditionalDataTypes": { "type": "array", "items": { "$ref": "#/definitions/RetailerAdditionalDataOptions" } }, "InvoicingDataTypes": { "type": "array", "items": { "$ref": "#/definitions/RetailerAdditionalDataOptions" } }, "Applications": { "type": "array", "items": { "$ref": "#/definitions/RetailerApplicationOptions" } }, "Modules": { "type": "array", "items": { "$ref": "#/definitions/RetailerConfigurationOption" } }, "Themes": { "type": "array", "items": { "$ref": "#/definitions/ThemeOption" } } } }, "RetailerConfigurationOption": { "type": "object", "properties": { "Id": { "type": "string" }, "DisplayName": { "type": "string" }, "Description": { "type": "string" } } }, "RetailerConfigurationCountryOption": { "type": "object", "properties": { "Id": { "type": "string" }, "DisplayName": { "type": "string" }, "Description": { "type": "string" }, "Alpha2Code": { "type": "string" } } }, "RetailerAdditionalDataOptions": { "type": "object", "properties": { "Id": { "type": "string" }, "DisplayName": { "type": "string" }, "Type": { "type": "string" }, "ModuleIds": { "type": "array", "items": { "format": "int32", "type": "integer" } } } }, "RetailerApplicationOptions": { "type": "object", "properties": { "Id": { "type": "string" }, "DisplayName": { "type": "string" }, "Description": { "type": "string" }, "Modules": { "type": "array", "items": { "$ref": "#/definitions/RetailerConfigurationOption" } } } }, "ThemeOption": { "type": "object", "properties": { "Key": { "type": "string" }, "DisplayName": { "type": "string" } } }, "CreateOrganisationBySalesForceIdRequest": { "type": "object", "properties": { "SalesForceId": { "type": "string" } } }, "CreateOrganisationResponse": { "type": "object", "properties": { "LegacyDealerId": { "format": "int32", "type": "integer" }, "ApiKey": { "type": "string" }, "Reference": { "type": "string" } } }, "OrganisationThemeResponse": { "type": "object", "properties": { "ThemeKey": { "type": "string" }, "VariantKey": { "type": "string" }, "Theme": { "$ref": "#/definitions/ThemeVariantModel" } } }, "ThemeVariantModel": { "type": "object", "properties": { "Key": { "type": "string" }, "Name": { "type": "string" }, "CssUrl": { "type": "string" }, "CssVars": { "type": "string" }, "LogoUrl": { "type": "string" }, "LogoHeaderUrl": { "type": "string" }, "FaviconUrl": { "type": "string" }, "NavbarLogoUrl": { "type": "string" }, "VideoStyle": { "type": "string" }, "Videos": { "type": "array", "items": { "$ref": "#/definitions/ThemeVariantVideoLink" } } } }, "ThemeVariantVideoLink": { "type": "object", "properties": { "Name": { "type": "string" }, "Url": { "type": "string" }, "Thumbnail": { "type": "string" } } }, "OrganisationSearchRequest": { "required": [ "Filters" ], "type": "object", "properties": { "Filters": { "$ref": "#/definitions/OrganisationFilterParameters" }, "Page": { "format": "int32", "type": "integer" }, "ResultsPerPage": { "format": "int32", "type": "integer" }, "SortBy": { "enum": [ "Unknown", "AsRequested", "RegularPaymentDescending", "RegularPaymentAscending", "Distance", "PriceDescending", "PriceAscending", "Relevance", "LastUpdatedDescending", "LastUpdatedAscending", "MileageDescending", "MileageAscending" ], "type": "string" } } }, "OrganisationFilterParameters": { "type": "object", "properties": { "Location": { "$ref": "#/definitions/LocationFilter" }, "Query": { "type": "string" }, "Scope": { "enum": [ "Group", "System", "Retailer" ], "type": "string" }, "OrganisationType": { "type": "string" }, "Active": { "enum": [ "All", "Active", "Inactive" ], "type": "string" } } }, "LocationFilter": { "type": "object", "properties": { "Latitude": { "format": "double", "type": "number" }, "Longitude": { "format": "double", "type": "number" }, "Distance": { "format": "double", "type": "number" }, "PostCode": { "type": "string" }, "Retailers": { "type": "array", "items": { "$ref": "#/definitions/OrganisationIdentifier" } } } }, "OrganisationSearchResponse": { "type": "object", "properties": { "Retailers": { "type": "array", "items": { "$ref": "#/definitions/OrganisationResponse" } }, "CurrentPage": { "format": "int32", "type": "integer" }, "TotalPages": { "format": "int32", "type": "integer" }, "OrganisationSearched": { "format": "int32", "type": "integer" }, "TotalResults": { "format": "int32", "type": "integer" } } }, "AddExistingUserToOrganisationRequest": { "type": "object", "properties": { "UserReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Notifications": { "type": "boolean" } } }, "OrganisationInviteRequest": { "required": [ "Email" ], "type": "object", "properties": { "Email": { "type": "string" }, "Branding": { "type": "string" }, "RoleId": { "format": "int32", "type": "integer" }, "Notifications": { "type": "boolean" } } }, "OrganisationInviteRolesResponse": { "type": "object", "properties": { "PermittedInviteRoles": { "type": "array", "items": { "$ref": "#/definitions/OrganisationInviteRole" } } } }, "OrganisationInviteRole": { "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "Name": { "type": "string" } } }, "OrganisationModuleResponse": { "type": "object", "properties": { "Modules": { "type": "array", "items": { "$ref": "#/definitions/OrganisationModuleModel" } } } }, "OrganisationModuleModel": { "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "Name": { "type": "string" }, "DisplayName": { "type": "string" }, "Description": { "type": "string" }, "IsPublic": { "type": "boolean" }, "IsEnabled": { "type": "boolean" }, "Applications": { "type": "array", "items": { "$ref": "#/definitions/ModuleApplicationModel" } }, "Status": { "$ref": "#/definitions/ModuleStatus" } } }, "ModuleApplicationModel": { "type": "object", "properties": { "Name": { "type": "string" }, "IsRequired": { "type": "boolean" } } }, "ModuleStatus": { "type": "object", "properties": { "IsAllowed": { "type": "boolean" }, "Message": { "type": "string" } } }, "OrganisationUpdateModulesResponse": { "type": "object", "properties": { "ModuleTypeIds": { "type": "array", "items": { "format": "int32", "type": "integer" } } } }, "OrganisationWorkspacesResponse": { "type": "object", "properties": { "Apps": { "type": "array", "items": { "$ref": "#/definitions/WorkspaceApiOverviewModel" } } } }, "OrganisationShowroomConfigurationResponse": { "type": "object", "properties": { "ShowroomConfiguration": { "$ref": "#/definitions/ShowroomConfigurationModel" } } }, "ShowroomConfigurationModel": { "type": "object", "properties": { "Id": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "DuplicateQuote": { "type": "boolean" }, "Providers": { "type": "boolean" }, "PreApproval": { "type": "boolean" }, "UseKanbanBoard": { "type": "boolean" }, "Statistics": { "type": "boolean" }, "Quoting": { "type": "boolean" }, "Leads": { "type": "boolean" }, "Customers": { "type": "boolean" }, "Proposals": { "type": "boolean" }, "ShowroomReporting": { "type": "boolean" }, "ShowroomUserManagement": { "type": "boolean" }, "FourSquare": { "type": "boolean" }, "VehicleSuggestions": { "type": "boolean" }, "ProfileButton": { "type": "boolean" }, "PartExchangeRules": { "type": "boolean" }, "ExportCustomerInformation": { "type": "boolean" }, "ShowroomRemoteApply": { "type": "boolean" }, "FranchiseApprovedVehicleSelection": { "type": "boolean" }, "Orders": { "type": "boolean" }, "Payments": { "type": "boolean" }, "PersistVaps": { "type": "boolean" }, "Volvo": { "type": "boolean" }, "EnableCalculationEndpointStats": { "type": "boolean" }, "ShowEndpointHitsInCalculationStats": { "type": "boolean" }, "ShowroomAccess": { "type": "boolean" }, "Promotions": { "type": "boolean" }, "EnableNonMotorAsset": { "type": "boolean" }, "HideAprFromShowroomQuickQuote": { "type": "boolean" }, "EnableShowroomCommunication": { "type": "boolean" }, "EnableShowroomVaps": { "type": "boolean" }, "SrDisableCommissionOverride": { "type": "boolean" }, "WorkQueues": { "type": "boolean" } } }, "OrganisationUsersResponse": { "type": "object", "properties": { "Users": { "type": "array", "items": { "$ref": "#/definitions/OrganisationUser" } } } }, "OrganisationUser": { "type": "object", "properties": { "Reference": { "type": "string" }, "Name": { "$ref": "#/definitions/PersonName" }, "Role": { "$ref": "#/definitions/OrganisationUserRole" }, "Username": { "type": "string" }, "Email": { "type": "string" }, "IsActive": { "type": "boolean" }, "LoginCount": { "format": "int64", "type": "integer" }, "FailedLoginCount": { "format": "int32", "type": "integer" }, "LastLogin": { "format": "date-time", "type": "string" }, "EndpointAuthenticationCount": { "format": "int64", "type": "integer" }, "NotificationSubscriptions": { "type": "array", "items": { "$ref": "#/definitions/OrganisationUserNotificationSubscription" } }, "Credentials": { "type": "array", "items": { "$ref": "#/definitions/OrganisationUserCredential" } }, "Managers": { "type": "array", "items": { "$ref": "#/definitions/TeamManager" } } } }, "OrganisationUserRole": { "type": "object", "properties": { "Id": { "type": "string" }, "Name": { "type": "string" } } }, "OrganisationUserNotificationSubscription": { "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "Description": { "type": "string" } } }, "OrganisationUserCredential": { "type": "object", "properties": { "Type": { "type": "string" }, "Value": { "type": "string" }, "VerifiedAt": { "format": "date-time", "type": "string" } } }, "TeamManager": { "type": "object", "properties": { "ManagerUserReference": { "type": "string" }, "FirstName": { "type": "string" }, "LastName": { "type": "string" }, "Email": { "type": "string" } } }, "UserSearchRequest": { "type": "object", "properties": { "Filters": { "$ref": "#/definitions/UserFilterParameters" }, "SortByProperty": { "enum": [ "Unknown", "FirstName", "LastName", "Email" ], "type": "string" }, "SortByAscending": { "type": "boolean" }, "Page": { "format": "int32", "type": "integer" }, "ResultsPerPage": { "format": "int32", "type": "integer" } } }, "UserFilterParameters": { "type": "object", "properties": { "Roles": { "type": "array", "items": { "enum": [ "Unknown", "SystemAdministrator", "WebserviceAccount", "DealerAdministrator", "DealerUser", "BranchUser", "SSOManager", "SSOUser", "CodeweaversStaff", "StatusUpdate", "ThirdPartySystem", "SalesAdministrator", "Pricing", "ContractActivation", "CreditManagement", "AssetRisk", "VehicleAdministration", "ContractSupport", "CreditControl", "FinancialControlling", "BusinessAnalyst", "Integrator", "SystemService", "WorkspaceAdmin", "BrokerAdministrator", "LenderAdministrator", "MercedesCustomer", "DriverPortalUser", "DriverPortalManager" ], "type": "string" } }, "Query": { "type": "string" } } }, "OrganisationApiKeyUsersResponse": { "type": "object", "properties": { "ApiKeyUsers": { "type": "array", "items": { "$ref": "#/definitions/OrganisationApiKeyUser" } } } }, "OrganisationApiKeyUser": { "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "ApiKey": { "type": "string" } } }, "RemoveUserFromOrganisationsRequest": { "type": "object", "properties": { "OrganisationReferences": { "type": "array", "items": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } } }, "RemoveUserFromOrganisationsResponse": { "type": "object", "properties": {} }, "CreateOrganisationUserRequest": { "type": "object", "properties": { "Username": { "type": "string" }, "Title": { "type": "string" }, "FistName": { "type": "string" }, "LastName": { "type": "string" }, "Password": { "type": "string" }, "RoleId": { "format": "int32", "type": "integer" }, "Notifications": { "type": "boolean" } } }, "ApplyDisplayPackageToAssociatedRequest": { "type": "object", "properties": { "PackageId": { "format": "int32", "type": "integer" } } }, "OrganisationReferencesResponse": { "type": "object", "properties": { "OrganisationReferences": { "type": "array", "items": { "$ref": "#/definitions/OrganisationReferenceModel" } } } }, "OrganisationReferenceModel": { "type": "object", "properties": { "Key": { "type": "string" }, "Value": { "type": "string" }, "Type": { "type": "string" } } }, "OrganisationReferenceTypesResponse": { "type": "object", "properties": { "Types": { "type": "array", "items": { "$ref": "#/definitions/OrganisationReferenceType" } } } }, "OrganisationReferenceType": { "type": "object", "properties": { "ReferenceTypeId": { "format": "int64", "type": "integer" }, "Key": { "type": "string" }, "ReferenceInformation": { "type": "string" }, "Type": { "type": "string" }, "AllowsCrossSystemLinking": { "type": "boolean" } } }, "GetLocalesForOrganisationResponse": { "type": "object", "properties": { "Locales": { "type": "array", "items": { "$ref": "#/definitions/LocaleData" } } } }, "GetOrganisationPrivacyPoliciesResponse": { "type": "object", "properties": { "Policies": { "type": "array", "items": { "$ref": "#/definitions/PrivacyPolicy" } } } }, "GetOrganisationVideosResponse": { "type": "object", "properties": { "VideoStyle": { "type": "string" }, "Videos": { "type": "object", "additionalProperties": { "$ref": "#/definitions/Video" } } } }, "Video": { "type": "object", "properties": { "Id": { "type": "string" }, "Url": { "type": "string" } } }, "GetIntegrationsForOrganisationResponse": { "type": "object", "properties": { "Integrations": { "type": "array", "items": { "$ref": "#/definitions/FinanceApplicationIntegration" } } } }, "FinanceApplicationIntegration": { "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Name": { "type": "string" }, "StringIdentifier": { "type": "string" }, "Url": { "type": "string" } } }, "GetFinanceApplicationIntegrationForOrganisationResponse": { "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Url": { "type": "string" }, "Name": { "type": "string" }, "StringIdentifier": { "type": "string" }, "Type": { "format": "int32", "type": "integer" }, "Environment": { "type": "string" }, "DestinationReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Parameters": { "type": "array", "items": { "$ref": "#/definitions/IntegrationParameterForOrganisation" } } } }, "IntegrationParameterForOrganisation": { "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Key": { "type": "string" }, "Value": { "type": "string" }, "Description": { "type": "string" }, "IsOverridable": { "type": "boolean" }, "IsEncrypted": { "type": "boolean" }, "IsEncryptable": { "type": "boolean" } } }, "GetCreditCheckAgencyForOrganisationResponse": { "type": "object", "properties": { "SubmissionKey": { "type": "string" }, "Description": { "type": "string" }, "DeleteDisabled": { "type": "boolean" }, "WebServiceOutSettings": { "type": "array", "items": { "$ref": "#/definitions/WebServiceOutSetting" } } } }, "WebServiceOutSetting": { "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "OverrideReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Value": { "type": "string" }, "Key": { "type": "string" }, "DefaultValue": { "type": "string" }, "IsOverrideable": { "type": "boolean" }, "IsEncrypted": { "type": "boolean" }, "IsEncryptable": { "type": "boolean" }, "Description": { "type": "string" }, "WebServiceClassIdentifier": { "type": "string" } } }, "SaveCreditRatingAgencySettingsForOrganisationRequest": { "type": "object", "properties": { "WebServiceOutSettings": { "type": "array", "items": { "$ref": "#/definitions/WebServiceOutSetting" } } } }, "SaveCreditRatingAgencySettingsForOrganisationResponse": { "type": "object", "properties": {} }, "GetWebServiceOutsForOrganisationResponse": { "type": "object", "properties": { "OverrideIntegrationReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "WebServiceOuts": { "type": "array", "items": { "$ref": "#/definitions/WebServiceOut" } } } }, "WebServiceOut": { "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "SubmissionKey": { "type": "string" }, "Description": { "type": "string" }, "IsNew": { "type": "boolean" }, "WebServiceOutSettings": { "type": "array", "items": { "$ref": "#/definitions/WebServiceOutSetting" } } } }, "SaveWebServiceOutsForOrganisationRequest": { "type": "object", "properties": { "WebServiceOutSettings": { "type": "array", "items": { "$ref": "#/definitions/WebServiceOutSetting" } } } }, "SaveWebServiceOutsForOrganisationResponse": { "type": "object", "properties": {} }, "SaveSubmitterOverrideForOrganisationRequest": { "type": "object", "properties": { "FinanceApplicationIntegrationReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } }, "SaveSubmitterOverrideForOrganisationResponse": { "type": "object", "properties": {} }, "RemoveWebServiceOutForOrganisationResponse": { "type": "object", "properties": {} }, "GetStockLocationsForOrganisationResponse": { "type": "object", "properties": { "StockLocations": { "type": "array", "items": { "$ref": "#/definitions/StockLocation" } } } }, "StockLocation": { "type": "object", "properties": { "OrganisationReference": { "type": "string" }, "TradingName": { "type": "string" }, "StockLocationReference": { "type": "string" }, "StockLocationType": { "type": "string" } } }, "SaveStockLocationForOrganisationRequest": { "type": "object", "properties": { "StockLocationReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "StockLocationType": { "type": "string" } } }, "SaveStockLocationForOrganisationResponse": { "type": "object", "properties": {} }, "UpdateStockLocationForOrganisationRequest": { "type": "object", "properties": { "NewStockLocationReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "PreviousStockLocationReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "StockLocationType": { "type": "string" } } }, "UpdateStockLocationForOrganisationResponse": { "type": "object", "properties": {} }, "RemoveStockLocationForOrganisationResponse": { "type": "object", "properties": {} }, "ApplyStockLocationToAssociatedOrganisationsRequest": { "type": "object", "properties": { "StockLocationReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "StockLocationType": { "type": "string" } } }, "ApplyStockLocationToAssociatedOrganisationsResponse": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/definitions/ErrorResponse" } }, "HasError": { "type": "boolean" }, "UpdatedAssociatedOrganisations": { "type": "array", "items": { "$ref": "#/definitions/AssociatedStockLocation" } } } }, "AssociatedStockLocation": { "type": "object", "properties": { "OrganisationReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "StockLocationReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "StockLocationType": { "enum": [ "Unknown", "Primary", "Retailer", "Group", "National" ], "type": "string" } } }, "GetOrganisationReportsSettingsResponse": { "type": "object", "properties": { "AvailableReports": { "type": "array", "items": { "$ref": "#/definitions/AvailableOrganisationReports" } } } }, "AvailableOrganisationReports": { "type": "object", "properties": { "Description": { "type": "string" }, "IsEnabled": { "type": "boolean" }, "Name": { "type": "string" }, "Id": { "type": "string" } } }, "DisableOrganisationReportSettingRequest": { "type": "object", "properties": { "ReportId": { "type": "string" } } }, "DisableOrganisationReportSettingResponse": { "type": "object", "properties": {} }, "EnableOrganisationReportSettingRequest": { "type": "object", "properties": { "ReportId": { "type": "string" } } }, "EnableOrganisationReportSettingResponse": { "type": "object", "properties": {} }, "GetAllApplicationsForOrganisationResponse": { "type": "object", "properties": { "Applications": { "type": "array", "items": { "$ref": "#/definitions/ProductModel" } } } }, "ProductModel": { "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "Name": { "type": "string" }, "Description": { "type": "string" }, "Modules": { "type": "array", "items": { "$ref": "#/definitions/ModuleModel" } }, "IsEnabled": { "type": "boolean" } } }, "ModuleModel": { "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "Name": { "type": "string" }, "DisplayName": { "type": "string" } } }, "UpdateOrganisationApplicationsRequest": { "type": "object", "properties": { "Applications": { "type": "array", "items": { "$ref": "#/definitions/OrganisationProduct" } } } }, "OrganisationProduct": { "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "IsEnabled": { "type": "boolean" } } }, "UpdateOrganisationApplicationsResponse": { "type": "object", "properties": {} }, "OrganisationPoliciesResponse": { "type": "object", "properties": { "Policies": { "type": "array", "items": { "$ref": "#/definitions/OrganisationPolicy" } } } }, "OrganisationPolicy": { "type": "object", "properties": { "Name": { "type": "string" }, "Version": { "type": "string" }, "CreatedAt": { "format": "date-time", "type": "string" }, "Content": { "type": "string" }, "PolicyType": { "type": "string" }, "AddedBy": { "type": "string" }, "AddedByReference": { "type": "string" }, "OrganisationReference": { "type": "string" }, "IsEnabled": { "type": "boolean" } } }, "SaveNewPolicyForOrganisationRequest": { "type": "object", "properties": { "Name": { "type": "string" }, "Version": { "type": "string" }, "Content": { "type": "string" }, "PolicyType": { "type": "string" }, "IsEnabled": { "type": "boolean" } } }, "SaveNewPolicyForOrganisationResponse": { "type": "object", "properties": { "Name": { "type": "string" }, "Version": { "type": "string" }, "CreatedAt": { "format": "date-time", "type": "string" }, "Content": { "type": "string" }, "PolicyType": { "type": "string" }, "AddedBy": { "type": "string" }, "AddedByReference": { "type": "string" }, "OrganisationReference": { "type": "string" }, "IsEnabled": { "type": "boolean" } } }, "OrganisationPolicyResponse": { "type": "object", "properties": { "OrganisationReference": { "type": "string" }, "AddedByReference": { "type": "string" }, "AddedBy": { "type": "string" }, "PolicyType": { "type": "string" }, "Content": { "type": "string" }, "CreatedAt": { "format": "date-time", "type": "string" }, "Version": { "type": "string" }, "Name": { "type": "string" }, "IsEnabled": { "type": "boolean" } } }, "GetOrganisationPluginConfigurationsResponse": { "type": "object", "properties": { "PluginsConfigurations": { "type": "array", "items": { "$ref": "#/definitions/PluginConfiguration" } } } }, "PluginConfiguration": { "type": "object", "properties": { "Reference": { "type": "string" }, "Name": { "type": "string" }, "PluginType": { "enum": [ "Unknown", "Alphera", "AstonMartin", "Bentley", "BlackHorse", "BlackHorseTesla", "CreditCalc", "Fca", "FinanceFinder", "FinCalc", "FlexiCalc", "MotoNovo", "MultiCalc", "PartExchange", "RollsRoyce", "Slider", "Tesla" ], "type": "string" }, "WhyFinanceIntroEnabled": { "type": "boolean" }, "MotorCreditCheckBrandingEnabled": { "type": "boolean" }, "CommercialVehicleModeEnabled": { "type": "boolean" }, "ShowWeeklyEquivalent": { "type": "boolean" }, "ShowProductNameInBanner": { "type": "boolean" }, "ShowLenderBranding": { "type": "boolean" }, "EmailQuoteEnabled": { "type": "boolean" }, "PrintQuoteEnabled": { "type": "boolean" }, "MotorCreditCheckEnabled": { "type": "boolean" }, "ShowTermInYears": { "type": "boolean" }, "StandaloneApplyFormEnabled": { "type": "boolean" } } }, "AddPluginConfigurationToOrganisationRequest": { "type": "object", "properties": { "Name": { "type": "string" }, "PluginType": { "enum": [ "Unknown", "Alphera", "AstonMartin", "Bentley", "BlackHorse", "BlackHorseTesla", "CreditCalc", "Fca", "FinanceFinder", "FinCalc", "FlexiCalc", "MotoNovo", "MultiCalc", "PartExchange", "RollsRoyce", "Slider", "Tesla" ], "type": "string" } } }, "AddPluginConfigurationToOrganisationResponse": { "type": "object", "properties": { "PluginConfigurationReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } }, "AddOrganisationAllowedOriginRequest": { "type": "object", "properties": { "Origin": { "type": "string" } } }, "AddOrganisationAllowedOriginResponse": { "type": "object", "properties": {} }, "GetOrganisationAllowedOriginsResponse": { "type": "object", "properties": { "Origins": { "type": "array", "items": { "type": "string" } } } }, "RemoveOrganisationAllowedOriginRequest": { "type": "object", "properties": { "Origin": { "type": "string" } } }, "RemoveOrganisationAllowedOriginResponse": { "type": "object", "properties": {} }, "AddOrganisationCountersignerRequest": { "type": "object", "properties": {} }, "AddOrganisationCountersignerResponse": { "type": "object", "properties": {} }, "RemoveOrganisationCountersignerResponse": { "type": "object", "properties": {} }, "GetOrganisationCountersignersResponse": { "type": "object", "properties": { "Countersigners": { "type": "array", "items": { "$ref": "#/definitions/OrganisationCountersigner" } } } }, "OrganisationCountersigner": { "type": "object", "properties": { "UserReference": { "type": "string" }, "FirstName": { "type": "string" }, "LastName": { "type": "string" }, "Email": { "type": "string" }, "OrganisationName": { "type": "string" } } }, "NotifyOrganisationCountersignerRequest": { "type": "object", "properties": { "FinanceApplicationReference": { "type": "string" } } }, "NotifyOrganisationCountersignerResponse": { "type": "object", "properties": {} }, "LendersResponse": { "type": "object", "properties": { "Lenders": { "type": "array", "items": { "$ref": "#/definitions/LenderForOrganisationModel" } } } }, "LenderForOrganisationModel": { "type": "object", "properties": { "Name": { "type": "string" }, "ConnectionState": { "enum": [ "Unknown", "Unavailable", "Connectable", "InProgress", "Connected" ], "type": "string" }, "SubmissionState": { "enum": [ "Unknown", "Unavailable", "Connectable", "Disabled", "Enabled" ], "type": "string" }, "LogoUrl": { "type": "string" }, "Reference": { "type": "string" } } }, "ConnectOrganisationLenderFormResponse": { "type": "object", "properties": { "Lender": { "$ref": "#/definitions/LenderForOrganisationModel" }, "Sections": { "type": "array", "items": { "$ref": "#/definitions/ConnectLenderFormSection" } } } }, "ConnectLenderFormSection": { "type": "object", "properties": { "Label": { "type": "string" }, "IsComplete": { "type": "boolean" }, "Order": { "format": "int32", "type": "integer" }, "Fields": { "type": "array", "items": { "$ref": "#/definitions/ConnectLenderFormField" } } } }, "ConnectLenderFormField": { "type": "object", "properties": { "Label": { "type": "string" }, "Identifier": { "type": "string" }, "Value": { "type": "string" }, "Error": { "type": "string" }, "Type": { "enum": [ "Unknown", "Input", "TextArea", "Select", "Email", "Currency", "TelephoneNumber", "Paragraph" ], "type": "string" }, "IsRequired": { "type": "boolean" }, "ToolTip": { "type": "string" }, "IsReadOnly": { "type": "boolean" }, "Options": { "type": "array", "items": { "$ref": "#/definitions/ConnectLenderFormFieldOption" } } } }, "ConnectLenderFormFieldOption": { "type": "object", "properties": { "Label": { "type": "string" }, "Value": { "type": "string" } } }, "UpdateConnectOrganisationLenderFormRequest": { "type": "object", "properties": { "Fields": { "type": "array", "items": { "$ref": "#/definitions/ConnectLenderFormFieldUpdate" } } } }, "ConnectLenderFormFieldUpdate": { "type": "object", "properties": { "Identifier": { "type": "string" }, "Value": { "type": "string" } } }, "SubmitOrganisationLenderConnectFormRequest": { "type": "object", "properties": {} }, "SubmitOrganisationLenderConnectFormResponse": { "type": "object", "properties": { "ResultMessage": { "type": "string" }, "Success": { "type": "boolean" } } }, "GetOrganisationIntegrationsResponse": { "type": "object", "properties": { "Integrations": { "type": "array", "items": { "$ref": "#/definitions/OrganisationIntegrationProvider" } } } }, "OrganisationIntegrationProvider": { "type": "object", "properties": { "Name": { "type": "string" }, "Category": { "type": "string" }, "Fields": { "type": "array", "items": { "$ref": "#/definitions/OrganisationIntegrationField" } }, "Usage": { "$ref": "#/definitions/OrganisationIntegrationUsageStats" }, "Description": { "type": "string" } } }, "OrganisationIntegrationField": { "type": "object", "properties": { "Name": { "type": "string" }, "Value": { "type": "string" } } }, "OrganisationIntegrationUsageStats": { "type": "object", "properties": { "LastUsed": { "format": "date-time", "type": "string" } } }, "AddIntegrationToOrganisationRequest": { "type": "object", "properties": { "CategoryName": { "type": "string" }, "Provider": { "type": "string" }, "Credentials": { "type": "array", "items": { "$ref": "#/definitions/OrganisationIntegrationField" } }, "Reason": { "type": "string" }, "Source": { "enum": [ "Unknown", "FinanceControlPanel", "StripeConnect" ], "type": "string" } } }, "AddIntegrationToOrganisationResponse": { "type": "object", "properties": {} }, "RemoveIntegrationFromOrganisationResponse": { "type": "object", "properties": {} }, "UpdateOrganisationIntegrationRequest": { "type": "object", "properties": { "Credentials": { "type": "array", "items": { "$ref": "#/definitions/Credential" } }, "Reason": { "type": "string" }, "Source": { "enum": [ "Unknown", "FinanceControlPanel", "StripeConnect" ], "type": "string" } } }, "Credential": { "type": "object", "properties": { "Name": { "type": "string" }, "Value": { "type": "string" } } }, "UpdateOrganisationIntegrationResponse": { "type": "object", "properties": {} }, "GetOrganisationIntegrationAuditRequest": { "type": "object", "properties": { "Page": { "format": "int32", "type": "integer" }, "ResultsPerPage": { "format": "int32", "type": "integer" } } }, "GetOrganisationIntegrationAuditResponse": { "type": "object", "properties": { "CredentialSets": { "type": "array", "items": { "$ref": "#/definitions/CredentialSet" } }, "Page": { "format": "int32", "type": "integer" }, "ResultsPerPage": { "format": "int32", "type": "integer" }, "TotalPages": { "format": "int32", "type": "integer" }, "TotalResults": { "format": "int32", "type": "integer" } } }, "CredentialSet": { "type": "object", "properties": { "Audit": { "$ref": "#/definitions/CredentialSetAudit" }, "Credentials": { "type": "array", "items": { "$ref": "#/definitions/CredentialSetValue" } }, "IsCurrent": { "type": "boolean" } } }, "CredentialSetAudit": { "type": "object", "properties": { "CreatedAt": { "format": "date-time", "type": "string" }, "DeletedAt": { "format": "date-time", "type": "string" }, "UserReference": { "type": "string" }, "Reason": { "type": "string" }, "User": { "$ref": "#/definitions/AuditUser" } } }, "CredentialSetValue": { "type": "object", "properties": { "Name": { "type": "string" }, "Value": { "type": "string" } } }, "AuditUser": { "type": "object", "properties": { "Reference": { "type": "string" }, "Username": { "type": "string" }, "FirstName": { "type": "string" }, "LastName": { "type": "string" } } }, "AddProviderCredentialsRequest": { "type": "object", "properties": { "DealerId": { "format": "int32", "type": "integer" }, "CategoryName": { "type": "string" }, "Provider": { "type": "string" }, "Credentials": { "type": "array", "items": { "$ref": "#/definitions/ProviderCredentialFieldModel" } }, "Reason": { "type": "string" }, "Source": { "enum": [ "Unknown", "FinanceControlPanel", "StripeConnect" ], "type": "string" } } }, "ProviderCredentialFieldModel": { "type": "object", "properties": { "Name": { "type": "string" }, "Value": { "type": "string" } } }, "AddProviderCredentialsResponse": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "type": "string" } } } }, "SearchCollectionPointsByDistanceRequest": { "required": [ "Latitude", "Longitude" ], "type": "object", "properties": { "Latitude": { "format": "double", "type": "number" }, "Longitude": { "format": "double", "type": "number" }, "MaximumDistance": { "format": "double", "type": "number" } } }, "SearchCollectionPointsByDistanceResponse": { "type": "object", "properties": { "CollectionPoints": { "type": "array", "items": { "$ref": "#/definitions/CollectionPointWithDistance" } } } }, "CollectionPointWithDistance": { "type": "object", "properties": { "CollectionPoint": { "$ref": "#/definitions/CollectionPoint" }, "Distance": { "format": "double", "type": "number" }, "DistanceUnit": { "enum": [ "Miles", "Kilometres", "Mil" ], "type": "string" } } }, "CollectionPoint": { "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Name": { "type": "string" }, "Address": { "$ref": "#/definitions/OrganisationAddress" }, "Price": { "format": "double", "type": "number" }, "MarketingText": { "type": "string" } } }, "GetOrganisationDeliveryFormulaResponse": { "type": "object", "properties": { "Formula": { "enum": [ "Unknown", "Unavailable", "FlatFee", "Tiered", "Scaled", "ScaledWithFlatOffset" ], "type": "string" }, "Details": { "$ref": "#/definitions/OrganisationDeliveryFeeDetails" }, "Description": { "type": "string" }, "DisallowsCollection": { "type": "boolean" } } }, "OrganisationDeliveryFeeDetails": { "type": "object", "properties": { "FlatFee": { "format": "double", "type": "number" }, "Scaling": { "$ref": "#/definitions/OrganisationScalingDeliveryFeeDetails" }, "Tiering": { "$ref": "#/definitions/OrganisationTieringDeliveryFeeDetails" }, "ScalingWithFlatOffset": { "$ref": "#/definitions/OrganisationScalingWithFlatOffsetDeliveryFeeDetails" }, "DistanceUnit": { "enum": [ "Miles", "Kilometres", "Mil" ], "type": "string" }, "MaximumDistance": { "format": "double", "type": "number" } } }, "UpdateOrganisationDeliveryFormulaRequest": { "type": "object", "properties": { "Formula": { "enum": [ "Unknown", "Unavailable", "FlatFee", "Tiered", "Scaled", "ScaledWithFlatOffset" ], "type": "string" }, "Details": { "$ref": "#/definitions/OrganisationDeliveryFeeDetails" }, "DisallowsCollection": { "type": "boolean" } } }, "UpdateOrganisationDeliveryFormulaResponse": { "type": "object", "properties": {} }, "GetOrganisationDeliveryWindowResponse": { "type": "object", "properties": { "AllowsDeliveryDateSelection": { "type": "boolean" }, "MinimumLeadTimeDays": { "format": "int32", "type": "integer" }, "NumberOfSelectableDates": { "format": "int32", "type": "integer" }, "SelectableDays": { "enum": [ "Unknown", "Weekdays", "WeekdaysPlusSaturdays", "AllDays" ], "type": "string" } } }, "UpdateOrganisationDeliveryWindowRequest": { "type": "object", "properties": { "AllowsDeliveryDateSelection": { "type": "boolean" }, "MinimumLeadTimeDays": { "format": "int32", "type": "integer" }, "NumberOfSelectableDates": { "format": "int32", "type": "integer" }, "SelectableDays": { "enum": [ "Unknown", "Weekdays", "WeekdaysPlusSaturdays", "AllDays" ], "type": "string" } } }, "UpdateOrganisationDeliveryWindowResponse": { "type": "object", "properties": {} }, "AddCollectionPointRequest": { "type": "object", "properties": { "CollectionPoint": { "$ref": "#/definitions/OrganisationAddress" }, "Name": { "type": "string" }, "Price": { "format": "double", "type": "number" }, "MarketingText": { "type": "string" } } }, "AddCollectionPointResponse": { "type": "object", "properties": {} }, "GetCollectionPointsResponse": { "type": "object", "properties": { "CollectionPoints": { "type": "array", "items": { "$ref": "#/definitions/CollectionPoint" } } } }, "RemoveCollectionPointResponse": { "type": "object", "properties": {} }, "CustomerOrganisationsImportRequest": { "type": "object", "properties": { "Organisations": { "type": "array", "items": { "$ref": "#/definitions/OrganisationRecord" } }, "WorkspaceReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "GroupOrganisationReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } }, "OrganisationRecord": { "required": [ "TradingName", "TelephoneNumber" ], "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "TradingName": { "maxLength": 2147483647, "minLength": 3, "type": "string" }, "TelephoneNumber": { "type": "string" }, "Email": { "type": "string" }, "Address": { "$ref": "#/definitions/OrganisationRecordAddress" } } }, "OrganisationRecordAddress": { "type": "object", "properties": { "Postcode": { "type": "string" } } }, "CustomerOrganisationsImportResponse": { "type": "object", "properties": { "Results": { "type": "array", "items": { "$ref": "#/definitions/Results" } } } }, "Results": { "type": "object", "properties": { "Reference": { "type": "string" }, "Id": { "format": "int32", "type": "integer" } } }, "RetrieveAssociatedOrganisationDetailsRequest": { "type": "object", "properties": { "ParentOrganisationReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "PageNumber": { "format": "int32", "type": "integer" }, "ResultsPerPage": { "format": "int32", "type": "integer" } } }, "CrossEnvironmentDuplicatorRequest": { "type": "object", "properties": {} }, "GetSectionResponse[OrganisationContentSection]": { "type": "object", "properties": { "OrganisationReference": { "format": "uuid", "type": "string", "readOnly": true, "example": "00000000-0000-0000-0000-000000000000" }, "Section": { "$ref": "#/definitions/OrganisationContentSection", "readOnly": true } } }, "OrganisationContentSection": { "type": "object", "properties": { "ContentSet": { "type": "string" } } }, "UpdateSectionRequest[OrganisationContentSection]": { "type": "object", "properties": { "Reason": { "type": "string" }, "Section": { "$ref": "#/definitions/OrganisationContentSection" } } }, "GetSectionResponse[OrganisationDetailsSection]": { "type": "object", "properties": { "OrganisationReference": { "format": "uuid", "type": "string", "readOnly": true, "example": "00000000-0000-0000-0000-000000000000" }, "Section": { "$ref": "#/definitions/OrganisationDetailsSection", "readOnly": true } } }, "OrganisationDetailsSection": { "type": "object", "properties": { "IsActive": { "type": "boolean" }, "TradingName": { "type": "string" }, "Introducer": { "type": "string" }, "ParentOrganisationId": { "format": "int32", "type": "integer" }, "FranchiseId": { "format": "int32", "type": "integer" }, "TypeId": { "format": "int32", "type": "integer" }, "FcaNumber": { "type": "string" }, "VatNumber": { "type": "string" }, "CompanyRegistrationNumber": { "type": "string" }, "Address": { "$ref": "#/definitions/AddressSection" }, "Communication": { "$ref": "#/definitions/CommunicationSection" }, "GdprCompliant": { "type": "boolean" } } }, "AddressSection": { "type": "object", "properties": { "HouseName": { "type": "string" }, "Street": { "type": "string" }, "Locale1": { "type": "string" }, "Locale2": { "type": "string" }, "Postcode": { "type": "string" }, "CityTown": { "type": "string" }, "County": { "type": "string" }, "CountryId": { "format": "int32", "type": "integer" }, "Longitude": { "format": "double", "type": "number" }, "Latitude": { "format": "double", "type": "number" } } }, "CommunicationSection": { "type": "object", "properties": { "PhoneNumber": { "type": "string" }, "FaxNumber": { "type": "string" }, "EmailAddress": { "type": "string" }, "Website": { "type": "string" }, "OffersWebsite": { "type": "string" }, "RetailerUrl": { "type": "string" } } }, "UpdateSectionRequest[OrganisationDetailsSection]": { "type": "object", "properties": { "Reason": { "type": "string" }, "Section": { "$ref": "#/definitions/OrganisationDetailsSection" } } }, "UpdateSectionResponse": { "type": "object", "properties": {} }, "GetAssociatedOrganisationsResponse": { "type": "object", "properties": { "AssociatedOrganisations": { "type": "array", "items": { "$ref": "#/definitions/AssociatedOrganisation" } } } }, "AssociatedOrganisation": { "type": "object", "properties": { "AssociatedKey": { "type": "string" }, "IsActive": { "type": "boolean" }, "LegacyDealerId": { "format": "int32", "type": "integer" }, "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "SystemId": { "format": "int32", "type": "integer" }, "TradingName": { "type": "string" } } }, "OrganisationAssociationRequest": { "type": "object", "properties": { "OrganisationReference": { "type": "string" }, "AssociatedOrganisationReference": { "type": "string" }, "AssociatedKey": { "type": "string" }, "NewAssociatedKey": { "type": "string" } } }, "AddOrganisationAssociationResponse": { "type": "object", "properties": {} }, "UpdateOrganisationAssociationResponse": { "type": "object", "properties": {} }, "GetOrganisationAssociationAuditRequest": { "type": "object", "properties": { "PageNumber": { "format": "int32", "type": "integer" }, "ResultsPerPage": { "format": "int32", "type": "integer" }, "StartDate": { "format": "date-time", "type": "string" }, "EndDate": { "format": "date-time", "type": "string" } } }, "GetOrganisationAssociationAuditResponse": { "type": "object", "properties": { "AuditRecords": { "type": "array", "items": { "$ref": "#/definitions/AssociationAudit" } }, "CurrentPage": { "format": "int32", "type": "integer" }, "ResultsPerPage": { "format": "int32", "type": "integer" }, "TotalPages": { "format": "int32", "type": "integer" }, "TotalResults": { "format": "int32", "type": "integer" } } }, "AssociationAudit": { "type": "object", "properties": { "ActionType": { "enum": [ "Unknown", "Add", "Update", "Remove" ], "type": "string" }, "Organisation": { "$ref": "#/definitions/OrganisationDetails" }, "Association": { "$ref": "#/definitions/OrganisationDetails" }, "PreviousAssociatedKey": { "type": "string" }, "NewAssociatedKey": { "type": "string" }, "UserDetails": { "$ref": "#/definitions/UserDetails" }, "OccurredAt": { "format": "date-time", "type": "string" }, "RelationshipType": { "enum": [ "Unknown", "Parent", "Child" ], "type": "string" } } }, "OrganisationDetails": { "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Name": { "type": "string" } } }, "UserDetails": { "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Name": { "type": "string" }, "Email": { "type": "string" } } }, "RemoveOrganisationAssociationResponse": { "type": "object", "properties": {} }, "GetGroupOrganisationsResponse": { "type": "object", "properties": { "GroupOrganisations": { "type": "array", "items": { "$ref": "#/definitions/GroupOrganisation" } } } }, "GroupOrganisation": { "type": "object", "properties": { "AssociatedKey": { "type": "string" }, "IsActive": { "type": "boolean" }, "LegacyDealerId": { "format": "int32", "type": "integer" }, "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "SystemId": { "format": "int32", "type": "integer" }, "TradingName": { "type": "string" } } }, "SearchAssociatedOrganisationsRequest": { "type": "object", "properties": { "PageNumber": { "format": "int32", "type": "integer" }, "ResultsPerPage": { "format": "int32", "type": "integer" }, "Filters": { "$ref": "#/definitions/SearchAssociatedOrganisationsFilters" } } }, "SearchAssociatedOrganisationsFilters": { "type": "object", "properties": { "AssociatedKey": { "type": "string" }, "TradingName": { "type": "string" } } }, "SearchAssociatedOrganisationsResponse": { "type": "object", "properties": { "AssociatedOrganisations": { "type": "array", "items": { "$ref": "#/definitions/FilteredAssociatedOrganisation" } }, "Associations": { "type": "array", "items": { "$ref": "#/definitions/FilteredAssociation" } }, "TotalResults": { "format": "int32", "type": "integer" } } }, "FilteredAssociatedOrganisation": { "type": "object", "properties": { "TradingName": { "type": "string" }, "AssociatedOrganisationReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "AssociatedKey": { "type": "string" }, "IsActive": { "type": "boolean" }, "LegacyDealerId": { "format": "int32", "type": "integer" }, "SystemId": { "format": "int32", "type": "integer" } } }, "FilteredAssociation": { "type": "object", "properties": { "AssociatedKey": { "type": "string" }, "Organisation": { "$ref": "#/definitions/AssociatedOrganisationApi" } } }, "AssociatedOrganisationApi": { "type": "object", "properties": { "Address": { "$ref": "#/definitions/OrganisationAddress" }, "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Email": { "type": "string" }, "Telephone": { "type": "string" }, "TradingName": { "type": "string" }, "IsActive": { "type": "boolean" }, "LegacyDealerId": { "format": "int32", "type": "integer" }, "SystemId": { "format": "int32", "type": "integer" } } }, "GetAdditionalDataForOrganisationResponse": { "type": "object", "properties": { "Fields": { "type": "array", "items": { "$ref": "#/definitions/OrganisationAdditionalData" } } } }, "OrganisationAdditionalData": { "type": "object", "properties": { "Name": { "type": "string" }, "Value": { "type": "string" }, "Type": { "enum": [ "Freeform", "Toggle" ], "type": "string" }, "IsPublic": { "type": "boolean" }, "IsRemovable": { "type": "boolean" } } }, "GetAdditionalDataFieldsResponse": { "type": "object", "properties": { "Fields": { "type": "array", "items": { "$ref": "#/definitions/AdditionalDataField" } } } }, "AdditionalDataField": { "type": "object", "properties": { "Name": { "type": "string" }, "Type": { "type": "string" }, "Id": { "format": "int64", "type": "integer" }, "ModuleIds": { "type": "array", "items": { "format": "int32", "type": "integer" } } } }, "OrganisationThirdPartyAnalyticsProvidersResponse": { "type": "object", "properties": { "GoogleTagManagerTrackingCode": { "type": "string" }, "GoogleAnalyticsTrackingCode": { "type": "string" } } }, "GetAllOrganisationTypesResponse": { "type": "object", "properties": { "OrganisationTypes": { "type": "array", "items": { "$ref": "#/definitions/OrganisationType" } } } }, "OrganisationType": { "type": "object", "properties": { "Key": { "format": "int32", "type": "integer" }, "DisplayName": { "type": "string" }, "Description": { "type": "string" } } }, "InitialiseFromEvaPartExchangeRequest": { "type": "object", "properties": { "ValuationGuid": { "type": "string" } } }, "InitialiseFromEvaPartExchangeResponse": { "type": "object", "properties": { "CodeweaversPartExchangeReference": { "type": "string" } } }, "SearchPartExchangesRequest": { "type": "object", "properties": { "Page": { "format": "int32", "type": "integer" }, "ResultsPerPage": { "format": "int32", "type": "integer" }, "Query": { "type": "string" } } }, "GetPartExchangeListResponse": { "type": "object", "properties": { "Results": { "type": "array", "items": { "$ref": "#/definitions/PartExchangeResponse" } }, "Pagination": { "$ref": "#/definitions/Pagination" } } }, "SavePartExchangeRequest": { "required": [ "OrganisationIdentifier" ], "type": "object", "properties": { "Vehicle": { "$ref": "#/definitions/PartExchangeVehicle" }, "OutstandingFinance": { "format": "double", "type": "number" }, "OrganisationIdentifier": { "$ref": "#/definitions/OrganisationIdentifier" }, "EstimatedHasOutstandingFinance": { "type": "boolean" } } }, "SavePartExchangeResponse": { "type": "object", "properties": { "PartExchangeReference": { "type": "string" } } }, "PartExchangeVehicleResponse": { "type": "object", "properties": { "PartExchangeReference": { "type": "string" }, "Vehicle": { "$ref": "#/definitions/PartExchangeVehicle" }, "AvailableSpecifications": { "type": "array", "items": { "$ref": "#/definitions/PartExchangeSpecification" } } } }, "GetPartExchangeQuestionsResponse": { "type": "object", "properties": { "Questions": { "type": "array", "items": { "$ref": "#/definitions/PartExchangeQuestionDefinition" } } } }, "PartExchangeQuestionDefinition": { "type": "object", "properties": { "Id": { "type": "string" }, "Reference": { "type": "string" }, "Question": { "type": "string" }, "Type": { "type": "string" }, "Placeholder": { "type": "string" }, "PossibleAnswers": { "type": "array", "items": { "$ref": "#/definitions/PartExchangeAnswerDefinition" } }, "Dependency": { "$ref": "#/definitions/PartExchangeQuestionDefinitionDependency" } } }, "PartExchangeAnswerDefinition": { "type": "object", "properties": { "Reference": { "type": "string" }, "Value": { "type": "string" }, "Descriptions": { "type": "array", "items": { "type": "string" } } } }, "PartExchangeQuestionDefinitionDependency": { "type": "object", "properties": { "Question": { "$ref": "#/definitions/PartExchangeQuestionDefinitionDependencyQuestion" } } }, "PartExchangeQuestionDefinitionDependencyQuestion": { "type": "object", "properties": { "Reference": { "type": "string" }, "Answer": { "$ref": "#/definitions/PartExchangeQuestionDefinitionDependencyQuestionAnswer" } } }, "PartExchangeQuestionDefinitionDependencyQuestionAnswer": { "type": "object", "properties": { "Reference": { "type": "string" } } }, "GetPartExchangeQuestionsBySectionResponse": { "type": "object", "properties": { "Sections": { "type": "array", "items": { "$ref": "#/definitions/PartExchangeQuestionsSection" } } } }, "PartExchangeQuestionsSection": { "type": "object", "properties": { "Id": { "type": "string" }, "Title": { "type": "string" }, "Description": { "type": "string" }, "Questions": { "type": "array", "items": { "$ref": "#/definitions/PartExchangeQuestionDefinition" } } } }, "ValidatePartExchangeQuestionsRequest": { "type": "object", "properties": { "Questions": { "type": "array", "items": { "$ref": "#/definitions/PartExchangeQuestion" } } } }, "ValidatePartExchangeQuestionsResponse": { "type": "object", "properties": { "ValidatedQuestions": { "type": "array", "items": { "$ref": "#/definitions/PartExchangeValidatedAnswer" } } } }, "PartExchangeValidatedAnswer": { "type": "object", "properties": { "QuestionId": { "type": "string" }, "IsValid": { "type": "boolean" }, "DisplayMessage": { "type": "string" } } }, "AddPartExchangeOfferRequest": { "type": "object", "properties": { "OrganisationIdentifier": { "$ref": "#/definitions/OrganisationIdentifier" }, "Amount": { "format": "double", "type": "number" }, "Expires": { "format": "date-time", "type": "string" } } }, "PartExchangeCalculateRequest": { "required": [ "Mileage" ], "type": "object", "properties": { "Questions": { "type": "array", "items": { "$ref": "#/definitions/PartExchangeQuestion" } }, "OutstandingFinance": { "format": "double", "type": "number" }, "Mileage": { "format": "int32", "maximum": 2147483647, "minimum": 1, "type": "integer" }, "OrganisationIdentifier": { "$ref": "#/definitions/OrganisationIdentifier" } } }, "PartExchangeCalculateResponse": { "type": "object", "properties": { "Reference": { "type": "string" }, "OutstandingFinance": { "format": "double", "type": "number" }, "Offer": { "$ref": "#/definitions/PartExchangeOffer" } } }, "GetPartExchangeOfferForDeliveryDateResponse": { "type": "object", "properties": { "Offer": { "$ref": "#/definitions/PartExchangeOffer" } } }, "GetPartExchangeRulesResponse": { "type": "object", "properties": { "Rules": { "type": "array", "items": { "$ref": "#/definitions/PartExchangeRule" } } } }, "PartExchangeRule": { "type": "object", "properties": { "RuleId": { "format": "int32", "type": "integer" }, "Type": { "enum": [ "NoRule", "Uplift", "Reduction", "Exclusion" ], "type": "string" }, "Value": { "format": "double", "type": "number" }, "Filters": { "type": "array", "items": { "$ref": "#/definitions/PartExchangeFilter" } }, "DateCreated": { "format": "date-time", "type": "string" } } }, "PartExchangeFilter": { "type": "object", "properties": { "Filter": { "enum": [ "Unknown", "Manufacturer", "Model", "Variant", "ModelYear", "Derivative", "Transmission", "FuelType", "BodyStyle", "All" ], "type": "string" }, "Value": { "type": "string" } } }, "PartExchangeRuleRequest": { "type": "object", "properties": { "RuleId": { "format": "int32", "type": "integer" }, "Type": { "enum": [ "NoRule", "Uplift", "Reduction", "Exclusion" ], "type": "string" }, "Value": { "format": "double", "type": "number" }, "Filters": { "type": "array", "items": { "$ref": "#/definitions/PartExchangeRuleRequestFilter" } }, "DateCreated": { "format": "date-time", "type": "string" } } }, "PartExchangeRuleRequestFilter": { "type": "object", "properties": { "Filter": { "enum": [ "Unknown", "Manufacturer", "Model", "Variant", "ModelYear", "Derivative", "Transmission", "FuelType", "BodyStyle", "All" ], "type": "string" }, "Value": { "type": "string" } } }, "CreateNewPartExchangeRuleResponse": { "type": "object", "properties": { "RuleId": { "format": "int32", "type": "integer" } } }, "GetPartExchangeRuleForResponse": { "type": "object", "properties": { "Rule": { "$ref": "#/definitions/PartExchangeRule" } } }, "CustomerPartExchangeResponse": { "type": "object", "properties": { "PartExchangeReferences": { "type": "array", "items": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } }, "PartExchanges": { "type": "array", "items": { "$ref": "#/definitions/PartExchangeResponse" } } } }, "AddPartExchangeToCustomerRequest": { "type": "object", "properties": { "PartExchangeReference": { "type": "string" } } }, "SendPartExchangeEmailRequest": { "type": "object", "properties": { "Email": { "type": "string" } } }, "SendPartExchangeEmailResponse": { "type": "object", "properties": {} }, "UpdatePartExchangeVehicleRequest": { "type": "object", "properties": { "Specification": { "$ref": "#/definitions/PartExchangeVehicleSpecification" } } }, "PartExchangeVehicleSpecification": { "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } }, "UpdatePartExchangeVehicleResponse": { "type": "object", "properties": { "PartExchangeReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Vehicle": { "$ref": "#/definitions/PartExchangeVehicle" } } }, "ProposalReservationPaymentResponse": { "type": "object", "properties": { "Reference": { "type": "string" }, "TransactionDate": { "format": "date-time", "type": "string" }, "Payment": { "format": "double", "type": "number" }, "TransactionId": { "type": "string" }, "IsRefunded": { "type": "boolean" }, "IsCaptured": { "type": "boolean" }, "ExternalTransactionReference": { "type": "string" }, "ProposalPayments": { "type": "array", "items": { "$ref": "#/definitions/ProposalPayment" } } } }, "ProposalPayment": { "type": "object", "properties": { "TransactionId": { "format": "int32", "type": "integer" }, "TransactionDescription": { "type": "string" }, "Amount": { "format": "double", "type": "number" }, "TransactionDate": { "format": "date-time", "type": "string" }, "CustomerName": { "type": "string" }, "CodeweaversTransactionId": { "type": "string" }, "ExternalTransactionReference": { "type": "string" }, "Id": { "format": "int32", "type": "integer" }, "RetailerId": { "format": "int32", "type": "integer" }, "PaymentProviderName": { "type": "string" }, "Application": { "type": "string" }, "Status": { "type": "string" }, "AuthorisedAt": { "format": "date-time", "type": "string" }, "CapturedAt": { "format": "date-time", "type": "string" }, "RefundedAt": { "format": "date-time", "type": "string" }, "StockIdentifier": { "type": "string" }, "CurrencyCode": { "type": "string" }, "TransactionType": { "type": "string" }, "StatusType": { "enum": [ "Unknown", "Success", "Declined", "Refunded", "Failed", "Authorised", "Expired", "Requires3dSecure", "Started" ], "type": "string" } } }, "PaymentRefundResponse": { "type": "object", "properties": {} }, "CaptureStripePaymentIntentResponse": { "type": "object", "properties": {} }, "AcceptStripePaymentWebhookRequest": { "type": "object", "properties": { "type": { "type": "string" }, "data": { "$ref": "#/definitions/StripePaymentWebhookRequestData" } } }, "StripePaymentWebhookRequestData": { "type": "object", "properties": { "object": { "$ref": "#/definitions/StripePaymentWebhookRequestDataObject" } } }, "StripePaymentWebhookRequestDataObject": { "type": "object", "properties": { "id": { "type": "string" }, "cancellation_reason": { "type": "string" }, "payment_intent": { "type": "string" } } }, "ConfirmThirdPartyFulfilledPaymentIntentRequest": { "type": "object", "properties": { "ExternalPaymentReference": { "type": "string" }, "ProposalReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } }, "ConfirmThirdPartyFulfilledPaymentIntentResponse": { "type": "object", "properties": {} }, "CreateStripePaymentIntentRequest": { "type": "object", "properties": { "ProposalReference": { "type": "string" }, "Application": { "type": "string" } } }, "CreateStripePaymentIntentResponse": { "type": "object", "properties": { "ClientSecret": { "type": "string" } } }, "ConfirmStripePaymentIntentRequest": { "type": "object", "properties": { "IntentId": { "type": "string" }, "ProposalReference": { "type": "string" } } }, "ConfirmStripePaymentIntentResponse": { "type": "object", "properties": {} }, "PayPalCreateOrderRequest": { "type": "object", "properties": { "ProposalReference": { "type": "string" }, "Application": { "type": "string" } } }, "PayPalCreateOrderResponse": { "type": "object", "properties": { "OrderId": { "type": "string" }, "OrderStatus": { "type": "string" } } }, "PayPalCaptureOrderRequest": { "type": "object", "properties": { "ProposalReference": { "type": "string" }, "OrderId": { "type": "string" } } }, "PayPalCaptureOrderResponse": { "type": "object", "properties": {} }, "JudoPayPaymentRequest": { "type": "object", "properties": { "ProposalReference": { "type": "string" }, "Application": { "type": "string" }, "OneUseToken": { "type": "string" } } }, "JudoPayPaymentResponse": { "type": "object", "properties": { "TransactionId": { "type": "string" }, "RequiresSca": { "type": "boolean" }, "AcsUrl": { "type": "string" }, "PaReq": { "type": "string" }, "Md": { "type": "string" }, "ReceiptId": { "type": "string" } } }, "CompleteJudoPayPaymentRequest": { "type": "object", "properties": { "TransactionId": { "type": "string" }, "TerminationToken": { "type": "string" } } }, "CompleteJudoPayPaymentResponse": { "type": "object", "properties": {} }, "SubmitPayoutRequest": { "type": "object", "properties": { "LenderProposalReference": { "type": "string" }, "OrderCaptureDetails": { "type": "array", "items": { "$ref": "#/definitions/OrderCaptureDetail" } }, "InvoiceableItems": { "type": "array", "items": { "$ref": "#/definitions/InvoiceableItemOld" } }, "BypassPayoutSubmission": { "type": "boolean" }, "PaidOutDateTime": { "format": "date-time", "type": "string" }, "ExternalCustomerId": { "type": "string" } } }, "OrderCaptureDetail": { "type": "object", "properties": { "Label": { "type": "string" }, "Value": { "type": "string" }, "Type": { "enum": [ "Text", "Date", "Mileage", "RegistrationNumber", "Vin", "Toggle" ], "type": "string" }, "IsEditable": { "type": "boolean" } } }, "InvoiceableItemOld": { "type": "object", "properties": { "Item": { "type": "string" }, "SupplierCode": { "type": "string" }, "InvoicePrice": { "format": "double", "type": "number" }, "VatAmount": { "format": "double", "type": "number" }, "InvoiceReference": { "type": "string" }, "InvoiceDate": { "format": "date-time", "type": "string" }, "ItemCategory": { "type": "string" }, "SupplierDescription": { "type": "string" }, "IsEditable": { "type": "boolean" }, "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } }, "SubmitPayoutResponse": { "type": "object", "properties": { "LenderProposalReference": { "type": "string" }, "Message": { "type": "string" } } }, "SubmitPayoutWithQueryRequest": { "type": "object", "properties": { "LenderProposalReference": { "type": "string" }, "OrderCaptureDetails": { "type": "array", "items": { "$ref": "#/definitions/OrderCaptureDetail" } }, "InvoiceableItems": { "type": "array", "items": { "$ref": "#/definitions/InvoiceableItemOld" } } } }, "SubmitPayoutWithQueryResponse": { "type": "object", "properties": { "LenderProposalReference": { "type": "string" } } }, "GetPayoutDetailsResponse": { "type": "object", "properties": { "OrderCaptureDetails": { "type": "array", "items": { "$ref": "#/definitions/OrderCaptureDetail" } }, "ItemsThatRequireAnInvoice": { "type": "array", "items": { "$ref": "#/definitions/InvoiceableItem" } }, "Invoices": { "type": "array", "items": { "$ref": "#/definitions/Invoice" } }, "CanEditInvoices": { "type": "boolean" } } }, "InvoiceableItem": { "type": "object", "properties": { "Item": { "type": "string" }, "InvoicePrice": { "format": "double", "type": "number" }, "VatAmount": { "format": "double", "type": "number" }, "IsEditable": { "type": "boolean" }, "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "ItemCategory": { "type": "string" } } }, "Invoice": { "type": "object", "properties": { "SupplierCode": { "type": "string" }, "InvoiceReference": { "type": "string" }, "InvoiceDate": { "format": "date-time", "type": "string" }, "Items": { "type": "array", "items": { "$ref": "#/definitions/InvoiceableItem" } } } }, "SavePayoutDetailsRequest": { "type": "object", "properties": { "OrderCaptureDetails": { "type": "array", "items": { "$ref": "#/definitions/OrderCaptureDetail" } }, "ItemsThatRequireAnInvoice": { "type": "array", "items": { "$ref": "#/definitions/InvoiceableItem" } }, "Invoices": { "type": "array", "items": { "$ref": "#/definitions/Invoice" } } } }, "SavePayoutDetailsResponse": { "type": "object", "properties": {} }, "RejectPayoutDetailsRequest": { "type": "object", "properties": { "Reason": { "type": "string" } } }, "RejectPayoutDetailsResponse": { "type": "object", "properties": {} }, "GetPayoutDetailsSummaryResponse": { "type": "object", "properties": { "SupplierInvoiceSummaries": { "type": "array", "items": { "$ref": "#/definitions/SupplierInvoiceSummary" } } } }, "SupplierInvoiceSummary": { "type": "object", "properties": { "SupplierCode": { "type": "string" }, "SupplierDescription": { "type": "string" }, "InvoiceTotalPrice": { "format": "double", "type": "number" }, "VatTotalAmount": { "format": "double", "type": "number" }, "InvoiceTotalIncVat": { "format": "double", "type": "number" }, "InvoiceReference": { "type": "string" } } }, "PlatformEventsRequest": { "type": "object", "properties": { "Tags": { "type": "array", "items": { "type": "string" } }, "StartTime": { "format": "date-time", "type": "string" }, "EndTime": { "format": "date-time", "type": "string" }, "UserToken": { "type": "string" }, "Username": { "type": "string" }, "Password": { "type": "string" }, "ApiKey": { "type": "string" }, "SystemKey": { "type": "string" }, "Referrer": { "type": "string" }, "AssociatedDealerKey": { "type": "string" }, "RetailerIdentifier": { "type": "string" }, "OrganisationIdentifier": { "$ref": "#/definitions/AuthenticationOrganisationIdentifier" }, "Origin": { "type": "string" }, "Locale": { "type": "string" } } }, "PlatformEventsResponse": { "type": "object", "properties": { "Events": { "type": "array", "items": { "$ref": "#/definitions/PlatformEventApiResponse" } } } }, "PlatformEventApiResponse": { "type": "object", "properties": { "Id": { "type": "string" }, "Tags": { "type": "array", "items": { "type": "string" } }, "Description": { "type": "string" }, "StartTime": { "format": "date-time", "type": "string" }, "EndTime": { "format": "date-time", "type": "string" }, "SystemKey": { "type": "string" }, "HostName": { "type": "string" }, "Username": { "type": "string" }, "PrimaryTag": { "type": "string" } } }, "CreatePlatformEventApiRequest": { "type": "object", "properties": { "Type": { "enum": [ "Import", "Deploy", "Migration", "ConfigKey", "CacheClear", "Other" ], "type": "string" }, "Tags": { "type": "array", "items": { "type": "string" } }, "Description": { "type": "string" }, "InstantEvent": { "type": "boolean" }, "HostName": { "type": "string" }, "StartTime": { "format": "date-time", "type": "string" }, "UserToken": { "type": "string" }, "Username": { "type": "string" }, "Password": { "type": "string" }, "ApiKey": { "type": "string" }, "SystemKey": { "type": "string" }, "Referrer": { "type": "string" }, "AssociatedDealerKey": { "type": "string" }, "RetailerIdentifier": { "type": "string" }, "OrganisationIdentifier": { "$ref": "#/definitions/AuthenticationOrganisationIdentifier" }, "Origin": { "type": "string" }, "Locale": { "type": "string" } } }, "CreatePlatformEventApiResponse": { "type": "object", "properties": { "Id": { "type": "string" } } }, "SearchPlatformSupportTasksRequest": { "type": "object", "properties": { "TaskType": { "type": "string" }, "ResolvedType": { "type": "string" }, "Query": { "type": "string" }, "OrganisationIdentifiers": { "type": "array", "items": { "type": "string" } }, "Department": { "type": "string" } } }, "GetPlatformSupportTasksResponse": { "type": "object", "properties": { "PageNumber": { "format": "int32", "type": "integer" }, "PageCount": { "format": "int32", "type": "integer" }, "TotalResults": { "format": "int32", "type": "integer" }, "PlatformSupportTasks": { "type": "array", "items": { "$ref": "#/definitions/PlatformSupportTask" } } } }, "PlatformSupportTask": { "type": "object", "properties": { "Type": { "type": "string" }, "Description": { "type": "string" }, "Reference": { "type": "string" }, "CreatedOnOrganisationId": { "type": "string" }, "Notes": { "type": "array", "items": { "$ref": "#/definitions/Note" } }, "CreatedOnOrganisationName": { "type": "string" }, "ResolvedAt": { "format": "date-time", "type": "string" }, "CreatedAt": { "format": "date-time", "type": "string" }, "NumberOfOccurrences": { "format": "int32", "type": "integer" }, "LastOccurrenceAt": { "format": "date-time", "type": "string" }, "CreatedBy": { "$ref": "#/definitions/SupportTaskUser" }, "Attributes": { "type": "array", "items": { "$ref": "#/definitions/Attribute" } }, "LastActionedAt": { "format": "date-time", "type": "string" } } }, "Note": { "type": "object", "properties": { "EntryTime": { "format": "date-time", "type": "string" }, "Content": { "type": "string" }, "CreatedBy": { "$ref": "#/definitions/SupportTaskUser" }, "IsResolutionNote": { "type": "boolean" } } }, "SupportTaskUser": { "type": "object", "properties": { "Reference": { "type": "string" }, "FirstName": { "type": "string" }, "LastName": { "type": "string" } } }, "Attribute": { "type": "object", "properties": { "Value": { "type": "string" }, "Type": { "type": "string" } } }, "UpdatePlatformSupportTaskRequest": { "type": "object", "properties": { "ItemReference": { "type": "string" }, "Description": { "type": "string" }, "AssigneeReference": { "type": "string" }, "TaskType": { "format": "int32", "type": "integer" }, "Attributes": { "type": "array", "items": { "$ref": "#/definitions/UpdatePlatformSupportTaskAttribute" } } } }, "UpdatePlatformSupportTaskAttribute": { "type": "object", "properties": { "Type": { "format": "int32", "type": "integer" }, "Value": { "type": "string" } } }, "AddPlatformSupportTaskNoteRequest": { "type": "object", "properties": { "Note": { "type": "string" }, "Status": { "enum": [ "Unknown", "UnResolved", "Resolved" ], "type": "string" } } }, "GetPluginConfigurationByReferenceResponse": { "type": "object", "properties": { "PluginConfiguration": { "$ref": "#/definitions/PluginConfiguration" } } }, "UpdatePluginConfigurationRequest": { "type": "object", "properties": { "Name": { "type": "string" }, "PluginType": { "enum": [ "Unknown", "Alphera", "AstonMartin", "Bentley", "BlackHorse", "BlackHorseTesla", "CreditCalc", "Fca", "FinanceFinder", "FinCalc", "FlexiCalc", "MotoNovo", "MultiCalc", "PartExchange", "RollsRoyce", "Slider", "Tesla" ], "type": "string" }, "CommercialVehicleModeEnabled": { "type": "boolean" }, "EmailQuoteEnabled": { "type": "boolean" }, "MotorCreditCheckBrandingEnabled": { "type": "boolean" }, "MotorCreditCheckEnabled": { "type": "boolean" }, "PrintQuoteEnabled": { "type": "boolean" }, "ShowLenderBranding": { "type": "boolean" }, "ShowProductNameInBanner": { "type": "boolean" }, "ShowTermInYears": { "type": "boolean" }, "ShowWeeklyEquivalent": { "type": "boolean" }, "StandaloneApplyFormEnabled": { "type": "boolean" }, "WhyFinanceIntroEnabled": { "type": "boolean" } } }, "UpdatePluginConfigurationResponse": { "type": "object", "properties": {} }, "GetPluginConfigurationTypesResponse": { "type": "object", "properties": { "Types": { "type": "array", "items": { "$ref": "#/definitions/PluginConfigurationType" } } } }, "PluginConfigurationType": { "type": "object", "properties": { "Name": { "type": "string" }, "DisplayName": { "type": "string" } } }, "DeletePrivacyPolicyByReferenceResponse": { "type": "object", "properties": {} }, "GetPrivacyPolicyByReferenceResponse": { "type": "object", "properties": { "PrivacyPolicy": { "$ref": "#/definitions/PrivacyPolicy" } } }, "PrivacyContentResponse": { "type": "object", "properties": { "Policy": { "type": "string" }, "TimeUpdated": { "format": "date-time", "type": "string" } } }, "FinanceProductsResponse": { "type": "object", "properties": { "FinanceProducts": { "type": "array", "items": { "$ref": "#/definitions/FinanceProductItem" } } } }, "FinanceProductItem": { "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "Name": { "type": "string" }, "Family": { "type": "string" }, "Lender": { "type": "string" }, "GroupName": { "type": "string" }, "Description": { "type": "string" } } }, "GetOrganisationPackagesResponse": { "type": "object", "properties": { "Packages": { "type": "array", "items": { "$ref": "#/definitions/OrganisationPromotionPackage" } } } }, "OrganisationPromotionPackage": { "type": "object", "properties": { "Reference": { "type": "string" }, "Name": { "type": "string" }, "Status": { "enum": [ "Unknown", "Active", "InActive", "Deleted" ], "type": "string" }, "AllowedProducts": { "type": "array", "items": { "enum": [ "Unknown", "HirePurchase", "PCP", "LeasePurchase", "ContractHire", "ContractPurchase", "FinanceLease", "VariableRate", "PersonalLoan", "MotorLoan", "ConditionalSale", "PersonalContractHire", "SecuredLoan", "CreditPurchase", "AnnualHoliday", "PersonalLease", "Cash", "PersonalLoanWithBalloon", "AdvancePurchasePlan", "OperatingLease", "PersonalOperatingLease", "ConditionalSaleBalloon", "FinanceLeaseWithoutBalloon", "HirePurchaseWithBalloon", "SalarySacrifice" ], "type": "string" } }, "SystemId": { "format": "int32", "type": "integer" }, "OrganisationId": { "format": "int32", "type": "integer" }, "ValidFrom": { "format": "date-time", "type": "string" }, "ValidTo": { "format": "date-time", "type": "string" }, "Organisations": { "type": "array", "items": { "$ref": "#/definitions/Organisation" } }, "Precedence": { "format": "int32", "type": "integer" }, "AllowedVehicleStates": { "type": "array", "items": { "type": "string" } } } }, "CreatePromotionPackageRequest": { "type": "object", "properties": { "Name": { "type": "string" }, "Products": { "type": "string" }, "ValidFrom": { "format": "date-time", "type": "string" }, "ValidTo": { "format": "date-time", "type": "string" }, "AllowedProducts": { "type": "array", "items": { "enum": [ "Unknown", "HirePurchase", "PCP", "LeasePurchase", "ContractHire", "ContractPurchase", "FinanceLease", "VariableRate", "PersonalLoan", "MotorLoan", "ConditionalSale", "PersonalContractHire", "SecuredLoan", "CreditPurchase", "AnnualHoliday", "PersonalLease", "Cash", "PersonalLoanWithBalloon", "AdvancePurchasePlan", "OperatingLease", "PersonalOperatingLease", "ConditionalSaleBalloon", "FinanceLeaseWithoutBalloon", "HirePurchaseWithBalloon", "SalarySacrifice" ], "type": "string" } }, "IsActive": { "type": "boolean" }, "Organisations": { "type": "array", "items": { "$ref": "#/definitions/OrganisationKey" } }, "AllowedVehicleStates": { "type": "array", "items": { "type": "string" } } } }, "OrganisationKey": { "type": "object", "properties": { "OrganisationId": { "format": "int32", "type": "integer" }, "SystemId": { "format": "int32", "type": "integer" } } }, "CreatePromotionPackageResponse": { "type": "object", "properties": { "Reference": { "type": "string" } } }, "UpdatePromotionalPackagePrecedenceRequest": { "type": "object", "properties": { "PromotionPackages": { "type": "array", "items": { "$ref": "#/definitions/PrecedencePromotionPackage" } } } }, "PrecedencePromotionPackage": { "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Precedence": { "format": "int32", "type": "integer" }, "OrganisationId": { "format": "int32", "type": "integer" } } }, "GetPromotionPackageResponse": { "type": "object", "properties": { "Reference": { "type": "string" }, "Name": { "type": "string" }, "Status": { "enum": [ "Unknown", "Active", "InActive", "Deleted" ], "type": "string" }, "ValidFrom": { "format": "date-time", "type": "string" }, "ValidTo": { "format": "date-time", "type": "string" }, "AllowedProducts": { "type": "array", "items": { "enum": [ "Unknown", "HirePurchase", "PCP", "LeasePurchase", "ContractHire", "ContractPurchase", "FinanceLease", "VariableRate", "PersonalLoan", "MotorLoan", "ConditionalSale", "PersonalContractHire", "SecuredLoan", "CreditPurchase", "AnnualHoliday", "PersonalLease", "Cash", "PersonalLoanWithBalloon", "AdvancePurchasePlan", "OperatingLease", "PersonalOperatingLease", "ConditionalSaleBalloon", "FinanceLeaseWithoutBalloon", "HirePurchaseWithBalloon", "SalarySacrifice" ], "type": "string" } }, "Organisations": { "type": "array", "items": { "$ref": "#/definitions/Organisation" } }, "AllowedVehicleStates": { "type": "array", "items": { "type": "string" } } } }, "UpdatePromotionPackageRequest": { "type": "object", "properties": { "Reference": { "type": "string" }, "Name": { "type": "string" }, "AllowedProducts": { "type": "array", "items": { "enum": [ "Unknown", "HirePurchase", "PCP", "LeasePurchase", "ContractHire", "ContractPurchase", "FinanceLease", "VariableRate", "PersonalLoan", "MotorLoan", "ConditionalSale", "PersonalContractHire", "SecuredLoan", "CreditPurchase", "AnnualHoliday", "PersonalLease", "Cash", "PersonalLoanWithBalloon", "AdvancePurchasePlan", "OperatingLease", "PersonalOperatingLease", "ConditionalSaleBalloon", "FinanceLeaseWithoutBalloon", "HirePurchaseWithBalloon", "SalarySacrifice" ], "type": "string" } }, "ValidFrom": { "format": "date-time", "type": "string" }, "ValidTo": { "format": "date-time", "type": "string" }, "IsActive": { "type": "boolean" }, "Organisations": { "type": "array", "items": { "$ref": "#/definitions/OrganisationKey" } }, "AllowedVehicleStates": { "type": "array", "items": { "type": "string" } } } }, "UpdatePromotionPackageResponse": { "type": "object", "properties": {} }, "GetPromotionsForPackageResponse": { "type": "object", "properties": { "Promotions": { "type": "array", "items": { "$ref": "#/definitions/Promotion" } } } }, "Promotion": { "type": "object", "properties": { "Name": { "type": "string" }, "Reference": { "type": "string" }, "Status": { "enum": [ "Unknown", "Active", "InActive", "Deleted" ], "type": "string" }, "Actions": { "type": "array", "items": { "$ref": "#/definitions/PromotionAction" } }, "Vehicles": { "type": "array", "items": { "$ref": "#/definitions/PromotionVehicle" } }, "DisplayType": { "enum": [ "Unknown", "None", "StandardBanner" ], "type": "string" }, "DisplayTitle": { "type": "string" }, "DisplayDescription": { "type": "string" } } }, "PromotionAction": { "type": "object", "properties": { "ActionType": { "enum": [ "Unknown", "RetailerContribution", "ManufacturerContribution", "RetailerMargin", "ManufacturerBonus", "LenderContribution", "SelloutOverride", "RetailerCashPriceDiscount", "CashPriceOverride", "BackendBonus", "BlockFinance", "InsuranceBonus", "LenderDiscount" ], "type": "string" }, "ValueType": { "enum": [ "Unknown", "Amount", "PercentageOfBasePriceAndOptions", "Apr", "CustomerRate", "Scheme", "Yield", "Toggle" ], "type": "string" }, "Value": { "type": "string" }, "Field": { "enum": [ "Unknown", "PercentageBasePriceDiscount", "FlatBasePriceDiscount", "PercentageOptionsDiscount", "FlatOptionsDiscount", "BasePriceDiscount", "OptionsDiscount", "RetailerContribution", "ManufacturerContribution", "RetailerMargin", "ManufacturerBonus" ], "type": "string" }, "Tooltip": { "type": "string" }, "Label": { "type": "string" }, "Type": { "type": "string" } } }, "PromotionVehicle": { "type": "object", "properties": { "Identifier": { "type": "string" }, "IdentifierType": { "type": "string" }, "VehicleType": { "type": "string" } } }, "GetNewPackageDetailsRequest": { "type": "object", "properties": { "Page": { "format": "int32", "type": "integer" }, "ResultsPerPage": { "format": "int32", "type": "integer" }, "PackageReference": { "type": "string" }, "Query": { "type": "string" } } }, "GetNewPackageDetailsResponse": { "type": "object", "properties": { "Promotions": { "type": "array", "items": { "$ref": "#/definitions/NewPackageDetails" } }, "Pagination": { "$ref": "#/definitions/Pagination" } } }, "NewPackageDetails": { "type": "object", "properties": { "Vehicle": { "$ref": "#/definitions/NewPromotionVehicleDetails" }, "Promotion": { "$ref": "#/definitions/NewPromotionDetails" }, "Discounts": { "type": "array", "items": { "$ref": "#/definitions/NewPromotionDiscountDetails" } } } }, "NewPromotionVehicleDetails": { "type": "object", "properties": { "Identifier": { "type": "string" }, "IdentifierType": { "enum": [ "Unknown", "Vrm", "Vin", "CapShortCode", "CapLongCode", "Titre", "Glasses", "CDL", "ABI", "FleetNet", "DHS", "CapShortEncrypted", "Ivs", "Suzuki", "CapDescription", "FordDescription", "VidCode", "Rams", "CodeweaversStockId", "PsaDescription", "Ids", "FreeText", "ManufacturerCode", "Search", "TeslaDescription", "AudiModelCode", "BmvsCode", "IvsModelToken", "CodeweaversDerivative", "CodeweaversDerivativeIdentifier", "JLR5000Code", "KeeId", "SecondaryManufacturer", "IvsBodyGroupCode", "FcaConfiguratorSlug", "CDI", "VolvoCode", "SkodaCode", "DealerStockId", "JlrComboCode", "BmwCapLongCode", "BmwCapShortCode", "BaumusterCode", "AutoTraderDerivativeIdentifier", "TribalDerivativeIdentifier", "Cazana", "Jato", "Mpv", "FcaCommercialModelDescription", "CapCarShortCode", "CapLcvShortCode", "CapBikeShortCode", "SubaruCode", "Infocar", "VolvoConfigurationCode", "ArgusCode", "TriumphCode", "AutoVistaNatCode", "Blvd", "AutobizVersionId", "BregoDerivativeIdentifier", "LastElement" ], "type": "string" }, "VehicleType": { "enum": [ "Unknown", "Car", "Lcv", "Bike", "Other", "NonVehicleAsset", "Hgv", "LastElement" ], "type": "string" }, "CashPrice": { "format": "double", "type": "number" }, "Description": { "type": "string" } } }, "NewPromotionDetails": { "type": "object", "properties": { "Reference": { "type": "string" }, "Name": { "type": "string" }, "IsActive": { "type": "boolean" } } }, "NewPromotionDiscountDetails": { "type": "object", "properties": { "Id": { "type": "string" }, "Label": { "type": "string" }, "Type": { "type": "string" }, "Value": { "type": "string" }, "ValueType": { "type": "string" }, "Tooltip": { "type": "string" } } }, "CreatePromotionRequest": { "required": [ "PackageReference", "Name", "Precedence", "IsActive", "Actions", "Vehicles" ], "type": "object", "properties": { "PackageReference": { "type": "string" }, "Name": { "type": "string" }, "Precedence": { "format": "int32", "type": "integer" }, "IsActive": { "type": "boolean" }, "Actions": { "type": "array", "items": { "$ref": "#/definitions/PromotionAction" } }, "Vehicles": { "type": "array", "items": { "$ref": "#/definitions/PromotionVehicle" } }, "Display": { "$ref": "#/definitions/PromotionDisplayRequest" } } }, "PromotionDisplayRequest": { "type": "object", "properties": { "DisplayType": { "enum": [ "Unknown", "None", "StandardBanner" ], "type": "string" }, "DisplayTitle": { "type": "string" }, "DisplayDescription": { "type": "string" } } }, "CreatePromotionResponse": { "type": "object", "properties": { "Reference": { "type": "string" } } }, "GetPromotionResponse": { "type": "object", "properties": { "Reference": { "type": "string" }, "PackageReference": { "type": "string" }, "Name": { "type": "string" }, "Precedence": { "format": "int32", "type": "integer" }, "IsActive": { "type": "boolean" }, "Actions": { "type": "array", "items": { "$ref": "#/definitions/PromotionAction" } }, "Vehicles": { "type": "array", "items": { "$ref": "#/definitions/GetPromotionVehicle" } }, "Display": { "$ref": "#/definitions/PromotionDisplayRequest" } } }, "GetPromotionVehicle": { "type": "object", "properties": { "Identifier": { "type": "string" }, "IdentifierType": { "type": "string" }, "VehicleType": { "type": "string" } } }, "UpdatePromotionRequest": { "type": "object", "properties": { "PackageReference": { "type": "string" }, "Name": { "type": "string" }, "Precedence": { "format": "int32", "type": "integer" }, "IsActive": { "type": "boolean" }, "Actions": { "type": "array", "items": { "$ref": "#/definitions/PromotionAction" } }, "Vehicles": { "type": "array", "items": { "$ref": "#/definitions/PromotionVehicle" } }, "Display": { "$ref": "#/definitions/PromotionDisplayRequest" } } }, "UpdatePromotionResponse": { "type": "object", "properties": {} }, "ActionTypeResponse": { "type": "object", "properties": { "ActionTypes": { "type": "array", "items": { "$ref": "#/definitions/ApiPromotionActionDefinition" } }, "VehicleIdentifierTypes": { "type": "array", "items": { "type": "string" } }, "AllowedProducts": { "type": "array", "items": { "enum": [ "Unknown", "HirePurchase", "PCP", "LeasePurchase", "ContractHire", "ContractPurchase", "FinanceLease", "VariableRate", "PersonalLoan", "MotorLoan", "ConditionalSale", "PersonalContractHire", "SecuredLoan", "CreditPurchase", "AnnualHoliday", "PersonalLease", "Cash", "PersonalLoanWithBalloon", "AdvancePurchasePlan", "OperatingLease", "PersonalOperatingLease", "ConditionalSaleBalloon", "FinanceLeaseWithoutBalloon", "HirePurchaseWithBalloon", "SalarySacrifice" ], "type": "string" } }, "VehicleTypes": { "type": "array", "items": { "type": "string" } }, "VehicleStates": { "type": "array", "items": { "enum": [ "Unknown", "PreOwned", "Preregistered", "Demonstrator", "New", "BuildToOrder" ], "type": "string" } } } }, "ApiPromotionActionDefinition": { "type": "object", "properties": { "Label": { "type": "string" }, "Type": { "enum": [ "Unknown", "RetailerContribution", "ManufacturerContribution", "RetailerMargin", "ManufacturerBonus", "LenderContribution", "SelloutOverride", "RetailerCashPriceDiscount", "CashPriceOverride", "BackendBonus", "BlockFinance", "InsuranceBonus", "LenderDiscount" ], "type": "string" }, "ValueTypes": { "type": "array", "items": { "$ref": "#/definitions/ApiValueType" } }, "Tooltip": { "type": "string" } } }, "ApiValueType": { "type": "object", "properties": { "Id": { "enum": [ "Unknown", "Amount", "PercentageOfBasePriceAndOptions", "Apr", "CustomerRate", "Scheme", "Yield", "Toggle" ], "type": "string" }, "Type": { "type": "string" }, "Label": { "type": "string" } } }, "VehicleSearchRequest": { "required": [ "Filters" ], "type": "object", "properties": { "Customer": { "$ref": "#/definitions/CustomerDetails" }, "Filters": { "$ref": "#/definitions/FilterParameters" }, "Page": { "format": "int32", "type": "integer" }, "ResultsPerPage": { "format": "int32", "type": "integer" }, "SortBy": { "enum": [ "Unknown", "AsRequested", "RegularPaymentDescending", "RegularPaymentAscending", "Distance", "PriceDescending", "PriceAscending", "Relevance", "LastUpdatedDescending", "LastUpdatedAscending", "MileageDescending", "MileageAscending" ], "type": "string" }, "IncludeNoFinanceOption": { "type": "boolean" }, "PartExchangeReference": { "description": "Uses the latest active offer for the part exchange and apply equity in finance calculations", "type": "string" }, "OrganisationIdentifier": { "$ref": "#/definitions/OrganisationIdentifier", "description": "This determines the organisation that the request will be run as. This changes the authentication context to be for this organisation." }, "Intention": { "description": "When using search this allows you to select the intention of the search to ensure the right collection of vehicles are presented. For example, if 'PublicWebsite' is used only vehicles that contain fully populated data will be returned.", "enum": [ "Default", "PublicWebsite", "ManagementWebsite" ], "type": "string" } } }, "FilterParameters": { "required": [ "Vehicle" ], "type": "object", "properties": { "Location": { "$ref": "#/definitions/LocationFilter" }, "Vehicle": { "$ref": "#/definitions/VehicleFilter" }, "Finance": { "$ref": "#/definitions/FinanceFilter" }, "DigitalRetailStore": { "$ref": "#/definitions/DigitalRetailStoreFilter" }, "DriverPolicy": { "$ref": "#/definitions/DriverPolicyFilter" } } }, "DigitalRetailStoreFilter": { "required": [ "Page" ], "type": "object", "properties": { "Page": { "$ref": "#/definitions/DigitalRetailStorePageFilter", "description": "The digital retail stores page that the search request has originated from." } } }, "DriverPolicyFilter": { "type": "object", "properties": { "SchemeReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } }, "DigitalRetailStorePageFilter": { "required": [ "Slug" ], "type": "object", "properties": { "Slug": { "description": "The pages slug value. When provided it will allow us to link the request to a specific page within your digital retail store ensuring any filters created are respected.", "type": "string" } } }, "VehicleGroupWithFacetsResponse": { "type": "object", "properties": { "FacetCategories": { "$ref": "#/definitions/FacetCategories" }, "Groups": { "type": "array", "items": { "$ref": "#/definitions/VehicleGroup" } }, "Modifications": { "$ref": "#/definitions/Modifications" }, "CurrentPage": { "format": "int32", "type": "integer" }, "TotalPages": { "format": "int32", "type": "integer" }, "NumberOfMatchingVehicleGroups": { "format": "int32", "type": "integer" }, "NumberOfMatchingVehiclesAcrossAllGroups": { "format": "int32", "type": "integer" }, "NumberOfVehiclesSearched": { "format": "int32", "type": "integer" } } }, "FacetCategories": { "type": "object", "properties": { "Manufacturer": { "$ref": "#/definitions/ImageMultiSelectFacetCategory" }, "Model": { "$ref": "#/definitions/ImageMultiSelectFacetCategory" }, "Door": { "$ref": "#/definitions/MultiSelectFacetCategory" }, "DriveTrain": { "$ref": "#/definitions/MultiSelectFacetCategory" }, "Fuel": { "$ref": "#/definitions/MultiSelectFacetCategory" }, "Transmission": { "$ref": "#/definitions/MultiSelectFacetCategory" }, "Colour": { "$ref": "#/definitions/MultiSelectFacetCategory" }, "BodyStyle": { "$ref": "#/definitions/MultiSelectFacetCategory" }, "InsuranceGroup": { "$ref": "#/definitions/MultiSelectFacetCategory" }, "Mileage": { "$ref": "#/definitions/MultiRangeFacetCategory" }, "Engine": { "$ref": "#/definitions/MultiRangeFacetCategory" }, "BootCapacity": { "$ref": "#/definitions/MultiSelectFacetCategory" }, "Age": { "$ref": "#/definitions/MultiRangeFacetCategory" }, "RegistrationYear": { "$ref": "#/definitions/MultiRangeFacetCategory" }, "Acceleration": { "$ref": "#/definitions/MultiSelectFacetCategory" }, "OnTheRoadPrice": { "$ref": "#/definitions/MultiRangeFacetCategory" }, "FranchiseApproved": { "$ref": "#/definitions/MultiSelectFacetCategory" }, "Distance": { "$ref": "#/definitions/DistanceFacetCategory" }, "Seat": { "$ref": "#/definitions/MultiSelectFacetCategory" }, "CustomBodyStyle": { "$ref": "#/definitions/MultiSelectFacetCategory" }, "State": { "$ref": "#/definitions/MultiSelectFacetCategory" }, "Variant": { "$ref": "#/definitions/MultiSelectFacetCategory" }, "LastUpdated": { "$ref": "#/definitions/MultiSelectFacetCategory" }, "Option": { "$ref": "#/definitions/MultiSelectFacetCategory" }, "EnginePower": { "$ref": "#/definitions/MultiRangeFacetCategory" }, "BatteryCapacity": { "$ref": "#/definitions/MultiRangeFacetCategory" }, "BatteryRange": { "$ref": "#/definitions/MultiRangeFacetCategory" }, "FuelConsumption": { "$ref": "#/definitions/MultiRangeFacetCategory" }, "Emissions": { "$ref": "#/definitions/MultiRangeFacetCategory" }, "ModelYear": { "$ref": "#/definitions/MultiRangeFacetCategory" }, "SafetyRating": { "$ref": "#/definitions/MultiRangeFacetCategory" }, "BatteryHealth": { "$ref": "#/definitions/MultiRangeFacetCategory" }, "NewMileage": { "$ref": "#/definitions/MultiSelectFacetCategory" } } }, "VehicleGroup": { "type": "object", "properties": { "Id": { "type": "string" }, "HeadlineVehicle": { "$ref": "#/definitions/VehicleSearchResult" }, "AvailableOptions": { "$ref": "#/definitions/VehicleGroupAvailableOptions" }, "NumberOfVehicles": { "format": "int32", "type": "integer" } } }, "Modifications": { "type": "object", "properties": { "Query": { "$ref": "#/definitions/QueryModification", "description": "If we make any modifications to the query they will be shown here." }, "SelectedFacets": { "$ref": "#/definitions/SelectedFacetsModifications", "description": "If we make any modifications to the selected facets they will be shown here." } } }, "ImageMultiSelectFacetCategory": { "type": "object", "properties": { "Enabled": { "type": "boolean" }, "Options": { "$ref": "#/definitions/ImageFacetCategoryOptions" }, "Order": { "format": "int32", "type": "integer" } } }, "MultiSelectFacetCategory": { "type": "object", "properties": { "Enabled": { "type": "boolean" }, "Options": { "$ref": "#/definitions/FacetCategoryOptions" }, "Order": { "format": "int32", "type": "integer" } } }, "MultiRangeFacetCategory": { "type": "object", "properties": { "Enabled": { "type": "boolean" }, "Order": { "format": "int32", "type": "integer" }, "Above": { "$ref": "#/definitions/MultiRangeFacetCategorySection" }, "Below": { "$ref": "#/definitions/MultiRangeFacetCategorySection" } } }, "DistanceFacetCategory": { "type": "object", "properties": { "Options": { "type": "array", "items": { "$ref": "#/definitions/DistanceFacet" } } } }, "VehicleSearchResult": { "type": "object", "properties": { "Vehicle": { "$ref": "#/definitions/Vehicle" }, "Retailer": { "$ref": "#/definitions/OrganisationResponse" }, "Finance": { "type": "array", "items": { "$ref": "#/definitions/FinanceDetails" } }, "DistanceFromLocation": { "$ref": "#/definitions/Distance" } } }, "VehicleGroupAvailableOptions": { "type": "object", "properties": { "FuelTypes": { "type": "array", "items": { "$ref": "#/definitions/Facet" } }, "Doors": { "type": "array", "items": { "$ref": "#/definitions/Facet" } }, "Colours": { "type": "array", "items": { "$ref": "#/definitions/Facet" } }, "Transmissions": { "type": "array", "items": { "$ref": "#/definitions/Facet" } }, "Drivetrains": { "type": "array", "items": { "$ref": "#/definitions/Facet" } }, "BodyStyles": { "type": "array", "items": { "$ref": "#/definitions/Facet" } }, "Retailers": { "type": "array", "items": { "$ref": "#/definitions/Facet" } }, "OnTheRoadPriceFrom": { "format": "double", "type": "number" }, "OnTheRoadPriceTo": { "format": "double", "type": "number" }, "MileageFrom": { "format": "int32", "type": "integer" }, "MileageTo": { "format": "int32", "type": "integer" }, "EnginesFrom": { "format": "double", "type": "number" }, "EnginesTo": { "format": "double", "type": "number" }, "AgesFrom": { "format": "double", "type": "number" }, "AgesTo": { "format": "double", "type": "number" }, "BatteryRangeFrom": { "format": "double", "type": "number" }, "BatteryRangeTo": { "format": "double", "type": "number" }, "BatteryCapacityFrom": { "format": "double", "type": "number" }, "BatteryCapacityTo": { "format": "double", "type": "number" }, "EmissionsFrom": { "format": "int32", "type": "integer" }, "EmissionsTo": { "format": "int32", "type": "integer" }, "EnginePowerFrom": { "format": "int32", "type": "integer" }, "EnginePowerTo": { "format": "int32", "type": "integer" } } }, "QueryModification": { "type": "object", "properties": { "Modified": { "description": "This indicates whether or not we modified the requested property.", "type": "boolean" }, "Value": { "description": "This will hold the modified value that we used during the search.", "type": "string" } } }, "SelectedFacetsModifications": { "type": "object", "properties": { "Models": { "$ref": "#/definitions/SelectedFacetModifications", "description": "If we make any modifications to the selected model facets they will be shown here." } } }, "ImageFacetCategoryOptions": { "type": "object", "properties": { "Values": { "type": "array", "items": { "$ref": "#/definitions/ImageFacet" } } } }, "FacetCategoryOptions": { "type": "object", "properties": { "Values": { "type": "array", "items": { "$ref": "#/definitions/Facet" } } } }, "MultiRangeFacetCategorySection": { "type": "object", "properties": { "Options": { "$ref": "#/definitions/FacetCategoryOptions" } } }, "DistanceFacet": { "type": "object", "properties": { "Display": { "description": "This value will contain the translated facet value and should be used for display on the integrating site.", "type": "string" }, "Value": { "description": "This value will contain our view of the facet and should be used to send back into our services when a user selects the facet.", "type": "string" } } }, "Facet": { "type": "object", "properties": { "DisplayValue": { "description": "This value will contain the translated facet value and should be used for display on the integrating site.", "type": "string" }, "Value": { "description": "This value will contain our view of the facet and should be used to send back into our services when a user selects the facet.", "type": "string" }, "DisplayCount": { "description": "This value will contain the translated facet count value and should be used for display on the integrating site.", "type": "string" }, "Count": { "format": "int32", "description": "This value will contain the count of vehicles which match the facet.", "type": "integer" }, "IsFeatured": { "description": "This indicates whether or not the option is featured and should always be viewable.", "type": "boolean" } } }, "SelectedFacetModifications": { "type": "object", "properties": { "Modified": { "description": "This indicates whether or not we modified the requested property.", "type": "boolean" }, "Value": { "description": "This will hold the modified values that we used during the search.", "type": "array", "items": { "type": "string" } } } }, "ImageFacet": { "type": "object", "properties": { "DisplayValue": { "description": "This value will contain the translated facet value and should be used for display on the integrating site.", "type": "string" }, "Value": { "description": "This value will contain our view of the facet and should be used to send back into our services when a user selects the facet.", "type": "string" }, "DisplayCount": { "description": "This value will contain the translated facet count value and should be used for display on the integrating site.", "type": "string" }, "Count": { "format": "int32", "description": "This value will contain the count of vehicles which match the facet.", "type": "integer" }, "IsFeatured": { "description": "This indicates whether or not the option is featured and should always be viewable.", "type": "boolean" }, "Image": { "$ref": "#/definitions/Image", "description": "The image which represents the facet. If returned as null it means we have not currently set the image for this facet, please get in contact with us if you require an image to be assigned." }, "ThumbnailImage": { "$ref": "#/definitions/Image", "description": "The thumbnail image which represents the facet. If returned as null it means we have not currently set the image for this facet, please ge tin contact with us if you require an image to be setup." } } }, "RunSanityChecksResponse": { "type": "object", "properties": { "Results": { "type": "array", "items": { "$ref": "#/definitions/SanityCheckResultResponse" } } } }, "SanityCheckResultResponse": { "type": "object", "properties": { "Message": { "type": "string" }, "State": { "enum": [ "Unknown", "Passed", "NotApplicable", "Failed" ], "type": "string" }, "Type": { "enum": [ "Unknown", "NegotiateNowStockCheck", "NegotiateNowInfoKeyCheck", "PartExchangeInfoKeyCheck", "VRMLookupInfoKeyCheck", "MotorCreditCheckInfoKeyCheck", "RetailerWithAutoSubmitHasSubmitter", "VehiclesModuleRequiresStockLocations", "ReservationsRequirePaymentProvider", "PartExchangesRequireProvider", "OrganisationReferences", "FinanceSubmitterActiveSanityCheck" ], "type": "string" }, "SanityCheckedAt": { "format": "date-time", "type": "string" } } }, "GetSanityCheckResultsResponse": { "type": "object", "properties": { "Results": { "type": "array", "items": { "$ref": "#/definitions/SanityCheckResultResponse" } } } }, "GetFailedResultsResponse": { "type": "object", "properties": { "Results": { "type": "array", "items": { "$ref": "#/definitions/FailedResult" } } } }, "FailedResult": { "type": "object", "properties": { "Organisation": { "$ref": "#/definitions/OrganisationForSanityCheckResponse" }, "Result": { "$ref": "#/definitions/SanityCheckResultResponse" } } }, "OrganisationForSanityCheckResponse": { "type": "object", "properties": { "Name": { "type": "string" }, "LegacyDealerId": { "format": "int32", "type": "integer" }, "Reference": { "type": "string" } } }, "GetSanityCheckStatsResponse": { "type": "object", "properties": { "Results": { "type": "array", "items": { "$ref": "#/definitions/StatsByType" } } } }, "StatsByType": { "type": "object", "properties": { "Type": { "enum": [ "Unknown", "NegotiateNowStockCheck", "NegotiateNowInfoKeyCheck", "PartExchangeInfoKeyCheck", "VRMLookupInfoKeyCheck", "MotorCreditCheckInfoKeyCheck", "RetailerWithAutoSubmitHasSubmitter", "VehiclesModuleRequiresStockLocations", "ReservationsRequirePaymentProvider", "PartExchangesRequireProvider", "OrganisationReferences", "FinanceSubmitterActiveSanityCheck" ], "type": "string" }, "FailedCount": { "format": "int32", "type": "integer" }, "PassedCount": { "format": "int32", "type": "integer" } } }, "GetSanityCheckTypesResponse": { "type": "object", "properties": { "Types": { "type": "array", "items": { "$ref": "#/definitions/SanityCheckType" } } } }, "SanityCheckType": { "type": "object", "properties": { "Name": { "type": "string" }, "Id": { "format": "int32", "type": "integer" } } }, "SnoozeRequest": { "type": "object", "properties": { "Reason": { "type": "string" }, "SnoozeUntil": { "format": "date-time", "type": "string" } } }, "WorkQueueItem": { "type": "object", "properties": { "ProposalReference": { "type": "string" }, "ProposalStatus": { "type": "string" }, "Source": { "type": "string" }, "Applicant": { "$ref": "#/definitions/ApplicantForWorkQueue" }, "LastActioned": { "format": "date-time", "type": "string" }, "Vehicle": { "$ref": "#/definitions/VehicleForWorkQueue" }, "Organisation": { "$ref": "#/definitions/OrganisationForWorkQueue" }, "Reasons": { "type": "array", "items": { "type": "string" } }, "ClaimStatus": { "$ref": "#/definitions/ClaimInformation" }, "Funding": { "$ref": "#/definitions/Funding" }, "WorkQueueStatus": { "$ref": "#/definitions/WorkQueueStatus" } } }, "ApplicantForWorkQueue": { "type": "object", "properties": { "FirstName": { "type": "string" }, "LastName": { "type": "string" }, "TradingName": { "type": "string" }, "Description": { "type": "string" } } }, "VehicleForWorkQueue": { "type": "object", "properties": { "Description": { "type": "string" }, "Manufacturer": { "type": "string" }, "Model": { "type": "string" }, "Derivative": { "type": "string" } } }, "OrganisationForWorkQueue": { "type": "object", "properties": { "LegacyDealerId": { "format": "int32", "type": "integer" }, "Name": { "type": "string" } } }, "ClaimInformation": { "type": "object", "properties": { "UserReference": { "type": "string" }, "UserDisplayName": { "type": "string" } } }, "Funding": { "type": "object", "properties": { "Type": { "type": "string" }, "Lender": { "type": "string" } } }, "WorkQueueStatus": { "type": "object", "properties": { "Status": { "enum": [ "Scheduled", "Completed", "Active" ], "type": "string" }, "CompletionStatus": { "type": "string" }, "CompletedAt": { "format": "date-time", "type": "string" }, "CompletedByUserReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CompletedByUserDisplayName": { "type": "string" }, "ScheduledFor": { "format": "date-time", "type": "string" }, "ScheduledByUserReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "ScheduledByUserDisplayName": { "type": "string" } } }, "CompleteProposalRequest": { "type": "object", "properties": { "CompletionState": { "type": "string" } } }, "AssignProposalRequest": { "required": [ "UserReference" ], "type": "object", "properties": { "UserReference": { "type": "string" } } }, "WorkQueueRequest": { "required": [ "NumberOfResults", "Filters" ], "type": "object", "properties": { "NumberOfResults": { "format": "int32", "maximum": 10, "minimum": 1, "type": "integer" }, "Filters": { "$ref": "#/definitions/WorkQueueFilters" } } }, "WorkQueueFilters": { "type": "object", "properties": { "IncludeUnassigned": { "type": "boolean" }, "AssignedUsers": { "type": "array", "items": { "type": "string" } } } }, "WorkQueueResponse": { "type": "object", "properties": { "WorkQueueItems": { "type": "array", "items": { "$ref": "#/definitions/WorkQueueItem" } } } }, "ClearWorkQueueRequest": { "required": [ "Filters", "ClearProposalsLastUpdatedBefore" ], "type": "object", "properties": { "Filters": { "$ref": "#/definitions/WorkQueueFilters" }, "ClearProposalsLastUpdatedBefore": { "format": "date-time", "type": "string" } } }, "ClearWorkQueueResponse": { "type": "object", "properties": { "NumberOfProposalsAffected": { "format": "int32", "type": "integer" }, "Completed": { "type": "boolean" } } }, "ProposalRatingResponse": { "type": "object", "properties": { "RawRating": { "format": "double", "type": "number" }, "DisplayRating": { "format": "int32", "type": "integer" } } }, "ProposalRatingFeedbackRequest": { "type": "object", "properties": { "RawRating": { "format": "double", "type": "number" }, "DisplayRating": { "format": "int32", "type": "integer" }, "Feedback": { "enum": [ "Unknown", "TooLow", "TooHigh", "SpotOn" ], "type": "string" } } }, "ProposalRatingFeedbackResponse": { "type": "object", "properties": {} }, "ProposalProgressResponse": { "type": "object", "properties": { "Actions": { "type": "array", "items": { "$ref": "#/definitions/ProposalAction" } } } }, "ProposalAction": { "type": "object", "properties": { "Domain": { "enum": [ "Vehicle", "Quote", "FinanceApplication" ], "type": "string" }, "Status": { "enum": [ "Available", "NotAvailable", "WithCustomer", "WithLender", "WithRetailer", "Completed" ], "type": "string" }, "Message": { "type": "string" }, "Type": { "enum": [ "Unknown", "MercedesCreditConsent" ], "type": "string" }, "Parameters": { "type": "array", "items": { "$ref": "#/definitions/ActionParameter" } }, "ActionStatus": { "enum": [ "Unknown", "NotCompleted", "Completed" ], "type": "string" } } }, "ActionParameter": { "type": "object", "properties": { "Type": { "enum": [ "Unknown", "Text", "FileUrl" ], "type": "string" }, "Value": { "type": "string" } } }, "TranslateNotificationRequest": { "type": "object", "properties": { "Credentials": { "$ref": "#/definitions/FinanceCredentials" }, "Notifications": { "type": "array", "items": { "$ref": "#/definitions/NotificationRequest" } } } }, "NotificationRequest": { "type": "object", "properties": { "Code": { "format": "int32", "type": "integer" }, "Value": { "type": "string" } } }, "TranslateNotificationResponse": { "type": "object", "properties": { "Notifications": { "type": "array", "items": { "$ref": "#/definitions/TranslatedNotification" } } } }, "TranslatedNotification": { "type": "object", "properties": { "Code": { "format": "int32", "type": "integer" }, "Text": { "type": "string" } } }, "IntegrationUrlValidityRequest": { "required": [ "Application", "Url" ], "type": "object", "properties": { "Application": { "type": "string" }, "Url": { "type": "string" } } }, "IntegrationUrlValidityResponse": { "type": "object", "properties": { "IsValid": { "type": "boolean" } } }, "FinancePackageOrganisationSearchResponse": { "type": "object", "properties": { "Organisations": { "type": "array", "items": { "$ref": "#/definitions/FinancePackageOrganisationSearchResult" } }, "Pagination": { "$ref": "#/definitions/IPaginationResponse" } } }, "FinancePackageOrganisationSearchResult": { "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "IsActive": { "type": "boolean" }, "DisplayName": { "type": "string" } } }, "FinancePackageSearchRequest": { "type": "object", "properties": { "SearchText": { "type": "string" }, "FinancePackageIds": { "type": "array", "items": { "format": "int64", "type": "integer" } } } }, "FinancePackageSearchResponse": { "type": "object", "properties": { "FinancePackages": { "type": "array", "items": { "$ref": "#/definitions/FinancePackage" } } } }, "FinancePackage": { "type": "object", "properties": { "Id": { "format": "int64", "type": "integer" }, "IsActive": { "type": "boolean" }, "DisplayName": { "type": "string" }, "TermGroups": { "type": "array", "items": { "$ref": "#/definitions/TermGroupMetaData" } } } }, "FinanceApplicationNotesResponse": { "type": "object", "properties": { "Notes": { "type": "array", "items": { "$ref": "#/definitions/NoteResponse" } } } }, "NoteResponse": { "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Type": { "enum": [ "DoNotUse", "Update", "Note" ], "type": "string" }, "Message": { "type": "string" }, "HasBeenRead": { "type": "boolean" }, "EntryTime": { "format": "date-time", "type": "string" }, "Author": { "$ref": "#/definitions/AuthorDetails" }, "Level": { "enum": [ "DoNotUse", "FinanceApplication", "Proposal" ], "type": "string" } } }, "AuthorDetails": { "type": "object", "properties": { "UserReference": { "type": "string" }, "UserDisplayName": { "type": "string" }, "OrganisationDisplayName": { "type": "string" } } }, "ExternalNotesConfigResponse": { "type": "object", "properties": { "IsAvailable": { "type": "boolean" }, "DefaultValue": { "type": "boolean" }, "Label": { "type": "string" } } }, "EvChargersResponse": { "type": "object", "properties": { "Locations": { "type": "array", "items": { "$ref": "#/definitions/EvCharger" } } } }, "EvCharger": { "type": "object", "properties": { "Name": { "type": "string" }, "Location": { "$ref": "#/definitions/ChargerLocation" } } }, "ChargerLocation": { "type": "object", "properties": { "Longitude": { "format": "double", "type": "number" }, "Latitude": { "format": "double", "type": "number" } } }, "EvRangeResponse": { "type": "object", "properties": { "Polygons": { "type": "array", "items": { "type": "array", "items": { "$ref": "#/definitions/Coordinates" } } } } }, "Coordinates": { "type": "object", "properties": { "Latitude": { "format": "double", "type": "number" }, "Longitude": { "format": "double", "type": "number" } } }, "CopyPackageRequest": { "type": "object", "properties": { "SourceUserToken": { "type": "string" }, "PackageId": { "format": "int32", "type": "integer" }, "ProductMappings": { "type": "array", "items": { "$ref": "#/definitions/CopyFinancePackageProductMapping" } }, "SystemKey": { "type": "string" } } }, "CopyFinancePackageProductMapping": { "type": "object", "properties": { "SourceId": { "format": "int32", "type": "integer" }, "TargetId": { "format": "int32", "type": "integer" } } }, "CheckoutResponse": { "type": "object", "properties": { "OrderReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "QuoteReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "VehicleReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Sections": { "$ref": "#/definitions/CheckoutSections" } } }, "CheckoutSections": { "type": "object", "properties": { "PartExchange": { "$ref": "#/definitions/CheckoutPartExchangeSection" }, "AdditionalServices": { "$ref": "#/definitions/CheckoutAdditionalServicesSection" }, "Handover": { "$ref": "#/definitions/CheckoutHandoverSection" }, "PaymentType": { "$ref": "#/definitions/CheckoutPaymentTypeSection" }, "Reservation": { "$ref": "#/definitions/CheckoutReservationSection" } } }, "CheckoutPartExchangeSection": { "type": "object", "properties": { "Status": { "enum": [ "Unknown", "NotStarted", "InProgress", "Complete" ], "type": "string" }, "IsAvailable": { "type": "boolean" }, "PartExchangeReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } }, "CheckoutAdditionalServicesSection": { "type": "object", "properties": { "Status": { "enum": [ "Unknown", "NotStarted", "InProgress", "Complete" ], "type": "string" }, "IsAvailable": { "type": "boolean" } } }, "CheckoutHandoverSection": { "type": "object", "properties": { "Status": { "enum": [ "Unknown", "NotStarted", "InProgress", "Complete" ], "type": "string" } } }, "CheckoutPaymentTypeSection": { "type": "object", "properties": { "Status": { "enum": [ "Unknown", "NotStarted", "InProgress", "Complete" ], "type": "string" }, "Type": { "enum": [ "Finance", "Cash" ], "type": "string" } } }, "CheckoutReservationSection": { "type": "object", "properties": { "Status": { "enum": [ "Unknown", "NotStarted", "InProgress", "Complete" ], "type": "string" }, "IsAvailable": { "type": "boolean" }, "ReservationFee": { "format": "double", "type": "number" } } }, "ApplicationOriginValidityRequest": { "required": [ "Application" ], "type": "object", "properties": { "Application": { "type": "string" } } }, "ApplicationOriginValidityResponse": { "type": "object", "properties": { "IsOriginValid": { "type": "boolean" } } }, "TestYarpResponse": { "type": "object", "properties": { "Result": { "type": "string" } } }, "ProposalOverviewResponse": { "type": "object", "properties": { "AppDomain": { "type": "string" }, "HostName": { "type": "string" }, "RequestIdentifier": { "type": "string" }, "TotalDuration": { "format": "int64", "type": "integer" }, "ProcessingDuration": { "format": "int64", "type": "integer" }, "HasError": { "type": "boolean" }, "Error": { "$ref": "#/definitions/ErrorResponse" }, "Errors": { "type": "array", "items": { "$ref": "#/definitions/ErrorResponse" } }, "Reference": { "type": "string" }, "QuoteReference": { "type": "string" }, "EntityType": { "type": "string" }, "IsReadOnly": { "type": "boolean" }, "IsProposed": { "type": "boolean" }, "IsQuote": { "type": "boolean" }, "Status": { "type": "string" }, "IsDeclined": { "type": "boolean" }, "ProposalType": { "enum": [ "Unknown", "Retail", "Fleet" ], "type": "string" } } }, "IdentityCheckResponse": { "type": "object", "properties": { "Status": { "enum": [ "Unknown", "Sent", "Pending", "Failed" ], "type": "string" } } }, "GetIdentityCheckResponse": { "type": "object", "properties": { "IdentityCheckStatus": { "enum": [ "Unknown", "EmailSent", "EmailFailedToSend", "JourneyStarted", "Successful", "Unsuccessful", "Completed", "Failed", "Cancelled", "InProgress" ], "type": "string" }, "CreatedAtOfLatestStatus": { "format": "date-time", "type": "string" }, "AdditionalNotes": { "type": "string" }, "Provider": { "enum": [ "Unknown", "ExperianCastlight", "Codeweavers", "Onfido", "Stripe", "Bonafidee" ], "type": "string" }, "FailureType": { "enum": [ "Unknown", "CheckUnsuccessful", "DataMismatch", "FaceNotMatched", "ImageQuality", "InvalidImages", "SelfieNotLive", "Inconclusive" ], "type": "string" } } }, "ResendIdentityCheckEmailResponse": { "type": "object", "properties": { "Status": { "enum": [ "Unknown", "Sent", "EmailFailedToSend" ], "type": "string" } } }, "GetProposalTypesResponse": { "type": "object", "properties": { "ProposalTypes": { "type": "array", "items": { "$ref": "#/definitions/ProposalTypeDto" } } } }, "ProposalTypeDto": { "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "Name": { "type": "string" } } }, "IsAvailableResponse": { "type": "object", "properties": { "IsAvailable": { "type": "boolean" }, "Error": { "type": "string" } } }, "CreateCopyRequest": { "type": "object", "properties": { "RetailerReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "QuoteReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } }, "CreateCopyResponse": { "type": "object", "properties": { "NewLeadReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "NewLeadNumber": { "type": "string" }, "ShowroomLinkToNewLead": { "type": "string" }, "Error": { "type": "string" }, "HasError": { "type": "boolean", "readOnly": true } } }, "AvailableLendersResponse": { "type": "object", "properties": { "Retailers": { "type": "array", "items": { "$ref": "#/definitions/Retailer" } }, "Consent": { "type": "string" }, "Error": { "type": "string" }, "HasError": { "type": "boolean", "readOnly": true } } }, "Retailer": { "type": "object", "properties": { "RetailerName": { "type": "string" }, "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Lenders": { "type": "array", "items": { "$ref": "#/definitions/LenderQuotes" } }, "Error": { "type": "string" } } }, "LenderQuotes": { "type": "object", "properties": { "LenderName": { "type": "string" }, "LogoUrl": { "type": "string" }, "Quotes": { "type": "array", "items": { "$ref": "#/definitions/QuoteResult" } } } }, "QuoteResult": { "type": "object", "properties": { "ProductName": { "type": "string" }, "QuoteReference": { "type": "string" }, "Apr": { "format": "double", "type": "number" }, "RegularPayment": { "format": "double", "type": "number" }, "Term": { "format": "int32", "type": "integer" }, "AnnualMileage": { "format": "int32", "type": "integer" }, "CashDeposit": { "format": "double", "type": "number" }, "FinalPayment": { "format": "double", "type": "number" }, "TotalAmountPayable": { "format": "double", "type": "number" } } }, "ProposalCountsResponse": { "type": "object", "properties": { "LeadCounts": { "$ref": "#/definitions/ProposalCountsDetails" }, "ProposalCounts": { "$ref": "#/definitions/ProposalCountsDetails" }, "OrderCounts": { "$ref": "#/definitions/ProposalCountsDetails" } } }, "ProposalCountsDetails": { "type": "object", "properties": { "Total": { "format": "int64", "type": "integer" }, "Unassigned": { "format": "int64", "type": "integer" }, "SelfAssigned": { "format": "int64", "type": "integer" } } }, "ProposalIntegrationContractsResponse": { "type": "object", "properties": { "IntegrationContracts": { "type": "array", "items": { "$ref": "#/definitions/IntegrationDetails" } } } }, "IntegrationDetails": { "type": "object", "properties": { "ProposalIntegrationContractKey": { "type": "string" }, "DisplayName": { "type": "string" }, "SupportedTriggers": { "type": "array", "items": { "$ref": "#/definitions/ProposalIntegrationContractTrigger" } }, "Parameters": { "type": "array", "items": { "$ref": "#/definitions/ProposalIntegrationContractParameter" } }, "EnquiryFormKey": { "type": "string" } } }, "ProposalIntegrationContractTrigger": { "type": "object", "properties": { "Key": { "type": "string" }, "DisplayName": { "type": "string" }, "Description": { "type": "string" } } }, "ProposalIntegrationContractParameter": { "type": "object", "properties": { "Key": { "type": "string" }, "DisplayName": { "type": "string" }, "Description": { "type": "string" }, "ValueType": { "type": "string" } } }, "ProposalIntegration": { "required": [ "Url", "DisplayName", "Description", "IntegrationKey", "Triggers", "Parameters" ], "type": "object", "properties": { "Url": { "type": "string" }, "DisplayName": { "type": "string" }, "Description": { "type": "string" }, "IntegrationKey": { "type": "string" }, "EnquiryFormKey": { "type": "string" }, "Triggers": { "type": "array", "items": { "$ref": "#/definitions/ProposalIntegrationTrigger" } }, "Parameters": { "type": "array", "items": { "$ref": "#/definitions/ProposalIntegrationParameter" } }, "RetailerSystemReference": { "type": "string" } } }, "ProposalIntegrationsWithReference": { "type": "object", "properties": { "ProposalIntegrations": { "type": "array", "items": { "$ref": "#/definitions/ProposalIntegrationWithReference" } } } }, "GetProposalIntegrationOrganisationsResponse": { "type": "object", "properties": { "Organisations": { "type": "array", "items": { "$ref": "#/definitions/OrganisationsWithProposalIntegrationReference" } } } }, "OrganisationsWithProposalIntegrationReference": { "type": "object", "properties": { "TradingName": { "type": "string" }, "DealerId": { "format": "int32", "type": "integer" }, "IsActive": { "type": "boolean" } } }, "ProposalPaymentsResponse": { "type": "object", "properties": { "Payments": { "type": "array", "items": { "$ref": "#/definitions/ProposalPayments" } }, "Pagination": { "$ref": "#/definitions/IPaginationResponse" }, "Cursor": { "format": "int64", "type": "integer" } } }, "ProposalPayments": { "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "TransactionId": { "type": "string" }, "CustomerName": { "type": "string" }, "Description": { "type": "string" }, "Amount": { "format": "double", "type": "number" }, "TransactionDate": { "format": "date-time", "type": "string" }, "AuthorisedAt": { "format": "date-time", "type": "string" }, "CapturedAt": { "format": "date-time", "type": "string" }, "ProposalReference": { "type": "string" }, "IsRefunded": { "type": "boolean" }, "Origin": { "enum": [ "Standard", "Order" ], "type": "string" }, "Organisation": { "$ref": "#/definitions/OrganisationResponse" }, "PaymentProviderName": { "type": "string" }, "ExternalTransactionReference": { "type": "string" }, "CurrencyCode": { "type": "string" }, "IsAnonymised": { "type": "boolean" }, "StatusType": { "enum": [ "Unknown", "Success", "Declined", "Refunded", "Failed", "Authorised", "Expired", "Requires3dSecure", "Started" ], "type": "string" } } }, "ProposalPaymentsRequest": { "type": "object", "properties": { "Page": { "format": "int32", "type": "integer" }, "ResultsPerPage": { "format": "int32", "type": "integer" }, "Query": { "type": "string" }, "Cursor": { "format": "int64", "type": "integer" } } }, "PersonalDataCaptureJourneyResponse": { "type": "object", "properties": { "Steps": { "type": "array", "items": { "$ref": "#/definitions/PersonalDataCaptureJourneyStep" } }, "IsJourneySupported": { "type": "boolean" } } }, "PersonalDataCaptureJourneyStep": { "type": "object", "properties": { "Type": { "type": "string" }, "Label": { "type": "string" }, "Description": { "type": "string" }, "Completed": { "type": "boolean" }, "Enabled": { "type": "boolean" }, "Message": { "$ref": "#/definitions/PersonalDataCaptureJourneyMessage" } } }, "PersonalDataCaptureJourneyMessage": { "type": "object", "properties": { "Message": { "type": "string" }, "Type": { "type": "string" } } }, "GetAllProposalInvoicesForProposalResponse": { "type": "object", "properties": { "ProposalInvoices": { "type": "array", "items": { "$ref": "#/definitions/ProposalInvoice" } } } }, "ProposalInvoice": { "type": "object", "properties": { "ProposalReference": { "type": "string" }, "InvoiceIdentifier": { "type": "string" }, "Amount": { "format": "double", "type": "number" }, "CreatedAt": { "format": "date-time", "type": "string" }, "UpdatedAt": { "format": "date-time", "type": "string" }, "Status": { "type": "string" }, "InvoiceReference": { "type": "string" }, "InvoicePdfUrl": { "type": "string" }, "Provider": { "type": "string" } } }, "GetAllProposalIdentitiesForProposalReferenceResponse": { "type": "object", "properties": { "ProposalIdentityVerifications": { "type": "array", "items": { "$ref": "#/definitions/ProposalIdentityVerification" } } } }, "ProposalIdentityVerification": { "type": "object", "properties": { "ProposalReference": { "type": "string" }, "CreatedAt": { "format": "date-time", "type": "string" }, "UpdatedAt": { "format": "date-time", "type": "string" }, "Status": { "type": "string" }, "Provider": { "type": "string" }, "IdentityReference": { "type": "string" }, "IdentityIdentifier": { "type": "string" } } }, "ConfirmFundingForIdentityResponse": { "type": "object", "properties": { "FinanceApplicationReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } }, "CreateProposalRequest": { "type": "object", "properties": { "QuoteReference": { "description": "Add a quote to the created proposal", "type": "string", "externalDocs": { "description": "Identical functionality to append quote API.", "url": "PUT,/api/proposals/{proposalReference}/quote/{quoteReference}" } }, "OrganisationIdentifier": { "$ref": "#/definitions/OrganisationIdentifier", "description": "This determines the organisation that the request will be run as. This changes the authentication context to be for this organisation." }, "AssignedUserReference": { "description": "Specify the assigned user if the proposal is created on behalf of a different user", "type": "string" }, "Entity": { "enum": [ "Private individual", "Other corporate", "Limited company", "Partnership", "Self employed", "PLC", "Registered Charity", "Educational Organisation", "Private Individual / Self Employed", "Limited liability partnership", "deferred", "Sole Trader", "Small Partnership", "Large Partnership", "Industrial Provident", "Other Non Incorporated", "Agency" ], "type": "string" }, "ExternalReference": { "type": "string" }, "ProposalDescription": { "maxLength": 100, "minLength": 0, "type": "string" }, "ReferrerUri": { "type": "string" }, "UtmParameters": { "$ref": "#/definitions/UtmParameters" }, "GrantCustomerAccessToProposal": { "description": "Experimental property to give the user access to their newly created proposal", "type": "boolean" } } }, "CreateProposalResponse": { "type": "object", "properties": { "ProposalReference": { "type": "string" }, "ProposalNumber": { "description": "A display identifier of the proposal that may be displayed to a customer to facilitate identifying a proposal over the phone for example.", "type": "string" } } }, "PartExchangesResponse": { "type": "object", "properties": { "PartExchanges": { "type": "array", "items": { "$ref": "#/definitions/PartExchangeResponse" } } } }, "GetPostApplyConfigurationResponse": { "type": "object", "properties": { "Configuration": { "$ref": "#/definitions/PostApplyConfiguration" } } }, "PostApplyConfiguration": { "type": "object", "properties": { "IsPcciRequired": { "type": "boolean" }, "IsPceRequired": { "type": "boolean" }, "IsPceVideoRequired": { "type": "boolean" }, "IsPceDocumentPresent": { "type": "boolean" }, "IsPcciDocumentPresent": { "type": "boolean" }, "RegulatoryBody": { "type": "string" } } }, "ProposalSearchRequest": { "type": "object", "properties": { "EndDateTime": { "format": "date-time", "type": "string" }, "StartDateTime": { "format": "date-time", "type": "string" }, "Query": { "type": "string" }, "StatusFilters": { "type": "array", "items": { "type": "string" } }, "IfTrueOnlyReturnsOrdersIfFalseOnlyReturnsNonOrders": { "type": "boolean" }, "AssignType": { "enum": [ "All", "ProvidedUserReference", "Unassigned" ], "type": "string" }, "SearchableSourceApplication": { "enum": [ "Unknown", "All", "InStore", "Online" ], "type": "string" }, "AssignedUserReference": { "type": "string" }, "Page": { "format": "int32", "type": "integer" }, "ResultsPerPage": { "format": "int32", "type": "integer" }, "SortOrder": { "enum": [ "Unknown", "Descending", "Ascending" ], "type": "string" }, "NotificationFilter": { "enum": [ "Unknown", "All", "WithNotification", "WithoutNotification" ], "type": "string" } } }, "ProposalSearchResponse": { "type": "object", "properties": { "Paging": { "$ref": "#/definitions/Pagination" }, "Proposals": { "type": "array", "items": { "$ref": "#/definitions/SearchProposal" } } } }, "SearchProposal": { "type": "object", "properties": { "Id": { "type": "string" }, "Status": { "type": "string" }, "Product": { "type": "string" }, "Source": { "type": "string" }, "Amount": { "type": "string" }, "EntityType": { "type": "string" }, "UnreadNotesCount": { "format": "int32", "type": "integer" }, "Customer": { "$ref": "#/definitions/SearchProposalApplicant" }, "Applicant": { "$ref": "#/definitions/SearchProposalApplicant" }, "Created": { "format": "date-time", "type": "string" }, "CreatedAt": { "format": "date-time", "type": "string" }, "Vehicle": { "$ref": "#/definitions/SearchProposalVehicle" }, "Dealer": { "$ref": "#/definitions/SearchDealer" }, "OverrideMessage": { "type": "string" }, "Claimed": { "$ref": "#/definitions/SearchProposalClaimInformation" }, "ExternalId": { "type": "string" }, "CreatedBy": { "type": "string" }, "ProposalOriginEntries": { "type": "array", "items": { "$ref": "#/definitions/SearchProposalOrigin" } }, "CanBeSetToNtu": { "type": "boolean" }, "CustomerReference": { "type": "string" }, "ProposalType": { "type": "string" }, "Notification": { "$ref": "#/definitions/SearchProposalNotification" } } }, "SearchProposalVehicle": { "type": "object", "properties": { "Manufacturer": { "type": "string" }, "Derivative": { "type": "string" }, "Model": { "type": "string" }, "Vrm": { "type": "string" }, "VehicleDescription": { "type": "string", "readOnly": true } } }, "SearchDealer": { "type": "object", "properties": { "Id": { "type": "string" }, "Name": { "type": "string" } } }, "SearchProposalOrigin": { "type": "object", "properties": { "Type": { "enum": [ "Unknown", "Source", "Medium", "Campaign", "Term", "Content" ], "type": "string" }, "Value": { "type": "string" }, "DisplayValue": { "type": "string" } } }, "SearchProposalNotification": { "type": "object", "properties": { "CreatedAt": { "format": "date-time", "type": "string" }, "Category": { "type": "string" }, "Description": { "type": "string" }, "Level": { "type": "string" } } }, "UpdateProposalPersonalInformationRequest": { "type": "object", "properties": { "Applicants": { "type": "array", "items": { "$ref": "#/definitions/IndividualApplicant" } } } }, "IndividualApplicant": { "type": "object", "properties": { "Title": { "enum": [ "Unknown", "Mr", "Mrs", "Ms", "Dr", "Miss", "Lord", "Lady", "Prof", "Sir" ], "type": "string" }, "FirstName": { "type": "string" }, "MiddleName": { "type": "string" }, "LastName": { "type": "string" }, "DateOfBirth": { "format": "date-time", "type": "string" }, "Dependents": { "format": "int32", "type": "integer" }, "PrimaryPhoneNumber": { "type": "string" }, "SecondaryPhoneNumber": { "type": "string" }, "EmailAddress": { "type": "string" }, "AddressHistory": { "type": "array", "items": { "$ref": "#/definitions/IndividualApplicantAddress" } }, "EmploymentHistory": { "type": "array", "items": { "$ref": "#/definitions/IndividualApplicantEmployment" } }, "Gender": { "enum": [ "Unknown", "Male", "Female" ], "type": "string" }, "MaritalStatus": { "enum": [ "Unknown", "Single", "Married", "Divorced", "Widowed", "Separated", "Cohabiting", "LivingWithPartner" ], "type": "string" }, "Identifications": { "type": "array", "items": { "$ref": "#/definitions/Identification" } }, "BankDetails": { "$ref": "#/definitions/IndividualApplicantBankDetails" } } }, "IndividualApplicantAddress": { "type": "object", "properties": { "Tenure": { "enum": [ "Unknown", "LivingWithParents", "LivingWithPartner", "Tenant", "Homeowner", "Other", "CouncilTenant", "FurnishedTenant", "UnfurnishedTenant", "OwnerLeaseHold", "OwnerFreeHold", "Lodger", "HouseAssociation", "OwnerShareTransfer", "Mortgage" ], "type": "string" }, "Address": { "$ref": "#/definitions/ProposalAddress" }, "YearsAtAddress": { "format": "int32", "maximum": 100, "minimum": 0, "type": "integer" }, "MonthsAtAddress": { "format": "int32", "maximum": 11, "minimum": 0, "type": "integer" } } }, "IndividualApplicantEmployment": { "type": "object", "properties": { "EmployerName": { "type": "string" }, "Occupation": { "type": "string" }, "PhoneNumber": { "type": "string" }, "OccupationBasis": { "enum": [ "Unknown", "FullTime", "PartTime", "SelfEmployedFullTime", "SelfEmployedPartTime", "Temporary", "Retired", "Unemployed", "OtherBasis", "Permanent", "OwnBusiness", "Contractor" ], "type": "string" }, "OccupationCategory": { "enum": [ "Unknown", "Accountancy", "AccountingProfessional", "Administration", "Agriculture", "ArmedForces", "ArmedForcesOfficer", "ArmedForcesOther", "Artists", "Benefits", "BusinessConsultant", "BusinessOwner", "CivilService", "ClergyReligiousWorker", "ClericalAdminSupport", "CompanyDirector", "ComputersIt", "Construction", "Consultants", "Counsellors", "Directors", "Driver", "Drivers", "Engineer", "Engineers", "EntertainmentProfessional", "Executive", "Factory", "FactoryWorker", "Farmers", "FinanceBankingInsurance", "FinanceBanking", "FoodPreparationService", "GovernmentCivilServant", "HealthOccupations", "HomeMaker", "HousePerson", "HousewifeHouseHusband", "Insurance", "ItTechnologyProfessional", "LawyersJudges", "LegalProfessional", "Librarians", "Management", "Manager", "MechanicsAndRepairers", "MediaProfessional", "MedicalDentalProfessional", "MiddleManager", "MilitaryOfficer", "Nurse", "OfficeStaff", "Other", "OwnerOfABusiness", "Police", "PrecisionProductionOcc", "PrivateMeansSelfEmployed", "Professional", "ProfessionalSports", "QualifiedProfessional", "Restauranteur", "Retail", "Retired", "Sales", "SalesRepActMgmnt", "ScientistResearcher", "SecurityOccupations", "SemiProfessional", "SeniorManager", "Service", "ServiceOccupations", "SkilledManual", "SkilledTradesman", "SocialWorkerProbOfficer", "SportingProfessional", "Student", "TaxiDriverBlackCab", "TaxiDriverNonBlackCab", "TeachersProfessors", "TeamLeader", "Telesales", "Temporary", "Travel", "Unemployed", "UniformedGuard", "UnskilledManual", "UnskilledWorker" ], "type": "string" }, "Address": { "$ref": "#/definitions/ProposalAddress" }, "MonthsWithEmployer": { "format": "int32", "maximum": 11, "minimum": 0, "type": "integer" }, "YearsWithEmployer": { "format": "int32", "maximum": 100, "minimum": 0, "type": "integer" }, "GrossAnnualSalary": { "format": "double", "type": "number" } } }, "IndividualApplicantBankDetails": { "type": "object", "properties": { "AccountName": { "type": "string" }, "SortCode": { "type": "string" }, "AccountNumber": { "type": "string" }, "BankName": { "type": "string" }, "BranchName": { "type": "string" }, "BankAddress": { "type": "string" }, "YearsAtBank": { "format": "int32", "maximum": 100, "minimum": 0, "type": "integer" } } }, "ProposalAddress": { "type": "object", "properties": { "HouseName": { "type": "string" }, "AddressLine1": { "type": "string" }, "AddressLine2": { "type": "string" }, "AddressLine3": { "type": "string" }, "Town": { "type": "string" }, "Postcode": { "type": "string" }, "County": { "type": "string" } } }, "ProposalStatusResponse": { "type": "object", "properties": { "Status": { "$ref": "#/definitions/Status" }, "QuoteReference": { "type": "string" } } }, "Status": { "type": "object", "properties": { "Id": { "type": "string" }, "Description": { "type": "string" }, "IsSubmitted": { "type": "boolean" }, "IsReadOnly": { "type": "boolean" } } }, "ProposalStatusesResponse": { "type": "object", "properties": { "HasError": { "type": "boolean" }, "Errors": { "type": "array", "items": { "$ref": "#/definitions/Error" } }, "StatusesWithReasons": { "type": "array", "items": { "$ref": "#/definitions/ProposalStatusesWithReasons" } } } }, "ProposalStatusesWithReasons": { "type": "object", "properties": { "DisplayName": { "type": "string" }, "Value": { "type": "string" }, "Enabled": { "type": "boolean" }, "StatusReasons": { "type": "array", "items": { "$ref": "#/definitions/ProposalStatusReason" } } } }, "ProposalStatusReason": { "type": "object", "properties": { "DisplayName": { "type": "string" }, "Value": { "type": "string" }, "Enabled": { "type": "boolean" } } }, "ProposalStatusDescriptionResponse": { "type": "object", "properties": { "Status": { "type": "string" }, "Heading": { "type": "string" }, "Description": { "type": "string" } } }, "SoftSearchResults": { "type": "object", "properties": { "Results": { "type": "array", "items": { "$ref": "#/definitions/SoftSearchResult" } }, "ConsumerScore": { "$ref": "#/definitions/ConsumerScoreResult" } } }, "SoftSearchResult": { "type": "object", "properties": { "Likelihood": { "format": "int32", "type": "integer" }, "DeclineReason": { "type": "string" }, "DateTime": { "format": "date-time", "type": "string" }, "QuoteReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "LenderName": { "type": "string" }, "ProductType": { "type": "string" }, "Apr": { "format": "double", "type": "number" }, "ProductKey": { "type": "string" }, "Description": { "type": "string" } } }, "ConsumerScoreResult": { "type": "object", "properties": { "Score": { "type": "string" }, "Description": { "type": "string" }, "DateTime": { "format": "date-time", "type": "string" } } }, "PerformSoftSearchRequest": { "type": "object", "properties": {} }, "PerformSoftSearchResponse": { "type": "object", "properties": {} }, "SearchProposalsByIdentifierResponse": { "type": "object", "properties": { "SearchResults": { "type": "array", "items": { "$ref": "#/definitions/ProposalSearchResult" } } } }, "ProposalSearchResult": { "type": "object", "properties": { "Type": { "type": "string" }, "DisplayId": { "format": "int64", "type": "integer" }, "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "ExternalSystemKey": { "type": "string" } } }, "UpdateProposalOrganisationByExternalReferenceRequest": { "type": "object", "properties": { "OrganisationIdentifier": { "$ref": "#/definitions/OrganisationIdentifier", "description": "This is the external organisation identifier of the organisation that you wish to assign the proposal to." } } }, "UpdateProposalOrganisationByExternalReferenceResponse": { "type": "object", "properties": {} }, "GetApplicableRetailersResponse": { "type": "object", "properties": { "CurrentRetailer": { "$ref": "#/definitions/ApplicableRetailer" }, "ApplicableRetailers": { "type": "array", "items": { "$ref": "#/definitions/ApplicableRetailer" } } } }, "ApplicableRetailer": { "type": "object", "properties": { "RetailerName": { "type": "string" }, "LegacyDealerId": { "format": "int32", "type": "integer" } } }, "AppendQuoteOverrideReasonToProposalQuoteRequest": { "type": "object", "properties": { "HasOverride": { "type": "boolean" }, "Reason": { "type": "string" } } }, "ProposalQuoteHistoryResponse": { "type": "object", "properties": { "QuoteHistory": { "type": "array", "items": { "$ref": "#/definitions/ProposalQuoteSummary" } } } }, "ProposalQuoteSummary": { "type": "object", "properties": { "QuoteReference": { "type": "string" }, "Description": { "type": "string" }, "IsActive": { "type": "boolean" }, "QuoteDateTime": { "format": "date-time", "type": "string" }, "QuoteSource": { "enum": [ "Unknown", "Retailer", "Customer" ], "type": "string" }, "Lender": { "type": "string" } } }, "ProposalsAlternativeQuotesRequest": { "required": [ "Lenders" ], "type": "object", "properties": { "Lenders": { "enum": [ "All", "DifferentToCurrentFinance", "SameAsCurrentFinance" ], "type": "string" } } }, "ProposalsAlternativeQuotesResponse": { "type": "object", "properties": { "CurrentFinance": { "$ref": "#/definitions/FinanceDetails" }, "AlternativeFinance": { "type": "array", "items": { "$ref": "#/definitions/FinanceDetails" } } } }, "TaskAuditResponse": { "type": "object", "properties": { "Events": { "type": "array", "items": { "$ref": "#/definitions/TaskAuditEvent" } } } }, "TaskAuditEvent": { "type": "object", "properties": { "PerformedBy": { "type": "string" }, "OccurredAt": { "format": "date-time", "type": "string" }, "TaskType": { "type": "string" }, "EventType": { "type": "string" }, "FinalStatus": { "type": "string" }, "Content": { "type": "string" }, "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } }, "TaskActivityAuditResponse": { "type": "object", "properties": { "Tasks": { "type": "array", "items": { "$ref": "#/definitions/TaskHistoryGroup" } } } }, "TaskHistoryGroup": { "type": "object", "properties": { "TaskName": { "type": "string" }, "TaskReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "LastUpdated": { "format": "date-time", "type": "string" }, "History": { "type": "array", "items": { "$ref": "#/definitions/ActivityChangeDetail" } } } }, "ActivityChangeDetail": { "type": "object", "properties": { "OccurredAt": { "format": "date-time", "type": "string" }, "PerformedBy": { "type": "string" }, "Action": { "type": "string" }, "Type": { "type": "string" }, "Description": { "type": "string" }, "Value": { "type": "string" }, "ActivityReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } }, "ProposalInformationResponse": { "type": "object", "properties": { "DealerName": { "type": "string" }, "QuoteReference": { "type": "string" }, "ProposalStatus": { "type": "string" }, "ProposalId": { "format": "int32", "type": "integer" }, "DealerId": { "format": "int32", "type": "integer" }, "ProposalReference": { "type": "string" }, "DealerContactId": { "format": "int32", "type": "integer" }, "HasBeenAnonymised": { "type": "boolean" }, "ToBeAnonymisedAt": { "format": "date-time", "type": "string" }, "LenderName": { "type": "string" }, "DealerContactName": { "type": "string" }, "LastSubmitted": { "format": "date-time", "type": "string" }, "AnonymisationReason": { "type": "string" }, "FormKey": { "type": "string" }, "IsProposalReadOnly": { "type": "boolean" }, "IsQuoteReadOnly": { "type": "boolean" }, "IsOverridden": { "type": "boolean" }, "Journey": { "type": "string" }, "UserReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "EntityType": { "type": "string" }, "ProposalType": { "type": "string" }, "AdditionalData": { "type": "array", "items": { "$ref": "#/definitions/AdditionalDataItem" } }, "SourceApplication": { "type": "string" }, "CreatedAt": { "format": "date-time", "type": "string" } } }, "AdditionalDataItem": { "type": "object", "properties": { "Key": { "type": "string" }, "Value": { "type": "string" } } }, "ProposalsOverviewResponse": { "type": "object", "properties": { "Reference": { "type": "string" }, "IsQuote": { "type": "boolean" }, "QuoteReference": { "type": "string" }, "IsProposed": { "type": "boolean" }, "ValidTo": { "format": "date-time", "type": "string" }, "HasBeenAnonymised": { "type": "boolean" }, "EntityType": { "enum": [ "Unknown", "OtherCorporate", "Association", "Corporate", "LimitedCompany", "LimitedLiabilityPartnership", "LocalAuthority", "NHSTrust", "Partnership", "PLC", "PrivateIndividual", "RegisteredCharity", "School", "SelfEmployed", "SoleTrader", "PrivateLimitedCompany", "GovernmentOrganisation", "UnlimitedCompany", "ForeignCompany", "RoyalCharter", "SmallPartnership", "LargePartnership", "EducationalOrganisation", "PrivateCompanyLimitedbyShares", "DesignatedActivityCompany", "DesignatedActivityCompanyLimitedbyGuarantee", "CompanyLimitedbyGuarantee", "SingleMemberCompany", "IndustrialAndProvidentSociety", "FriendlySociety", "TradeUnion", "Specialfund", "UndertakingsforCollectiveInvestmentInTransferableSecurities", "EuropeanEconomicInterestGroupings", "SocietasEuropaea", "OtherLegalFormROI", "OtherLegalForm", "OtherNonLegalForm", "OtherNonIncorporated" ], "type": "string" }, "ReadOnlyStatus": { "$ref": "#/definitions/ReadOnlyStatus" }, "OriginalReferrerUri": { "type": "string" } } }, "ReadOnlyStatus": { "type": "object", "properties": { "IsQuoteReadOnly": { "type": "boolean" }, "IsProposalReadOnly": { "type": "boolean" }, "IsAssetReadOnly": { "type": "boolean" } } }, "ProposalNotesResponse": { "type": "object", "properties": { "Notes": { "type": "array", "items": { "$ref": "#/definitions/ProposalNote" } } } }, "ProposalNote": { "type": "object", "properties": { "Content": { "type": "string" }, "TimeStamp": { "format": "date-time", "type": "string" } } }, "GetAllNotesRequest": { "type": "object", "properties": { "OrderBy": { "enum": [ "Unknown", "Ascending", "Descending" ], "type": "string" } } }, "GetProposalMarketingPreferencesResponse": { "type": "object", "properties": { "MarketingPreferences": { "type": "array", "items": { "$ref": "#/definitions/ProposalMarketingPreference" } } } }, "ProposalMarketingPreference": { "type": "object", "properties": { "Type": { "enum": [ "Unknown", "Telephone", "Sms", "Email" ], "type": "string" }, "OptedIn": { "type": "boolean" }, "DisplayName": { "type": "string" } } }, "GetProposalInformationOverviewResponse": { "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "DisplayId": { "format": "int64", "type": "integer" }, "SystemId": { "format": "int32", "type": "integer" }, "SystemKey": { "type": "string" }, "CreatedAt": { "format": "date-time", "type": "string" }, "Status": { "type": "string" }, "EntityType": { "type": "string" }, "ProposalType": { "type": "string" }, "SourceApplication": { "type": "string" }, "Journey": { "type": "string" }, "IsVisible": { "type": "boolean" }, "IsOverridden": { "type": "boolean" }, "QuoteReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Organisation": { "$ref": "#/definitions/OrganisationInformation" }, "CreatedBy": { "$ref": "#/definitions/CreatedByInformation" }, "Anonymisation": { "$ref": "#/definitions/AnonymisationInformation" }, "Destination": { "$ref": "#/definitions/DestinationInformation" }, "ReadonlyStatus": { "$ref": "#/definitions/ReadonlyStatusInformation" }, "AdditionalData": { "type": "array", "items": { "$ref": "#/definitions/AdditionalDataInformation" } }, "CreditLineApplicationProposalReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "FinanceApplicationIntegration": { "$ref": "#/definitions/FinanceApplicationIntegrationInformation" } } }, "OrganisationInformation": { "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "LegacyDealerId": { "format": "int32", "type": "integer" }, "Name": { "type": "string" } } }, "CreatedByInformation": { "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Name": { "type": "string" } } }, "AnonymisationInformation": { "type": "object", "properties": { "IsAnonymised": { "type": "boolean" }, "ToBeAnonymisedAt": { "format": "date-time", "type": "string" }, "Reason": { "type": "string" } } }, "DestinationInformation": { "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Name": { "type": "string" }, "LatestSubmittedAt": { "format": "date-time", "type": "string" }, "FormKey": { "type": "string" } } }, "ReadonlyStatusInformation": { "type": "object", "properties": { "IsProposalReadOnly": { "type": "boolean" }, "IsQuoteReadOnly": { "type": "boolean" } } }, "AdditionalDataInformation": { "type": "object", "properties": { "Key": { "type": "string" }, "Value": { "type": "string" } } }, "FinanceApplicationIntegrationInformation": { "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Name": { "type": "string" }, "DestinationReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "DestinationName": { "type": "string" } } }, "ProposalFormResponse": { "type": "object", "properties": { "Sections": { "type": "array", "items": { "$ref": "#/definitions/ProposalFormSection" } }, "Status": { "$ref": "#/definitions/ProposalFormStatus" }, "Capabilities": { "$ref": "#/definitions/ProposalFormCapabilities" } } }, "ProposalFormSection": { "type": "object", "properties": { "Identifier": { "description": "This value is unique to the form field and should not be hardcoded.", "type": "string", "externalDocs": { "description": "This value is used to identify the section and fields that need to be added or removed from the update API response.", "url": "PUT,/api/proposals/{proposalReference}/form-fields" } }, "Label": { "description": "This is a display value usually presented to identify the category of fields presented to the user.\r\nThis value is content managed and should not be hardcoded in the integration.", "type": "string" }, "IsValidToSubmit": { "description": "This value indicates whether the section is valid to submit", "type": "boolean" }, "Sections": { "description": "Each section can include nested sections.\r\nFor example: An Address History section will include nested sections for each address.", "type": "array", "items": { "$ref": "#/definitions/ProposalFormSection" } }, "Fields": { "description": "This section includes the fields that need to be presented to the user.", "type": "array", "items": { "$ref": "#/definitions/ProposalFormField" } }, "Actions": { "$ref": "#/definitions/Actions", "description": "Each section may include a header and/or footer actions.\r\nFor example: An Address History section will include a delete button to remove an address." }, "Version": { "format": "int32", "description": "Used internally, can be ignored by API consumers.", "type": "integer" }, "Type": { "description": "Specifies the structural role of this section, such as a repeatable collection (e.g., addresses), a container for nested sections, or a set of fields for data entry.\r\nThe exact values are subject to future definition.", "type": "string" } } }, "ProposalFormStatus": { "type": "object", "properties": { "IsResubmittable": { "type": "boolean" }, "IsSubmittable": { "type": "boolean" }, "IsSubmittedByUser": { "type": "boolean" }, "ProposalEntityType": { "enum": [ "Private individual", "Other corporate", "Limited company", "Partnership", "Self employed", "PLC", "Registered Charity", "Educational Organisation", "Private Individual / Self Employed", "Limited liability partnership", "deferred", "Sole Trader", "Small Partnership", "Large Partnership", "Industrial Provident", "Other Non Incorporated", "Agency" ], "type": "string" } } }, "ProposalFormCapabilities": { "type": "object", "properties": { "IsPostcodeLookupEnabled": { "type": "boolean" }, "IsAddressLookupEnabled": { "type": "boolean" } } }, "ProposalFormField": { "type": "object", "properties": { "Label": { "description": "This is a display value usually presented to the user next to the UI form control component.\r\nThis value is content managed and should not be hardcoded in the integration.", "type": "string" }, "Identifier": { "description": "This value is unique to the form field and should not be hardcoded.", "type": "string", "externalDocs": { "description": "This value is the FieldIdentifier for update API requests.", "url": "PUT,/api/proposals/{proposalReference}/form-fields" } }, "Value": { "description": "The current field value.", "type": "string" }, "Error": { "description": "This is used to indicate an erroneous field when not null.", "type": "string" }, "Type": { "description": "This is typically used in a component factory to display different UI controls to the user.\r\nThere is a possibility that field types can change and it is important that the component factory has a default fallback UI component.", "enum": [ "Input", "InputWithoutCopyAndPaste", "TextArea", "Select", "CheckBox", "Hidden", "TextContent", "PrivacyPolicy", "Consent", "DisplayText", "Email", "Number", "Currency", "TelephoneNumber", "Postcode", "Date", "BankSortCode", "AddressLookup", "Radio" ], "type": "string" }, "IsRequired": { "description": "This is typically used to indicate if the field is required to successfully submit.", "type": "boolean", "externalDocs": { "description": "Cross field relationships can modify this value. An update request of Value:'X' for Field:'A' may result in Field:'B' IsRequired property value changing.", "url": "PUT,/api/proposals/{proposalReference}/form-fields" } }, "ToolTip": { "description": "This is a display value usually presented next to the UI form control component to provide additional information.\r\nThis value is content managed and should not be hardcoded in the integration.", "type": "string" }, "ToolTipPrompt": { "description": "This is a display value usually presented next to the UI form control component to provide additional information Can be used to provide verbal information instead of just a tooltip icon.\r\nThis value is content managed and should not be hardcoded in the integration.", "type": "string" }, "IsReadOnly": { "description": "This value identifies whether the user can modify the value.", "type": "boolean" }, "Key": { "description": "This value is not unique to the field and should not be used to identify a specific field instance.", "type": "string" }, "Options": { "description": "This list will contain possible values for field types which are not free text entry types.", "type": "array", "items": { "$ref": "#/definitions/ProposalFormOption" } }, "ValidationRules": { "description": "This list will contain all validation rules for the field.", "type": "array", "items": { "$ref": "#/definitions/ProposalFormValidationRule" } }, "InformationMessages": { "description": "This list will contain all information messages for the field.", "type": "array", "items": { "$ref": "#/definitions/ProposalInformationMessage" } }, "IsDynamicField": { "description": "Used to highlight a field that appears as a result of the answer to another field.", "type": "boolean" }, "DisplayOptions": { "$ref": "#/definitions/ProposalFormFieldDisplayOptions", "description": "This contains details on how the field is configured to be displayed" }, "Actions": { "description": "Actions linked to this particular field.", "type": "array", "items": { "$ref": "#/definitions/ProposalFormFieldAction" } }, "IsDefaultValue": { "description": "Used to establish if a field value is user-entered, or has been defaulted to a specific one", "type": "boolean" } } }, "Actions": { "type": "object", "properties": { "Header": { "description": "These actions are usually presented to the user at the top of the form section.\r\nNote: not all sections will have header actions.", "type": "array", "items": { "$ref": "#/definitions/Action" } }, "Footer": { "description": "These actions are usually presented to the user at the bottom of the form section.\r\nNote: not all sections will have footer actions.", "type": "array", "items": { "$ref": "#/definitions/Action" } } } }, "ProposalFormOption": { "type": "object", "properties": { "Text": { "description": "This is a display value usually presented to the user as a selectable option.\r\nThis value is content managed and can change.", "type": "string" }, "Value": { "type": "string", "externalDocs": { "description": "This should be used as the Value in the update field value API request", "url": "PUT,/api/proposals/{proposalReference}/form-fields" } } } }, "ProposalFormValidationRule": { "type": "object", "properties": { "Type": { "description": "This indicates the type of validation rule.", "type": "string", "externalDocs": { "description": "ServerSideRegex rules will always be applied by the update field API", "url": "PUT,/api/proposals/{proposalReference}/form-fields" } }, "Value": { "description": "The rule to be applied when the field value is modified by the user.\r\nThis value is content managed and should not be hardcoded in the integration.", "type": "string" }, "ErrorMessage": { "description": "This should be presented to the user if the provided value fails the validation rule.\r\nThis value is content managed and should not be hardcoded in the integration.", "type": "string" }, "Flags": { "description": "JavaScript regular expression flags that modify how the validation pattern in Value is evaluated.\r\nThis value is content managed and should not be hardcoded in the integration.", "type": "string" } } }, "ProposalInformationMessage": { "type": "object", "properties": { "Message": { "description": "This should be presented to the user if the provided value has warning message.\r\nThis value is content managed and should not be hardcoded in the integration.", "type": "string" } } }, "ProposalFormFieldDisplayOptions": { "type": "object", "properties": { "Alignment": { "description": "This is the intended alignment for the proposal form field.", "enum": [ "Unknown", "Top", "Center", "Bottom" ], "type": "string" }, "SupportsHtml": { "description": "This will identify if the proposal form field label should support HTML.", "type": "boolean" } } }, "ProposalFormFieldAction": { "type": "object", "properties": { "Type": { "description": "This is typically used in an action factory to display different UI controls to the user.\r\nThere is a possibility action types can change and it is important that the component factory has a default fallback UI component.", "type": "string" }, "Label": { "description": "This is a display value usually presented to the user as the action text.\r\nThis value is content managed and can change.", "type": "string" }, "Enabled": { "description": "Whether the action can be performed at this time.", "type": "boolean" } } }, "Action": { "type": "object", "properties": { "Type": { "description": "This is typically used in an action factory to display different UI controls to the user.\r\nThere is a possibility action types can change and it is important that the component factory has a default fallback UI component.", "enum": [ "Link", "AddSection", "DeleteSection", "Text" ], "type": "string" }, "Description": { "description": "This is a display value usually presented to the user as the action text.\r\nThis value is content managed and can change.", "type": "string" }, "Value": { "type": "string", "externalDocs": { "description": "This value is used in the submit action API request.", "url": "POST,/api/proposals/{proposalReference}/form-action" } }, "Error": { "description": "This is used to indicate an failed action when not null.", "type": "string" }, "HelpText": { "description": "Help text to add more information about the action", "type": "string" } } }, "ProposalFormUpdateFieldsRequest": { "required": [ "Updates" ], "type": "object", "properties": { "Updates": { "type": "array", "items": { "$ref": "#/definitions/UpdateFieldRequest" } }, "MinusFormTypes": { "description": "Two form types may include the same field(s). When retrieving a form for FormType \"B\" minus FormType \"A\", FormType \"B\" will be returned without the fields that also exist on FormType \"A\".", "type": "array", "items": { "enum": [ "Affordability", "CustomerContactCapture", "CustomerCreditCheck", "CustomerDeliveryAddress", "EligibilityRateForRisk", "CustomerEnquiry", "CustomerFinanceApplication", "CustomerFinanceApplicationWithoutBankDetails", "CustomerReserve", "CustomerSoftSearch", "CustomerSuitability", "DecisionInPrinciple", "DriverPortal", "Eligibility", "FinancePortalExternalInitialise", "PartialFinanceApplication", "RetailerFinanceApplication", "RetailerLeadCapture", "Unknown" ], "type": "string" } }, "ReturnAllFieldErrors": { "description": "The returned form state will include all outstanding field errors, including fields not sent in the updates", "type": "boolean" } } }, "UpdateFieldRequest": { "required": [ "FieldIdentifier", "Value" ], "type": "object", "properties": { "FieldIdentifier": { "type": "string" }, "Value": { "type": "string" } } }, "ProposalFormUpdateResponse": { "type": "object", "properties": { "Sections": { "type": "array", "items": { "$ref": "#/definitions/ProposalFormSection" } }, "Status": { "$ref": "#/definitions/ProposalFormStatus" } } }, "ProposalFormUpdateFieldDataRequest": { "required": [ "FieldIdentifier", "Data" ], "type": "object", "properties": { "FieldIdentifier": { "type": "string" }, "Data": { "$ref": "#/definitions/ProposalFormV3PutFieldData" }, "MinusFormTypes": { "description": "Two form types may include the same field(s). When retrieving a form for FormType \"B\" minus FormType \"A\", FormType \"B\" will be returned without the fields that also exist on FormType \"A\".", "type": "array", "items": { "enum": [ "Affordability", "CustomerContactCapture", "CustomerCreditCheck", "CustomerDeliveryAddress", "EligibilityRateForRisk", "CustomerEnquiry", "CustomerFinanceApplication", "CustomerFinanceApplicationWithoutBankDetails", "CustomerReserve", "CustomerSoftSearch", "CustomerSuitability", "DecisionInPrinciple", "DriverPortal", "Eligibility", "FinancePortalExternalInitialise", "PartialFinanceApplication", "RetailerFinanceApplication", "RetailerLeadCapture", "Unknown" ], "type": "string" } }, "ReturnAllFieldErrors": { "description": "The returned form state will include all outstanding field errors, including fields not sent in the updates", "type": "boolean" } } }, "ProposalFormV3PutFieldData": { "required": [ "Value", "Type" ], "type": "object", "properties": { "Value": { "type": "string" }, "Type": { "enum": [ "Unknown", "AddressLookupId" ], "type": "string" } } }, "ProposalActionRequest": { "required": [ "ActionType" ], "type": "object", "properties": { "ActionType": { "type": "string" }, "Value": { "type": "string" }, "MinusFormTypes": { "description": "Two form types may include the same field(s). When retrieving a form for FormType \"B\" minus FormType \"A\", FormType \"B\" will be returned without the fields that also exist on FormType \"A\".", "type": "array", "items": { "enum": [ "Affordability", "CustomerContactCapture", "CustomerCreditCheck", "CustomerDeliveryAddress", "EligibilityRateForRisk", "CustomerEnquiry", "CustomerFinanceApplication", "CustomerFinanceApplicationWithoutBankDetails", "CustomerReserve", "CustomerSoftSearch", "CustomerSuitability", "DecisionInPrinciple", "DriverPortal", "Eligibility", "FinancePortalExternalInitialise", "PartialFinanceApplication", "RetailerFinanceApplication", "RetailerLeadCapture", "Unknown" ], "type": "string" } }, "ReturnAllFieldErrors": { "description": "The returned form state will include all outstanding field errors, including fields not sent in the updates", "type": "boolean" } } }, "ProposalSubmitRequest": { "type": "object", "properties": { "FormType": { "description": "This value dictates both the validation rules enforced and consequential submission behaviour.", "enum": [ "Affordability", "CustomerContactCapture", "CustomerCreditCheck", "CustomerDeliveryAddress", "EligibilityRateForRisk", "CustomerEnquiry", "CustomerFinanceApplication", "CustomerFinanceApplicationWithoutBankDetails", "CustomerReserve", "CustomerSoftSearch", "CustomerSuitability", "DecisionInPrinciple", "DriverPortal", "Eligibility", "FinancePortalExternalInitialise", "PartialFinanceApplication", "RetailerFinanceApplication", "RetailerLeadCapture", "Unknown" ], "type": "string" }, "Lead": { "type": "string" } } }, "AddProposalToFleetAgreementResponse": { "type": "object", "properties": {} }, "RemoveProposalFromFleetAgreementResponse": { "type": "object", "properties": {} }, "GetFleetAgreementForProposalReferenceResponse": { "type": "object", "properties": { "Reference": { "type": "string" }, "FleetCode": { "type": "string" }, "OrganisationReference": { "type": "string" }, "CreatedAt": { "format": "date-time", "type": "string" } } }, "GetProposalEntitiesForProductResponse": { "type": "object", "properties": { "ProductEntities": { "type": "array", "items": { "$ref": "#/definitions/ProposalProductEntity" } } } }, "ProposalProductEntity": { "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "Description": { "type": "string" }, "DisplayText": { "type": "string" }, "IsForBusiness": { "type": "boolean" } } }, "EmailPartExchangeResponse": { "type": "object", "properties": {} }, "GetEligibilityByLenderResponse": { "type": "object", "properties": { "EligibilityChecks": { "type": "array", "items": { "$ref": "#/definitions/EligibilityCheck" } }, "TotalCount": { "format": "int32", "type": "integer" }, "MaxPageNumber": { "format": "int32", "type": "integer" } } }, "EligibilityCheck": { "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "ProposalReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Status": { "enum": [ "Unknown", "InProgress", "Completed", "Failed", "BadRequest", "InsufficientTrace", "Rejected", "FormDetailsHaveChangedSinceLastEligibilitySubmission" ], "type": "string" }, "CreatedAt": { "format": "date-time", "type": "string" }, "LegacyOrganisationId": { "format": "int32", "type": "integer" }, "OrganisationName": { "type": "string" }, "ProposalStatus": { "type": "string" }, "ExpiresAt": { "format": "date-time", "type": "string" } } }, "CompleteCustomerActionResponse": { "type": "object", "properties": {} }, "CreditLineApplicationAvailableCreditResponse": { "type": "object", "properties": { "CreditLine": { "$ref": "#/definitions/CreditLineSummary" }, "MhaSigningDate": { "format": "date-time", "type": "string" }, "RecommendedCredit": { "format": "double", "type": "number" }, "CanRequestCreditUplift": { "type": "boolean" } } }, "UpdateCreditLineApplicationRequest": { "type": "object", "properties": { "ExpiryDate": { "format": "date-time", "type": "string" }, "TotalCredit": { "format": "double", "type": "number" }, "SingleArticleLimit": { "format": "double", "type": "number" } } }, "RequestCreditUpliftRequest": { "type": "object", "properties": { "Reason": { "type": "string" } } }, "GetCreditLineApplicationQuotesForProposalResponse": { "type": "object", "properties": { "Quotes": { "type": "array", "items": { "$ref": "#/definitions/CreditLineApplicationQuoteApiResponse" } }, "Summary": { "$ref": "#/definitions/QuotesSummary" }, "Pagination": { "$ref": "#/definitions/Pagination" }, "SubmissionStatusFilter": { "type": "string" } } }, "CreditLineApplicationQuoteApiResponse": { "type": "object", "properties": { "Quote": { "$ref": "#/definitions/CreditLineApplicationQuoteSummary" }, "Quantity": { "format": "int32", "type": "integer" }, "CreatedAt": { "format": "date-time", "type": "string" }, "SubmittedAt": { "format": "date-time", "type": "string" }, "Locked": { "type": "boolean" } } }, "QuotesSummary": { "type": "object", "properties": { "TotalAmountPayable": { "format": "double", "type": "number" }, "TotalSubmittedAmountPayable": { "format": "double", "type": "number" }, "TotalNotSubmittedAmountPayable": { "format": "double", "type": "number" } } }, "CreditLineApplicationQuoteSummary": { "type": "object", "properties": { "QuoteReference": { "type": "string" }, "VehicleDescription": { "type": "string" }, "VehicleManufacturer": { "type": "string" }, "VehicleOptions": { "type": "array", "items": { "$ref": "#/definitions/CreditLineApplicationQuoteVehicleOption" } }, "OnTheRoadPrice": { "format": "double", "type": "number" }, "TotalRegularPayment": { "format": "double", "type": "number" }, "CashDeposit": { "format": "double", "type": "number" }, "AdvancedRentals": { "format": "int32", "type": "integer" }, "AnnualMileage": { "format": "int32", "type": "integer" }, "Term": { "format": "int32", "type": "integer" }, "UnitPrice": { "format": "double", "type": "number" }, "VehicleType": { "type": "string" }, "RentalProfile": { "type": "string" }, "P11D": { "format": "double", "type": "number" }, "ProductName": { "type": "string" } } }, "CreditLineApplicationQuoteVehicleOption": { "type": "object", "properties": { "Description": { "type": "string" }, "Category": { "type": "string" } } }, "UpdateCreditLineApplicationQuoteRequest": { "type": "object", "properties": { "Quantity": { "format": "int32", "type": "integer" } } }, "SaveCreditLineApplicationQuoteRequest": { "type": "object", "properties": { "Quantity": { "format": "int32", "type": "integer" } } }, "CreditLineApplicationOrdersResponse": { "type": "object", "properties": { "Pagination": { "$ref": "#/definitions/Pagination" }, "Orders": { "type": "array", "items": { "$ref": "#/definitions/CreditLineApplicationOrderSummary" } } } }, "CreditLineApplicationOrderSummary": { "type": "object", "properties": { "ProposalReference": { "type": "string" }, "ProposalId": { "format": "int32", "type": "integer" }, "CreatedAt": { "format": "date-time", "type": "string" }, "Status": { "type": "string" }, "StatusKey": { "type": "string" }, "Vehicle": { "$ref": "#/definitions/VehicleSummary" } } }, "VehicleSummary": { "type": "object", "properties": { "Manufacturer": { "type": "string" }, "Model": { "type": "string" }, "Derivative": { "type": "string" } } }, "GetCreditLineApplicationReferenceGivenOrderReferenceResponse": { "type": "object", "properties": { "CreditLineApplicationReference": { "type": "string" } } }, "CreditCheckResponse": { "type": "object", "properties": { "TierId": { "description": "Obsolete. Use ScoreString", "type": "string" }, "Score": { "format": "double", "type": "number" }, "ScoreString": { "description": "Possible values: \"Excellent\", \"Good\", \"Average\", \"Poor\", \"Bankrupt\"", "type": "string" }, "Tiers": { "description": "Obsolete", "type": "array", "items": { "$ref": "#/definitions/CreditCheckTier" } } } }, "CreditCheckTier": { "type": "object", "properties": { "Id": { "type": "string" }, "Description": { "type": "string" }, "Min": { "format": "int32", "type": "integer" }, "Max": { "format": "int32", "type": "integer" } } }, "PrivacyPolicyConsentRequest": { "required": [ "PolicyType" ], "type": "object", "properties": { "PolicyType": { "description": "Indicates the policy and permissions that requires consent", "enum": [ "Dpa", "MccDpa", "CloseOnlyDpa", "ConfusedPrivacyPolicy", "RetailerLeadCapture", "Account", "Eligibility", "MercedesCreditConsent", "ContactCapture", "DeliveryAddress", "ReservationTermsAndConditions", "AdditionalApplicantProposalCapturePrivacyPolicy", "FinanceApply", "MotorCreditCheck", "EmailMeThisQuote", "Marketing", "CommissionCapture", "Reserve", "ProposalCapture", "QuoteSave", "SoftSearch", "ContactForm", "PartExchange", "IddCapture" ], "type": "string" } } }, "PrivacyPolicyResponse": { "type": "object", "properties": { "HasAccepted": { "description": "Indicates whether the privacy policy has been accepted", "type": "boolean" }, "DateAccepted": { "format": "date-time", "description": "The date the privacy policy was accepted", "type": "string" }, "Overview": { "description": "The privacy policy text context", "type": "string" } } }, "PrivacyPolicyStatusResponse": { "type": "object", "properties": { "HasAccepted": { "description": "Indicates whether the privacy policy has been accepted", "type": "boolean" }, "DateAccepted": { "format": "date-time", "description": "The date the privacy policy was accepted", "type": "string" } } }, "TimelineDiagramResponse": { "type": "object", "properties": { "DiagramConfiguration": { "type": "string" } } }, "SubmissionsSearchRequest": { "required": [ "Page", "ResultsPerPage" ], "type": "object", "properties": { "Page": { "format": "int32", "maximum": 2147483647, "minimum": 1, "type": "integer" }, "ResultsPerPage": { "format": "int32", "maximum": 100, "minimum": 1, "type": "integer" }, "OrderBy": { "enum": [ "Unknown", "Ascending", "Descending" ], "type": "string" }, "Filters": { "$ref": "#/definitions/TimelineFilters" } } }, "SubmissionsSearchResponse": { "type": "object", "properties": { "Submissions": { "type": "array", "items": { "$ref": "#/definitions/DeprecatedSubmission" } }, "Page": { "format": "int32", "type": "integer" }, "ResultsPerPage": { "format": "int32", "type": "integer" }, "TotalPages": { "format": "int32", "type": "integer" }, "TotalResults": { "format": "int32", "type": "integer" } } }, "DeprecatedSubmission": { "type": "object", "properties": { "RequestTime": { "format": "date-time", "type": "string" }, "ResponseTime": { "format": "date-time", "type": "string" }, "Request": { "type": "string" }, "Response": { "type": "string" }, "Url": { "type": "string" }, "Successful": { "type": "boolean" } } }, "ProposalStatusEventsResponse": { "type": "object", "properties": { "StatusEvents": { "type": "array", "items": { "$ref": "#/definitions/ProposalStatusEvent" } } } }, "ProposalStatusEvent": { "type": "object", "properties": { "Status": { "type": "string" }, "Reference": { "type": "string" }, "Provider": { "type": "string" }, "Event": { "type": "string" }, "OccurredAt": { "format": "date-time", "type": "string" }, "ExternalReference": { "type": "string" }, "AdditionalData": { "type": "object", "additionalProperties": { "type": "string" } }, "Type": { "type": "string" } } }, "AccessDetailsRequest": { "required": [ "Page", "ResultsPerPage" ], "type": "object", "properties": { "Page": { "format": "int32", "maximum": 2147483647, "minimum": 1, "type": "integer" }, "ResultsPerPage": { "format": "int32", "maximum": 1000, "minimum": 1, "type": "integer" }, "AccessDetailsFilters": { "$ref": "#/definitions/AccessDetailsFilter" }, "OrderBy": { "enum": [ "Unknown", "Ascending", "Descending" ], "type": "string" } } }, "AccessDetailsFilter": { "type": "object", "properties": { "Route": { "type": "string" }, "UserReference": { "type": "string" }, "Granted": { "type": "boolean" } } }, "AccessDetailsResponse": { "type": "object", "properties": { "Events": { "type": "array", "items": { "$ref": "#/definitions/AccessEvent" } }, "Page": { "format": "int32", "type": "integer" }, "ResultsPerPage": { "format": "int32", "type": "integer" }, "TotalPages": { "format": "int32", "type": "integer" }, "TotalResults": { "format": "int32", "type": "integer" }, "AvailableFilters": { "$ref": "#/definitions/AccessDetailsAvailableFilters" } } }, "AccessEvent": { "type": "object", "properties": { "Granted": { "type": "boolean" }, "UserReference": { "type": "string" }, "Route": { "type": "string" }, "RequestType": { "type": "string" }, "AccessReason": { "type": "string" }, "GrantDecisionReason": { "type": "string" }, "IpAddress": { "type": "string" }, "Time": { "format": "date-time", "type": "string" }, "UserType": { "type": "string" } } }, "AccessDetailsAvailableFilters": { "type": "object", "properties": { "UserReferences": { "type": "array", "items": { "type": "string" } }, "Routes": { "type": "array", "items": { "type": "string" } } } }, "AnonymiseProposalPostRequest": { "required": [ "Reason" ], "type": "object", "properties": { "Reason": { "type": "string" }, "ForceRemovalIgnoreRules": { "type": "boolean" } } }, "ProposalAffordabilityResponse": { "type": "object", "properties": { "MonthlyTotalIncome": { "format": "double", "type": "number" }, "MonthlyTotalExpenditure": { "format": "double", "type": "number" }, "DisplayAffordabilitySection": { "type": "boolean" } } }, "ProposalsSubmissionSystemsResponse": { "type": "object", "properties": { "Systems": { "type": "array", "items": { "$ref": "#/definitions/ProposalsSubmissionSystem" } } } }, "ProposalsSubmissionSystem": { "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "Name": { "type": "string" } } }, "ProposalsSubmissionSearchRequest": { "required": [ "From", "To" ], "type": "object", "properties": { "From": { "format": "date-time", "type": "string" }, "To": { "format": "date-time", "type": "string" }, "Filter": { "$ref": "#/definitions/ProposalsSubmissionSearchRequestFilter" } } }, "ProposalsSubmissionSearchRequestFilter": { "type": "object", "properties": { "SystemReferences": { "type": "array", "items": { "type": "string" } } } }, "ProposalsSubmissionSearchResponse": { "type": "object", "properties": { "Submissions": { "type": "array", "items": { "$ref": "#/definitions/Submission" } } } }, "Submission": { "type": "object", "properties": { "ProposalReference": { "type": "string" }, "FinanceApplicationIntegrationReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Result": { "enum": [ "Success", "Fail" ], "type": "string" }, "Time": { "format": "date-time", "type": "string" } } }, "FinanceApplicationsResponse": { "type": "object", "properties": { "FinanceApplications": { "type": "array", "items": { "$ref": "#/definitions/FinanceApplication" } }, "Status": { "$ref": "#/definitions/FinanceApplicationProposalStatusResponse" } } }, "FinanceApplication": { "type": "object", "properties": { "DestinationName": { "type": "string" }, "FinanceApplicationReference": { "type": "string" }, "IsActive": { "type": "boolean" }, "ChangesAllowed": { "description": "If true then documents, esigns and id checks can be updated as required.\r\nIf false then no changes to the proposal or it's associated content should be modified.", "type": "boolean" }, "ExternalReference": { "type": "string" }, "QuoteReference": { "type": "string" }, "Status": { "type": "string" } } }, "FinanceApplicationProposalStatusResponse": { "type": "object", "properties": { "Id": { "enum": [ "Proposed", "WaitingFurtherInformation", "Approved", "ConditionallyApproved", "Referred", "SubmissionFailed", "CompletedDeal", "NotTakenUp", "Quote", "SystemIntermediate", "UnableToAssist", "AwaitingResubmission", "BrokerAccepted", "BrokerNTU", "BrokerPaidOut", "BrokerProcessingPayout", "BrokerReqFurtherInfo", "Cancelled", "ReferredToBroker", "ReferredToUnderwriter", "Reproposed", "AwaitingDocuments", "PendingPayout", "RejectedAtPayout", "DeliveryAuthorised", "UnrecoverableError", "MadeLiveInQuery", "DocumentPackApproved", "AwaitingDeliveryAuthorisation" ], "type": "string" } } }, "SetActiveFinanceApplicationResponse": { "type": "object", "properties": {} }, "SubmitEligibilityApplicationResponse": { "type": "object", "properties": {} }, "GetEligibilityResultsResponse": { "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "LenderPreference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Results": { "type": "array", "items": { "$ref": "#/definitions/EligibilityResult" } }, "Status": { "enum": [ "Unknown", "InProgress", "Completed", "Failed", "BadRequest", "InsufficientTrace", "Rejected", "FormDetailsHaveChangedSinceLastEligibilitySubmission" ], "type": "string" }, "AllowLenderSwitch": { "type": "boolean" }, "CreatedAt": { "format": "date-time", "type": "string" } } }, "EligibilityResult": { "type": "object", "properties": { "LenderReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "LenderName": { "type": "string" }, "Rate": { "format": "double", "type": "number" }, "LikelihoodPercentage": { "format": "double", "type": "number" }, "LikelihoodDescription": { "type": "string" }, "LenderLogoUrl": { "type": "string" }, "Status": { "enum": [ "Unknown", "InProgress", "Completed", "Failed", "BadRequest", "InsufficientTrace", "Rejected", "FormDetailsHaveChangedSinceLastEligibilitySubmission" ], "type": "string" }, "ProductFamily": { "type": "string" }, "ProviderType": { "enum": [ "Unknown", "Lender", "Broker", "LenderWithDecisionInPrinciple" ], "type": "string" }, "CreditTier": { "enum": [ "Unknown", "BelowAverage", "Fair", "Good", "VeryGood", "Excellent" ], "type": "string" }, "Banding": { "enum": [ "Unknown", "Low", "Medium", "High" ], "type": "string" }, "ExpiresAt": { "format": "date-time", "type": "string" } } }, "SubmitSingleLenderEligibilityApplicationResponse": { "type": "object", "properties": { "StatusCode": { "enum": [ "Unknown", "ReadyToPoll", "InvalidFormValidation" ], "type": "string" } } }, "UpdateEligibilityLenderPreferenceRequest": { "type": "object", "properties": { "LenderReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "EligibilityResultReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } }, "UpdateEligibilityLenderPreferenceResponse": { "type": "object", "properties": {} }, "DecisionInPrincipleResponse": { "type": "object", "properties": { "Results": { "type": "array", "items": { "$ref": "#/definitions/DecisionInPrincipleResult" } } } }, "DecisionInPrincipleResult": { "type": "object", "properties": { "LenderReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "LenderName": { "type": "string" }, "MaxMonthlyBudget": { "format": "int32", "type": "integer" }, "Decision": { "enum": [ "Unknown", "Eligible", "EligibleAlternateAmount", "NotEligible", "NoDecision", "InProgress", "Failed", "FormDetailsChangedSinceLastDecisionInPrincipleSubmission" ], "type": "string" }, "DecisionDescription": { "type": "string" }, "CreatedAt": { "format": "date-time", "type": "string" } } }, "SubmitDecisionInPrincipleResponse": { "type": "object", "properties": {} }, "GetEntitiesForQuoteResponse": { "type": "object", "properties": { "Entities": { "type": "array", "items": { "$ref": "#/definitions/Entity" } } } }, "Entity": { "type": "object", "properties": { "DisplayText": { "type": "string" }, "Description": { "type": "string" }, "IsSelectable": { "type": "boolean" }, "RequiresCalculation": { "type": "boolean" } } }, "GetSavedQuotesResponse": { "type": "object", "properties": { "SavedQuotes": { "type": "array", "items": { "$ref": "#/definitions/SavedQuote" } } } }, "SavedQuote": { "type": "object", "properties": { "Quote": { "$ref": "#/definitions/FinanceQuotesResponse" }, "DisplayDetails": { "type": "array", "items": { "$ref": "#/definitions/DisplayDetail" } }, "Status": { "enum": [ "Unknown", "Valid", "CanRecalculate", "RequiresChanges", "Unavailable" ], "type": "string" }, "QuoteNumber": { "type": "string" }, "SchemeReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } }, "UpdateSavedQuotesRequest": { "type": "object", "properties": { "UserReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "SavedQuotesReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "SavedQuotes": { "type": "array", "items": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } } }, "UpdateSavedQuotesResponse": { "type": "object", "properties": {} }, "VehicleTestDriveResponse": { "type": "object", "properties": { "Status": { "enum": [ "Unknown", "Sent", "Pending", "Failed" ], "type": "string" } } }, "RemoteApplySendRequest": { "required": [ "ProposalReference", "EmailAddress", "FirstName", "LastName" ], "type": "object", "properties": { "ProposalReference": { "type": "string" }, "QuoteReferences": { "type": "array", "items": { "type": "string" } }, "EmailAddress": { "type": "string" }, "FirstName": { "type": "string" }, "LastName": { "type": "string" }, "Message": { "type": "string" } } }, "RemoteApplySendResponse": { "type": "object", "properties": {} }, "RemoteApplyQuotesResponse": { "type": "object", "properties": { "QuoteReferences": { "type": "array", "items": { "type": "string" } } } }, "GetAvailableReportsResponse": { "type": "object", "properties": { "Reports": { "type": "array", "items": { "$ref": "#/definitions/Report" } } } }, "Report": { "type": "object", "properties": { "Name": { "type": "string" }, "Description": { "type": "string" }, "DisplayName": { "type": "string" }, "Id": { "type": "string" }, "Filters": { "type": "array", "items": { "$ref": "#/definitions/ReportFilter" } } } }, "ReportFilter": { "type": "object", "properties": { "Type": { "type": "string" }, "Name": { "type": "string" }, "Description": { "type": "string" }, "Max": { "format": "int32", "type": "integer" }, "Min": { "format": "int32", "type": "integer" }, "Options": { "type": "array", "items": { "$ref": "#/definitions/FilterOption" } } } }, "FilterOption": { "type": "object", "properties": { "Id": { "type": "string" }, "Name": { "type": "string" }, "IsDefault": { "type": "boolean" } } }, "GetReportForResponse": { "type": "object", "properties": { "FileContents": { "type": "string" }, "FileName": { "type": "string" }, "FileMimeType": { "type": "string" } } }, "GetIdentityChecksByProviderResponse": { "type": "object", "properties": { "IdentityChecks": { "type": "array", "items": { "$ref": "#/definitions/GetIdentityChecksByProviderItem" } }, "TotalResults": { "format": "int32", "type": "integer" }, "PageNumber": { "format": "int32", "type": "integer" }, "PageSize": { "format": "int32", "type": "integer" } } }, "GetIdentityChecksByProviderItem": { "type": "object", "properties": { "ProposalReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "IdentityCheckReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreatedAt": { "format": "date-time", "type": "string" }, "IdentityCheckStatus": { "enum": [ "Unknown", "EmailSent", "EmailFailedToSend", "JourneyStarted", "Successful", "Unsuccessful", "Completed", "Failed", "Cancelled", "InProgress" ], "type": "string" }, "CreatedAtOfLatestStatus": { "format": "date-time", "type": "string" }, "AdditionalNotes": { "type": "string" }, "Provider": { "enum": [ "Unknown", "ExperianCastlight", "Codeweavers", "Onfido", "Stripe", "Bonafidee" ], "type": "string" }, "FailureType": { "enum": [ "Unknown", "CheckUnsuccessful", "DataMismatch", "FaceNotMatched", "ImageQuality", "InvalidImages", "SelfieNotLive", "Inconclusive" ], "type": "string" } } }, "AvailableSalutationsResponse": { "type": "object", "properties": { "Salutations": { "type": "array", "items": { "$ref": "#/definitions/Salutation" } } } }, "Salutation": { "type": "object", "properties": { "DisplayText": { "type": "string" }, "Id": { "type": "string" } } }, "SearchForSarReportsRequest": { "type": "object", "properties": { "ApplicantEmailAddress": { "type": "string" } } }, "SearchForSarReportsResponse": { "type": "object", "properties": { "SarReports": { "type": "array", "items": { "$ref": "#/definitions/SarReportDetails" } } } }, "SarReportDetails": { "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreatedAt": { "format": "date-time", "type": "string" }, "CreatedByUserReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreatedByEmailAddress": { "type": "string" }, "SentAt": { "format": "date-time", "type": "string" }, "HasExpired": { "type": "boolean" } } }, "PreviewSarReportRequest": { "type": "object", "properties": { "ApplicantEmailAddress": { "type": "string" } } }, "PreviewSarReportResponse": { "type": "object", "properties": { "ThirdPartyCountersigners": { "type": "array", "items": { "$ref": "#/definitions/SarReportThirdPartyCountersignerEntity" } }, "LenderESignSigners": { "type": "array", "items": { "$ref": "#/definitions/SarReportLenderESignSignerEntity" } }, "Proposals": { "type": "array", "items": { "$ref": "#/definitions/SarReportProposalEntity" } }, "User": { "$ref": "#/definitions/SarReportUserEntity" }, "ThirdPartyData": { "type": "string" } } }, "SarReportThirdPartyCountersignerEntity": { "type": "object", "properties": { "Reference": { "type": "string" }, "EmailAddress": { "type": "string" }, "MobileNumber": { "type": "string" }, "Description": { "type": "string" }, "FirstName": { "type": "string" }, "LastName": { "type": "string" }, "IsActive": { "type": "boolean" }, "OrganisationTradingName": { "type": "string" }, "OrganisationReference": { "type": "string" }, "OrganisationLegacyDealerId": { "format": "int32", "type": "integer" }, "OrganisationSystemKey": { "type": "string" }, "OrganisationSystemId": { "format": "int32", "type": "integer" } } }, "SarReportLenderESignSignerEntity": { "type": "object", "properties": { "Reference": { "type": "string" }, "BusinessRepFirstName": { "type": "string" }, "BusinessRepLastName": { "type": "string" }, "MobileNumber": { "type": "string" }, "Email": { "type": "string" } } }, "SarReportProposalEntity": { "type": "object", "properties": { "Reference": { "type": "string" }, "SystemId": { "format": "int32", "type": "integer" }, "SystemKey": { "type": "string" }, "IsSelectable": { "type": "boolean" }, "ProposalFormData": { "type": "string" }, "DeliveryAddressData": { "type": "string" }, "Status": { "type": "string" } } }, "SarReportUserEntity": { "type": "object", "properties": { "Reference": { "type": "string" }, "FirstName": { "type": "string" }, "LastName": { "type": "string" }, "Email": { "type": "string" }, "Title": { "type": "string" }, "Username": { "type": "string" } } }, "CreateAndRetrieveSarReportRequest": { "type": "object", "properties": { "ThirdPartyCountersignerEntities": { "type": "array", "items": { "$ref": "#/definitions/ThirdPartyCountersignerEntity" } }, "LenderESignSignerEntities": { "type": "array", "items": { "$ref": "#/definitions/LenderESignSignerEntity" } }, "UserReference": { "type": "string" }, "ProposalEntities": { "type": "array", "items": { "$ref": "#/definitions/ProposalEntity" } } } }, "ThirdPartyCountersignerEntity": { "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } }, "LenderESignSignerEntity": { "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } }, "ProposalEntity": { "type": "object", "properties": { "Reference": { "type": "string" }, "SystemId": { "format": "int32", "type": "integer" } } }, "CreateAndRetrieveSarReportResponse": { "type": "object", "properties": { "SarReportReference": { "type": "string" } } }, "SendSarReportsResponse": { "type": "object", "properties": {} }, "GetSarReportByReferenceResponse": { "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreatedAt": { "format": "date-time", "type": "string" }, "CreatedByUserReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "CreatedByEmailAddress": { "type": "string" }, "SentAt": { "format": "date-time", "type": "string" }, "HasExpired": { "type": "boolean" } } }, "GetSarReportPasswordResponse": { "type": "object", "properties": { "Password": { "type": "string" } } }, "GenerateTransferTokenRequest": { "type": "object", "properties": { "SessionReference": { "type": "string" }, "TimeToLiveMinutes": { "format": "int32", "type": "integer" } } }, "GenerateTransferTokenResponse": { "type": "object", "properties": { "TransferToken": { "type": "string" } } }, "ConsumeTransferTokenResponse": { "type": "object", "properties": { "SessionToken": { "type": "string" } } }, "SessionResponse": { "type": "object", "properties": { "ExpiresAt": { "format": "date-time", "description": "The representation of when the session expires as a date time.", "type": "string" }, "ExpiresIn": { "format": "int64", "description": "The representation of how long until the session expires in milliseconds.", "type": "integer" } } }, "SessionExtendResponse": { "type": "object", "properties": { "UserToken": { "type": "string" }, "ExpiresAt": { "format": "date-time", "type": "string" }, "ExpiresIn": { "format": "int64", "type": "integer" } } }, "GetSettlementProvidersResponse": { "type": "object", "properties": { "Providers": { "type": "array", "items": { "$ref": "#/definitions/SettlementProvider" } } } }, "SettlementProvider": { "type": "object", "properties": { "Identifier": { "type": "string" }, "Fields": { "type": "array", "items": { "$ref": "#/definitions/SettlementProviderField" } } } }, "SettlementProviderField": { "type": "object", "properties": { "Key": { "type": "string" }, "DisplayText": { "type": "string" }, "Type": { "type": "string" }, "Description": { "type": "string" } } }, "GetSettlementRequest": { "type": "object", "properties": { "Identifier": { "type": "string" }, "ProposalReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Values": { "type": "array", "items": { "$ref": "#/definitions/SettlementRequestParameters" } } } }, "SettlementRequestParameters": { "type": "object", "properties": { "Key": { "type": "string" }, "Value": { "type": "string" } } }, "GetSettlementResponse": { "type": "object", "properties": { "SettlementAmount": { "format": "double", "type": "number" } } }, "ProposalActionSearchRequest": { "type": "object", "properties": { "Granularity": { "type": "string" }, "StartTime": { "format": "date-time", "type": "string" }, "EndTime": { "format": "date-time", "type": "string" }, "DealerIds": { "type": "array", "items": { "type": "string" } } } }, "ProposalActionsResponse": { "type": "object", "properties": { "Actions": { "type": "object", "additionalProperties": { "$ref": "#/definitions/ProposalActionStatistic" } } } }, "ProposalActionStatistic": { "type": "object", "properties": { "Count": { "format": "int32", "type": "integer" } } }, "AddProposalActionRequest": { "type": "object", "properties": { "Actions": { "type": "array", "items": { "type": "string" } }, "ProposalReference": { "type": "string" } } }, "GetSubmissionEndpointMaintenancePeriodsResponse": { "type": "object", "properties": { "MaintenancePeriods": { "type": "array", "items": { "$ref": "#/definitions/SubmissionEndpointMaintenancePeriod" } } } }, "SubmissionEndpointMaintenancePeriod": { "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "WebServiceOutIdentifier": { "type": "string" }, "StartAt": { "format": "date-time", "type": "string" }, "EndAt": { "format": "date-time", "type": "string" } } }, "CreateSubmissionEndpointMaintenancePeriodRequest": { "type": "object", "properties": { "WebServiceOutIdentifier": { "type": "string" }, "StartAt": { "format": "date-time", "type": "string" }, "EndAt": { "format": "date-time", "type": "string" } } }, "CreateSubmissionEndpointMaintenancePeriodResponse": { "type": "object", "properties": {} }, "UpdateSubmissionEndpointMaintenancePeriodRequest": { "type": "object", "properties": { "WebServiceOutIdentifier": { "type": "string" }, "StartAt": { "format": "date-time", "type": "string" }, "EndAt": { "format": "date-time", "type": "string" } } }, "UpdateSubmissionEndpointMaintenancePeriodResponse": { "type": "object", "properties": {} }, "DeleteSubmissionEndpointMaintenancePeriodResponse": { "type": "object", "properties": {} }, "SupplierSearchRequest": { "type": "object", "properties": { "SearchText": { "type": "string" }, "LenderProposalReference": { "type": "string" } } }, "SupplierSearchResponse": { "type": "object", "properties": { "Results": { "type": "array", "items": { "$ref": "#/definitions/Supplier" } } } }, "Supplier": { "type": "object", "properties": { "Description": { "type": "string" }, "SupplierCode": { "type": "string" } } }, "GetAllSystemsResponse": { "type": "object", "properties": { "Systems": { "type": "array", "items": { "$ref": "#/definitions/AllSystemsSystem" } } } }, "AllSystemsSystem": { "type": "object", "properties": { "Id": { "type": "string" }, "Name": { "type": "string" }, "ExternalKey": { "type": "string" }, "Reference": { "type": "string" } } }, "GetSystemByExternalSystemKeyResponse": { "type": "object", "properties": { "Id": { "type": "string" }, "Name": { "type": "string" }, "SupportDetails": { "$ref": "#/definitions/SystemDetailsDetails" }, "Language": { "type": "object", "additionalProperties": { "type": "string" } }, "PrivacyPolicyLink": { "type": "string" }, "ExternalPortals": { "type": "array", "items": { "$ref": "#/definitions/SystemDetailsExternalPortal" } }, "ExternalKey": { "type": "string" } } }, "SystemDetailsDetails": { "type": "object", "properties": { "Email": { "type": "string" }, "Telephone": { "type": "string" }, "Link": { "type": "string" }, "Message": { "type": "string" }, "Contacts": { "type": "array", "items": { "$ref": "#/definitions/SystemDetailsContact" } }, "ShowResetPasswordPrompt": { "type": "boolean" } } }, "SystemDetailsExternalPortal": { "type": "object", "properties": { "Url": { "type": "string" }, "Title": { "type": "string" }, "Icon": { "type": "string" } } }, "SystemDetailsContact": { "type": "object", "properties": { "Label": { "type": "string" }, "Email": { "type": "string" }, "Telephone": { "type": "string" }, "Link": { "type": "string" } } }, "TemplateListModel": { "type": "object", "properties": { "Templates": { "type": "array", "items": { "$ref": "#/definitions/TemplateMetaModel" } } } }, "TemplateMetaModel": { "type": "object", "properties": { "Id": { "type": "string" }, "Name": { "type": "string" }, "TagSets": { "type": "array", "items": { "$ref": "#/definitions/KeyValuePair[String,String]" } }, "IsLive": { "type": "boolean" }, "IsDeleted": { "type": "boolean" }, "Date": { "format": "date-time", "type": "string" }, "PublishedDate": { "format": "date-time", "type": "string" }, "ExpirationDate": { "format": "date-time", "type": "string" }, "OrganisationReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Format": { "enum": [ "Unknown", "Text", "Html", "Razor", "Fluid", "Static" ], "type": "string" } } }, "SaveUpdateTemplateRequest": { "type": "object", "properties": { "Id": { "type": "string" }, "Contents": { "type": "string" }, "Tags": { "type": "array", "items": { "type": "string" } }, "TagSets": { "type": "array", "items": { "$ref": "#/definitions/KeyValuePair[String,String]" } }, "Name": { "type": "string" }, "AdditionalData": { "type": "object", "additionalProperties": { "type": "string" } }, "PublishedDate": { "format": "date-time", "type": "string" }, "ExpirationDate": { "format": "date-time", "type": "string" }, "Format": { "enum": [ "Unknown", "Text", "Html", "Razor", "Fluid", "Static" ], "type": "string" }, "OrganisationReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } }, "TemplateSave": { "type": "object", "properties": { "Id": { "type": "string" }, "HasError": { "type": "boolean" }, "Message": { "type": "string" } } }, "TemplateDetailsResponse": { "type": "object", "properties": { "Id": { "type": "string" }, "Name": { "type": "string" }, "Contents": { "type": "string" }, "TimeModified": { "type": "string" }, "TagSets": { "type": "array", "items": { "$ref": "#/definitions/KeyValuePair[String,String]" } }, "IsLive": { "type": "boolean" }, "IsDeleted": { "type": "boolean" }, "AdditionalData": { "type": "object", "additionalProperties": { "type": "string" } }, "PublishedDate": { "type": "string" }, "ExpirationDate": { "type": "string" }, "OrganisationReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Format": { "enum": [ "Unknown", "Text", "Html", "Razor", "Fluid", "Static" ], "type": "string" } } }, "DeleteContentTemplateResponse": { "type": "object", "properties": { "HasError": { "type": "boolean" }, "Message": { "type": "string" } } }, "TemplateVersions": { "type": "object", "properties": { "Versions": { "type": "array", "items": { "$ref": "#/definitions/TemplateVersion" } } } }, "TemplateVersion": { "type": "object", "properties": { "Id": { "type": "string" }, "TimeModified": { "type": "string" }, "EditedBy": { "type": "string" }, "Email": { "type": "string" } } }, "ExecuteTemplateRequest": { "type": "object", "properties": { "IsPreview": { "type": "boolean" }, "Model": { "type": "object" } } }, "ExecuteTemplateResponse": { "type": "object", "properties": { "RenderedTemplate": { "type": "string" }, "ModelAsJson": { "type": "string" }, "TimeModified": { "format": "date-time", "type": "string" } } }, "PreviewTemplateRequest": { "type": "object", "properties": { "Content": { "type": "string" }, "Format": { "enum": [ "Unknown", "Text", "Html", "Razor", "Fluid", "Static" ], "type": "string" }, "Model": { "type": "object" } } }, "PreviewTemplateResponse": { "type": "object", "properties": { "HasRenderError": { "type": "boolean" }, "RenderErrorMessages": { "type": "array", "items": { "type": "string" } } } }, "SaveUpdateTemplateResponse": { "type": "object", "properties": { "TemplateId": { "type": "string" }, "TemplateVersion": { "type": "string" } } }, "TemplateTagsModel": { "type": "object", "properties": { "Tags": { "type": "array", "items": { "type": "string" } }, "TagSets": { "type": "array", "items": { "$ref": "#/definitions/KeyValuePair[String,String]" } } } }, "CreateTermsAndConditions": { "type": "object", "properties": { "Name": { "type": "string" } } }, "CreateTermsAndConditionsResponse": { "type": "object", "properties": { "TemplateId": { "type": "string" } } }, "TermsAndConditionsListResponse": { "type": "object", "properties": { "TermsAndConditionsList": { "type": "array", "items": { "$ref": "#/definitions/TermsAndConditions" } } } }, "TermsAndConditions": { "type": "object", "properties": { "TemplateId": { "type": "string" }, "Name": { "type": "string" } } }, "TestMigrateParityResponse": { "type": "object", "properties": { "Result": { "type": "string" }, "Method": { "type": "string" }, "RequestUri": { "type": "string" }, "Referrer": { "type": "string" }, "ExternalApplication": { "type": "string" }, "ApplicationInstanceId": { "type": "string" }, "RequestTracing": { "type": "string" }, "LifeCycleTracingId": { "type": "string" }, "ForwardedHost": { "type": "string" }, "RequestIdentifier": { "type": "string" }, "IpAddress": { "type": "string" }, "UserAgent": { "type": "string" }, "Origin": { "type": "string" }, "Referer": { "type": "string" }, "TlsCipher": { "type": "string" } } }, "TestMigrateRequest": { "type": "object", "properties": { "TestValue": { "type": "string" } } }, "TestMigrateResponse": { "type": "object", "properties": { "Result": { "type": "string" } } }, "AllThemesResponse": { "type": "object", "properties": { "Themes": { "type": "array", "items": { "$ref": "#/definitions/Theme" } } } }, "Theme": { "type": "object", "properties": { "Key": { "type": "string" } } }, "SearchRequest": { "type": "object", "properties": { "CategoryId": { "format": "int32", "type": "integer" }, "AfterLogId": { "type": "string" }, "PageSize": { "format": "int32", "type": "integer" }, "IncludeArchived": { "type": "boolean" }, "IncludeLevels": { "type": "array", "items": { "enum": [ "Info", "Error" ], "type": "string" } } } }, "ExportRequest": { "type": "object", "properties": { "CategoryId": { "format": "int32", "type": "integer" }, "Date": { "type": "string" }, "IncludeArchived": { "type": "boolean" }, "IncludeLevels": { "type": "array", "items": { "enum": [ "Info", "Error" ], "type": "string" } } } }, "ThirdPartyLogArchiveRequest": { "type": "object", "properties": { "CategoryId": { "format": "int32", "type": "integer" }, "Ids": { "type": "array", "items": { "type": "string" } } } }, "ThirdPartySubscriptionCategoriesResponse": { "type": "object", "properties": { "Categories": { "type": "array", "items": { "$ref": "#/definitions/ThirdPartyCategory" } } } }, "ThirdPartyCategory": { "type": "object", "properties": { "DisplayName": { "type": "string" }, "Reference": { "type": "string" } } }, "ThirdPartySubscriptionNotificationsResponse": { "type": "object", "properties": { "Notifications": { "type": "object", "properties": { "Log": { "type": "boolean" }, "Daily": { "type": "boolean" } } } } }, "AddThirdPartyCountersignerRequest": { "type": "object", "properties": { "EmailAddress": { "type": "string" }, "MobileNumber": { "type": "string" }, "DisplayName": { "type": "string" }, "Description": { "type": "string" }, "FirstName": { "type": "string" }, "LastName": { "type": "string" }, "IsActive": { "type": "boolean" } } }, "ThirdPartyCountersignerResponse": { "type": "object", "properties": { "Countersigner": { "$ref": "#/definitions/ThirdPartyCountersigner" } } }, "ThirdPartyCountersigner": { "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "EmailAddress": { "type": "string" }, "MobileNumber": { "type": "string" }, "DisplayName": { "type": "string" }, "Description": { "type": "string" }, "FirstName": { "type": "string" }, "LastName": { "type": "string" }, "IsActive": { "type": "boolean" } } }, "ThirdPartyCountersignerListResponse": { "type": "object", "properties": { "Countersigners": { "type": "array", "items": { "$ref": "#/definitions/ThirdPartyCountersigner" } } } }, "EditThirdPartyCountersignerRequest": { "type": "object", "properties": { "EmailAddress": { "type": "string" }, "MobileNumber": { "type": "string" }, "DisplayName": { "type": "string" }, "Description": { "type": "string" }, "FirstName": { "type": "string" }, "LastName": { "type": "string" }, "IsActive": { "type": "boolean" } } }, "GetAllServicesResponse": { "type": "object", "properties": { "Services": { "type": "array", "items": { "$ref": "#/definitions/CodeweaversService" } } } }, "CodeweaversService": { "type": "object", "properties": { "DisplayName": { "type": "string" }, "Reference": { "type": "string" }, "Suppliers": { "type": "array", "items": { "$ref": "#/definitions/CodeweaversServiceSupplier" } } } }, "CodeweaversServiceSupplier": { "type": "object", "properties": { "DisplayName": { "type": "string" }, "Reference": { "type": "string" } } }, "GetServiceStatsResponse": { "type": "object", "properties": { "Stats": { "type": "array", "items": { "$ref": "#/definitions/StatsPerPointInTime" } } } }, "StatsPerPointInTime": { "type": "object", "properties": { "Time": { "format": "date-time", "type": "string" }, "HitsPerResponseType": { "type": "array", "items": { "$ref": "#/definitions/TypeCount" } } } }, "TypeCount": { "type": "object", "properties": { "Type": { "type": "string" }, "Hits": { "format": "int64", "type": "integer" } } }, "ServiceSupplierEndpointStatsResponse": { "type": "object", "properties": { "Endpoints": { "type": "array", "items": { "$ref": "#/definitions/EndpointStats" } } } }, "EndpointStats": { "type": "object", "properties": { "DisplayName": { "type": "string" }, "Stats": { "type": "array", "items": { "$ref": "#/definitions/StatsPerPointInTime" } } } }, "ServiceSupplierInvocationDetailsResponse": { "type": "object", "properties": { "ServiceInvocations": { "type": "array", "items": { "$ref": "#/definitions/ServiceInvocation" } } } }, "ServiceInvocation": { "type": "object", "properties": { "ExternalServiceCalls": { "type": "array", "items": { "$ref": "#/definitions/ExternalServiceCall" } }, "TypeOfResult": { "type": "string" }, "StartTime": { "format": "date-time", "type": "string" }, "EndTime": { "format": "date-time", "type": "string" }, "Messages": { "type": "array", "items": { "type": "string" } } } }, "ExternalServiceCall": { "type": "object", "properties": { "StartTime": { "format": "date-time", "type": "string" }, "EndTime": { "format": "date-time", "type": "string" }, "Request": { "$ref": "#/definitions/RequestDetails" }, "Response": { "$ref": "#/definitions/ResponseDetails" } } }, "RequestDetails": { "type": "object", "properties": { "Url": { "type": "string" }, "HttpMethod": { "type": "string" }, "Headers": { "type": "object", "additionalProperties": { "type": "string" } }, "Body": { "type": "string" } } }, "ResponseDetails": { "type": "object", "properties": { "Headers": { "type": "object", "additionalProperties": { "type": "string" } }, "Body": { "type": "string" }, "StatusCode": { "format": "int32", "type": "integer" }, "ConnectionFailure": { "type": "string" } } }, "TranslatableApplicationsResponse": { "type": "object", "properties": { "Applications": { "type": "array", "items": { "$ref": "#/definitions/TranslatableApplication" } } } }, "TranslatableApplication": { "type": "object", "properties": { "Name": { "type": "string" }, "SupportedLocales": { "type": "array", "items": { "type": "string" } } } }, "AllTranslationVersionsForApplicationResponse": { "type": "object", "properties": { "Versions": { "type": "array", "items": { "$ref": "#/definitions/TranslationVersion" } } } }, "TranslationVersion": { "type": "object", "properties": { "VersionReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "AvailableLocales": { "type": "array", "items": { "type": "string" } }, "UploadedAt": { "format": "date-time", "type": "string" }, "ActivationStatus": { "$ref": "#/definitions/TranslationActivationStatus" } } }, "TranslationActivationStatus": { "type": "object", "properties": { "IsActive": { "type": "boolean" }, "Details": { "$ref": "#/definitions/TranslationActivationDetails" } } }, "TranslationActivationDetails": { "type": "object", "properties": { "ActivatedBy": { "$ref": "#/definitions/TranslationActivationUser" }, "ActivatedAt": { "format": "date-time", "type": "string" }, "Reason": { "type": "string" } } }, "TranslationActivationUser": { "type": "object", "properties": { "Name": { "type": "string" }, "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } }, "CreateTranslationLocaleRequest": { "required": [ "LocaleCode" ], "type": "object", "properties": { "LocaleCode": { "type": "string" } } }, "CreateTranslationLocaleForApplicationRequest": { "required": [ "LocaleCode" ], "type": "object", "properties": { "LocaleCode": { "type": "string" } } }, "UploadTranslationSchemaFileResponse": { "type": "object", "properties": {} }, "FileUploadRequest": { "type": "object", "properties": { "File": { "type": "string" }, "FileName": { "type": "string" } } }, "FileUploadResponse": { "type": "object", "properties": { "FileUrl": { "type": "string" } } }, "GetUserRateLimitsResponse": { "type": "object", "properties": { "RateLimits": { "type": "array", "items": { "$ref": "#/definitions/GetRateLimitDto" } } } }, "GetRateLimitDto": { "type": "object", "properties": { "RequestsPerTimeFrame": { "format": "int32", "type": "integer" }, "TimeFrameInSeconds": { "format": "int32", "type": "integer" }, "Endpoint": { "type": "string" }, "IsBrowserBased": { "type": "boolean" } } }, "SaveRateLimitRequest": { "type": "object", "properties": { "RateLimits": { "type": "array", "items": { "$ref": "#/definitions/RateLimitToSave" } } } }, "RateLimitToSave": { "type": "object", "properties": { "RequestsPerTimeFrame": { "format": "int32", "type": "integer" }, "TimeFrameInSeconds": { "format": "int32", "type": "integer" }, "Endpoint": { "type": "string" }, "IsBrowserBased": { "type": "boolean" } } }, "GetOrganisationsForUserResponse": { "type": "object", "properties": { "Organisations": { "type": "array", "items": { "$ref": "#/definitions/OrganisationResponse" } } } }, "GetLenderOrganisationsResponse": { "type": "object", "properties": { "LenderOrganisations": { "type": "array", "items": { "$ref": "#/definitions/LenderOrganisation" } } } }, "LenderOrganisation": { "type": "object", "properties": { "Name": { "type": "string" }, "Reference": { "type": "string" } } }, "UserModulesResponse": { "type": "object", "properties": { "Modules": { "type": "array", "items": { "$ref": "#/definitions/UserModule" } } } }, "UserModule": { "type": "object", "properties": { "TypeId": { "format": "int32", "type": "integer" }, "Name": { "type": "string" }, "Enabled": { "type": "boolean" } } }, "UserModulesUpdateRequest": { "type": "object", "properties": { "Modules": { "type": "array", "items": { "$ref": "#/definitions/UserModulesUpdateRequestModule" } } } }, "UserModulesUpdateRequestModule": { "type": "object", "properties": { "TypeId": { "format": "int32", "type": "integer" }, "IsEnabled": { "type": "boolean" } } }, "UserModulesUpdateResponse": { "type": "object", "properties": {} }, "GetUserOrganisationsByOrganisationsAvailableToAdministratorResponse": { "type": "object", "properties": { "Organisations": { "type": "array", "items": { "$ref": "#/definitions/UserOrganisation" } } } }, "UserOrganisation": { "type": "object", "properties": { "IsPrimary": { "type": "boolean" }, "SystemId": { "format": "int32", "type": "integer" }, "Reference": { "type": "string" }, "TradingName": { "type": "string" } } }, "GetPluginConfigurationByUserReferenceResponse": { "type": "object", "properties": { "PluginConfiguration": { "$ref": "#/definitions/PluginConfiguration" } } }, "SetUserPluginConfigurationRequest": { "type": "object", "properties": { "PluginConfigurationReference": { "type": "string" } } }, "UserUpdateManagersRequest": { "type": "object", "properties": { "ManagerUserReferences": { "type": "array", "items": { "type": "string" } } } }, "GetWorkspacesForUserByUsernameRequest": { "type": "object", "properties": { "Username": { "type": "string" }, "PlatformApplication": { "type": "string" } } }, "GetWorkspacesForUserByUsernameResponse": { "type": "object", "properties": { "AppSpaces": { "type": "array", "items": { "$ref": "#/definitions/Workspace" } }, "Workspaces": { "type": "array", "items": { "$ref": "#/definitions/Workspace" } } } }, "Workspace": { "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "AppReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "SystemId": { "format": "int32", "type": "integer" }, "ExternalSystemKey": { "type": "string" }, "Key": { "type": "string" }, "DisplayName": { "type": "string" }, "Authenticators": { "type": "array", "items": { "$ref": "#/definitions/WorkspaceAuthenticator" } }, "LogoUrl": { "type": "string" } } }, "WorkspaceAuthenticator": { "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "Name": { "type": "string" }, "DisplayName": { "type": "string" }, "SignInUrl": { "type": "string" }, "SignOutUrl": { "type": "string" }, "TimeOutUrl": { "type": "string" }, "SessionTimespanInSeconds": { "format": "int32", "type": "integer" } } }, "GetUserLoginProviderRequest": { "required": [ "Username", "Workspace", "ExternalSystemKey" ], "type": "object", "properties": { "Username": { "type": "string" }, "Workspace": { "type": "string" }, "ExternalSystemKey": { "type": "string" } } }, "GetUserLoginProviderResponse": { "type": "object", "properties": { "Provider": { "enum": [ "Unknown", "CodeweaversCredentials", "GoogleSingleSignOn", "CoxOktaSingleSignOn", "CoxEntraSingleSignOn" ], "type": "string" } } }, "GetWorkspacesForUserByUserReferenceResponse": { "type": "object", "properties": { "Workspaces": { "type": "array", "items": { "$ref": "#/definitions/Workspace" } } } }, "SearchUsersRequestModel": { "required": [ "Query" ], "type": "object", "properties": { "Query": { "type": "string" }, "AllowCrossSystemSearch": { "type": "boolean" }, "WebserviceUsersOnly": { "type": "boolean" }, "ActiveUsersOnly": { "type": "boolean" }, "Page": { "format": "int32", "type": "integer" }, "ResultsPerPage": { "format": "int32", "type": "integer" } } }, "SearchUsersResponseModel": { "type": "object", "properties": { "Results": { "type": "array", "items": { "$ref": "#/definitions/SearchUsersResult" } }, "Pagination": { "$ref": "#/definitions/Pagination" } } }, "SearchUsersResult": { "type": "object", "properties": { "UserReference": { "type": "string" }, "Username": { "type": "string" }, "IsActive": { "type": "boolean" }, "PrimaryOrganisation": { "$ref": "#/definitions/PrimaryOrganisation" }, "LastLogin": { "format": "date-time", "type": "string" }, "LoginCount": { "format": "int64", "type": "integer" }, "Role": { "type": "string" }, "VerifiedEmail": { "type": "boolean" } } }, "PrimaryOrganisation": { "type": "object", "properties": { "TradingName": { "type": "string" }, "LegacyDealerId": { "format": "int32", "type": "integer" } } }, "UpdateUserRequest": { "type": "object", "properties": { "Password": { "type": "string" }, "Username": { "type": "string" }, "FirstName": { "type": "string" }, "LastName": { "type": "string" }, "Active": { "type": "boolean" }, "RoleId": { "format": "int32", "type": "integer" }, "Title": { "type": "string" }, "PrimaryDealerId": { "format": "int32", "type": "integer" }, "NotificationSubscriptions": { "type": "array", "items": { "type": "string" } }, "AssociatedDealerIds": { "type": "array", "items": { "format": "int32", "type": "integer" } }, "AssociatedDealerIdsToRemove": { "type": "array", "items": { "format": "int32", "type": "integer" } }, "DefaultChannelKey": { "type": "string" }, "DeactivationReason": { "type": "string" } } }, "UpdateUserResponse": { "type": "object", "properties": {} }, "GetUserEndpointsResponse": { "type": "object", "properties": { "Endpoints": { "type": "array", "items": { "$ref": "#/definitions/Endpoint" } } } }, "Endpoint": { "type": "object", "properties": { "Path": { "type": "string" } } }, "GetUserEndpointPerDayUsageRequest": { "type": "object", "properties": { "Endpoint": { "type": "string" }, "From": { "format": "date-time", "type": "string" }, "To": { "format": "date-time", "type": "string" } } }, "GetUserEndpointPerDayUsageResponse": { "type": "object", "properties": { "UsagesPerDay": { "type": "array", "items": { "$ref": "#/definitions/EndpointUsage" } } } }, "EndpointUsage": { "type": "object", "properties": { "Time": { "format": "date-time", "type": "string" }, "SuccessfulCount": { "format": "int64", "type": "integer" }, "RateLimitedCount": { "format": "int64", "type": "integer" }, "LastFiftyPercentCount": { "format": "int64", "type": "integer" }, "LastTenPercentCount": { "format": "int64", "type": "integer" } } }, "GetUserEndpointPerMinuteUsageRequest": { "type": "object", "properties": { "Endpoint": { "type": "string" }, "From": { "format": "date-time", "type": "string" }, "To": { "format": "date-time", "type": "string" } } }, "GetUserEndpointPerMinuteUsageResponse": { "type": "object", "properties": { "UsagesPerMinute": { "type": "array", "items": { "$ref": "#/definitions/EndpointUsage" } } } }, "InviteUserToOrganisationsRequest": { "required": [ "Email" ], "type": "object", "properties": { "Email": { "type": "string" }, "Branding": { "type": "string" }, "RoleId": { "format": "int32", "type": "integer" }, "Notifications": { "type": "boolean" }, "OrganisationReferences": { "type": "array", "items": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } } }, "AliasedUsersReportResponse": { "type": "object", "properties": { "CSV": { "type": "string" } } }, "OffersSearchResponse": { "type": "object", "properties": { "Offers": { "type": "array", "items": { "$ref": "#/definitions/SlimOffer" } }, "TotalResults": { "format": "int32", "type": "integer" }, "NumberOfPages": { "format": "int32", "type": "integer" }, "CurrentPage": { "format": "int32", "type": "integer" } } }, "SlimOffer": { "type": "object", "properties": { "AdditionalDetails": { "type": "object", "additionalProperties": { "type": "string" } }, "OfferDescription": { "type": "string" }, "Reference": { "type": "string" }, "QuoteReference": { "type": "string" }, "VehicleReference": { "type": "string" }, "ValidFrom": { "format": "date-time", "type": "string" }, "ValidTo": { "format": "date-time", "type": "string" }, "LastModified": { "format": "date-time", "type": "string" }, "OfferTitle": { "type": "string" }, "OfferSubtitle": { "type": "string" }, "Vehicle": { "$ref": "#/definitions/SlimOfferVehicle" }, "Quote": { "$ref": "#/definitions/SlimOfferQuote" }, "Active": { "type": "boolean" }, "HeadlineOffer": { "type": "boolean" } } }, "SlimOfferVehicle": { "type": "object", "properties": { "Identifier": { "type": "string" }, "IdentifierType": { "type": "string" } } }, "SlimOfferQuote": { "type": "object", "properties": { "RegularPayment": { "format": "double", "type": "number" }, "TotalRegularPayment": { "format": "double", "type": "number" }, "Term": { "format": "int32", "type": "integer" }, "AnnualMileage": { "format": "int32", "type": "integer" }, "OnTheRoadPrice": { "format": "double", "type": "number" }, "ProductType": { "type": "string" }, "ProductKey": { "type": "string" } } }, "UpdateValueAddedProductsPackageRequest": { "type": "object", "properties": { "PackageName": { "type": "string" }, "Vaps": { "type": "array", "items": { "$ref": "#/definitions/OrganisationVap" } } } }, "GetVapPackageOrganisationsResponse": { "type": "object", "properties": { "Organisations": { "type": "array", "items": { "$ref": "#/definitions/VapPackageOrganisation" } } } }, "VapPackageOrganisation": { "type": "object", "properties": { "Reference": { "type": "string" }, "Name": { "type": "string" }, "Active": { "type": "boolean" } } }, "CreateValueAddedProductsPackageRequest": { "type": "object", "properties": { "PackageName": { "type": "string" }, "Vaps": { "type": "array", "items": { "$ref": "#/definitions/OrganisationVap" } } } }, "CreateValueAddedProductPackageResponse": { "type": "object", "properties": { "VapPackageReference": { "type": "string" } } }, "VapTypesResponse": { "type": "object", "properties": { "Types": { "type": "array", "items": { "type": "string" } } } }, "VapRuleTypesResponse": { "type": "object", "properties": { "VapTypes": { "type": "array", "items": { "$ref": "#/definitions/VapRuleType" } } } }, "VapRuleType": { "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "Name": { "type": "string" }, "IsCondition": { "type": "boolean" }, "Description": { "type": "string" }, "ValidationRuleType": { "type": "string" } } }, "VatStatusResponse": { "type": "object", "properties": { "VatStatusList": { "type": "array", "items": { "$ref": "#/definitions/VatStatusType" } }, "Default": { "$ref": "#/definitions/VatStatusType" } } }, "VatStatusType": { "type": "object", "properties": { "VatStatusId": { "format": "int32", "type": "integer" }, "VatStatusKey": { "enum": [ "Unknown", "NotPaid", "FullyPaid", "Margin", "StandardVatAsDeposit" ], "type": "string" }, "DisplayName": { "type": "string" } } }, "CreateVehicleAlertRequest": { "required": [ "Email", "Url", "VehicleSearchRequest" ], "type": "object", "properties": { "Email": { "type": "string" }, "Url": { "type": "string" }, "VehicleSearchRequest": { "$ref": "#/definitions/VehicleSearchRequest" } } }, "CreateVehicleAlertResponse": { "type": "object", "properties": { "AlertUserReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } }, "BuildVehicleAlertRequest": { "required": [ "Url", "VehicleSearchRequest" ], "type": "object", "properties": { "Email": { "type": "string" }, "Url": { "type": "string" }, "VehicleSearchRequest": { "$ref": "#/definitions/VehicleSearchRequest" } } }, "BuildVehicleAlertResponse": { "type": "object", "properties": { "Exists": { "type": "boolean" }, "Description": { "type": "string" } } }, "GetVehicleAlertsResponse": { "type": "object", "properties": { "Alerts": { "type": "array", "items": { "$ref": "#/definitions/VehicleAlert" } } } }, "VehicleAlert": { "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Url": { "type": "string" }, "Description": { "type": "string" } } }, "VehicleCodeTypesResponse": { "type": "object", "properties": { "Codes": { "type": "array", "items": { "$ref": "#/definitions/VehicleCode" } } } }, "VehicleCode": { "type": "object", "properties": { "Type": { "enum": [ "Unknown", "CapCarShortCode", "CapLcvShortCode", "CapBikeShortCode", "CapLongCode", "Glass", "Titre", "Ids", "CodeweaversDerivativeIdentifier", "CodeweaversStockIdentifier", "Ivs", "ExternalVehicleId", "Vrm", "Vin", "Vid", "BmvsCode", "KeeId", "JLR5000Code", "FcaConfiguratorSlug", "VolvoCode", "JlrComboCode", "AutoTraderDerivativeIdentifier", "FreeText", "TeslaDescription", "BaumusterCode", "TribalDerivativeIdentifier", "SkodaCode", "SeatCode", "VolkswagenCode", "AudiCode", "CazanaId", "Jato", "Mpv", "SubaruCode", "Infocar", "VolvoConfigurationCode", "TriumphCode", "Blvd", "AutobizVersionId", "AutoVistaNatCode", "BregoDerivativeIdentifier" ], "type": "string" } } }, "GetVehicleContributionTableResponse": { "type": "object", "properties": { "TableId": { "format": "int64", "type": "integer" }, "VersionId": { "format": "int64", "type": "integer" }, "SystemId": { "format": "int32", "type": "integer" }, "TableName": { "type": "string" }, "Contributions": { "type": "array", "items": { "$ref": "#/definitions/VehicleContribution" } } } }, "VehicleContribution": { "type": "object", "properties": { "VehicleType": { "type": "string" }, "IdentifierType": { "type": "string" }, "Identifier": { "type": "string" }, "Value": { "type": "string" }, "ValidTo": { "format": "date-time", "type": "string" }, "ValidFrom": { "format": "date-time", "type": "string" }, "RuleTypeId": { "format": "int32", "type": "integer" } } }, "GetVehicleContributionTableVersionsResponse": { "type": "object", "properties": { "Versions": { "type": "array", "items": { "$ref": "#/definitions/ContributionTableVersion" } } } }, "ContributionTableVersion": { "type": "object", "properties": { "Id": { "format": "int64", "type": "integer" }, "TableId": { "format": "int64", "type": "integer" }, "CreatedAt": { "format": "date-time", "type": "string" }, "UserReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } }, "CreateVehicleContributionTableRequest": { "type": "object", "properties": { "TableName": { "type": "string" } } }, "CreateVehicleContributionTableResponse": { "type": "object", "properties": { "TableName": { "type": "string" }, "VersionId": { "format": "int64", "type": "integer" }, "Id": { "format": "int64", "type": "integer" } } }, "SearchVehicleContributionTableResponse": { "type": "object", "properties": { "VehicleContributionTables": { "type": "array", "items": { "$ref": "#/definitions/VehicleContributionTable" } }, "Pagination": { "$ref": "#/definitions/Pagination" } } }, "VehicleContributionTable": { "type": "object", "properties": { "Id": { "format": "int64", "type": "integer" }, "VersionId": { "format": "int64", "type": "integer" }, "Name": { "type": "string" } } }, "SaveVehicleContributionTableRequestAndResponse": { "type": "object", "properties": { "Id": { "format": "int64", "type": "integer" }, "VersionId": { "format": "int64", "type": "integer" }, "Name": { "type": "string" }, "EligibleVehicles": { "type": "array", "items": { "$ref": "#/definitions/VehicleWithContributions" } } } }, "VehicleWithContributions": { "type": "object", "properties": { "VehicleIdentifier": { "type": "string" }, "IdentifierType": { "type": "string" }, "VehicleType": { "format": "int32", "type": "integer" }, "Contributions": { "type": "array", "items": { "$ref": "#/definitions/VehicleContributionRule" } } } }, "VehicleContributionRule": { "type": "object", "properties": { "RuleTypeId": { "format": "int32", "type": "integer" }, "ValidFrom": { "format": "date-time", "type": "string" }, "ValidTo": { "format": "date-time", "type": "string" }, "Value": { "type": "string" }, "Reference": { "type": "string" } } }, "GetVehicleImagesResponse": { "type": "object", "properties": { "Images": { "type": "array", "items": { "$ref": "#/definitions/VehicleImage" } } } }, "VehicleImage": { "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "Url": { "type": "string" }, "OriginalUrl": { "type": "string" }, "Retailer": { "$ref": "#/definitions/OrganisationResponse" } } }, "GetVehicleImagePlayerTokenResponse": { "type": "object", "properties": { "Token": { "type": "string" }, "TokenExpiresAt": { "format": "date-time", "type": "string" } } }, "VehicleStockImportCreateRequest": { "required": [ "Type" ], "type": "object", "properties": { "Type": { "description": "The type of import you would like to run, indicating the way in which you would like us to clear your current stock available in our system.\r\n \r\nComplete: This will ensure all vehicles against all organisations you have access to will be removed and the vehicles included in the import added to the requested organisation.\r\nSnapshot: This will ensure all vehicles against the organisations included in this import will be removed and the vehicles then added to the requested organisation.\r\nDelta: We will only remove vehicles you have requested to be removed, using the NoLongerAvailable field within each vehicle on the request.", "enum": [ "Unknown", "Complete", "Snapshot", "Delta" ], "type": "string" } } }, "VehicleStockImportCreateResponse": { "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } }, "VehicleStockImportSearchRequest": { "required": [ "PageNumber", "PageSize" ], "type": "object", "properties": { "PageNumber": { "format": "int32", "type": "integer" }, "PageSize": { "format": "int32", "type": "integer" }, "From": { "format": "date-time", "type": "string" }, "To": { "format": "date-time", "type": "string" } } }, "VehicleStockImportSearchResponse": { "type": "object", "properties": { "Results": { "type": "array", "items": { "$ref": "#/definitions/StockImport" } }, "NumberOfPages": { "format": "int32", "type": "integer" }, "NumberOfResults": { "format": "int32", "type": "integer" } } }, "StockImport": { "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Created": { "format": "date-time", "type": "string" }, "User": { "$ref": "#/definitions/UserSummaryResponse" }, "Source": { "type": "string" }, "Status": { "enum": [ "Unknown", "NotStarted", "Running", "Completed", "Expired" ], "type": "string" }, "Type": { "enum": [ "Unknown", "Complete", "Snapshot", "Delta" ], "type": "string" }, "TotalVehicleCount": { "format": "int32", "description": "This indicates the amount of vehicles we have began processing. This field will begin to be populated once Start is called.", "type": "integer" }, "VehicleSuccessCount": { "format": "int32", "description": "This indicates the amount of vehicles we have successfully processed. This field will begin to be populated once Start is called.", "type": "integer" }, "VehicleFailureCount": { "format": "int32", "description": "This indicates the amount of vehicles we have failed to process. This field could be populated during an Add request or once Start is called.", "type": "integer" } } }, "VehicleStockImportAddRequest": { "required": [ "Vehicles" ], "type": "object", "properties": { "Vehicles": { "type": "array", "items": { "$ref": "#/definitions/ImportVehicle" } } } }, "ImportVehicle": { "required": [ "Physical" ], "type": "object", "properties": { "OrganisationReference": { "$ref": "#/definitions/OrganisationIdentifier", "description": "Identifies the organisation that should be used in the request context." }, "Physical": { "$ref": "#/definitions/PhysicalVehicle" }, "Marketing": { "$ref": "#/definitions/VehicleMarketingInformation" }, "Specification": { "$ref": "#/definitions/OverridableVehicleSpecification", "description": "This is used in the scenario where we do not have a defined Specification Code to use for this information. If a Code is provided then we will not use this information." } } }, "OverridableVehicleSpecification": { "type": "object", "properties": { "Manufacturer": { "type": "string" }, "Model": { "type": "string" }, "Variant": { "type": "string" }, "Derivative": { "type": "string" }, "Description": { "type": "string" }, "FuelType": { "type": "string" }, "BodyStyle": { "type": "string" }, "Transmission": { "type": "string" }, "Seats": { "format": "int32", "type": "integer" }, "Doors": { "format": "int32", "type": "integer" }, "DriveTrain": { "type": "string" }, "EnginePower": { "$ref": "#/definitions/EnginePower" }, "EngineSize": { "format": "int32", "type": "integer" }, "ModelYear": { "format": "int32", "type": "integer" } } }, "VehicleStockImportAddResponse": { "type": "object", "properties": {} }, "VehicleStockImportStatusResponse": { "type": "object", "properties": { "Status": { "enum": [ "Unknown", "NotStarted", "Running", "Completed", "Expired" ], "type": "string" }, "TotalVehicleCount": { "format": "int32", "description": "This indicates the amount of vehicles we have began processing. This field will begin to be populated once Start is called.", "type": "integer" }, "VehicleSuccessCount": { "format": "int32", "description": "This indicates the amount of vehicles we have successfully processed. This field will begin to be populated once Start is called.", "type": "integer" }, "VehicleFailureCount": { "format": "int32", "description": "This indicates the amount of vehicles we have failed to process. This field could be populated during an Add request or once Start is called.", "type": "integer" }, "Vehicles": { "type": "array", "items": { "$ref": "#/definitions/VehicleStockImportResult" } } } }, "VehicleStockImportResult": { "type": "object", "properties": { "ExternalVehicleId": { "description": "This will be the External Vehicle Identifier sent in with the Vehicle during the Add API request if one is available. If one is not available we will pick the best next identifier we can find.", "type": "string" }, "CodeweaversStockId": { "format": "uuid", "description": "This will be our identifier for the vehicle which we have created during the import. This will only be populated if the Vehicle was successfully imported or removed.", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Action": { "description": "This is the Action that took place on the Vehicle. For example if you selected for the Import to be a Complete Import during the Create request we may be deleting Vehicles that were not present in the Add requests and these will be highlighted in the Vehicles set with an Action of Deleted.", "enum": [ "Unknown", "AddOrUpdate", "Delete", "RemoveManufacturerActivelyUpdating" ], "type": "string" }, "Errors": { "description": "This will contain any of the errors that occured during the import.", "type": "array", "items": { "$ref": "#/definitions/ErrorResponse" } } } }, "GetImportsResponse": { "type": "object", "properties": { "Imports": { "type": "array", "items": { "$ref": "#/definitions/Import" } } } }, "Import": { "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "Name": { "type": "string" }, "Created": { "format": "date-time", "type": "string" }, "TriggeredTime": { "format": "date-time", "type": "string" }, "TriggeredCount": { "format": "int32", "type": "integer" }, "Default": { "type": "boolean" }, "Assigned": { "type": "boolean" } } }, "CreateOrUpdateImportRequest": { "type": "object", "properties": { "Import": { "$ref": "#/definitions/ImportUpdates" }, "Mappings": { "type": "array", "items": { "$ref": "#/definitions/ImportMapping" } } } }, "ImportUpdates": { "type": "object", "properties": { "Name": { "type": "string" } } }, "ImportMapping": { "type": "object", "properties": { "Type": { "enum": [ "Unknown", "ExternalVehicleIdentifier", "ExternalVehicleLink", "VehicleIdentificationNumber", "RegistrationNumber", "RegistrationDate", "RegistrationCountryCode", "Mileage", "MileageUnit", "VehicleType", "VehicleStatus", "OnTheRoadPrice", "BasePrice", "RoadFundLicence", "RegistrationFee", "Delivery", "ExteriorColour", "InteriorColour", "Manufacturer", "Model", "Variant", "Derivative", "Description", "Codes", "Images", "ExternalRetailerIdentifier", "StandardColour", "ReservedDate", "LastUpdatedDate" ], "type": "string" }, "Column": { "type": "string" }, "Separator": { "type": "string" } } }, "CreateImportResponse": { "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" } } }, "GetImportResponse": { "type": "object", "properties": { "Import": { "$ref": "#/definitions/Import" }, "Mappings": { "type": "array", "items": { "$ref": "#/definitions/ImportMapping" } } } }, "SaveVehiclesResponse": { "type": "object", "properties": { "Vehicles": { "type": "array", "items": { "$ref": "#/definitions/SaveVehicleResponse" } } } }, "SaveVehicleResponse": { "type": "object", "properties": { "ExternalVehicleId": { "type": "string" }, "CodeweaversStockId": { "type": "string" }, "Errors": { "type": "array", "items": { "$ref": "#/definitions/ErrorResponse" } }, "Action": { "enum": [ "Unknown", "AddOrUpdate", "Delete", "RemoveManufacturerActivelyUpdating" ], "type": "string" } } }, "VehiclePlatesResponse": { "type": "object", "properties": { "Plates": { "type": "array", "items": { "$ref": "#/definitions/VehiclePlate" } } } }, "VehiclePlate": { "type": "object", "properties": { "Plate": { "type": "string" }, "Date": { "format": "date-time", "type": "string" } } }, "VehicleRegistrationRegionsResponse": { "type": "object", "properties": { "Regions": { "type": "array", "items": { "$ref": "#/definitions/VehicleRegistrationRegion" } } } }, "VehicleRegistrationRegion": { "type": "object", "properties": { "Code": { "type": "string" }, "Name": { "type": "string" } } }, "CompareVehiclesRequest": { "type": "object", "properties": { "Vehicles": { "type": "array", "items": { "$ref": "#/definitions/ComparisonVehicle" } } } }, "ComparisonVehicle": { "type": "object", "properties": { "VehicleReference": { "$ref": "#/definitions/VehicleReference" } } }, "CompareVehiclesResponse": { "type": "object", "properties": { "Vehicles": { "type": "array", "items": { "$ref": "#/definitions/VehicleDetails" } }, "Categories": { "type": "array", "items": { "$ref": "#/definitions/CompareCategories" } } } }, "VehicleDetails": { "type": "object", "properties": { "Image": { "type": "string" }, "Manufacturer": { "type": "string" }, "Model": { "type": "string" }, "Variant": { "type": "string" }, "Derivative": { "type": "string" }, "OnTheRoadPrice": { "format": "double", "type": "number" }, "CostBreakdown": { "$ref": "#/definitions/CostBreakdown" }, "Hash": { "type": "string" }, "VehicleReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } }, "CompareCategories": { "type": "object", "properties": { "Name": { "type": "string" }, "SubCategories": { "type": "array", "items": { "$ref": "#/definitions/SubCategory" } } } }, "SubCategory": { "type": "object", "properties": { "Label": { "type": "string" }, "Values": { "type": "array", "items": { "$ref": "#/definitions/CategoryValue" } } } }, "CategoryValue": { "type": "object", "properties": { "VehicleReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Value": { "type": "string" } } }, "VehicleSearchResponse": { "type": "object", "properties": { "Results": { "type": "array", "items": { "$ref": "#/definitions/VehicleSearchResult" } }, "Modifications": { "$ref": "#/definitions/Modifications", "description": "We may make modifications to certain filters on the provided request to ensure results are returned. All modifications are itemised here." }, "CurrentPage": { "format": "int32", "type": "integer" }, "TotalPages": { "format": "int32", "type": "integer" }, "VehiclesSearched": { "format": "int32", "type": "integer" }, "TotalResults": { "format": "int32", "type": "integer" } } }, "VehicleSearchWithFacetsResponse": { "type": "object", "properties": { "FacetCategories": { "$ref": "#/definitions/FacetCategories" }, "Results": { "type": "array", "items": { "$ref": "#/definitions/VehicleSearchResult" } }, "Modifications": { "$ref": "#/definitions/Modifications", "description": "We may make modifications to certain filters on the provided request to ensure results are returned. All modifications are itemised here." }, "CurrentPage": { "format": "int32", "type": "integer" }, "TotalPages": { "format": "int32", "type": "integer" }, "VehiclesSearched": { "format": "int32", "type": "integer" }, "TotalResults": { "format": "int32", "type": "integer" } } }, "VehicleGroupResponse": { "type": "object", "properties": { "Groups": { "type": "array", "items": { "$ref": "#/definitions/VehicleGroup" } }, "Modifications": { "$ref": "#/definitions/Modifications" }, "CurrentPage": { "format": "int32", "type": "integer" }, "TotalPages": { "format": "int32", "type": "integer" }, "NumberOfMatchingVehicleGroups": { "format": "int32", "type": "integer" }, "NumberOfMatchingVehiclesAcrossAllGroups": { "format": "int32", "type": "integer" }, "NumberOfVehiclesSearched": { "format": "int32", "type": "integer" } } }, "VehicleSearchCountResponse": { "type": "object", "properties": { "VehiclesSearched": { "format": "int32", "type": "integer" }, "TotalResults": { "format": "int32", "type": "integer" } } }, "VehicleSearchFacetsResponse": { "type": "object", "properties": { "FacetCategories": { "$ref": "#/definitions/FacetCategories" } } }, "StandardEquipmentResponse": { "type": "object", "properties": { "Equipment": { "type": "array", "items": { "$ref": "#/definitions/StandardEquipmentItem" } } } }, "CodesResponse": { "type": "object", "properties": { "Codes": { "type": "array", "items": { "$ref": "#/definitions/VehicleCodeItem" } } } }, "VehicleCodeItem": { "type": "object", "properties": { "Label": { "type": "string" }, "Value": { "type": "string" } } }, "TechicalDetailsResponse": { "type": "object", "properties": { "TechnicalDetails": { "type": "array", "items": { "$ref": "#/definitions/TechicalDetailsItem" } } } }, "VehicleEnvironmentalDataRequest": { "type": "object", "properties": { "Options": { "type": "array", "items": { "$ref": "#/definitions/EquipmentOption" } } } }, "GetVehicleCashQuoteRequest": { "type": "object", "properties": { "OrganisationIdentifier": { "$ref": "#/definitions/OrganisationIdentifier" }, "CustomerReference": { "type": "string" } } }, "GetVehicleCashQuoteResponse": { "type": "object", "properties": { "QuoteReference": { "type": "string" } } }, "VehicleMarketingFeaturesResponse": { "type": "object", "properties": { "MarketingFeatures": { "type": "array", "items": { "$ref": "#/definitions/MarketingFeature" } } } }, "PricingResponse": { "type": "object", "properties": { "Pricing": { "description": "These are the pricing breakdowns available for the vehicle requested.", "type": "array", "items": { "$ref": "#/definitions/PricingItem" } } } }, "PricingItem": { "type": "object", "properties": { "From": { "format": "date-time", "description": "The date in which this cost breakdown is valid from.", "type": "string" }, "To": { "format": "date-time", "description": "The date in which this cost breakdown is valid to. Can be null if the cost breakdown is indefinitely valid.", "type": "string" }, "OnTheRoadPriceExcludingSalesTax": { "format": "double", "type": "number" }, "CostBreakdownExcludingSalesTax": { "$ref": "#/definitions/CostBreakdown" }, "OnTheRoadPriceIncludingSalesTax": { "format": "double", "type": "number" }, "CostBreakdownIncludingSalesTax": { "$ref": "#/definitions/CostBreakdown" } } }, "EquipmentOptionsClearResponse": { "type": "object", "properties": { "Vehicle": { "$ref": "#/definitions/UpdatedVehicle" }, "EnvironmentalData": { "$ref": "#/definitions/EnvironmentalData" } } }, "EquipmentOptionsUpdateDiscountResponse": { "type": "object", "properties": { "EquipmentOption": { "$ref": "#/definitions/NewEquipmentOption" }, "Vehicle": { "$ref": "#/definitions/UpdatedVehicle" } } }, "EquipmentOptionsSelectionResponse": { "type": "object", "properties": { "Vehicle": { "$ref": "#/definitions/UpdatedVehicle" }, "Changes": { "type": "array", "items": { "$ref": "#/definitions/EquipmentOptionsSelectionChange" } }, "EnvironmentalData": { "$ref": "#/definitions/EnvironmentalData" } } }, "EquipmentOptionsSelectionChange": { "type": "object", "properties": { "Type": { "enum": [ "Unknown", "Added", "Removed", "Included", "Excluded" ], "type": "string" }, "Option": { "$ref": "#/definitions/EquipmentOptionsSelectionChangedOption" }, "Notifications": { "type": "array", "items": { "$ref": "#/definitions/EquipmentOptionsSelectionChangeNotification" } } } }, "EquipmentOptionsSelectionChangedOption": { "type": "object", "properties": { "Id": { "type": "string" } } }, "EquipmentOptionsSelectionChangeNotification": { "type": "object", "properties": { "Message": { "type": "string" } } }, "StockAuditRequest": { "type": "object", "properties": { "CodeweaversIdentifier": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "StartDate": { "format": "date-time", "type": "string" }, "EndDate": { "format": "date-time", "type": "string" } } }, "StockAuditResponse": { "type": "object", "properties": { "Audits": { "type": "array", "items": { "$ref": "#/definitions/StockAudit" } } } }, "StockAudit": { "type": "object", "properties": { "Timestamp": { "format": "date-time", "type": "string" }, "Changes": { "type": "array", "items": { "$ref": "#/definitions/StockAuditChanges" } }, "UserReference": { "type": "string" }, "UserName": { "type": "string" }, "Hostname": { "type": "string" } } }, "StockAuditChanges": { "type": "object", "properties": { "Field": { "type": "string" }, "Before": { "type": "string" }, "After": { "type": "string" }, "LogType": { "type": "string" } } }, "SaveVehiclesRequest": { "required": [ "Vehicles" ], "type": "object", "properties": { "Vehicles": { "type": "array", "items": { "$ref": "#/definitions/ImportVehicle" } }, "ImportType": { "description": "The type of import you would like to run, indicating the way in which you would like us to clear your current stock available in our system.\r\n \r\nComplete: This will ensure all vehicles against all organisations you have access to will be removed and the vehicles included in the import added to the requested organisation.\r\nSnapshot: This will ensure all vehicles against the organisations included in this import will be removed and the vehicles then added to the requested organisation.\r\nDelta: We will only remove vehicles you have requested to be removed, using the NoLongerAvailable field within each vehicle on the request.", "enum": [ "Unknown", "Complete", "Snapshot", "Delta" ], "type": "string" } } }, "PointOfSaleResponse": { "type": "object", "properties": { "QuoteReferences": { "type": "array", "items": { "type": "string" } } } }, "RetrieveVehicleAccessoriesResponse": { "type": "object", "properties": { "Categories": { "type": "array", "items": { "$ref": "#/definitions/VehicleAccessoriesCategory" } }, "Disclaimer": { "$ref": "#/definitions/VehicleAccessoriesDisclaimer" } } }, "VehicleAccessoriesCategory": { "type": "object", "properties": { "Reference": { "type": "string" }, "Name": { "type": "string" }, "Image": { "$ref": "#/definitions/Image" }, "Accessories": { "type": "array", "items": { "$ref": "#/definitions/VehicleAccessoryResult" } } } }, "VehicleAccessoriesDisclaimer": { "type": "object", "properties": { "Value": { "type": "string" } } }, "VehicleAccessoryResult": { "type": "object", "properties": { "Reference": { "type": "string" }, "Name": { "type": "string" }, "Image": { "$ref": "#/definitions/Image" }, "Price": { "format": "double", "type": "number" }, "InstallationPrice": { "format": "double", "type": "number" }, "VatPercentage": { "format": "double", "type": "number" }, "Selected": { "type": "boolean" } } }, "AddVehicleAccessoryRequest": { "required": [ "Accessory" ], "type": "object", "properties": { "Accessory": { "$ref": "#/definitions/VehicleAccessory" } } }, "VehicleAccessory": { "required": [ "Reference", "Name", "Price", "VatPercentage" ], "type": "object", "properties": { "Reference": { "type": "string" }, "Name": { "type": "string" }, "Description": { "type": "string" }, "Price": { "format": "double", "type": "number" }, "VatPercentage": { "format": "double", "type": "number" }, "Selected": { "type": "boolean" }, "Images": { "type": "array", "items": { "$ref": "#/definitions/Image" } }, "InstallationPrice": { "format": "double", "type": "number" } } }, "UpdateVehicleAccessoriesResponse": { "type": "object", "properties": { "Vehicle": { "$ref": "#/definitions/UpdatedVehicle" } } }, "RetrieveVehicleAccessoryResponse": { "type": "object", "properties": { "Accessory": { "$ref": "#/definitions/VehicleAccessory" } } }, "PricingRequest": { "type": "object", "properties": { "OnTheRoadPriceIncludingSalesTax": { "format": "double", "type": "number" }, "CostBreakdownIncludingSalesTax": { "$ref": "#/definitions/CostBreakdown" }, "RemoveAllSystemDiscounts": { "type": "boolean" } } }, "PricingByReferenceResponse": { "type": "object", "properties": { "Pricing": { "description": "These are the pricing breakdowns available for the vehicle requested.", "type": "array", "items": { "$ref": "#/definitions/PricingByReferenceItem" } } } }, "PricingByReferenceItem": { "type": "object", "properties": { "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "From": { "format": "date-time", "description": "The date in which this cost breakdown is valid from.", "type": "string" }, "To": { "format": "date-time", "description": "The date in which this cost breakdown is valid to. Can be null if the cost breakdown is indefinitely valid.", "type": "string" }, "OnTheRoadPriceExcludingSalesTax": { "format": "double", "type": "number" }, "CostBreakdownExcludingSalesTax": { "$ref": "#/definitions/CostBreakdown" }, "OnTheRoadPriceIncludingSalesTax": { "format": "double", "type": "number" }, "CostBreakdownIncludingSalesTax": { "$ref": "#/definitions/CostBreakdown" } } }, "VehicleSelectionCategoriesResponse": { "type": "object", "properties": { "Categories": { "type": "array", "items": { "$ref": "#/definitions/VehicleSelectionCategory" } } } }, "VehicleSelectionCategory": { "type": "object", "properties": { "Id": { "type": "string" }, "Label": { "type": "string" } } }, "VehicleSelectionRequest": { "type": "object", "properties": { "CurrentOnly": { "type": "boolean" }, "ElectricOnly": { "type": "boolean" }, "AllowedManufacturers": { "type": "array", "items": { "type": "string" } }, "AllowedVehicleTypes": { "type": "array", "items": { "type": "string" } }, "PreviouslySelectedOptions": { "type": "array", "items": { "type": "string" } } } }, "VehicleSelectionResponse": { "type": "object", "properties": { "Category": { "type": "string" }, "Options": { "type": "array", "items": { "$ref": "#/definitions/VehicleSelectionOption" } }, "IsElectricOnly": { "type": "boolean" }, "IdentifierType": { "type": "string" } } }, "VehicleSelectionOption": { "type": "object", "properties": { "Display": { "type": "string" }, "Id": { "type": "string" } } }, "VehicleSelectionForIdentifierResponse": { "type": "object", "properties": { "IdentifierType": { "type": "string" }, "Categories": { "type": "array", "items": { "$ref": "#/definitions/VehicleSelectionFromIdentifierCategoryWithOptions" } } } }, "VehicleSelectionFromIdentifierCategoryWithOptions": { "type": "object", "properties": { "Category": { "type": "string" }, "Options": { "type": "array", "items": { "$ref": "#/definitions/VehicleSelectionFromIdentifierOption" } } } }, "VehicleSelectionFromIdentifierOption": { "type": "object", "properties": { "Display": { "type": "string" }, "Id": { "type": "string" }, "IsSelected": { "type": "boolean" } } }, "SaveVehicleSpecificationsRequest": { "required": [ "Specifications" ], "type": "object", "properties": { "Specifications": { "type": "array", "items": { "$ref": "#/definitions/ManageableVehicleSpecification" } } } }, "ManageableVehicleSpecification": { "required": [ "DataSet", "FuelType", "Transmission", "Manufacturer", "Type", "BodyStyle", "DriveTrain", "ModelYear" ], "type": "object", "properties": { "DataSet": { "enum": [ "Unknown", "Cap", "Glass", "Codeweavers", "Ids", "Ivs", "Psa", "CapLcv", "Glasses", "Tfs", "PsaComcar", "Autobiz", "Brego" ], "type": "string" }, "ImportCode": { "$ref": "#/definitions/Code", "description": "The unique data providers code for the vehicle." }, "Codes": { "type": "array", "items": { "$ref": "#/definitions/Code" } }, "OnTheRoadPrice": { "format": "double", "description": "This is mandatory if the CostBreakdown property is not supplied.", "type": "number" }, "CostBreakdown": { "$ref": "#/definitions/CostBreakdown", "description": "This is mandatory if the OnTheRoadPrice property is not supplied." }, "FuelType": { "enum": [ "Unknown", "Petrol", "Diesel", "Electric", "Hybrid", "PetrolMildHybrid", "HybridPetrolElectric", "HybridPetrolElectricPlugin", "DieselMildHybrid", "HybridDieselElectric", "HybridDieselElectricPlugin", "HybridPetrolLpg", "HybridPetrolBioEthanol", "HybridPetrolCng", "HydrogenFuelCell" ], "type": "string" }, "Transmission": { "enum": [ "Unknown", "Manual", "Automatic", "Sport" ], "type": "string" }, "BrandTransmission": { "type": "string" }, "Manufacturer": { "enum": [ "Abarth", "AC", "Aixam", "AlfaRomeo", "Asia", "AstonMartin", "Audi", "Austin", "Bentley", "BMW", "Bristol", "Cadillac", "Caterham", "Chevrolet", "Chrysler", "Citroen", "ColemanMilne", "Corvette", "Dacia", "Daewoo", "Daihatsu", "Daimler", "DeTomaso", "Dodge", "Ducati", "Eagle", "FSO", "Farbio", "FBS", "Ferrari", "Fiat", "Ford", "HarleyDavidson", "Honda", "Hummer", "Hyundai", "Infiniti", "Invicta", "Isuzu", "Jaguar", "Jeep", "Jensen", "Kia", "KTM", "Lada", "Lamborghini", "Lancia", "LandRover", "Lexus", "Ligier", "Lotus", "LTI", "Marcos", "Marlin", "Maserati", "Maybach", "Mazda", "MercedesBenz", "MGMotorUk", "Microcar", "Mini", "Mitsubishi", "Morgan", "Nissan", "Noble", "Opel", "Perodua", "Peugeot", "PGO", "Porsche", "Proton", "Reliant", "Renault", "RollsRoyce", "Rover", "Saab", "San", "SAO", "Seat", "Skoda", "Smart", "Ssangyong", "Subaru", "Suzuki", "Talbot", "Tata", "TDCars", "Tesla", "Toyota", "Triumph", "TVR", "Vauxhall", "Volvo", "Alpina", "Mclaren", "MRAD", "Iveco", "Kawasaki", "Alpine", "DSAutomobiles", "Yamaha", "VolkswagenPassengerCars", "VolkswagenCommercialVehicles" ], "type": "string" }, "Model": { "type": "string" }, "Variant": { "type": "string" }, "Derivative": { "type": "string" }, "Description": { "type": "string" }, "Type": { "enum": [ "Car", "Lcv", "Bike", "Hgv" ], "type": "string" }, "BodyStyle": { "enum": [ "Unknown", "Convertible", "Coupe", "Estate", "Hatchback", "MPV", "Pickup", "SUV", "Saloon", "Limo", "Roadster", "Compact" ], "type": "string" }, "BrandBodyStyle": { "type": "string" }, "DriveTrain": { "enum": [ "Unknown", "FrontWheelDrive", "RearWheelDrive", "FourWheelDrive", "AllWheelDrive" ], "type": "string" }, "BrandDriveTrain": { "type": "string" }, "IntroducedDate": { "format": "date-time", "type": "string" }, "DiscontinuedDate": { "format": "date-time", "type": "string" }, "IsVatReclaimable": { "type": "boolean" }, "IsRde2Compliant": { "type": "boolean" }, "EnvironmentalData": { "$ref": "#/definitions/EnvironmentalData" }, "ZeroTo60": { "format": "double", "description": "The time it takes for a vehicle to reach 60mph in seconds.", "type": "number" }, "Doors": { "format": "int32", "type": "integer" }, "Seats": { "format": "int32", "type": "integer" }, "BootCapacity": { "format": "int32", "type": "integer" }, "EngineSize": { "format": "int32", "type": "integer" }, "BrakeHorsePower": { "format": "int32", "type": "integer" }, "ModelYear": { "format": "int32", "type": "integer" } } }, "SaveVehicleSpecificationsResponse": { "type": "object", "properties": { "Specifications": { "type": "array", "items": { "$ref": "#/definitions/SaveVehicleSpecificationResponse" } } } }, "SaveVehicleSpecificationResponse": { "type": "object", "properties": { "ImportIdentifier": { "type": "string" }, "CodeweaversDerivativeIdentifier": { "type": "string" }, "Errors": { "type": "array", "items": { "$ref": "#/definitions/ErrorResponse" } } } }, "VehicleStatusTypesResponse": { "type": "object", "properties": { "Statuses": { "type": "array", "items": { "$ref": "#/definitions/VehicleStatus" } } } }, "VehicleStatus": { "type": "object", "properties": { "Type": { "enum": [ "Unknown", "PreOwned", "Preregistered", "Demonstrator", "New", "BuildToOrder" ], "type": "string" } } }, "VehicleTypesResponse": { "type": "object", "properties": { "VehicleTypes": { "type": "array", "items": { "$ref": "#/definitions/VehicleType" } } } }, "VehicleType": { "type": "object", "properties": { "Id": { "enum": [ "Unknown", "Car", "Lcv", "Bike", "Other", "NonVehicleAsset" ], "type": "string" }, "Name": { "type": "string" }, "IsDefault": { "type": "boolean" }, "Conditions": { "type": "array", "items": { "$ref": "#/definitions/VehicleTypeConditions" } } } }, "VehicleTypeConditions": { "type": "object", "properties": { "Name": { "type": "string" }, "Type": { "type": "string" }, "IsDefault": { "type": "boolean" }, "DataSet": { "enum": [ "UNKNOWN", "CAP", "GLASSES", "IDS", "IVS", "PSA", "TFS", "CAPLCV", "CODEWEAVERS", "AUTOBIZ", "BREGO", "LastElement" ], "type": "string" }, "IdentifierType": { "type": "string" } } }, "SaveVehicleVideosRequest": { "type": "object", "properties": { "Videos": { "type": "array", "items": { "$ref": "#/definitions/VehicleVideo" } } } }, "GetVideosResponse": { "type": "object", "properties": { "Videos": { "type": "array", "items": { "$ref": "#/definitions/VideoLink" } } } }, "CreateVideoLinkRequest": { "type": "object", "properties": { "VideoIdentifier": { "type": "string" }, "Style": { "type": "string" }, "Name": { "type": "string" }, "Thumbnail": { "type": "string" }, "Url": { "type": "string" }, "Locale": { "type": "string" } } }, "UpdateVideoLinkByIdRequest": { "type": "object", "properties": { "VideoIdentifier": { "type": "string" }, "Style": { "type": "string" }, "Name": { "type": "string" }, "Thumbnail": { "type": "string" }, "Url": { "type": "string" }, "Locale": { "type": "string" } } }, "WebhookRequest": { "type": "object", "properties": { "EventTags": { "type": "array", "items": { "type": "string" } }, "OccuredAt": { "format": "date-time", "type": "string" }, "Uri": { "type": "string" }, "AuthenticationToken": { "type": "string" } } }, "CreatePrivacyPolicyByWorkspaceReferenceRequest": { "type": "object", "properties": { "Title": { "type": "string" }, "Content": { "type": "string" }, "SelectedLocations": { "type": "array", "items": { "type": "string" } }, "ContentSet": { "type": "string" }, "LegacyTemplateId": { "type": "string" }, "EntityTypes": { "type": "array", "items": { "format": "int32", "type": "integer" } }, "Locales": { "type": "array", "items": { "type": "string" } } } }, "CreatePrivacyPolicyByWorkspaceReferenceResponse": { "type": "object", "properties": { "PrivacyPolicyReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } }, "UpdatePrivacyPolicyByWorkspaceReferenceRequest": { "type": "object", "properties": { "Title": { "type": "string" }, "Content": { "type": "string" }, "SelectedLocations": { "type": "array", "items": { "type": "string" } }, "Reference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "ContentSet": { "type": "string" }, "LegacyTemplateId": { "type": "string" }, "EntityTypeIds": { "type": "array", "items": { "format": "int32", "type": "integer" } }, "Locales": { "type": "array", "items": { "type": "string" } } } }, "UpdatePrivacyPolicyByWorkspaceReferenceResponse": { "type": "object", "properties": {} }, "CreateOrganisationRequest": { "required": [ "TradingName", "TelephoneNumber" ], "type": "object", "properties": { "TradingName": { "maxLength": 2147483647, "minLength": 3, "type": "string" }, "Introducer": { "type": "string" }, "TelephoneNumber": { "type": "string" }, "FaxNumber": { "type": "string" }, "Email": { "type": "string" }, "IsActive": { "type": "boolean" }, "Website": { "type": "string" }, "OffersWebsite": { "type": "string" }, "RetailerUrl": { "type": "string" }, "AutoSubmitToLender": { "type": "boolean" }, "AutoSubmitToLenderDemo": { "type": "boolean" }, "Address": { "$ref": "#/definitions/CreateOrganisationAddress" }, "DealerReference": { "type": "string" }, "FcaNumber": { "type": "string" }, "OrganisationTypeKey": { "format": "int32", "type": "integer" }, "CreateStockLocation": { "type": "boolean" }, "VatNumber": { "type": "string" }, "CompanyRegistrationNumber": { "type": "string" }, "ParentOrganisationLegacyDealerId": { "format": "int32", "type": "integer" }, "FranchiseId": { "format": "int32", "type": "integer" }, "RepresentativeExampleProductPreferenceId": { "format": "int32", "type": "integer" }, "SalesforceId": { "type": "string" } } }, "CreateOrganisationAddress": { "type": "object", "properties": { "Postcode": { "type": "string" }, "HouseName": { "type": "string" }, "Street": { "type": "string" }, "Locale1": { "type": "string" }, "Locale2": { "type": "string" }, "CityTown": { "type": "string" }, "County": { "type": "string" }, "CountryAlpha2Code": { "type": "string" }, "Latitude": { "format": "double", "type": "number" }, "Longitude": { "format": "double", "type": "number" } } }, "WorkspaceModel": { "type": "object", "properties": { "Description": { "type": "string" }, "Key": { "type": "string" }, "LogoUrl": { "type": "string" }, "AppType": { "enum": [ "Unknown", "RetailerPointOfSale", "FleetPointOfSale", "LenderPointOfSale" ], "type": "string" }, "AllowedModuleSources": { "enum": [ "None", "App", "Role", "Organisation", "User" ], "type": "string" }, "AccessType": { "enum": [ "Unknown", "AppOrganisationsCanBeAccessByOtherApps", "AppOrganisationsCanOnlyBeAccessedByThisApp" ], "type": "string" }, "OrganisationAccess": { "enum": [ "Unknown", "AppOrganisationsCanBeAccessByOtherApps", "AppOrganisationsCanOnlyBeAccessedByThisApp" ], "type": "string" }, "Reference": { "type": "string" }, "ModuleIds": { "type": "array", "items": { "format": "int32", "type": "integer" } }, "AuthenticatorIds": { "type": "array", "items": { "format": "int32", "type": "integer" } }, "DisplayName": { "type": "string" }, "SalesForceId": { "type": "string" } } }, "CreateWorkspaceResponse": { "type": "object", "properties": { "WorkspaceReference": { "type": "string" } } }, "GetAllWorkspaces": { "type": "object", "properties": { "Apps": { "type": "array", "items": { "$ref": "#/definitions/WorkspaceApiOverviewModel" } }, "TotalResults": { "format": "int32", "type": "integer" } } }, "GetWorkspaceByReferenceResponse": { "type": "object", "properties": { "Workspace": { "$ref": "#/definitions/WorkspaceModel" } } }, "UpdateWorkspaceRequest": { "type": "object", "properties": { "ReasonForUpdate": { "type": "string" }, "OrganisationReferencesToAdd": { "type": "array", "items": { "type": "string" } }, "OrganisationReferencesToRemove": { "type": "array", "items": { "type": "string" } }, "Description": { "type": "string" }, "Key": { "type": "string" }, "LogoUrl": { "type": "string" }, "AppType": { "enum": [ "Unknown", "RetailerPointOfSale", "FleetPointOfSale", "LenderPointOfSale" ], "type": "string" }, "ModuleBehaviourType": { "enum": [ "None", "App", "Role", "Organisation", "User" ], "type": "string" }, "AllowedModuleSources": { "enum": [ "None", "App", "Role", "Organisation", "User" ], "type": "string" }, "AccessType": { "enum": [ "Unknown", "AppOrganisationsCanBeAccessByOtherApps", "AppOrganisationsCanOnlyBeAccessedByThisApp" ], "type": "string" }, "OrganisationAccess": { "enum": [ "Unknown", "AppOrganisationsCanBeAccessByOtherApps", "AppOrganisationsCanOnlyBeAccessedByThisApp" ], "type": "string" }, "Reference": { "type": "string" }, "ModuleIds": { "type": "array", "items": { "format": "int32", "type": "integer" } }, "AuthenticatorIds": { "type": "array", "items": { "format": "int32", "type": "integer" } }, "DisplayName": { "type": "string" }, "SalesForceId": { "type": "string" } } }, "GetWorkspaceAuditsByReferenceRequest": { "type": "object", "properties": { "Page": { "format": "int32", "type": "integer" }, "ResultsPerPage": { "format": "int32", "type": "integer" } } }, "GetWorkspaceAuditsByReferenceResponse": { "type": "object", "properties": { "TotalResults": { "format": "int32", "type": "integer" }, "WorkspaceAudits": { "type": "array", "items": { "$ref": "#/definitions/WorkspaceAudit" } } } }, "WorkspaceAudit": { "type": "object", "properties": { "WorkspaceReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "OccurredAt": { "format": "date-time", "type": "string" }, "UserReference": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "Reason": { "type": "string" }, "BeforeStateJson": { "type": "string" }, "AfterStateJson": { "type": "string" }, "Version": { "format": "int32", "type": "integer" } } }, "WorkspaceOrganisationsSearchRequest": { "required": [ "Query" ], "type": "object", "properties": { "Query": { "type": "string" }, "PageNumber": { "format": "int32", "type": "integer" }, "ResultsPerPage": { "format": "int32", "type": "integer" }, "Filters": { "$ref": "#/definitions/AdminOrganisationFilters" } } }, "WorkspaceOrganisationsSearchResponse": { "type": "object", "properties": { "TotalResults": { "format": "int32", "type": "integer" }, "TotalPages": { "format": "int32", "type": "integer" }, "Organisations": { "type": "array", "items": { "$ref": "#/definitions/OrganisationSearchResult" } }, "SanityCheckResults": { "type": "array", "items": { "$ref": "#/definitions/OrganisationSanityCheck" } }, "GdprComplianceCheckResults": { "type": "array", "items": { "$ref": "#/definitions/OrganisationGdprComplianceCheck" } } } }, "OrganisationSanityCheck": { "type": "object", "properties": { "OrganisationName": { "type": "string" }, "OrganisationReference": { "type": "string" }, "SanityCheck": { "$ref": "#/definitions/SanityCheckResultResponse" } } }, "OrganisationGdprComplianceCheck": { "type": "object", "properties": { "OrganisationName": { "type": "string" }, "OrganisationReference": { "type": "string" }, "GdprComplianceCheck": { "type": "boolean" } } }, "GetWorkspacePlatformSettingsResponse": { "type": "object", "properties": { "Id": { "type": "string" }, "Name": { "type": "string" }, "SupportDetails": { "$ref": "#/definitions/WorkspaceContactDetails" }, "Language": { "type": "object", "additionalProperties": { "type": "string" } }, "PrivacyPolicyLink": { "type": "string" }, "ExternalPortals": { "type": "array", "items": { "$ref": "#/definitions/WorkspaceExternalPortal" } }, "ExternalKey": { "type": "string" } } }, "WorkspaceContactDetails": { "type": "object", "properties": { "Email": { "type": "string" }, "Telephone": { "type": "string" }, "Link": { "type": "string" }, "Message": { "type": "string" }, "ShowResetPasswordPrompt": { "type": "boolean" } } }, "WorkspaceExternalPortal": { "type": "object", "properties": { "Url": { "type": "string" }, "Title": { "type": "string" }, "Icon": { "type": "string" } } } }, "securityDefinitions": { "basic": { "type": "basic", "description": "Basic HTTP Authentication" }, "apiKey": { "type": "apiKey", "description": "API Key Authentication", "name": "X-CW-ApiKey", "in": "header" } } }