Skip to content
.seventhings.com

Prefill your credentials

Fill in your non-secret values to have them appear in the examples below. Stored locally in your browser.

Create a new Rental Case

POST
/customer-api/v1/rental-management/rental-case
curl --request POST \
--url https://your-instance.seventhings.com/customer-api/v1/rental-management/rental-case \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "status": "requested", "title": "Rent the printer.", "references": [ { "type": "asset", "uuid": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11" } ], "issue_date": "2025-04-23", "issue_date_reminder": { "unit": "days", "value": 2 }, "due_date": "2025-04-23", "due_date_reminder": { "unit": "days", "value": 2 }, "responsible_user_uuid": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11", "renter": { "type": "plain", "value": "example" }, "comment": "The printer is running low on ink.", "attachments": [ "7d8296ad-da7c-45f7-b676-9220b3a9d4dc" ] }'

Create a new Rental Case.

Rental Case to be created

Media typeapplication/json

The payload for creating a new rental case.

object
status

The status of the rental case.

string
Allowed values: requested confirmed borrowed rejected completed return_overdue pickup_overdue
title
required

The title of the rental case.

string
Example
Rent the printer.
references
required
Array<object>
>= 1 items <= 100 items

The reference of the rental case.

object
type
required

The type of the referenced object.

string
Allowed values: asset
Example
asset
uuid
required

The UUID of the referenced object.

string format: uuid
Example
a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11
name

Display name of the referenced object.

string
Example
Asset name (asset barcode)
id

The id of the referenced object.

integer
Example
1
issue_date
required

The start of the rental case.

string format: date
Example
2025-04-23
issue_date_reminder

The amount of time to send a reminder.

object
unit
required

The unit of the time interval.

string
Allowed values: days weeks months years
Example
weeks
value
required

The value of the time interval.

integer
Example
2
due_date
required

The start of the rental case.

string format: date
Example
2025-04-23
due_date_reminder
object
unit
required

The unit of the time interval.

string
Allowed values: days weeks months years
Example
weeks
value
required

The value of the time interval.

integer
Example
2
responsible_user_uuid
required

The uuid of the responsible user.

string format: uuid
Example
a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11
renter

The renter.

object
type
required

The type of the renter.

string
Allowed values: plain user
Example
plain
value
required

The value of the renter. In case of a user the uuid is given.

string
comment

A comment that is displayed in the rental case details.

string
nullable
Example
The printer is running low on ink.
attachments
required
Array<string>
0

Success

Location
string

Location of the newly created Rental Case

Location-UUID
uuid

The UUID of the newly created object.

Request body is missing or invalid or request data is invalid.

Access token is missing or invalid.

You are not permitted to perform the requested operation.

Internal Server Error.