Passer au contenu principal
PATCH
Modifier une caution

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

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.

Required string length: 1 - 255
Pattern: ^[\x20-\x7E]+$
Exemple:

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

Paramètres de chemin

depositId
string<uuid>
requis

Identifiant de la caution.

Exemple:

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

Corps

name
string

Nom affiché au client.

Required string length: 1 - 100
depositAmount
number

Montant demandé en garantie au client, rendu après la location sauf retenue décidée par le loueur. Hors total de la location et sans TVA.

method
enum<string>

Moyen par lequel la caution est garantie.

Options disponibles:
CREDIT_CARD,
CASH,
TRANSFER,
CHECK,
SWIKLY,
STRIPE,
TYLLT,
MOBILE_MONEY,
OTHER
description
string | null

Description libre ; null si absente.

Maximum string length: 500
categoryId
string<uuid> | null

Catégorie tarifaire à laquelle l’élément est réservé ; null : toutes les catégories.

Exemple:

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

isDefault
boolean

Caution retenue quand une offre omet depositId et que la franchise retenue n’a pas de caution liée active : défaut de la catégorie du véhicule, sinon défaut global. Un seul défaut par catégorie et un seul global ; un défaut est toujours actif.

isActive
boolean

false : retiré de la vente. Désactiver l’élément par défaut exige aussi isDefault: false (sinon 409 DEFAULT_ITEM_REQUIRED).

displayOrder
integer

Rang d’affichage ; ordre de la liste.

Plage requise: 0 <= x <= 2147483647

Réponse

Modifier une caution

data
object
requis
Exemple: