Changer la couverture d’une location

curl --request POST \
  --url https://api.lexio.rent/api/external/v1/rentals/{rentalId}/change-coverage \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "mileagePackageId": "9d0e1f2a-3b4c-4d5e-8f60-819203142536",
  "expectedTotalTTC": 398.4
}
'

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    mileagePackageId: '9d0e1f2a-3b4c-4d5e-8f60-819203142536',
    expectedTotalTTC: 398.4
  })
};

fetch('https://api.lexio.rent/api/external/v1/rentals/{rentalId}/change-coverage', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.lexio.rent/api/external/v1/rentals/{rentalId}/change-coverage"

payload = {
    "mileagePackageId": "9d0e1f2a-3b4c-4d5e-8f60-819203142536",
    "expectedTotalTTC": 398.4
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.lexio.rent/api/external/v1/rentals/{rentalId}/change-coverage",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'mileagePackageId' => '9d0e1f2a-3b4c-4d5e-8f60-819203142536',
    'expectedTotalTTC' => 398.4
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "data": {
    "id": "9c2d7e4a-5b1f-4d3c-8a6e-0f1b2c3d4e5f",
    "number": "LOC-2026.11-0042",
    "status": "RESERVED",
    "source": "PARTNER",
    "partnerCode": "azur-voyages",
    "partnerReference": "AV-884213",
    "period": {
      "startAt": "2026-11-10T10:00:00+01:00",
      "endAt": "2026-11-15T10:00:00+01:00",
      "timezone": "Europe/Paris",
      "billedDays": 5,
      "durationMinutes": 7200
    },
    "actualStartAt": null,
    "actualEndAt": null,
    "vehicle": {
      "id": "3b1f5c2a-8d4e-4f6a-9b7c-2e5d8a1f4c63",
      "name": "208 Allure",
      "brand": "Peugeot",
      "model": "208",
      "vehicleType": "CITY",
      "plate": "AB-123-CD",
      "serialNumber": null
    },
    "customer": {
      "id": "7c4e2b9a-1f3d-4a6e-8b5c-9d0e1f2a3b4c",
      "isCompany": false,
      "firstName": "Marie",
      "lastName": "Martin",
      "companyName": null,
      "email": "marie.martin@example.com",
      "phone": "+33612345678"
    },
    "pickupLocation": {
      "locationId": "c41a9e3b-2d55-4b0f-8c11-0f3a7d6e9b42",
      "name": "Agence Nice Gare",
      "address": "12 avenue Thiers, 06000 Nice"
    },
    "returnLocation": {
      "locationId": null,
      "name": "Hôtel Negresco",
      "address": "37 promenade des Anglais, 06000 Nice"
    },
    "mileage": {
      "mileagePackageId": "5b7c9d1e-2f3a-4b5c-8d6e-7f8091a2b3c4",
      "name": "200 km/jour",
      "isUnlimited": false,
      "includedKm": 1000,
      "overageRatePerKmHT": 0.25
    },
    "deductible": {
      "deductibleId": "2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f",
      "name": "Franchise réduite",
      "description": "Reste à charge réduit en cas de sinistre.",
      "excessAmount": 500
    },
    "deposit": {
      "depositId": "4e5f6a7b-8c9d-4e0f-9a1b-3c4d5e6f7081",
      "name": "Caution citadine",
      "depositAmount": 800
    },
    "options": [
      {
        "optionId": "6a7b8c9d-0e1f-4a2b-9c3d-5e6f70819203",
        "name": "Siège enfant",
        "kind": "STANDARD",
        "quantity": 1
      }
    ],
    "lines": [
      {
        "key": "BASE",
        "label": "Tarif de base",
        "refId": null,
        "quantity": 1,
        "unitPriceHT": 210,
        "unitPriceTTC": 252,
        "amountHT": 210,
        "amountTTC": 252,
        "ratePercent": null
      },
      {
        "key": "DURATION_DISCOUNT",
        "label": "Réduction durée 5 jours",
        "refId": null,
        "quantity": 1,
        "unitPriceHT": -10.5,
        "unitPriceTTC": -12.6,
        "amountHT": -10.5,
        "amountTTC": -12.6,
        "ratePercent": 5
      },
      {
        "key": "MILEAGE",
        "label": "Forfait 200 km/jour",
        "refId": null,
        "quantity": 1,
        "unitPriceHT": 0,
        "unitPriceTTC": 0,
        "amountHT": 0,
        "amountTTC": 0,
        "ratePercent": null
      },
      {
        "key": "DEDUCTIBLE",
        "label": "Franchise réduite",
        "refId": null,
        "quantity": 1,
        "unitPriceHT": 37.5,
        "unitPriceTTC": 45,
        "amountHT": 37.5,
        "amountTTC": 45,
        "ratePercent": null
      },
      {
        "key": "OPTION",
        "label": "Siège enfant",
        "refId": "6a7b8c9d-0e1f-4a2b-9c3d-5e6f70819203",
        "quantity": 1,
        "unitPriceHT": 20,
        "unitPriceTTC": 24,
        "amountHT": 20,
        "amountTTC": 24,
        "ratePercent": null
      }
    ],
    "promoCode": null,
    "currency": "EUR",
    "vatPercent": 20,
    "isVatReverseCharge": false,
    "totalHT": 257,
    "vatAmount": 51.4,
    "totalTTC": 308.4,
    "balance": {
      "totalTTC": 308.4,
      "paidAmount": 0,
      "dueAmount": 308.4,
      "overpaidAmount": 0
    },
    "notes": "Siège enfant à installer avant la remise.",
    "createdAt": "2026-11-02T09:15:02+01:00",
    "updatedAt": "2026-11-02T09:15:02+01:00"
  },
  "effects": {
    "priceChange": {
      "previousTotalHT": 257,
      "previousTotalTTC": 308.4,
      "newTotalHT": 351.8,
      "newTotalTTC": 422.16,
      "differenceHT": 94.8,
      "differenceTTC": 113.76
    },
    "previousCoverage": {
      "mileage": {
        "mileagePackageId": "5b7c9d1e-2f3a-4b5c-8d6e-7f8091a2b3c4",
        "name": "200 km/jour",
        "isUnlimited": false,
        "includedKm": 1000,
        "overageRatePerKmHT": 0.25
      },
      "deductible": {
        "deductibleId": "2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f",
        "name": "Franchise réduite",
        "description": "Reste à charge réduit en cas de sinistre.",
        "excessAmount": 500
      },
      "deposit": {
        "depositId": "4e5f6a7b-8c9d-4e0f-9a1b-3c4d5e6f7081",
        "name": "Caution citadine",
        "depositAmount": 800
      }
    },
    "depositResolution": "UNCHANGED",
    "amendment": {
      "id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
      "number": "AVT-LOC-2026.11-0042-001"
    },
    "overpayment": {
      "overpaidAmount": 24,
      "resolution": "REFUND_PENDING",
      "resolvableByKey": true,
      "refundPaymentId": "b7c8d9e0-f1a2-4b3c-8d4e-5f6a7b8c9d0e"
    }
  }
}

{
  "type": "https://api.lexio.rent/errors/malformed-request",
  "title": "Corps de requête illisible",
  "status": 400,
  "code": "MALFORMED_REQUEST",
  "detail": "<string>",
  "instance": "<string>",
  "requestId": "<string>"
}

{
  "type": "https://api.lexio.rent/errors/api-key-disabled",
  "title": "Clé API désactivée",
  "status": 401,
  "code": "API_KEY_DISABLED",
  "detail": "<string>",
  "instance": "<string>",
  "requestId": "<string>"
}

{
  "type": "https://api.lexio.rent/errors/feature-not-available",
  "title": "Fonctionnalité non incluse",
  "status": 403,
  "code": "FEATURE_NOT_AVAILABLE",
  "detail": "<string>",
  "instance": "<string>",
  "requestId": "<string>",
  "feature": "<string>"
}

{
  "type": "https://api.lexio.rent/errors/not-found",
  "title": "Ressource introuvable",
  "status": 404,
  "code": "NOT_FOUND",
  "detail": "<string>",
  "instance": "<string>",
  "requestId": "<string>",
  "resource": "RENTAL"
}

{
  "type": "https://api.lexio.rent/errors/booking-refused",
  "title": "Réservation refusée",
  "status": 409,
  "code": "BOOKING_REFUSED",
  "detail": "<string>",
  "instance": "<string>",
  "requestId": "<string>"
}

{
  "type": "https://api.lexio.rent/errors/payload-too-large",
  "title": "Corps trop volumineux",
  "status": 413,
  "code": "PAYLOAD_TOO_LARGE",
  "detail": "<string>",
  "instance": "<string>",
  "requestId": "<string>",
  "maxBytes": 2
}

{
  "type": "https://api.lexio.rent/errors/unsupported-media-type",
  "title": "Type de contenu non pris en charge",
  "status": 415,
  "code": "UNSUPPORTED_MEDIA_TYPE",
  "detail": "<string>",
  "instance": "<string>",
  "requestId": "<string>",
  "accepted": [
    "<string>"
  ]
}

{
  "type": "https://api.lexio.rent/errors/idempotency-key-reused",
  "title": "Clé d’idempotence réutilisée",
  "status": 422,
  "code": "IDEMPOTENCY_KEY_REUSED",
  "detail": "<string>",
  "instance": "<string>",
  "requestId": "<string>"
}

{
  "type": "https://api.lexio.rent/errors/rate-limited",
  "title": "Trop de requêtes",
  "status": 429,
  "code": "RATE_LIMITED",
  "detail": "<string>",
  "instance": "<string>",
  "requestId": "<string>",
  "limit": "PRE_AUTH",
  "windowSeconds": 2,
  "retryAfter": 1
}

{
  "type": "https://api.lexio.rent/errors/internal-error",
  "title": "Erreur interne",
  "status": 500,
  "code": "INTERNAL_ERROR",
  "detail": "<string>",
  "instance": "<string>",
  "requestId": "<string>"
}

Modifications

Changer la couverture d’une location

Accès : rentals.write

Change le forfait kilométrique, la franchise ou la caution d’une location RESERVED ou IN_PROGRESS : au moins un des trois champs.

Règles

Franchise changée sans depositId : caution recalculée (effects.depositResolution).
Élément changé : tarif du jour ; inchangé : prix gardé. Un élément offert dans Lexio et remplacé perd la gratuité.
Mêmes identifiants : 200 sans effet. Sur IN_PROGRESS, avenant si le changement est significatif (effects.amendment).

Refus

REFERENCE_NOT_FOUND : identifiant inconnu.
REFERENCE_INACTIVE : nouvel élément désactivé ou hors catégorie du véhicule (garder l’actuel reste permis).
BOOKING_REFUSED : élément payant sur un contrat au loyer mensuel.
VEHICLE_UNAVAILABLE : véhicule sans tarif.

Aperçu et prix : ?dryRun=true, expectedTotalTTC (PRICE_CHANGED), overpaymentResolution (OVERPAYMENT_RESOLUTION_REQUIRED, SEPA_DEBIT_PENDING) : voir Idempotence.

POST

rentals

{rentalId}

change-coverage

Changer la couverture d’une location

curl --request POST \
  --url https://api.lexio.rent/api/external/v1/rentals/{rentalId}/change-coverage \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "mileagePackageId": "9d0e1f2a-3b4c-4d5e-8f60-819203142536",
  "expectedTotalTTC": 398.4
}
'

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    mileagePackageId: '9d0e1f2a-3b4c-4d5e-8f60-819203142536',
    expectedTotalTTC: 398.4
  })
};

