Passer au contenu principal
POST
Créer une franchise

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"

Corps

application/json
name
string
requis

Nom affiché au client.

Required string length: 1 - 100
excessAmount
number
requis

Montant laissé à la charge du client en cas de sinistre. Hors total de la location et sans TVA : il n’est pas facturé.

price
object
requis

Prix HT de cette franchise (son rachat) pour le client.

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"

linkedDepositId
string<uuid> | null

Caution retenue avec cette franchise quand une offre omet depositId ; null : aucune. À l’écriture : caution active, globale ou de la catégorie de la franchise (sinon 422 REFERENCE_INACTIVE).

Exemple:

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

isDefault
boolean

Franchise retenue quand une offre omet deductibleId : défaut de la catégorie du véhicule, sinon défaut global. Un seul défaut par catégorie et un seul global ; en désigner un autre retire ce statut à l’ancien. 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).

Réponse

Créer une franchise

data
object
requis
Exemple: