The Get Vehicle Residual API calculates the residual value of a vehicle when the vehicle details (Model number, Model yea, accessories, etc.) and the combinations of contract terms and miles.
Toyota Terms of Service - Legal
development
https://api.test.toyota.com/tmna/test
Percorsi
/GetVehicleResidual
post /GetVehicleResidual
clientIdHeader
X-IBM-Client-Id
(apiKey ubicato in header)
api-key-1
X-IBM-Client-Secret
(apiKey ubicato in header)
jsonRequest
Obbligatorio in body
object
Content-Type
Facoltativo in header
string
application/json
Accept
Facoltativo in header
string
application/json
Richiesta di esempio
Risposta di esempio
POST https://api.test.toyota.com/tmna/test/Vehicle/v/GetVehicleResidual
Tenta questa operazione
Definizioni
{
"properties": {
"GetVehicleResidual": {
"type": "object",
"properties": {
"systemEnvironmentCode": {
"type": "string"
},
"VehicleResidualBOD": {
"type": "object",
"properties": {
"ApplicationArea": {
"type": "object",
"properties": {
"CreationDateTime": {
"type": "string"
},
"BODID": {
"type": "string"
},
"Sender": {
"type": "object",
"properties": {
"UserID": {
"type": "string"
},
"CreatorNameCode": {
"type": "string"
},
"SendorNameCode": {
"type": "string"
}
}
},
"Destination": {
"type": "object",
"properties": {
"DestinationNameCode": {
"type": "string"
}
}
}
}
},
"VehicleResidualDataArea": {
"type": "object",
"properties": {
"BusinessContext": {
"type": "object",
"properties": {
"TransactionType": {
"type": "string"
},
"Action": {
"type": "string"
}
}
},
"VehicleResidualPayload": {
"type": "object",
"properties": {
"VehicleResidualDetail": {
"type": "object",
"properties": {
"VehicleId": {
"type": "object",
"properties": {
"VIN": {
"type": "string"
}
}
},
"VehicleModel": {
"type": "object",
"properties": {
"ModelYear": {
"type": "string"
},
"Make": {
"type": "string"
},
"Model": {
"type": "string"
}
}
},
"VehicleType": {
"type": "string"
},
"InceptionMiles": {
"type": "string"
}
}
}
}
}
}
}
}
}
}
}
},
"example": {
"GetVehicleResidual": {
"systemEnvironmentCode": "TESS",
"VehicleResidualBOD": {
"ApplicationArea": {
"CreationDateTime": "2001-12-17T09:30:47Z",
"BODID": "be45d42b-a4f9-357e-9a88-fcc11c0c88c8",
"Sender": {
"UserID": "12315",
"CreatorNameCode": "Dealer Daily",
"SendorNameCode": "Dealer Daily"
},
"Destination": {
"DestinationNameCode": "TFS"
}
},
"VehicleResidualDataArea": {
"BusinessContext": {
"TransactionType": "SYNC",
"Action": "GetVehicleResidual"
},
"VehicleResidualPayload": {
"VehicleResidualDetail": {
"VehicleId": {
"VIN": "JTDKDTB30D1555049"
},
"VehicleModel": {
"ModelYear": "2014",
"Make": "TOYOTA",
"Model": "4440"
},
"VehicleType": "N",
"InceptionMiles": "250"
}
}
}
}
}
}
}
{
"properties": {
"ShowVehicleResidual": {
"type": "object",
"properties": {
"VehicleResidualBOD": {
"type": "object",
"properties": {
"ApplicationArea": {
"type": "object",
"properties": {
"CreationDateTime": {
"type": "string"
},
"BODID": {
"type": "string"
},
"Sender": {
"type": "object",
"properties": {
"UserID": {
"type": "string"
},
"CreatorNameCode": {
"type": "string"
},
"SendorNameCode": {
"type": "string"
}
}
},
"Destination": {
"type": "object",
"properties": {
"DestinationNameCode": {
"type": "string"
}
}
}
}
},
"VehicleResidualDataArea": {
"type": "object",
"properties": {
"BusinessContext": {
"type": "object",
"properties": {
"TransactionType": {
"type": "string"
},
"Action": {
"type": "string"
},
"ExtendedStatus": {
"type": "array",
"items": {
"type": "object",
"properties": {
"StatusCode": {
"type": "string"
}
}
}
}
}
},
"VehicleResidualPayload": {
"type": "object",
"properties": {
"VehicleResidualDetail": {
"type": "object",
"properties": {
"ResidualValueList": {
"type": "object",
"properties": {
"ResidualValue": {
"type": "array",
"items": {
"type": "object",
"properties": {
"AnnualContractMileage": {
"type": "string"
},
"ContractTerm": {
"type": "string"
},
"PurchasedMiles": {
"type": "string"
},
"ResidualPercentage": {
"type": "string"
},
"ResidualPricing": {
"type": "object",
"properties": {
"Price": {
"type": "array",
"items": {
"type": "object",
"properties": {
"PriceCode": {
"type": "string"
},
"ChargeAmount": {
"type": "object",
"properties": {
"currencyID": {
"type": "string"
},
"Value": {
"type": "string"
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
},
"example": {
"ShowVehicleResidual": {
"VehicleResidualBOD": {
"ApplicationArea": {
"CreationDateTime": "2001-12-17T09:30:47Z",
"BODID": "be45d42b-a4f9-357e-9a88-fcc11c0c88c8",
"Sender": {
"UserID": "12315",
"CreatorNameCode": "TFSResidualService",
"SendorNameCode": "TFSResidualService"
},
"Destination": {
"DestinationNameCode": "Dealer Daily"
}
},
"VehicleResidualDataArea": {
"BusinessContext": {
"TransactionType": "SYNC",
"Action": "GetVehicleResidual",
"ExtendedStatus": [
{
"StatusCode": "SUCCESS"
}
]
},
"VehicleResidualPayload": {
"VehicleResidualDetail": {
"ResidualValueList": {
"ResidualValue": [
{
"AnnualContractMileage": "12000.0",
"ContractTerm": "24",
"PurchasedMiles": "0.0",
"ResidualPercentage": "0.63",
"ResidualPricing": {
"Price": [
{
"PriceCode": "AltMileAdjustment",
"ChargeAmount": {
"currencyID": "USD",
"Value": "0.02"
}
},
{
"PriceCode": "FinalResidualValue",
"ChargeAmount": {
"currencyID": "USD",
"Value": "12100.0"
}
},
{
"PriceCode": "BaseResidualValue",
"ChargeAmount": {
"currencyID": "USD",
"Value": "0.0"
}
},
{
"PriceCode": "SumOfAccessories",
"ChargeAmount": {
"currencyID": "USD",
"Value": "300.0"
}
},
{
"PriceCode": "TotalMileAdjustment",
"ChargeAmount": {
"currencyID": "USD",
"Value": "2500.0"
}
},
{
"PriceCode": "OverMileAdjustment",
"ChargeAmount": {
"currencyID": "USD",
"Value": "0.0"
}
}
]
}
},
{
"AnnualContractMileage": "12000.0",
"ContractTerm": "24",
"PurchasedMiles": "0.0",
"ResidualPercentage": "0.63",
"ResidualPricing": {
"Price": [
{
"PriceCode": "AltMileAdjustment",
"ChargeAmount": {
"currencyID": "USD",
"Value": "0.02"
}
},
{
"PriceCode": "FinalResidualValue",
"ChargeAmount": {
"currencyID": "USD",
"Value": "12100.0"
}
},
{
"PriceCode": "BaseResidualValue",
"ChargeAmount": {
"currencyID": "USD",
"Value": "0.0"
}
},
{
"PriceCode": "SumOfAccessories",
"ChargeAmount": {
"currencyID": "USD",
"Value": "300.0"
}
},
{
"PriceCode": "TotalMileAdjustment",
"ChargeAmount": {
"currencyID": "USD",
"Value": "2500.0"
}
},
{
"PriceCode": "OverMileAdjustment",
"ChargeAmount": {
"currencyID": "USD",
"Value": "0.0"
}
}
]
}
}
]
}
}
}
}
}
}
}
}
{
"properties": {
"httpCode": {
"type": "string"
},
"httpMessage": {
"type": "string"
},
"moreInformation": {
"type": "string"
}
},
"required": [
"httpCode",
"httpMessage",
"moreInformation"
],
"example": {
"httpCode": "401",
"httpMessage": "Unauthorized",
"moreInformation": "Invalid client id or secret."
},
"additionalProperties": false
}
{
"properties": {
"httpCode": {
"type": "string"
},
"httpMessage": {
"type": "string"
},
"moreInformation": {
"type": "string"
}
},
"required": [
"httpCode",
"httpMessage",
"moreInformation"
],
"example": {
"httpCode": "404",
"httpMessage": "Not Found",
"moreInformation": "No resources match requested URI"
},
"additionalProperties": false
}