> ## Documentation Index > Fetch the complete documentation index at: https://docs.lexio.rent/llms.txt > Use this file to discover all available pages before exploring further. # Lister les avenants d’une location > **Accès** : `rentals.read` Liste les avenants d’une location, quel que soit leur statut, du plus récent au plus ancien (`createdAt` décroissant, puis `id`). - Les montants sont les totaux de la location avant et après l’avenant. Tant que la signature est en attente (`PENDING`, `SENT`, `VIEWED`), `newTotalHT` et `newTotalTTC` suivent le total à jour de la location ; ensuite ils sont figés (pour `SIGNED`, ceux signés par le client). - `document` est une URL signée valable une heure. Les données de signature ne sont jamais exposées. Une clé partenaire ne lit que les locations de son `partnerCode` : toute autre répond 404. ## OpenAPI ````yaml /openapi.json get /rentals/{rentalId}/amendments openapi: 3.1.0 info: title: API Lexio version: 1.0.1 description: >- # API Lexio v1 L’API Lexio permet à un loueur de véhicules, ou à une plateforme partenaire autorisée par lui, de chiffrer, réserver, suivre et administrer ses locations depuis un serveur. Chaque appel agit sur l’organisation Lexio d’un seul loueur. - **Adresse de base** : `https://api.lexio.rent/api/external/v1` - **Authentification** : `Authorization: Bearer lck_…`, une clé créée par le loueur dans Lexio. - **Format** : JSON en UTF-8 ; erreurs RFC 9457 avec un `code` stable. - **Spécification OpenAPI 3.1** : [https://docs.lexio.rent/openapi.json](https://docs.lexio.rent/openapi.json), à importer dans votre client HTTP ou à utiliser pour générer un client. - **Contact** (support technique, demande d’accès, organisation de test) : contact@lexio.rent. Vocabulaire : une **location** (`/rentals`) est un contrat de location d’un véhicule ; un **lieu** (`/locations`) est une adresse de départ ou de retour. ## Guides 1. [Démarrage rapide](https://docs.lexio.rent/demarrage-rapide) : de la recherche d’un véhicule à l’annulation. 2. [Authentification et scopes](https://docs.lexio.rent/authentification) : clés du loueur et clés partenaires, scopes, plans. 3. [Montants et TVA](https://docs.lexio.rent/montants-et-tva) : HT, TTC, devises, caution et franchise. 4. [Cycle de vie d’une location](https://docs.lexio.rent/cycle-de-vie) : statuts et actions possibles. 5. [Limites de débit](https://docs.lexio.rent/limites), [Pagination](https://docs.lexio.rent/pagination), [Idempotence et reprise](https://docs.lexio.rent/idempotence). 6. [Synchronisation par événements](https://docs.lexio.rent/synchronisation) : suivre les changements sans webhook. 7. [Versions et évolutions](https://docs.lexio.rent/versions), [Erreurs](https://docs.lexio.rent/erreurs). 8. [Intégration d’une plateforme de réservation](https://docs.lexio.rent/integration-broker) : parcours partenaire, paiement. 9. [Ce qui se gère dans Lexio](https://docs.lexio.rent/ce-qui-se-gere-dans-lexio) et [Historique des versions](https://docs.lexio.rent/historique). contact: name: Support Lexio email: contact@lexio.rent url: https://docs.lexio.rent servers: - url: https://api.lexio.rent/api/external/v1 description: Production security: - ApiKey: [] tags: - name: Organisation description: >- Réglages de l’organisation liée à la clé : devise, fuseau, TVA, horaires, règles de réservation. - name: Offre description: >- Disponibilités et devis : ce qui est réservable, à quel prix, avant de créer une location. - name: Locations description: >- Les contrats de location : création, lecture, modification de notes, suppression. - name: Modifications description: >- Changer les dates, le véhicule, la protection, le titulaire ou les options d’une location, ou l’annuler. - name: Départ et retour description: >- Remise des clés et retour du véhicule : kilométrage, carburant, photos, état des lieux. - name: Paiements description: Encaissements, cautions et remboursements enregistrés sur une location. - name: Événements description: >- Flux des changements à relire pour synchroniser votre système, sans webhook. - name: Clients description: Fiches des clients particuliers et entreprises. - name: Flotte description: Véhicules, leur archivage et leurs indisponibilités. - name: Catalogue description: >- Catégories, lieux, options, franchises, cautions et forfaits kilométriques proposés à la location. - name: Tarification description: Saisons, remises de durée, paliers de délai et réglages de prix. - name: Entretien description: Alertes et historique d’entretien des véhicules. paths: /rentals/{rentalId}/amendments: get: tags: - Modifications summary: Lister les avenants d’une location description: >- **Accès** : `rentals.read` Liste les avenants d’une location, quel que soit leur statut, du plus récent au plus ancien (`createdAt` décroissant, puis `id`). - Les montants sont les totaux de la location avant et après l’avenant. Tant que la signature est en attente (`PENDING`, `SENT`, `VIEWED`), `newTotalHT` et `newTotalTTC` suivent le total à jour de la location ; ensuite ils sont figés (pour `SIGNED`, ceux signés par le client). - `document` est une URL signée valable une heure. Les données de signature ne sont jamais exposées. Une clé partenaire ne lit que les locations de son `partnerCode` : toute autre répond 404. operationId: listRentalAmendments parameters: - in: path name: rentalId schema: examples: - 9c2d7e4a-5b1f-4d3c-8a6e-0f1b2c3d4e5f type: string format: uuid required: true description: Identifiant de la location. - in: query name: limit schema: type: integer minimum: 1 maximum: 100 default: 50 description: Taille de la page, de 1 à 100 ; 50 par défaut. - in: query name: cursor schema: type: string minLength: 1 maxLength: 4096 description: >- Valeur `nextCursor` de la page précédente ; omis pour la première page. responses: '200': description: Lister les avenants d’une location headers: X-Request-Id: $ref: '#/components/headers/XRequestId' RateLimit-Limit: $ref: '#/components/headers/RateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/RateLimitRemaining' RateLimit-Reset: $ref: '#/components/headers/RateLimitReset' content: application/json: schema: type: object properties: data: maxItems: 100 type: array items: $ref: '#/components/schemas/Amendment' nextCursor: description: >- Curseur de la page suivante, à passer tel quel en `cursor` ; null en fin de liste. Voir [Pagination](https://docs.lexio.rent/pagination). examples: - eyJpZCI6IjljMmQ3ZTRhIn0 anyOf: - type: string minLength: 1 - type: 'null' required: - data - nextCursor '400': description: '`VALIDATION_FAILED`' headers: X-Request-Id: $ref: '#/components/headers/XRequestId' RateLimit-Limit: $ref: '#/components/headers/RateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/RateLimitRemaining' RateLimit-Reset: $ref: '#/components/headers/RateLimitReset' content: application/problem+json: schema: $ref: '#/components/schemas/ValidationFailedProblem' '401': description: >- `API_KEY_DISABLED`, `API_KEY_EXPIRED`, `API_KEY_INVALID`, `API_KEY_MISSING`, `API_KEY_REVOKED` headers: X-Request-Id: $ref: '#/components/headers/XRequestId' RateLimit-Limit: $ref: '#/components/headers/RateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/RateLimitRemaining' RateLimit-Reset: $ref: '#/components/headers/RateLimitReset' WWW-Authenticate: $ref: '#/components/headers/WwwAuthenticate' content: application/problem+json: schema: oneOf: - $ref: '#/components/schemas/ApiKeyDisabledProblem' - $ref: '#/components/schemas/ApiKeyExpiredProblem' - $ref: '#/components/schemas/ApiKeyInvalidProblem' - $ref: '#/components/schemas/ApiKeyMissingProblem' - $ref: '#/components/schemas/ApiKeyRevokedProblem' '403': description: >- `FEATURE_NOT_AVAILABLE`, `INSUFFICIENT_SCOPE`, `ORGANIZATION_SUSPENDED` headers: X-Request-Id: $ref: '#/components/headers/XRequestId' RateLimit-Limit: $ref: '#/components/headers/RateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/RateLimitRemaining' RateLimit-Reset: $ref: '#/components/headers/RateLimitReset' content: application/problem+json: schema: oneOf: - $ref: '#/components/schemas/FeatureNotAvailableProblem' - $ref: '#/components/schemas/InsufficientScopeProblem' - $ref: '#/components/schemas/OrganizationSuspendedProblem' '404': description: '`NOT_FOUND`' headers: X-Request-Id: $ref: '#/components/headers/XRequestId' RateLimit-Limit: $ref: '#/components/headers/RateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/RateLimitRemaining' RateLimit-Reset: $ref: '#/components/headers/RateLimitReset' content: application/problem+json: schema: $ref: '#/components/schemas/NotFoundProblem' '429': description: '`RATE_LIMITED`' headers: X-Request-Id: $ref: '#/components/headers/XRequestId' RateLimit-Limit: $ref: '#/components/headers/RateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/RateLimitRemaining' RateLimit-Reset: $ref: '#/components/headers/RateLimitReset' Retry-After: $ref: '#/components/headers/RetryAfter' content: application/problem+json: schema: $ref: '#/components/schemas/RateLimitedProblem' '500': description: '`INTERNAL_ERROR`' headers: X-Request-Id: $ref: '#/components/headers/XRequestId' RateLimit-Limit: $ref: '#/components/headers/RateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/RateLimitRemaining' RateLimit-Reset: $ref: '#/components/headers/RateLimitReset' content: application/problem+json: schema: $ref: '#/components/schemas/InternalErrorProblem' '503': description: '`SERVICE_UNAVAILABLE`' headers: X-Request-Id: $ref: '#/components/headers/XRequestId' RateLimit-Limit: $ref: '#/components/headers/RateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/RateLimitRemaining' RateLimit-Reset: $ref: '#/components/headers/RateLimitReset' Retry-After: $ref: '#/components/headers/RetryAfter' content: application/problem+json: schema: $ref: '#/components/schemas/ServiceUnavailableProblem' security: - ApiKey: [] components: headers: XRequestId: description: Identifiant de la requête, à communiquer au support. schema: type: string RateLimitLimit: description: Plafond du seau de débit qui s’applique à la requête. schema: type: integer minimum: 0 RateLimitRemaining: description: Requêtes encore permises dans la fenêtre en cours. schema: type: integer minimum: 0 RateLimitReset: description: Secondes avant la remise à zéro de la fenêtre. schema: type: integer minimum: 0 WwwAuthenticate: description: >- Schéma d’authentification attendu (`Bearer`), avec `error="invalid_token"` pour une clé refusée. schema: type: string RetryAfter: description: Secondes à attendre avant de rejouer la requête. schema: type: integer minimum: 0 schemas: Amendment: examples: - id: f6b8d0e2-4a5c-4e7a-9b1d-3f5a7c9e1b4d rentalId: a1c3e5f7-2b4d-4f6a-8c0e-1d3f5b7d9e2a number: AVT-LOC-2026.11-0042-001 status: SIGNED changeType: DATE_EXTENSION changedFields: - END_AT - TOTAL previousTotalHT: 175 previousTotalTTC: 210 newTotalHT: 210 newTotalTTC: 252 differenceHT: 35 differenceTTC: 42 currency: EUR createdAt: '2026-11-14T09:12:40+01:00' sentAt: '2026-11-14T09:12:41+01:00' signedAt: '2026-11-14T09:30:05+01:00' signatureExpiresAt: '2026-11-21T09:12:41+01:00' document: url: https://storage.lexio.rent/d/f6b8d0e2?sig=7c3a expiresAt: '2026-11-14T10:30:05+01:00' type: object properties: id: examples: - 7c9e6679-7425-40de-944b-e07fc1f90ae7 description: Identifiant de l’avenant. type: string format: uuid rentalId: examples: - 7c9e6679-7425-40de-944b-e07fc1f90ae7 description: Location concernée (`GET /rentals/{rentalId}`). type: string format: uuid number: description: Numéro de l’avenant, dérivé de celui de la location. type: string status: description: >- `PENDING`, `SENT`, `VIEWED` : signature du client en attente. `SIGNED`, `DECLINED`, `EXPIRED`, `CANCELLED` : définitifs. type: string enum: - PENDING - SENT - VIEWED - SIGNED - EXPIRED - DECLINED - CANCELLED changeType: description: Nature principale de la modification. type: string enum: - DATE_EXTENSION - DATE_REDUCTION - VEHICLE_CHANGE - PRICE_ADJUSTMENT - OPTIONS_CHANGE - DRIVER_CHANGE - MILEAGE_CHANGE - DEDUCTIBLE_CHANGE - DEPOSIT_CHANGE - RENT_CHANGE - MULTIPLE changedFields: description: Éléments de la location modifiés, sans doublon. maxItems: 12 type: array items: type: string enum: - START_AT - END_AT - VEHICLE - TOTAL - MONTHLY_RENT - MILEAGE - OPTIONS - DRIVERS - PICKUP_LOCATION - RETURN_LOCATION - DEDUCTIBLE - DEPOSIT previousTotalHT: description: Total HT de la location avant l’avenant. type: number previousTotalTTC: description: Total TTC avant l’avenant. type: number newTotalHT: description: >- Total HT après l’avenant ; suit la location tant que la signature est en attente. type: number newTotalTTC: description: Total TTC après l’avenant. type: number differenceHT: description: '`newTotalHT` − `previousTotalHT`, signé.' type: number differenceTTC: description: '`newTotalTTC` − `previousTotalTTC`, signé.' type: number currency: description: Devise de la location (ISO 4217). examples: - EUR type: string enum: - EUR - XPF - CHF - CAD - GBP - USD - XOF createdAt: examples: - '2026-11-10T10:00:00+01:00' description: Création, heure de l’agence avec décalage. type: string format: date-time sentAt: description: Envoi au client pour signature ; null tant qu’il n’est pas envoyé. anyOf: - examples: - '2026-11-10T10:00:00+01:00' type: string format: date-time - type: 'null' signedAt: description: Signature ; null si non signé. anyOf: - examples: - '2026-11-10T10:00:00+01:00' type: string format: date-time - type: 'null' signatureExpiresAt: description: Échéance de la demande de signature ; null sans demande. anyOf: - examples: - '2026-11-10T10:00:00+01:00' type: string format: date-time - type: 'null' document: description: >- PDF signé s’il existe, sinon PDF de l’avenant, URL signée valable une heure, à ne pas stocker ; null sans PDF. anyOf: - $ref: '#/components/schemas/SignedDocument' - type: 'null' required: - id - rentalId - number - status - changeType - changedFields - previousTotalHT - previousTotalTTC - newTotalHT - newTotalTTC - differenceHT - differenceTTC - currency - createdAt - sentAt - signedAt - signatureExpiresAt - document ValidationFailedProblem: type: object properties: type: type: string const: https://api.lexio.rent/errors/validation-failed title: type: string const: Requête invalide status: type: number const: 400 code: type: string const: VALIDATION_FAILED detail: type: string instance: type: string requestId: type: string errors: minItems: 1 maxItems: 100 type: array items: type: object properties: pointer: type: string code: type: string enum: - required - invalid_type - invalid_format - invalid_value - too_small - too_big - too_many_decimals - out_of_range - unknown_field - null_not_allowed - empty_string - empty_patch - mutually_exclusive - not_applicable - duplicate - end_before_start - date_in_past - nonexistent_local_time - offset_not_allowed - offset_required - upload_expired - upload_incomplete - upload_conflict detail: type: string required: - pointer - code - detail required: - type - title - status - code - detail - instance - requestId - errors ApiKeyDisabledProblem: type: object properties: type: type: string const: https://api.lexio.rent/errors/api-key-disabled title: type: string const: Clé API désactivée status: type: number const: 401 code: type: string const: API_KEY_DISABLED detail: type: string instance: type: string requestId: type: string required: - type - title - status - code - detail - instance - requestId ApiKeyExpiredProblem: type: object properties: type: type: string const: https://api.lexio.rent/errors/api-key-expired title: type: string const: Clé API expirée status: type: number const: 401 code: type: string const: API_KEY_EXPIRED detail: type: string instance: type: string requestId: type: string required: - type - title - status - code - detail - instance - requestId ApiKeyInvalidProblem: type: object properties: type: type: string const: https://api.lexio.rent/errors/api-key-invalid title: type: string const: Clé API invalide status: type: number const: 401 code: type: string const: API_KEY_INVALID detail: type: string instance: type: string requestId: type: string required: - type - title - status - code - detail - instance - requestId ApiKeyMissingProblem: type: object properties: type: type: string const: https://api.lexio.rent/errors/api-key-missing title: type: string const: Clé API absente status: type: number const: 401 code: type: string const: API_KEY_MISSING detail: type: string instance: type: string requestId: type: string required: - type - title - status - code - detail - instance - requestId ApiKeyRevokedProblem: type: object properties: type: type: string const: https://api.lexio.rent/errors/api-key-revoked title: type: string const: Clé API révoquée status: type: number const: 401 code: type: string const: API_KEY_REVOKED detail: type: string instance: type: string requestId: type: string required: - type - title - status - code - detail - instance - requestId FeatureNotAvailableProblem: type: object properties: type: type: string const: https://api.lexio.rent/errors/feature-not-available title: type: string const: Fonctionnalité non incluse status: type: number const: 403 code: type: string const: FEATURE_NOT_AVAILABLE detail: type: string instance: type: string requestId: type: string feature: type: string minLength: 1 required: - type - title - status - code - detail - instance - requestId - feature InsufficientScopeProblem: type: object properties: type: type: string const: https://api.lexio.rent/errors/insufficient-scope title: type: string const: Scope insuffisant status: type: number const: 403 code: type: string const: INSUFFICIENT_SCOPE detail: type: string instance: type: string requestId: type: string requiredScopes: minItems: 1 maxItems: 20 type: array items: type: string enum: - offers.read - quotes.write - rentals.read - rentals.write - rentals.operate - rentals.delete - payments.write - payments.refund - customers.read - customers.write - customers.delete - vehicles.read - vehicles.write - vehicles.delete - catalog.read - catalog.write - pricing.read - pricing.write - maintenance.read - maintenance.write required: - type - title - status - code - detail - instance - requestId - requiredScopes OrganizationSuspendedProblem: type: object properties: type: type: string const: https://api.lexio.rent/errors/organization-suspended title: type: string const: Organisation suspendue status: type: number const: 403 code: type: string const: ORGANIZATION_SUSPENDED detail: type: string instance: type: string requestId: type: string required: - type - title - status - code - detail - instance - requestId NotFoundProblem: type: object properties: type: type: string const: https://api.lexio.rent/errors/not-found title: type: string const: Ressource introuvable status: type: number const: 404 code: type: string const: NOT_FOUND detail: type: string instance: type: string requestId: type: string resource: type: string enum: - RENTAL - RENTAL_OPTION - QUOTE - PAYMENT - INVOICE - PHOTO - AMENDMENT - INSPECTION - CUSTOMER - VEHICLE - VEHICLE_BLOCK - CATEGORY - OPTION - DEDUCTIBLE - DEPOSIT - MILEAGE_PACKAGE - LOCATION - SEASON - SEASON_CALENDAR_MONTH - DURATION_DISCOUNT - LEAD_TIME_TIER - MAINTENANCE_RECORD - MAINTENANCE_OPERATION required: - type - title - status - code - detail - instance - requestId - resource RateLimitedProblem: type: object properties: type: type: string const: https://api.lexio.rent/errors/rate-limited title: type: string const: Trop de requêtes status: type: number const: 429 code: type: string const: RATE_LIMITED detail: type: string instance: type: string requestId: type: string limit: type: string enum: - PRE_AUTH - PER_KEY - WRITE - QUOTE windowSeconds: type: integer minimum: 1 retryAfter: type: integer minimum: 0 required: - type - title - status - code - detail - instance - requestId - limit - windowSeconds - retryAfter InternalErrorProblem: type: object properties: type: type: string const: https://api.lexio.rent/errors/internal-error title: type: string const: Erreur interne status: type: number const: 500 code: type: string const: INTERNAL_ERROR detail: type: string instance: type: string requestId: type: string required: - type - title - status - code - detail - instance - requestId ServiceUnavailableProblem: type: object properties: type: type: string const: https://api.lexio.rent/errors/service-unavailable title: type: string const: Service momentanément indisponible status: type: number const: 503 code: type: string const: SERVICE_UNAVAILABLE detail: type: string instance: type: string requestId: type: string dependency: type: string enum: - PAYMENT_PROVIDER - FILE_STORAGE - ACCOUNTING - EMAIL required: - type - title - status - code - detail - instance - requestId - dependency SignedDocument: description: Fichier téléchargeable par une adresse signée et temporaire. examples: - url: >- https://storage.example.com/contrats/LOC-2026.11-0042.pdf?signature=9b2e41c7 expiresAt: '2026-11-10T11:12:00+01:00' type: object properties: url: description: >- Adresse signée et temporaire du fichier : ne la conservez pas, relisez la ressource pour en obtenir une nouvelle. type: string format: uri expiresAt: examples: - '2026-11-10T10:00:00+01:00' description: Instant où l’adresse cesse d’être valable. type: string format: date-time required: - url - expiresAt securitySchemes: ApiKey: type: http scheme: bearer bearerFormat: lck_… description: >- Clé API `lck_…` créée dans Lexio (Paramètres → Développeur), envoyée en `Authorization: Bearer`. Voir [Authentification](https://docs.lexio.rent/authentification). ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.