Handovers

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

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 record
  • handoverId - Human-readable handover number (organization prefix followed by 10 digits)
  • organizationId - A unique identifier for the organization the handover belongs to
  • rentalId - 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) or hand_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, accepted or rejected
  • pdfMediaId - A unique identifier for the generated PDF report (nullable)
  • pdfMedia - The generated PDF report with its download url (nullable). Returned only on Get Handover by ID
  • endDate - Date the handover was completed in ISO 8601 format (nullable)
  • giver - Person who handed the items over (nullable). email is nullable
  • receiver - Person who received the items (nullable). email is nullable
  • transporter - 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 order
    • entityId - A unique identifier for the item. Depending on entityType:
      equipment use an ID from Get Equipments
      inventory use an ID from Get Inventories
    • entityType - One of: equipment, inventory
    • bookingId - 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 format
  • updatedAt - Last update date in ISO 8601 format