Retrieve handover records — completed hand-in and hand-out protocols for equipment and inventory, including the involved persons and the generated PDF report
Available Operations
- GET
/handovers- List all handovers - GET
/handovers/{id}- Get handover by ID
Handover Entity
{
"id": "string",
"handoverId": "string",
"organizationId": "uuid",
"rentalId": "uuid",
"handType": "hand_in | hand_out",
"endCustomerType": "here | not_here",
"status": "pending | accepted | rejected",
"pdfMediaId": "uuid",
"pdfMedia": { "id": "uuid", "url": "string" },
"endDate": "date-time",
"giver": {
"id": "uuid",
"firstName": "string",
"lastName": "string",
"email": "string"
},
"receiver": {
"id": "uuid",
"firstName": "string",
"lastName": "string",
"email": "string"
},
"transporter": {
"id": "uuid",
"firstName": "string",
"lastName": "string"
},
"items": [
{
"entityId": "uuid",
"entityType": "equipment | inventory",
"bookingId": "uuid"
}
],
"warehouseReturn": {
"id": "uuid",
"quantity": "number",
"isPartial": "boolean",
"warehouseId": "uuid",
"createdAt": "date-time"
},
"createdAt": "date-time",
"updatedAt": "date-time"
}Field Descriptions:
id- A unique identifier for the handover recordhandoverId- Human-readable handover number (organization prefix followed by 10 digits)organizationId- A unique identifier for the organization the handover belongs torentalId- A unique identifier for the contract the handover was started from (see Get Contracts)handType- Direction of the handover:hand_out(handed to the customer) orhand_in(returned by the customer)endCustomerType- Whether the end customer was present at the handover (here) or the items were handed over through a transporter (not_here)status- Approval status of the handover:pending,acceptedorrejectedpdfMediaId- A unique identifier for the generated PDF report (nullable)pdfMedia- The generated PDF report with its downloadurl(nullable). Returned only on Get Handover by IDendDate- Date the handover was completed in ISO 8601 format (nullable)giver- Person who handed the items over (nullable).emailis nullablereceiver- Person who received the items (nullable).emailis nullabletransporter- Person who transported the items when the end customer was not present (nullable)items- Array of equipment or inventory items covered by the handover, in protocol orderentityId- A unique identifier for the item. Depending onentityType:
equipmentuse an ID from Get Equipments
inventoryuse an ID from Get InventoriesentityType- One of:equipment,inventorybookingId- A unique identifier for the booking the item belongs to (see Get Bookings) (nullable)
warehouseReturn- Warehouse return details for returned inventory (nullable, deprecated)createdAt- Creation date in ISO 8601 formatupdatedAt- Last update date in ISO 8601 format