RentalResource

idintegerrequired

statusStatus (string)required

Possible values: [in_treatment, reserved, preparing, dispatched, delivered, ongoing, overdue, finished, canceled]

billing_statusRentalBillingStatus (string)required

Possible values: [not_billable, to_be_billed, billed]

notestring | nullnullablerequired

expected_return_datestringrequired

renter_idintegerrequired

user_idinteger | nullnullablerequired

renter object

idintegerrequired

codestring | nullnullablerequired

external_idstring | nullnullablerequired

namestringrequired

descriptionstring | nullnullablerequired

emailstring | nullnullablerequired

phonestring | nullnullablerequired

mobilestring | nullnullablerequired

company_namestring | nullnullablerequired

company_positionstring | nullnullablerequired

tags object[]

Array [

idintegerrequired

namestringrequired

colorstring | nullnullablerequired

items_countinteger

renters_countinteger

rentals_countinteger

created_atstringrequired

updated_atstringrequired

]

created_atstringrequired

updated_atstringrequired

deleted_atstringrequired

user object

idintegerrequired

namestringrequired

emailstringrequired

languagestringrequired

email_verified_atstringrequired

created_atstringrequired

updated_atstringrequired

items object[]

Array [

idintegerrequired

codestring | nullnullablerequired

external_idstring | nullnullablerequired

namestringrequired

descriptionstring | nullnullablerequired

typeTypes (string)required

Possible values: [individual, bulk, container, kit]

quantityintegerrequired

quantity_on_rentintegerrequired

minimum_quantityinteger | nullnullablerequired

low_stock_alert_enabledbooleanrequired

track_individuallybooleanrequired

reference_numberstring | nullnullablerequired

internal_numberstring | nullnullablerequired

state_notesstring | nullnullablerequired

item_type_idinteger | nullnullablerequired

warehouse_idinteger | nullnullablerequired

parent_item_idinteger | nullnullablerequired

max_capacityinteger | nullnullablerequired

tags object[]

Array [

idintegerrequired

namestringrequired

colorstring | nullnullablerequired

items_countinteger

renters_countinteger

rentals_countinteger

created_atstringrequired

updated_atstringrequired

]

item_type object

idstringrequired

namestringrequired

iconstringrequired

colorstringrequired

descriptionstringrequired

is_activestringrequired

sort_orderstringrequired

items_countinteger

created_atstringrequired

updated_atstringrequired

created_atstringrequired

updated_atstringrequired

deleted_atstringrequired

]

status_eventsstring

created_atstringrequired

updated_atstringrequired

RentalResource

{
  "id": 0,
  "status": "in_treatment",
  "billing_status": "not_billable",
  "note": "string",
  "expected_return_date": "string",
  "renter_id": 0,
  "user_id": 0,
  "renter": {
    "id": 0,
    "code": "string",
    "external_id": "string",
    "name": "string",
    "description": "string",
    "email": "string",
    "phone": "string",
    "mobile": "string",
    "company_name": "string",
    "company_position": "string",
    "tags": [
      {
        "id": 0,
        "name": "string",
        "color": "string",
        "items_count": 0,
        "renters_count": 0,
        "rentals_count": 0,
        "created_at": "string",
        "updated_at": "string"
      }
    ],
    "created_at": "string",
    "updated_at": "string",
    "deleted_at": "string"
  },
  "user": {
    "id": 0,
    "name": "string",
    "email": "string",
    "language": "string",
    "email_verified_at": "string",
    "created_at": "string",
    "updated_at": "string"
  },
  "items": [
    {
      "id": 0,
      "code": "string",
      "external_id": "string",
      "name": "string",
      "description": "string",
      "type": "individual",
      "quantity": 0,
      "quantity_on_rent": 0,
      "minimum_quantity": 0,
      "low_stock_alert_enabled": true,
      "track_individually": true,
      "reference_number": "string",
      "internal_number": "string",
      "state_notes": "string",
      "item_type_id": 0,
      "warehouse_id": 0,
      "parent_item_id": 0,
      "max_capacity": 0,
      "tags": [
        {
          "id": 0,
          "name": "string",
          "color": "string",
          "items_count": 0,
          "renters_count": 0,
          "rentals_count": 0,
          "created_at": "string",
          "updated_at": "string"
        }
      ],
      "item_type": {
        "id": "string",
        "name": "string",
        "icon": "string",
        "color": "string",
        "description": "string",
        "is_active": "string",
        "sort_order": "string",
        "items_count": 0,
        "created_at": "string",
        "updated_at": "string"
      },
      "created_at": "string",
      "updated_at": "string",
      "deleted_at": "string"
    }
  ],
  "status_events": "string",
  "created_at": "string",
  "updated_at": "string"
}