> ## Documentation Index > Fetch the complete documentation index at: https://docs-pos.solya.app/llms.txt > Use this file to discover all available pages before exploring further. # Open a rental > Opens a rental in the `active` state: the unit leaves the store with the customer until `dueAt`, which the server DERIVES as `startAt + days` (do not send it). `days` is one of the four offered tiers — 1, 3, 7 or 14 — and no other value is accepted. MONEY, read carefully: this endpoint moves NONE. `depositAmountCents` / `depositReference` merely RECORD a caution the payment terminal has already pre-authorised (the money is HELD on the customer's card, not captured), and the rental fee itself (`ratePerDayCents x days`) is NOT charged here or by any other endpoint in this API — take it at the till. Never call this before the pre-auth actually exists; you would open an unsecured rental. `id` is CALLER-SUPPLIED and is the dedup key: if your call times out, retry with the SAME id — a 409 CONFLICT then means your first attempt committed, so read it back with `getRental` instead of minting a new id. The duplicate-id check runs FIRST, so an existing id returns 409 even when the window is also invalid — you will not see the 422 until the id is unique. 422 when the derived `dueAt` is not in the future (a stale `startAt`, or a window that has already elapsed); 400 on a bad tier, a non-hex `skuId` or a non-positive amount. ## OpenAPI ````yaml /openapi.json post /v1/rentals openapi: 3.0.3 info: title: Solya POS API version: 1.0.0 description: >- The Solya POS backend HTTP surface. Every documented operation is agent-ready: it carries an `operationId`, an agent-facing `description`, the `pos.*` scopes it enforces (`x-required-permissions`) and an `x-agent-tier`. Success responses return the payload as raw JSON; failures return the `ErrorResponse` envelope (`{ error: { code, message, statusCode } }`). servers: - url: / description: The backend, relative to its deployed origin. security: [] paths: /v1/rentals: post: tags: - Rentals summary: Open a rental description: >- Opens a rental in the `active` state: the unit leaves the store with the customer until `dueAt`, which the server DERIVES as `startAt + days` (do not send it). `days` is one of the four offered tiers — 1, 3, 7 or 14 — and no other value is accepted. MONEY, read carefully: this endpoint moves NONE. `depositAmountCents` / `depositReference` merely RECORD a caution the payment terminal has already pre-authorised (the money is HELD on the customer's card, not captured), and the rental fee itself (`ratePerDayCents x days`) is NOT charged here or by any other endpoint in this API — take it at the till. Never call this before the pre-auth actually exists; you would open an unsecured rental. `id` is CALLER-SUPPLIED and is the dedup key: if your call times out, retry with the SAME id — a 409 CONFLICT then means your first attempt committed, so read it back with `getRental` instead of minting a new id. The duplicate-id check runs FIRST, so an existing id returns 409 even when the window is also invalid — you will not see the 422 until the id is unique. 422 when the derived `dueAt` is not in the future (a stale `startAt`, or a window that has already elapsed); 400 on a bad tier, a non-hex `skuId` or a non-positive amount. operationId: createRental requestBody: required: true content: application/json: schema: type: object properties: id: type: string minLength: 1 skuId: type: string pattern: ^[0-9a-f]{64}$ customerId: type: string minLength: 1 storeId: type: string minLength: 1 startAt: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$ days: anyOf: - type: number enum: - 1 - type: number enum: - 3 - type: number enum: - 7 - type: number enum: - 14 ratePerDayCents: type: integer minimum: 0 exclusiveMinimum: true maximum: 9007199254740991 depositAmountCents: type: integer minimum: 0 exclusiveMinimum: true maximum: 9007199254740991 depositReference: type: string minLength: 1 required: - id - skuId - customerId - storeId - startAt - days - ratePerDayCents - depositAmountCents - depositReference example: id: rnt-2030-000184 skuId: >- 6b1f0c93a4d7e28150c3af6b9d24e70f8a5c1b3e6d90f27a4c8b5e1d3f7a9c02 customerId: cust-1 storeId: shop-1 startAt: '2030-01-01T09:00:00.000Z' days: 3 ratePerDayCents: 640 depositAmountCents: 4000 depositReference: PREAUTH-4821 responses: '201': description: >- The opened rental: `active`, `dueAt` derived from `startAt + days`, no `settlement` yet, attributed to the calling actor. content: application/json: schema: type: object properties: id: type: string skuId: type: string customerId: type: string storeId: type: string period: type: object properties: startAt: type: string dueAt: type: string required: - startAt - dueAt additionalProperties: false days: anyOf: - type: number enum: - 1 - type: number enum: - 3 - type: number enum: - 7 - type: number enum: - 14 ratePerDayCents: type: integer minimum: -9007199254740991 maximum: 9007199254740991 depositAmountCents: type: integer minimum: -9007199254740991 maximum: 9007199254740991 depositReference: type: string status: type: string enum: - active - returned - overdue settlement: type: object properties: returnedAt: type: string condition: type: string enum: - conforme - dommage lateFeeCents: type: integer minimum: -9007199254740991 maximum: 9007199254740991 damageRetentionCents: type: integer minimum: -9007199254740991 maximum: 9007199254740991 releasedDepositCents: type: integer minimum: -9007199254740991 maximum: 9007199254740991 required: - returnedAt - condition - lateFeeCents - damageRetentionCents - releasedDepositCents additionalProperties: false actorId: type: string rentedAt: type: string required: - id - skuId - customerId - storeId - period - days - ratePerDayCents - depositAmountCents - depositReference - status - actorId - rentedAt additionalProperties: false description: >- The opened rental: `active`, `dueAt` derived from `startAt + days`, no `settlement` yet, attributed to the calling actor. example: id: rnt-2030-000184 skuId: >- 6b1f0c93a4d7e28150c3af6b9d24e70f8a5c1b3e6d90f27a4c8b5e1d3f7a9c02 customerId: cust-1 storeId: shop-1 period: startAt: '2030-01-01T09:00:00.000Z' dueAt: '2030-01-04T09:00:00.000Z' days: 3 ratePerDayCents: 640 depositAmountCents: 4000 depositReference: PREAUTH-4821 status: active actorId: user-associate-1 rentedAt: '2030-01-01T09:00:00.000Z' '400': description: >- The request failed schema validation; `error.fieldErrors` lists the fields. content: application/json: schema: $ref: '#/components/schemas/ValidationErrorResponse' '401': description: No valid credential was presented — send a bearer token. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: The actor is authenticated but lacks the required `pos.*` scope. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '409': description: >- The request conflicts with current state (duplicate id or stale version). content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '422': description: The request is well-formed but violates a domain rule. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '500': description: An unexpected server error — safe to retry idempotent requests. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - bearerAuth: [] components: schemas: ValidationErrorResponse: type: object required: - error additionalProperties: false description: >- A `VALIDATION_FAILED` envelope carrying the offending fields in `fieldErrors`. properties: error: type: object required: - code - message - statusCode additionalProperties: false properties: code: type: string enum: - VALIDATION_FAILED message: type: string statusCode: type: integer fieldErrors: type: array description: >- One entry per rejected field: the field path and why it was rejected. items: type: object required: - field - message additionalProperties: false properties: field: type: string description: Dot-path of the offending field. message: type: string description: Why the field was rejected. ErrorResponse: type: object required: - error additionalProperties: false description: The uniform failure envelope every non-2xx response returns. properties: error: type: object required: - code - message - statusCode additionalProperties: false properties: code: type: string enum: - VALIDATION_FAILED - UNAUTHORIZED - FORBIDDEN - NOT_FOUND - CONFLICT - BUSINESS_RULE_VIOLATION - INTERNAL_ERROR description: >- Machine-readable kernel `ResultCode` — branch on this, not on `message`. message: type: string description: >- Human-readable explanation. Safe to surface; never leaks server internals. statusCode: type: integer description: >- The HTTP status, mirrored into the body so a client need not read headers. securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: >- `Authorization: Bearer `. Accepts EITHER a Keycloak access token (scopes-in-token) OR an opaque POS session token; both resolve to the same `pos.*` scope vocabulary the route guards enforce. ````