fetch('https://api.lexio.rent/api/external/v1/rentals/{rentalId}/change-coverage', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.lexio.rent/api/external/v1/rentals/{rentalId}/change-coverage"

payload = {
    "mileagePackageId": "9d0e1f2a-3b4c-4d5e-8f60-819203142536",
    "expectedTotalTTC": 398.4
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.lexio.rent/api/external/v1/rentals/{rentalId}/change-coverage",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'mileagePackageId' => '9d0e1f2a-3b4c-4d5e-8f60-819203142536',
    'expectedTotalTTC' => 398.4
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "data": {
    "id": "9c2d7e4a-5b1f-4d3c-8a6e-0f1b2c3d4e5f",
    "number": "LOC-2026.11-0042",
    "status": "RESERVED",
    "source": "PARTNER",
    "partnerCode": "azur-voyages",
    "partnerReference": "AV-884213",
    "period": {
      "startAt": "2026-11-10T10:00:00+01:00",
      "endAt": "2026-11-15T10:00:00+01:00",
      "timezone": "Europe/Paris",
      "billedDays": 5,
      "durationMinutes": 7200
    },
    "actualStartAt": null,
    "actualEndAt": null,
    "vehicle": {
      "id": "3b1f5c2a-8d4e-4f6a-9b7c-2e5d8a1f4c63",
      "name": "208 Allure",
      "brand": "Peugeot",
      "model": "208",
      "vehicleType": "CITY",
      "plate": "AB-123-CD",
      "serialNumber": null
    },
    "customer": {
      "id": "7c4e2b9a-1f3d-4a6e-8b5c-9d0e1f2a3b4c",
      "isCompany": false,
      "firstName": "Marie",
      "lastName": "Martin",
      "companyName": null,
      "email": "marie.martin@example.com",
      "phone": "+33612345678"
    },
    "pickupLocation": {
      "locationId": "c41a9e3b-2d55-4b0f-8c11-0f3a7d6e9b42",
      "name": "Agence Nice Gare",
      "address": "12 avenue Thiers, 06000 Nice"
    },
    "returnLocation": {
      "locationId": null,
      "name": "Hôtel Negresco",
      "address": "37 promenade des Anglais, 06000 Nice"
    },
    "mileage": {
      "mileagePackageId": "5b7c9d1e-2f3a-4b5c-8d6e-7f8091a2b3c4",
      "name": "200 km/jour",
      "isUnlimited": false,
      "includedKm": 1000,
      "overageRatePerKmHT": 0.25
    },
    "deductible": {
      "deductibleId": "2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f",
      "name": "Franchise réduite",
      "description": "Reste à charge réduit en cas de sinistre.",
      "excessAmount": 500
    },
    "deposit": {
      "depositId": "4e5f6a7b-8c9d-4e0f-9a1b-3c4d5e6f7081",
      "name": "Caution citadine",
      "depositAmount": 800
    },
    "options": [
      {
        "optionId": "6a7b8c9d-0e1f-4a2b-9c3d-5e6f70819203",
        "name": "Siège enfant",
        "kind": "STANDARD",
        "quantity": 1
      }
    ],
    "lines": [
      {
        "key": "BASE",
        "label": "Tarif de base",
        "refId": null,
        "quantity": 1,
        "unitPriceHT": 210,
        "unitPriceTTC": 252,
        "amountHT": 210,
        "amountTTC": 252,
        "ratePercent": null
      },
      {
        "key": "DURATION_DISCOUNT",
        "label": "Réduction durée 5 jours",
        "refId": null,
        "quantity": 1,
        "unitPriceHT": -10.5,
        "unitPriceTTC": -12.6,
        "amountHT": -10.5,
        "amountTTC": -12.6,
        "ratePercent": 5
      },
      {
        "key": "MILEAGE",
        "label": "Forfait 200 km/jour",
        "refId": null,
        "quantity": 1,
        "unitPriceHT": 0,
        "unitPriceTTC": 0,
        "amountHT": 0,
        "amountTTC": 0,
        "ratePercent": null
      },
      {
        "key": "DEDUCTIBLE",
        "label": "Franchise réduite",
        "refId": null,
        "quantity": 1,
        "unitPriceHT": 37.5,
        "unitPriceTTC": 45,
        "amountHT": 37.5,
        "amountTTC": 45,
        "ratePercent": null
      },
      {
        "key": "OPTION",
        "label": "Siège enfant",
        "refId": "6a7b8c9d-0e1f-4a2b-9c3d-5e6f70819203",
        "quantity": 1,
        "unitPriceHT": 20,
        "unitPriceTTC": 24,
        "amountHT": 20,
        "amountTTC": 24,
        "ratePercent": null
      }
    ],
    "promoCode": null,
    "currency": "EUR",
    "vatPercent": 20,
    "isVatReverseCharge": false,
    "totalHT": 257,
    "vatAmount": 51.4,
    "totalTTC": 308.4,
    "balance": {
      "totalTTC": 308.4,
      "paidAmount": 0,
      "dueAmount": 308.4,
      "overpaidAmount": 0
    },
    "notes": "Siège enfant à installer avant la remise.",
    "createdAt": "2026-11-02T09:15:02+01:00",
    "updatedAt": "2026-11-02T09:15:02+01:00"
  },
  "effects": {
    "priceChange": {
      "previousTotalHT": 257,
      "previousTotalTTC": 308.4,
      "newTotalHT": 351.8,
      "newTotalTTC": 422.16,
      "differenceHT": 94.8,
      "differenceTTC": 113.76
    },
    "previousCoverage": {
      "mileage": {
        "mileagePackageId": "5b7c9d1e-2f3a-4b5c-8d6e-7f8091a2b3c4",
        "name": "200 km/jour",
        "isUnlimited": false,
        "includedKm": 1000,
        "overageRatePerKmHT": 0.25
      },
      "deductible": {
        "deductibleId": "2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f",
        "name": "Franchise réduite",
        "description": "Reste à charge réduit en cas de sinistre.",
        "excessAmount": 500
      },
      "deposit": {
        "depositId": "4e5f6a7b-8c9d-4e0f-9a1b-3c4d5e6f7081",
        "name": "Caution citadine",
        "depositAmount": 800
      }
    },
    "depositResolution": "UNCHANGED",
    "amendment": {
      "id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
      "number": "AVT-LOC-2026.11-0042-001"
    },
    "overpayment": {
      "overpaidAmount": 24,
      "resolution": "REFUND_PENDING",
      "resolvableByKey": true,
      "refundPaymentId": "b7c8d9e0-f1a2-4b3c-8d4e-5f6a7b8c9d0e"
    }
  }
}

{
  "type": "https://api.lexio.rent/errors/malformed-request",
  "title": "Corps de requête illisible",
  "status": 400,
  "code": "MALFORMED_REQUEST",
  "detail": "<string>",
  "instance": "<string>",
  "requestId": "<string>"
}

{
  "type": "https://api.lexio.rent/errors/api-key-disabled",
  "title": "Clé API désactivée",
  "status": 401,
  "code": "API_KEY_DISABLED",
  "detail": "<string>",
  "instance": "<string>",
  "requestId": "<string>"
}

{
  "type": "https://api.lexio.rent/errors/feature-not-available",
  "title": "Fonctionnalité non incluse",
  "status": 403,
  "code": "FEATURE_NOT_AVAILABLE",
  "detail": "<string>",
  "instance": "<string>",
  "requestId": "<string>",
  "feature": "<string>"
}

{
  "type": "https://api.lexio.rent/errors/not-found",
  "title": "Ressource introuvable",
  "status": 404,
  "code": "NOT_FOUND",
  "detail": "<string>",
  "instance": "<string>",
  "requestId": "<string>",
  "resource": "RENTAL"
}

{
  "type": "https://api.lexio.rent/errors/booking-refused",
  "title": "Réservation refusée",
  "status": 409,
  "code": "BOOKING_REFUSED",
  "detail": "<string>",
  "instance": "<string>",
  "requestId": "<string>"
}

{
  "type": "https://api.lexio.rent/errors/payload-too-large",
  "title": "Corps trop volumineux",
  "status": 413,
  "code": "PAYLOAD_TOO_LARGE",
  "detail": "<string>",
  "instance": "<string>",
  "requestId": "<string>",
  "maxBytes": 2
}

{
  "type": "https://api.lexio.rent/errors/unsupported-media-type",
  "title": "Type de contenu non pris en charge",
  "status": 415,
  "code": "UNSUPPORTED_MEDIA_TYPE",
  "detail": "<string>",
  "instance": "<string>",
  "requestId": "<string>",
  "accepted": [
    "<string>"
  ]
}

{
  "type": "https://api.lexio.rent/errors/idempotency-key-reused",
  "title": "Clé d’idempotence réutilisée",
  "status": 422,
  "code": "IDEMPOTENCY_KEY_REUSED",
  "detail": "<string>",
  "instance": "<string>",
  "requestId": "<string>"
}

{
  "type": "https://api.lexio.rent/errors/rate-limited",
  "title": "Trop de requêtes",
  "status": 429,
  "code": "RATE_LIMITED",
  "detail": "<string>",
  "instance": "<string>",
  "requestId": "<string>",
  "limit": "PRE_AUTH",
  "windowSeconds": 2,
  "retryAfter": 1
}

{
  "type": "https://api.lexio.rent/errors/internal-error",
  "title": "Erreur interne",
  "status": 500,
  "code": "INTERNAL_ERROR",
  "detail": "<string>",
  "instance": "<string>",
  "requestId": "<string>"
}

Autorisations

Authorization

string

header

requis

Clé API lck_… créée dans Lexio (Paramètres → Développeur), envoyée en Authorization: Bearer. Voir Authentification.

En-têtes

Idempotency-Key

string

requis

Clé unique de l’opération, réutilisée à chaque nouvel essai : un rejeu avec la même clé et le même corps renvoie la réponse initiale sans rien réécrire. Voir Idempotence. Facultative avec ?dryRun=true sur les opérations qui l’acceptent.

Required string length: 1 - 255

Pattern: ^[\x20-\x7E]+$

Exemple:

"8b3e1d2c-4a5f-4c6b-9e7d-1f2a3b4c5d6e"

Paramètres de chemin

rentalId

string<uuid>

requis

Identifiant de la location.

Exemple:

"9c2d7e4a-5b1f-4d3c-8a6e-0f1b2c3d4e5f"

Paramètres de requête

dryRun

enum<string>

true : aperçu, la même action annulée en fin de transaction.

Options disponibles:

true,

false

Corps

application/json

mileagePackageId

string<uuid> | null

Omis : inchangé. null : kilométrage illimité. Inconnu → 422 REFERENCE_NOT_FOUND ; nouveau forfait désactivé → 422 REFERENCE_INACTIVE.

Exemple:

"7c9e6679-7425-40de-944b-e07fc1f90ae7"

deductibleId

string<uuid> | null

Omis : inchangée. null : sans franchise. Une nouvelle franchise doit être active et applicable à la catégorie du véhicule (sinon 422 REFERENCE_INACTIVE) ; garder la franchise actuelle reste permis même désactivée.

Exemple:

"7c9e6679-7425-40de-944b-e07fc1f90ae7"

depositId

string<uuid> | null

Omis : inchangée, sauf si deductibleId change (caution liée de la franchise retenue, sinon défaut de la catégorie, sinon de l’organisation, sinon aucune). null : sans caution. Fourni : l’emporte toujours.

Exemple:

"7c9e6679-7425-40de-944b-e07fc1f90ae7"

expectedTotalTTC

number

Total TTC affiché par l’aperçu (dryRun). Écart d’au moins une unité mineure avec le total recalculé → 409 PRICE_CHANGED.

overpaymentResolution

enum<string>

REFUND_PENDING : remboursement PENDING par virement du trop-perçu ; NO_REFUND : le loueur le conserve. Exige le scope payments.refund.

Options disponibles:

REFUND_PENDING,

NO_REFUND

Réponse

Changer la couverture d’une location

data

object

requis

Location, dans la même représentation pour la lecture, la liste et chaque écriture. Montants dans currency, voir Montants et TVA.

Show child attributes

Exemple:

{
  "id": "9c2d7e4a-5b1f-4d3c-8a6e-0f1b2c3d4e5f",
  "number": "LOC-2026.11-0042",
  "status": "RESERVED",
  "source": "PARTNER",
  "partnerCode": "azur-voyages",
  "partnerReference": "AV-884213",
  "period": {
    "startAt": "2026-11-10T10:00:00+01:00",
    "endAt": "2026-11-15T10:00:00+01:00",
    "timezone": "Europe/Paris",
    "billedDays": 5,
    "durationMinutes": 7200
  },
  "actualStartAt": null,
  "actualEndAt": null,
  "vehicle": {
    "id": "3b1f5c2a-8d4e-4f6a-9b7c-2e5d8a1f4c63",
    "name": "208 Allure",
    "brand": "Peugeot",
    "model": "208",
    "vehicleType": "CITY",
    "plate": "AB-123-CD",
    "serialNumber": null
  },
  "customer": {
    "id": "7c4e2b9a-1f3d-4a6e-8b5c-9d0e1f2a3b4c",
    "isCompany": false,
    "firstName": "Marie",
    "lastName": "Martin",
    "companyName": null,
    "email": "marie.martin@example.com",
    "phone": "+33612345678"
  },
  "pickupLocation": {
    "locationId": "c41a9e3b-2d55-4b0f-8c11-0f3a7d6e9b42",
    "name": "Agence Nice Gare",
    "address": "12 avenue Thiers, 06000 Nice"
  },
  "returnLocation": {
    "locationId": null,
    "name": "Hôtel Negresco",
    "address": "37 promenade des Anglais, 06000 Nice"
  },
  "mileage": {
    "mileagePackageId": "5b7c9d1e-2f3a-4b5c-8d6e-7f8091a2b3c4",
    "name": "200 km/jour",
    "isUnlimited": false,
    "includedKm": 1000,
    "overageRatePerKmHT": 0.25
  },
  "deductible": {
    "deductibleId": "2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f",
    "name": "Franchise réduite",
    "description": "Reste à charge réduit en cas de sinistre.",
    "excessAmount": 500
  },
  "deposit": {
    "depositId": "4e5f6a7b-8c9d-4e0f-9a1b-3c4d5e6f7081",
    "name": "Caution citadine",
    "depositAmount": 800
  },
  "options": [
    {
      "optionId": "6a7b8c9d-0e1f-4a2b-9c3d-5e6f70819203",
      "name": "Siège enfant",
      "kind": "STANDARD",
      "quantity": 1
    }
  ],
  "lines": [
    {
      "key": "BASE",
      "label": "Tarif de base",
      "refId": null,
      "quantity": 1,
      "unitPriceHT": 210,
      "unitPriceTTC": 252,
      "amountHT": 210,
      "amountTTC": 252,
      "ratePercent": null
    },
    {
      "key": "DURATION_DISCOUNT",
      "label": "Réduction durée 5 jours",
      "refId": null,
      "quantity": 1,
      "unitPriceHT": -10.5,
      "unitPriceTTC": -12.6,
      "amountHT": -10.5,
      "amountTTC": -12.6,
      "ratePercent": 5
    },
    {
      "key": "MILEAGE",
      "label": "Forfait 200 km/jour",
      "refId": null,
      "quantity": 1,
      "unitPriceHT": 0,
      "unitPriceTTC": 0,
      "amountHT": 0,
      "amountTTC": 0,
      "ratePercent": null
    },
    {
      "key": "DEDUCTIBLE",
      "label": "Franchise réduite",
      "refId": null,
      "quantity": 1,
      "unitPriceHT": 37.5,
      "unitPriceTTC": 45,
      "amountHT": 37.5,
      "amountTTC": 45,
      "ratePercent": null
    },
    {
      "key": "OPTION",
      "label": "Siège enfant",
      "refId": "6a7b8c9d-0e1f-4a2b-9c3d-5e6f70819203",
      "quantity": 1,
      "unitPriceHT": 20,
      "unitPriceTTC": 24,
      "amountHT": 20,
      "amountTTC": 24,
      "ratePercent": null
    }
  ],
  "promoCode": null,
  "currency": "EUR",
  "vatPercent": 20,
  "isVatReverseCharge": false,
  "totalHT": 257,
  "vatAmount": 51.4,
  "totalTTC": 308.4,
  "balance": {
    "totalTTC": 308.4,
    "paidAmount": 0,
    "dueAmount": 308.4,
    "overpaidAmount": 0
  },
  "notes": "Siège enfant à installer avant la remise.",
  "createdAt": "2026-11-02T09:15:02+01:00",
  "updatedAt": "2026-11-02T09:15:02+01:00"
}

effects

object

requis

Show child attributes

Organisation

Offre

Locations

Modifications

Départ et retour

Paiements

Événements

Clients

Flotte

Catalogue

Tarification

Entretien

Changer la couverture d’une location

Autorisations

En-têtes

Paramètres de chemin

Paramètres de requête

Corps

Réponse