Create a Quote

POST /api/calculate

Start by calculating rental prices for a product. You pass the acquisition cost, the product sector, and the durations and calculation types you want offers for. The response contains one offer per duration and calculation type — this is where the customer picks the terms that suit them. Keep the returned calculation: you reference it by its IRI in the next step.

curl -X POST 'https://sandbox.partner.miete24.com/api/calculate' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "acquisitionCost": 1000.23,
    "productSector": "IT_AND_OFFICE_EQUIPMENT",
    "paymentInterval": "monthly",
    "calculationTypes": ["leasing", "rent_to_own"],
    "durations": [24, 36, 48]
  }'

const response = await fetch('https://sandbox.partner.miete24.com/api/calculate', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    acquisitionCost: 1000.23,
    productSector: 'IT_AND_OFFICE_EQUIPMENT',
    paymentInterval: 'monthly',
    calculationTypes: ['leasing', 'rent_to_own'],
    durations: [24, 36, 48],
  }),
});
const calculation = await response.json();

{
  "@id": "/api/calculations/2b1c9d7e-4f6a-4c2e-9b1a-8d3f5e7c1a2b",
  "id": "2b1c9d7e-4f6a-4c2e-9b1a-8d3f5e7c1a2b",
  "response": {
    "offers": [
      { "duration": 36, "calculationType": "leasing", "rate": 32.90 }
    ]
  }
}

Errors: 422 when the product sector cannot be resolved or a duration is not allowed for the sector; 401 for a missing or invalid API key.

Full parameters, all operations & code samples → Calculation reference

POST /api/quote_requests

Turn the calculation into a quote request by submitting the end customer's contact and address details together with the calculation IRI from step 1. The privacy policy acknowledgement is mandatory. A successful call creates the quote request and the quote that starts moving through the lifecycle above.

The request must name the offer the customer picked: pass duration and calculationType of one offer from the calculation's response. If the calculation contains exactly one offer (one duration, one calculation type), you can omit both and that offer is selected automatically. A calculation with several offers and no selection is rejected with 422, because the hub could never turn it into a quote.

curl -X POST 'https://sandbox.partner.miete24.com/api/quote_requests' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "calculation": "/api/calculations/2b1c9d7e-4f6a-4c2e-9b1a-8d3f5e7c1a2b",
    "duration": 36,
    "calculationType": "leasing",
    "customerType": "company",
    "company": "Muster GmbH",
    "firstName": "Erika",
    "lastName": "Mustermann",
    "email": "erika@muster-gmbh.example",
    "street": "Hauptstrasse",
    "houseNumber": "5",
    "postalCode": "10115",
    "city": "Berlin",
    "country": "DE",
    "acknowledgedPrivacy": true
  }'

const response = await fetch('https://sandbox.partner.miete24.com/api/quote_requests', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    calculation: '/api/calculations/2b1c9d7e-4f6a-4c2e-9b1a-8d3f5e7c1a2b',
    duration: 36,
    calculationType: 'leasing',
    customerType: 'company',
    company: 'Muster GmbH',
    firstName: 'Erika',
    lastName: 'Mustermann',
    email: 'erika@muster-gmbh.example',
    street: 'Hauptstrasse',
    houseNumber: '5',
    postalCode: '10115',
    city: 'Berlin',
    country: 'DE',
    acknowledgedPrivacy: true,
  }),
});
const quoteRequest = await response.json();

{
  "@id": "/api/quote_requests/7d2f4a11-9c3b-4e8d-8a1f-6b5c2d9e0f34",
  "id": "7d2f4a11-9c3b-4e8d-8a1f-6b5c2d9e0f34",
  "email": "erika@muster-gmbh.example",
  "customerType": "company"
}

Errors: 422 when a required field is missing, the email is invalid, the calculation IRI is unknown, acknowledgedPrivacy is not true, the duration/calculationType pair matches none of the offers, or the calculation has several offers and no pair was passed; 401 for a missing or invalid API key.

Full parameters, all operations & code samples → Quote Request reference

GET /api/quotes/{id}

Follow the quote as it moves through the lifecycle by reading its status — the states shown in the diagram above (for example in_review, accepted_by_customer, completed). Poll this endpoint, or subscribe to a webhook to be notified on every change instead of polling.

curl -X GET 'https://sandbox.partner.miete24.com/api/quotes/{id}' \
  -H 'X-Api-Key: YOUR_API_KEY'

const response = await fetch('https://sandbox.partner.miete24.com/api/quotes/{id}', {
  method: 'GET',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
});
const quote = await response.json();

{
  "@id": "/api/quotes/9f8e7d6c-5b4a-4938-8271-0a1b2c3d4e5f",
  "id": "9f8e7d6c-5b4a-4938-8271-0a1b2c3d4e5f",
  "status": "in_review"
}

Errors: 404 for an unknown quote id; 401 for a missing or invalid API key.

Full parameters, all operations & code samples → Quote reference