Skip to main content
GET
Error

Authorizations

Authorization
string
header
required

Authorization: Bearer <token>. 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.

Path Parameters

rentalId
string
required
Minimum string length: 1

Response

The rental; settlement is absent until it has been returned.

The rental; settlement is absent until it has been returned.

id
string
required
skuId
string
required
customerId
string
required
storeId
string
required
period
object
required
days
required
Available options:
1
ratePerDayCents
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
depositAmountCents
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
depositReference
string
required
status
enum<string>
required
Available options:
active,
returned,
overdue
actorId
string
required
rentedAt
string
required
settlement
object