YearlyMileages

post

Body

application/jsontext/jsonapplication/*+json

Responses

200

OK

text/plainapplication/jsontext/json

post

/yearly-mileages/search

HTTPcURLJavaScriptPython

POST /yearly-mileages/search HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 1804

{
  "calculationRequest": {
    "productId": 1,
    "campaignId": 1,
    "vendorId": 1,
    "salespersonId": 1,
    "customerType": "NotSet",
    "customer": {
      "$type": "text",
      "address": [
        {
          "addressType": "VisitingAddress",
          "addressLine1": "text",
          "addressLine2": "text",
          "zip": "text",
          "city": "text",
          "county": "text",
          "country": "text"
        }
      ],
      "externalReferences": [
        {
          "key": "text",
          "value": "text"
        }
      ],
      "locale": "text"
    },
    "object": {
      "$type": "text",
      "purchasePrice": {
        "amount": 1,
        "vatAmount": 1
      },
      "objectTypeID": "Vehicle, boat, agriculture, aquaculture, construction machine",
      "objectSubTypeID": "ICE vehicle, electric vehicle, boat under 7 meters, MC",
      "objectCondition": "New, Used",
      "yearModel": 1,
      "make": "text",
      "model": "text",
      "engine": "text",
      "kmPerYear": 1,
      "modelCode": "text",
      "priceKmExceeded": 1,
      "objectCarExtras": [
        {
          "extrasCode": "text",
          "name": "text",
          "price": {
            "amount": 1,
            "vatAmount": 1
          }
        }
      ],
      "carExtrasPriceFactoryInstalled": 1,
      "carExtrasPriceDealerInstalled": 1,
      "fuelType": 1,
      "carRegNo": "text",
      "carKilometers": 1,
      "carChassisNo": "text",
      "kmTotal": 1,
      "carProdNo": "text"
    },
    "financialParameters": {
      "equity": {
        "amount": 1,
        "vatAmount": 1
      },
      "startupFee": {
        "amount": 1,
        "vatAmount": 1
      },
      "terms": {
        "$type": "text",
        "termCount": 1,
        "termLength": 1
      },
      "interestRate": 1,
      "termFee": {
        "amount": 1,
        "vatAmount": 1
      },
      "residualValue": {
        "amount": 1,
        "vatAmount": 1
      },
      "residualValuePercent": 1,
      "nonRecurrentFee": 1,
      "loanType": "Annuity",
      "fundingInterestId": 1
    },
    "embeddedProducts": [
      {
        "code": "INVOICE_ESTIMATOR",
        "name": "Invoice estimator",
        "price": {
          "amount": 1,
          "vatAmount": 1
        },
        "customDataFields": [
          {
            "$type": "text",
            "name": "text",
            "value": 1
          }
        ],
        "priceDataFields": [
          {
            "$type": "text",
            "name": "text",
            "value": 1
          }
        ],
        "isIncludedInTermFee": true
      }
    ],
    "context": {
      "externalSystemRef": 112233445566,
      "externalSystemRef2": "text",
      "externalSystemCode": "MNET, WEBCALC, LENDO",
      "integrationClientId": 1,
      "channel": 1
    },
    "includePaymentPlan": true,
    "deliveryDate": "2026-03-07T23:41:53.719Z"
  }
}

application/jsontext/jsonapplication/*+json

200

OK

{
  "yearlyMileages": [
    {
      "mileage": 1
    }
  ],
  "defaultMileage": {
    "mileage": 1
  }
}