FairePlace Property Management API

Inventory

Endpointhttps://api.faireplace.com/api

Inventory management

List all inventory items

GET

https://api.faireplace.com/api

/inventory/items

Retrieves the list of all inventory items with pagination and filters

List all inventory items › query Parameters

page

integer · min: 1

Page number (default: 1)

Default: 1

limit

integer · min: 1 · max: 100

Number of items per page (default: 20, max: 100)

Default: 20

condition_status

string · enum

Filter by condition

Condition state of an inventory item

Enum values:

EXCELLENT

GOOD

FAIR

POOR

DAMAGED

NEEDS_REPAIR

BROKEN

MISSING

Example: GOOD

List all inventory items › Responses

Inventory items list retrieved successfully

object[]

Complete inventory item

id

string · uuid · required

Unique identifier of the inventory item

Example: 550e8400-e29b-41d4-a716-446655440000

inventory_type_id

string · uuid · required

Inventory type ID

Example: 550e8400-e29b-41d4-a716-446655440001

name

string · maxLength: 255 · required

Specific name of the item

Example: Samsung Refrigerator

quantity

integer · min: 1 · required

Quantity of items

Example: 1

unit

string · maxLength: 20 · required

Unit of measurement

Example: piece

condition_status

string · enum · required

Condition state of an inventory item

Enum values:

EXCELLENT

GOOD

FAIR

POOR

DAMAGED

NEEDS_REPAIR

BROKEN

MISSING

Example: GOOD

created_at

string · date-time · required

Creation date

Example: 2024-01-15T10:30:00Z

updated_at

string · date-time · required

Last modification date

Example: 2024-01-15T10:30:00Z

description

string | null

Detailed description of the item

Example: Samsung 300L refrigerator with freezer

brand

string | null · maxLength: 100

Brand of the item

Example: Samsung

model

string | null · maxLength: 100

Model of the item

Example: RT32K5070S8

serial_number

string | null · maxLength: 100

Serial number

Example: SN123456789

condition_notes

string | null

Notes on the condition of the item

Example: Works perfectly

last_condition_check

string | null · date

Date of the last condition check

Example: 2024-01-15

next_condition_check

string | null · date

Date of the next scheduled condition check

Example: 2024-07-15

purchase_date

string | null · date

Purchase date

Example: 2023-06-01

purchase_price

number | null · decimal

Purchase price

Example: 899.99

current_value

number | null · decimal

Estimated current value

Example: 750

insured_value

number | null · decimal

Insured value

Example: 800

insurance_policy_number

string | null · maxLength: 100

Insurance policy number

Example: POL123456789

last_maintenance_date

string | null · date

Date of the last maintenance

Example: 2024-01-10

next_maintenance_date

string | null · date

Date of the next scheduled maintenance

Example: 2024-07-10

maintenance_frequency_days

integer | null

Maintenance frequency in days

Example: 180

maintenance_notes

string | null

Maintenance notes

Example: Filter cleaning completed

tags

string[]

Tags for search/filtering

Example: ["kitchen","appliance","cooling"]

object | null

Custom fields per tenant

Example: {"warranty_end":"2025-06-01","supplier":"Darty"}

notes

string | null

General notes

Example: Installed in June 2023

GET/inventory/items

curl --request GET \
  --url https://api.faireplace.com/api/inventory/items

shell

Example Responses

[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "inventory_type_id": "550e8400-e29b-41d4-a716-446655440001",
    "name": "Samsung Refrigerator",
    "description": "Samsung 300L refrigerator with freezer",
    "brand": "Samsung",
    "model": "RT32K5070S8",
    "serial_number": "SN123456789",
    "quantity": 1,
    "unit": "piece",
    "condition_status": "GOOD",
    "condition_notes": "Works perfectly",
    "last_condition_check": "2024-01-15",
    "next_condition_check": "2024-07-15",
    "purchase_date": "2023-06-01",
    "purchase_price": 899.99,
    "current_value": 750,
    "insured_value": 800,
    "insurance_policy_number": "POL123456789",
    "last_maintenance_date": "2024-01-10",
    "next_maintenance_date": "2024-07-10",
    "maintenance_frequency_days": 180,
    "maintenance_notes": "Filter cleaning completed",
    "tags": [
      "kitchen",
      "appliance",
      "cooling"
    ],
    "custom_fields": {
      "warranty_end": "2025-06-01",
      "supplier": "Darty"
    },
    "notes": "Installed in June 2023",
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z"
  }
]

json

application/json

Create a new inventory item

POST

https://api.faireplace.com/api

/inventory/items

Creates a new inventory item

Create a new inventory item › Request Body

Data for creating a new inventory item

inventory_type_id

string · uuid · required

Inventory type ID

Example: 550e8400-e29b-41d4-a716-446655440001

name

string · maxLength: 255 · required

Specific name of the item

Example: Samsung Refrigerator

condition_status

string · enum · required

Condition state of an inventory item

Enum values:

EXCELLENT

GOOD

FAIR

POOR

DAMAGED

NEEDS_REPAIR

BROKEN

MISSING

Example: GOOD

description

string | null

Detailed description of the item

Example: Samsung 300L refrigerator with freezer

brand

string | null · maxLength: 100

Brand of the item

Example: Samsung

model

string | null · maxLength: 100

Model of the item

Example: RT32K5070S8

serial_number

string | null · maxLength: 100

Serial number

Example: SN123456789

quantity

integer · min: 1

Quantity of items

Example: 1

unit

string · maxLength: 20

Unit of measurement

Example: piece

condition_notes

string | null

Notes on the condition of the item

Example: Works perfectly

last_condition_check

string | null · date

Date of the last condition check

Example: 2024-01-15

next_condition_check

string | null · date

Date of the next scheduled condition check

Example: 2024-07-15

purchase_date

string | null · date

Purchase date

Example: 2023-06-01

purchase_price

number | null · decimal

Purchase price

Example: 899.99

current_value

number | null · decimal

Estimated current value

Example: 750

insured_value

number | null · decimal

Insured value

Example: 800

insurance_policy_number

string | null · maxLength: 100

Insurance policy number

Example: POL123456789

last_maintenance_date

string | null · date

Date of the last maintenance

Example: 2024-01-10

next_maintenance_date

string | null · date

Date of the next scheduled maintenance

Example: 2024-07-10

maintenance_frequency_days

integer | null

Maintenance frequency in days

Example: 180

maintenance_notes

string | null

Maintenance notes

Example: Filter cleaning completed

tags

string[]

Tags for search/filtering

Example: ["kitchen","appliance","cooling"]

object | null

Custom fields per tenant

Example: {"warranty_end":"2025-06-01","supplier":"Darty"}

notes

string | null

General notes

Example: Installed in June 2023

Create a new inventory item › Responses

Inventory item created successfully

Complete inventory item

id

string · uuid · required

Unique identifier of the inventory item

Example: 550e8400-e29b-41d4-a716-446655440000

inventory_type_id

string · uuid · required

Inventory type ID

Example: 550e8400-e29b-41d4-a716-446655440001

name

string · maxLength: 255 · required

Specific name of the item

Example: Samsung Refrigerator

quantity

integer · min: 1 · required

Quantity of items

Example: 1

unit

string · maxLength: 20 · required

Unit of measurement

Example: piece

condition_status

string · enum · required

Condition state of an inventory item

Enum values:

EXCELLENT

GOOD

FAIR

POOR

DAMAGED

NEEDS_REPAIR

BROKEN

MISSING

Example: GOOD

created_at

string · date-time · required

Creation date

Example: 2024-01-15T10:30:00Z

updated_at

string · date-time · required

Last modification date

Example: 2024-01-15T10:30:00Z

description

string | null

Detailed description of the item

Example: Samsung 300L refrigerator with freezer

brand

string | null · maxLength: 100

Brand of the item

Example: Samsung

model

string | null · maxLength: 100

Model of the item

Example: RT32K5070S8

serial_number

string | null · maxLength: 100

Serial number

Example: SN123456789

condition_notes

string | null

Notes on the condition of the item

Example: Works perfectly

last_condition_check

string | null · date

Date of the last condition check

Example: 2024-01-15

next_condition_check

string | null · date

Date of the next scheduled condition check

Example: 2024-07-15

purchase_date

string | null · date

Purchase date

Example: 2023-06-01

purchase_price

number | null · decimal

Purchase price

Example: 899.99

current_value

number | null · decimal

Estimated current value

Example: 750

insured_value

number | null · decimal

Insured value

Example: 800

insurance_policy_number

string | null · maxLength: 100

Insurance policy number

Example: POL123456789

last_maintenance_date

string | null · date

Date of the last maintenance

Example: 2024-01-10

next_maintenance_date

string | null · date

Date of the next scheduled maintenance

Example: 2024-07-10

maintenance_frequency_days

integer | null

Maintenance frequency in days

Example: 180

maintenance_notes

string | null

Maintenance notes

Example: Filter cleaning completed

tags

string[]

Tags for search/filtering

Example: ["kitchen","appliance","cooling"]

object | null

Custom fields per tenant

Example: {"warranty_end":"2025-06-01","supplier":"Darty"}

notes

string | null

General notes

Example: Installed in June 2023

POST/inventory/items

curl --request POST \
  --url https://api.faireplace.com/api/inventory/items \
  --header 'Content-Type: application/json' \
  --data '
{
  "inventory_type_id": "550e8400-e29b-41d4-a716-446655440001",
  "name": "Samsung Refrigerator",
  "description": "Samsung 300L refrigerator with freezer",
  "brand": "Samsung",
  "model": "RT32K5070S8",
  "serial_number": "SN123456789",
  "quantity": 1,
  "unit": "piece",
  "condition_status": "GOOD",
  "condition_notes": "Works perfectly",
  "last_condition_check": "2024-01-15",
  "next_condition_check": "2024-07-15",
  "purchase_date": "2023-06-01",
  "purchase_price": 899.99,
  "current_value": 750,
  "insured_value": 800,
  "insurance_policy_number": "POL123456789",
  "last_maintenance_date": "2024-01-10",
  "next_maintenance_date": "2024-07-10",
  "maintenance_frequency_days": 180,
  "maintenance_notes": "Filter cleaning completed",
  "tags": [
    "kitchen",
    "appliance",
    "cooling"
  ],
  "custom_fields": {
    "warranty_end": "2025-06-01",
    "supplier": "Darty"
  },
  "notes": "Installed in June 2023"
}
'

shell

Example Request Body

{
  "inventory_type_id": "550e8400-e29b-41d4-a716-446655440001",
  "name": "Samsung Refrigerator",
  "description": "Samsung 300L refrigerator with freezer",
  "brand": "Samsung",
  "model": "RT32K5070S8",
  "serial_number": "SN123456789",
  "quantity": 1,
  "unit": "piece",
  "condition_status": "GOOD",
  "condition_notes": "Works perfectly",
  "last_condition_check": "2024-01-15",
  "next_condition_check": "2024-07-15",
  "purchase_date": "2023-06-01",
  "purchase_price": 899.99,
  "current_value": 750,
  "insured_value": 800,
  "insurance_policy_number": "POL123456789",
  "last_maintenance_date": "2024-01-10",
  "next_maintenance_date": "2024-07-10",
  "maintenance_frequency_days": 180,
  "maintenance_notes": "Filter cleaning completed",
  "tags": [
    "kitchen",
    "appliance",
    "cooling"
  ],
  "custom_fields": {
    "warranty_end": "2025-06-01",
    "supplier": "Darty"
  },
  "notes": "Installed in June 2023"
}

json

Example Responses

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "inventory_type_id": "550e8400-e29b-41d4-a716-446655440001",
  "name": "Samsung Refrigerator",
  "description": "Samsung 300L refrigerator with freezer",
  "brand": "Samsung",
  "model": "RT32K5070S8",
  "serial_number": "SN123456789",
  "quantity": 1,
  "unit": "piece",
  "condition_status": "GOOD",
  "condition_notes": "Works perfectly",
  "last_condition_check": "2024-01-15",
  "next_condition_check": "2024-07-15",
  "purchase_date": "2023-06-01",
  "purchase_price": 899.99,
  "current_value": 750,
  "insured_value": 800,
  "insurance_policy_number": "POL123456789",
  "last_maintenance_date": "2024-01-10",
  "next_maintenance_date": "2024-07-10",
  "maintenance_frequency_days": 180,
  "maintenance_notes": "Filter cleaning completed",
  "tags": [
    "kitchen",
    "appliance",
    "cooling"
  ],
  "custom_fields": {
    "warranty_end": "2025-06-01",
    "supplier": "Darty"
  },
  "notes": "Installed in June 2023",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

json

application/json

Get inventory item by ID

GET

https://api.faireplace.com/api

/inventory/items/{id}

Retrieves a specific inventory item by its identifier

Get inventory item by ID › path Parameters

id

string · uuid · required

Inventory item ID

Get inventory item by ID › Responses

Inventory item retrieved successfully

Complete inventory item

id

string · uuid · required

Unique identifier of the inventory item

Example: 550e8400-e29b-41d4-a716-446655440000

inventory_type_id

string · uuid · required

Inventory type ID

Example: 550e8400-e29b-41d4-a716-446655440001

name

string · maxLength: 255 · required

Specific name of the item

Example: Samsung Refrigerator

quantity

integer · min: 1 · required

Quantity of items

Example: 1

unit

string · maxLength: 20 · required

Unit of measurement

Example: piece

condition_status

string · enum · required

Condition state of an inventory item

Enum values:

EXCELLENT

GOOD

FAIR

POOR

DAMAGED

NEEDS_REPAIR

BROKEN

MISSING

Example: GOOD

created_at

string · date-time · required

Creation date

Example: 2024-01-15T10:30:00Z

updated_at

string · date-time · required

Last modification date

Example: 2024-01-15T10:30:00Z

description

string | null

Detailed description of the item

Example: Samsung 300L refrigerator with freezer

brand

string | null · maxLength: 100

Brand of the item

Example: Samsung

model

string | null · maxLength: 100

Model of the item

Example: RT32K5070S8

serial_number

string | null · maxLength: 100

Serial number

Example: SN123456789

condition_notes

string | null

Notes on the condition of the item

Example: Works perfectly

last_condition_check

string | null · date

Date of the last condition check

Example: 2024-01-15

next_condition_check

string | null · date

Date of the next scheduled condition check

Example: 2024-07-15

purchase_date

string | null · date

Purchase date

Example: 2023-06-01

purchase_price

number | null · decimal

Purchase price

Example: 899.99

current_value

number | null · decimal

Estimated current value

Example: 750

insured_value

number | null · decimal

Insured value

Example: 800

insurance_policy_number

string | null · maxLength: 100

Insurance policy number

Example: POL123456789

last_maintenance_date

string | null · date

Date of the last maintenance

Example: 2024-01-10

next_maintenance_date

string | null · date

Date of the next scheduled maintenance

Example: 2024-07-10

maintenance_frequency_days

integer | null

Maintenance frequency in days

Example: 180

maintenance_notes

string | null

Maintenance notes

Example: Filter cleaning completed

tags

string[]

Tags for search/filtering

Example: ["kitchen","appliance","cooling"]

object | null

Custom fields per tenant

Example: {"warranty_end":"2025-06-01","supplier":"Darty"}

notes

string | null

General notes

Example: Installed in June 2023

GET/inventory/items/{id}

curl --request GET \
  --url https://api.faireplace.com/api/inventory/items/:id

shell

Example Responses

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "inventory_type_id": "550e8400-e29b-41d4-a716-446655440001",
  "name": "Samsung Refrigerator",
  "description": "Samsung 300L refrigerator with freezer",
  "brand": "Samsung",
  "model": "RT32K5070S8",
  "serial_number": "SN123456789",
  "quantity": 1,
  "unit": "piece",
  "condition_status": "GOOD",
  "condition_notes": "Works perfectly",
  "last_condition_check": "2024-01-15",
  "next_condition_check": "2024-07-15",
  "purchase_date": "2023-06-01",
  "purchase_price": 899.99,
  "current_value": 750,
  "insured_value": 800,
  "insurance_policy_number": "POL123456789",
  "last_maintenance_date": "2024-01-10",
  "next_maintenance_date": "2024-07-10",
  "maintenance_frequency_days": 180,
  "maintenance_notes": "Filter cleaning completed",
  "tags": [
    "kitchen",
    "appliance",
    "cooling"
  ],
  "custom_fields": {
    "warranty_end": "2025-06-01",
    "supplier": "Darty"
  },
  "notes": "Installed in June 2023",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

json

application/json

Update inventory item

PUT

https://api.faireplace.com/api

/inventory/items/{id}

Updates an existing inventory item

Update inventory item › path Parameters

id

string · uuid · required

Inventory item ID

Update inventory item › Request Body

Data for updating an inventory item

inventory_type_id

string | null · uuid

Inventory type ID

name

string | null · maxLength: 255

Specific name of the item

description

string | null

Detailed description of the item

brand

string | null · maxLength: 100

Brand of the item

model

string | null · maxLength: 100

Model of the item

serial_number

string | null · maxLength: 100

Serial number

quantity

integer | null · min: 1

Quantity of items

unit

string | null · maxLength: 20

Unit of measurement

condition_status

string · enum

Condition state of an inventory item

Enum values:

EXCELLENT

GOOD

FAIR

POOR

DAMAGED

NEEDS_REPAIR

BROKEN

MISSING

Example: GOOD

condition_notes

string | null

Notes on the condition of the item

last_condition_check

string | null · date

Date of the last condition check

next_condition_check

string | null · date

Date of the next scheduled condition check

purchase_date

string | null · date

Purchase date

purchase_price

number | null · decimal

Purchase price

current_value

number | null · decimal

Estimated current value

insured_value

number | null · decimal

Insured value

insurance_policy_number

string | null · maxLength: 100

Insurance policy number

last_maintenance_date

string | null · date

Date of the last maintenance

next_maintenance_date

string | null · date

Date of the next scheduled maintenance

maintenance_frequency_days

integer | null

Maintenance frequency in days

maintenance_notes

string | null

Maintenance notes

tags

array | null

Tags for search/filtering

object | null

Custom fields per tenant

notes

string | null

General notes

Update inventory item › Responses

Inventory item updated successfully

Complete inventory item

id

string · uuid · required

Unique identifier of the inventory item

Example: 550e8400-e29b-41d4-a716-446655440000

inventory_type_id

string · uuid · required

Inventory type ID

Example: 550e8400-e29b-41d4-a716-446655440001

name

string · maxLength: 255 · required

Specific name of the item

Example: Samsung Refrigerator

quantity

integer · min: 1 · required

Quantity of items

Example: 1

unit

string · maxLength: 20 · required

Unit of measurement

Example: piece

condition_status

string · enum · required

Condition state of an inventory item

Enum values:

EXCELLENT

GOOD

FAIR

POOR

DAMAGED

NEEDS_REPAIR

BROKEN

MISSING

Example: GOOD

created_at

string · date-time · required

Creation date

Example: 2024-01-15T10:30:00Z

updated_at

string · date-time · required

Last modification date

Example: 2024-01-15T10:30:00Z

description

string | null

Detailed description of the item

Example: Samsung 300L refrigerator with freezer

brand

string | null · maxLength: 100

Brand of the item

Example: Samsung

model

string | null · maxLength: 100

Model of the item

Example: RT32K5070S8

serial_number

string | null · maxLength: 100

Serial number

Example: SN123456789

condition_notes

string | null

Notes on the condition of the item

Example: Works perfectly

last_condition_check

string | null · date

Date of the last condition check

Example: 2024-01-15

next_condition_check

string | null · date

Date of the next scheduled condition check

Example: 2024-07-15

purchase_date

string | null · date

Purchase date

Example: 2023-06-01

purchase_price

number | null · decimal

Purchase price

Example: 899.99

current_value

number | null · decimal

Estimated current value

Example: 750

insured_value

number | null · decimal

Insured value

Example: 800

insurance_policy_number

string | null · maxLength: 100

Insurance policy number

Example: POL123456789

last_maintenance_date

string | null · date

Date of the last maintenance

Example: 2024-01-10

next_maintenance_date

string | null · date

Date of the next scheduled maintenance

Example: 2024-07-10

maintenance_frequency_days

integer | null

Maintenance frequency in days

Example: 180

maintenance_notes

string | null

Maintenance notes

Example: Filter cleaning completed

tags

string[]

Tags for search/filtering

Example: ["kitchen","appliance","cooling"]

object | null

Custom fields per tenant

Example: {"warranty_end":"2025-06-01","supplier":"Darty"}

notes

string | null

General notes

Example: Installed in June 2023

PUT/inventory/items/{id}

curl --request PUT \
  --url https://api.faireplace.com/api/inventory/items/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "inventory_type_id": "00000000-0000-0000-0000-000000000000",
  "name": {},
  "description": {},
  "brand": {},
  "model": {},
  "serial_number": {},
  "quantity": {},
  "unit": {},
  "condition_status": "GOOD",
  "condition_notes": {},
  "last_condition_check": "2024-08-25",
  "next_condition_check": "2024-08-25",
  "purchase_date": "2024-08-25",
  "purchase_price": {},
  "current_value": {},
  "insured_value": {},
  "insurance_policy_number": {},
  "last_maintenance_date": "2024-08-25",
  "next_maintenance_date": "2024-08-25",
  "maintenance_frequency_days": {},
  "maintenance_notes": {},
  "tags": {},
  "custom_fields": {},
  "notes": {}
}
'

shell

Example Request Body

{
  "inventory_type_id": "00000000-0000-0000-0000-000000000000",
  "name": {},
  "description": {},
  "brand": {},
  "model": {},
  "serial_number": {},
  "quantity": {},
  "unit": {},
  "condition_status": "GOOD",
  "condition_notes": {},
  "last_condition_check": "2024-08-25",
  "next_condition_check": "2024-08-25",
  "purchase_date": "2024-08-25",
  "purchase_price": {},
  "current_value": {},
  "insured_value": {},
  "insurance_policy_number": {},
  "last_maintenance_date": "2024-08-25",
  "next_maintenance_date": "2024-08-25",
  "maintenance_frequency_days": {},
  "maintenance_notes": {},
  "tags": {},
  "custom_fields": {},
  "notes": {}
}

json

Example Responses

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "inventory_type_id": "550e8400-e29b-41d4-a716-446655440001",
  "name": "Samsung Refrigerator",
  "description": "Samsung 300L refrigerator with freezer",
  "brand": "Samsung",
  "model": "RT32K5070S8",
  "serial_number": "SN123456789",
  "quantity": 1,
  "unit": "piece",
  "condition_status": "GOOD",
  "condition_notes": "Works perfectly",
  "last_condition_check": "2024-01-15",
  "next_condition_check": "2024-07-15",
  "purchase_date": "2023-06-01",
  "purchase_price": 899.99,
  "current_value": 750,
  "insured_value": 800,
  "insurance_policy_number": "POL123456789",
  "last_maintenance_date": "2024-01-10",
  "next_maintenance_date": "2024-07-10",
  "maintenance_frequency_days": 180,
  "maintenance_notes": "Filter cleaning completed",
  "tags": [
    "kitchen",
    "appliance",
    "cooling"
  ],
  "custom_fields": {
    "warranty_end": "2025-06-01",
    "supplier": "Darty"
  },
  "notes": "Installed in June 2023",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

json

application/json

Delete inventory item

DELETE

https://api.faireplace.com/api

/inventory/items/{id}

Deletes an inventory item and all its associated data.

Cascade deletion behavior:

All room_inventory junctions (links with rooms) are automatically deleted
All inventory_condition_history records are automatically deleted
All inventory_photo associations are automatically deleted (the media files themselves are not deleted)

The deletion is atomic: either everything is deleted, or nothing is deleted in case of an error.

Note: This operation is irreversible. Make sure the inventory item can be deleted before calling this endpoint.

Delete inventory item › path Parameters

id

string · uuid · required

Inventory item ID

Delete inventory item › Responses

Inventory item and all its associated data deleted successfully

No data returned

DELETE/inventory/items/{id}

curl --request DELETE \
  --url https://api.faireplace.com/api/inventory/items/:id

shell

Example Responses

No example specified for this content type

List inventory items by type

GET

https://api.faireplace.com/api

/inventory/items/type/{type_id}

Retrieves all inventory items of a specific type

List inventory items by type › path Parameters

type_id

string · uuid · required

Inventory type ID

List inventory items by type › Responses

Inventory items of the specified type retrieved successfully

object[]

Complete inventory item

id

string · uuid · required

Unique identifier of the inventory item

Example: 550e8400-e29b-41d4-a716-446655440000

inventory_type_id

string · uuid · required

Inventory type ID

Example: 550e8400-e29b-41d4-a716-446655440001

name

string · maxLength: 255 · required

Specific name of the item

Example: Samsung Refrigerator

quantity

integer · min: 1 · required

Quantity of items

Example: 1

unit

string · maxLength: 20 · required

Unit of measurement

Example: piece

condition_status

string · enum · required

Condition state of an inventory item

Enum values:

EXCELLENT

GOOD

FAIR

POOR

DAMAGED

NEEDS_REPAIR

BROKEN

MISSING

Example: GOOD

created_at

string · date-time · required

Creation date

Example: 2024-01-15T10:30:00Z

updated_at

string · date-time · required

Last modification date

Example: 2024-01-15T10:30:00Z

description

string | null

Detailed description of the item

Example: Samsung 300L refrigerator with freezer

brand

string | null · maxLength: 100

Brand of the item

Example: Samsung

model

string | null · maxLength: 100

Model of the item

Example: RT32K5070S8

serial_number

string | null · maxLength: 100

Serial number

Example: SN123456789

condition_notes

string | null

Notes on the condition of the item

Example: Works perfectly

last_condition_check

string | null · date

Date of the last condition check

Example: 2024-01-15

next_condition_check

string | null · date

Date of the next scheduled condition check

Example: 2024-07-15

purchase_date

string | null · date

Purchase date

Example: 2023-06-01

purchase_price

number | null · decimal

Purchase price

Example: 899.99

current_value

number | null · decimal

Estimated current value

Example: 750

insured_value

number | null · decimal

Insured value

Example: 800

insurance_policy_number

string | null · maxLength: 100

Insurance policy number

Example: POL123456789

last_maintenance_date

string | null · date

Date of the last maintenance

Example: 2024-01-10

next_maintenance_date

string | null · date

Date of the next scheduled maintenance

Example: 2024-07-10

maintenance_frequency_days

integer | null

Maintenance frequency in days

Example: 180

maintenance_notes

string | null

Maintenance notes

Example: Filter cleaning completed

tags

string[]

Tags for search/filtering

Example: ["kitchen","appliance","cooling"]

object | null

Custom fields per tenant

Example: {"warranty_end":"2025-06-01","supplier":"Darty"}

notes

string | null

General notes

Example: Installed in June 2023

GET/inventory/items/type/{type_id}

curl --request GET \
  --url https://api.faireplace.com/api/inventory/items/type/:type_id

shell

Example Responses

[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "inventory_type_id": "550e8400-e29b-41d4-a716-446655440001",
    "name": "Samsung Refrigerator",
    "description": "Samsung 300L refrigerator with freezer",
    "brand": "Samsung",
    "model": "RT32K5070S8",
    "serial_number": "SN123456789",
    "quantity": 1,
    "unit": "piece",
    "condition_status": "GOOD",
    "condition_notes": "Works perfectly",
    "last_condition_check": "2024-01-15",
    "next_condition_check": "2024-07-15",
    "purchase_date": "2023-06-01",
    "purchase_price": 899.99,
    "current_value": 750,
    "insured_value": 800,
    "insurance_policy_number": "POL123456789",
    "last_maintenance_date": "2024-01-10",
    "next_maintenance_date": "2024-07-10",
    "maintenance_frequency_days": 180,
    "maintenance_notes": "Filter cleaning completed",
    "tags": [
      "kitchen",
      "appliance",
      "cooling"
    ],
    "custom_fields": {
      "warranty_end": "2025-06-01",
      "supplier": "Darty"
    },
    "notes": "Installed in June 2023",
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z"
  }
]

json

application/json

List inventory items by condition

GET

https://api.faireplace.com/api

/inventory/items/condition/{condition}

Retrieves all inventory items with a specific condition

List inventory items by condition › path Parameters

condition

string · enum · required

Condition status

Condition state of an inventory item

Enum values:

EXCELLENT

GOOD

FAIR

POOR

DAMAGED

NEEDS_REPAIR

BROKEN

MISSING

Example: GOOD

List inventory items by condition › Responses

Inventory items with the specified condition retrieved successfully

object[]

Complete inventory item

id

string · uuid · required

Unique identifier of the inventory item

Example: 550e8400-e29b-41d4-a716-446655440000

inventory_type_id

string · uuid · required

Inventory type ID

Example: 550e8400-e29b-41d4-a716-446655440001

name

string · maxLength: 255 · required

Specific name of the item

Example: Samsung Refrigerator

quantity

integer · min: 1 · required

Quantity of items

Example: 1

unit

string · maxLength: 20 · required

Unit of measurement

Example: piece

condition_status

string · enum · required

Condition state of an inventory item

Enum values:

EXCELLENT

GOOD

FAIR

POOR

DAMAGED

NEEDS_REPAIR

BROKEN

MISSING

Example: GOOD

created_at

string · date-time · required

Creation date

Example: 2024-01-15T10:30:00Z

updated_at

string · date-time · required

Last modification date

Example: 2024-01-15T10:30:00Z

description

string | null

Detailed description of the item

Example: Samsung 300L refrigerator with freezer

brand

string | null · maxLength: 100

Brand of the item

Example: Samsung

model

string | null · maxLength: 100

Model of the item

Example: RT32K5070S8

serial_number

string | null · maxLength: 100

Serial number

Example: SN123456789

condition_notes

string | null

Notes on the condition of the item

Example: Works perfectly

last_condition_check

string | null · date

Date of the last condition check

Example: 2024-01-15

next_condition_check

string | null · date

Date of the next scheduled condition check

Example: 2024-07-15

purchase_date

string | null · date

Purchase date

Example: 2023-06-01

purchase_price

number | null · decimal

Purchase price

Example: 899.99

current_value

number | null · decimal

Estimated current value

Example: 750

insured_value

number | null · decimal

Insured value

Example: 800

insurance_policy_number

string | null · maxLength: 100

Insurance policy number

Example: POL123456789

last_maintenance_date

string | null · date

Date of the last maintenance

Example: 2024-01-10

next_maintenance_date

string | null · date

Date of the next scheduled maintenance

Example: 2024-07-10

maintenance_frequency_days

integer | null

Maintenance frequency in days

Example: 180

maintenance_notes

string | null

Maintenance notes

Example: Filter cleaning completed

tags

string[]

Tags for search/filtering

Example: ["kitchen","appliance","cooling"]

object | null

Custom fields per tenant

Example: {"warranty_end":"2025-06-01","supplier":"Darty"}

notes

string | null

General notes

Example: Installed in June 2023

GET/inventory/items/condition/{condition}

curl --request GET \
  --url https://api.faireplace.com/api/inventory/items/condition/:condition

shell

Example Responses

[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "inventory_type_id": "550e8400-e29b-41d4-a716-446655440001",
    "name": "Samsung Refrigerator",
    "description": "Samsung 300L refrigerator with freezer",
    "brand": "Samsung",
    "model": "RT32K5070S8",
    "serial_number": "SN123456789",
    "quantity": 1,
    "unit": "piece",
    "condition_status": "GOOD",
    "condition_notes": "Works perfectly",
    "last_condition_check": "2024-01-15",
    "next_condition_check": "2024-07-15",
    "purchase_date": "2023-06-01",
    "purchase_price": 899.99,
    "current_value": 750,
    "insured_value": 800,
    "insurance_policy_number": "POL123456789",
    "last_maintenance_date": "2024-01-10",
    "next_maintenance_date": "2024-07-10",
    "maintenance_frequency_days": 180,
    "maintenance_notes": "Filter cleaning completed",
    "tags": [
      "kitchen",
      "appliance",
      "cooling"
    ],
    "custom_fields": {
      "warranty_end": "2025-06-01",
      "supplier": "Darty"
    },
    "notes": "Installed in June 2023",
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z"
  }
]

json

application/json

Search inventory items

GET

https://api.faireplace.com/api

/inventory/items/search

Performs an advanced search across inventory items

Search inventory items › query Parameters

search_term

string

General search term

inventory_type_id

string · uuid

Filter by inventory type

condition

string · enum

Filter by condition

Condition state of an inventory item

Enum values:

EXCELLENT

GOOD

FAIR

POOR

DAMAGED

NEEDS_REPAIR

BROKEN

MISSING

Example: GOOD

estate_id

string · uuid

Filter by property

category_id

string · uuid

Filter by inventory category

object_nature

string

Filter by object nature

Search inventory items › Responses

Search results retrieved successfully

object[]

Complete inventory item

id

string · uuid · required

Unique identifier of the inventory item

Example: 550e8400-e29b-41d4-a716-446655440000

inventory_type_id

string · uuid · required

Inventory type ID

Example: 550e8400-e29b-41d4-a716-446655440001

name

string · maxLength: 255 · required

Specific name of the item

Example: Samsung Refrigerator

quantity

integer · min: 1 · required

Quantity of items

Example: 1

unit

string · maxLength: 20 · required

Unit of measurement

Example: piece

condition_status

string · enum · required

Condition state of an inventory item

Enum values:

EXCELLENT

GOOD

FAIR

POOR

DAMAGED

NEEDS_REPAIR

BROKEN

MISSING

Example: GOOD

created_at

string · date-time · required

Creation date

Example: 2024-01-15T10:30:00Z

updated_at

string · date-time · required

Last modification date

Example: 2024-01-15T10:30:00Z

description

string | null

Detailed description of the item

Example: Samsung 300L refrigerator with freezer

brand

string | null · maxLength: 100

Brand of the item

Example: Samsung

model

string | null · maxLength: 100

Model of the item

Example: RT32K5070S8

serial_number

string | null · maxLength: 100

Serial number

Example: SN123456789

condition_notes

string | null

Notes on the condition of the item

Example: Works perfectly

last_condition_check

string | null · date

Date of the last condition check

Example: 2024-01-15

next_condition_check

string | null · date

Date of the next scheduled condition check

Example: 2024-07-15

purchase_date

string | null · date

Purchase date

Example: 2023-06-01

purchase_price

number | null · decimal

Purchase price

Example: 899.99

current_value

number | null · decimal

Estimated current value

Example: 750

insured_value

number | null · decimal

Insured value

Example: 800

insurance_policy_number

string | null · maxLength: 100

Insurance policy number

Example: POL123456789

last_maintenance_date

string | null · date

Date of the last maintenance

Example: 2024-01-10

next_maintenance_date

string | null · date

Date of the next scheduled maintenance

Example: 2024-07-10

maintenance_frequency_days

integer | null

Maintenance frequency in days

Example: 180

maintenance_notes

string | null

Maintenance notes

Example: Filter cleaning completed

tags

string[]

Tags for search/filtering

Example: ["kitchen","appliance","cooling"]

object | null

Custom fields per tenant

Example: {"warranty_end":"2025-06-01","supplier":"Darty"}

notes

string | null

General notes

Example: Installed in June 2023

GET/inventory/items/search

curl --request GET \
  --url https://api.faireplace.com/api/inventory/items/search

shell

Example Responses

[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "inventory_type_id": "550e8400-e29b-41d4-a716-446655440001",
    "name": "Samsung Refrigerator",
    "description": "Samsung 300L refrigerator with freezer",
    "brand": "Samsung",
    "model": "RT32K5070S8",
    "serial_number": "SN123456789",
    "quantity": 1,
    "unit": "piece",
    "condition_status": "GOOD",
    "condition_notes": "Works perfectly",
    "last_condition_check": "2024-01-15",
    "next_condition_check": "2024-07-15",
    "purchase_date": "2023-06-01",
    "purchase_price": 899.99,
    "current_value": 750,
    "insured_value": 800,
    "insurance_policy_number": "POL123456789",
    "last_maintenance_date": "2024-01-10",
    "next_maintenance_date": "2024-07-10",
    "maintenance_frequency_days": 180,
    "maintenance_notes": "Filter cleaning completed",
    "tags": [
      "kitchen",
      "appliance",
      "cooling"
    ],
    "custom_fields": {
      "warranty_end": "2025-06-01",
      "supplier": "Darty"
    },
    "notes": "Installed in June 2023",
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z"
  }
]

json

application/json

List inventory categories

GET

https://api.faireplace.com/api

/inventory/categories

Retrieves the list of all inventory categories

List inventory categories › Responses

Inventory categories list retrieved successfully

object[]

Inventory category

id

string · uuid · required

Unique identifier of the category

Example: 550e8400-e29b-41d4-a716-446655440000

name

string · maxLength: 255 · required

Category name

Example: Doors and woodwork

created_at

string · date-time · required

Creation date

Example: 2024-01-15T10:30:00Z

updated_at

string · date-time · required

Last modification date

Example: 2024-01-15T10:30:00Z

description

string | null

Category description

Example: Doors and woodwork

GET/inventory/categories

curl --request GET \
  --url https://api.faireplace.com/api/inventory/categories

shell

Example Responses

[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Doors and woodwork",
    "description": "Doors and woodwork",
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z"
  }
]

json

application/json

Create a new inventory category

POST

https://api.faireplace.com/api

/inventory/categories

Creates a new inventory category

Create a new inventory category › Request Body

Data for creating a new inventory category

name

string · maxLength: 255 · required

Category name

Example: Doors and woodwork

description

string | null

Category description

Example: Doors and woodwork

Create a new inventory category › Responses

Inventory category created successfully

Inventory category

id

string · uuid · required

Unique identifier of the category

Example: 550e8400-e29b-41d4-a716-446655440000

name

string · maxLength: 255 · required

Category name

Example: Doors and woodwork

created_at

string · date-time · required

Creation date

Example: 2024-01-15T10:30:00Z

updated_at

string · date-time · required

Last modification date

Example: 2024-01-15T10:30:00Z

description

string | null

Category description

Example: Doors and woodwork

POST/inventory/categories

curl --request POST \
  --url https://api.faireplace.com/api/inventory/categories \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Doors and woodwork",
  "description": "Doors and woodwork"
}
'

shell

Example Request Body

{
  "name": "Doors and woodwork",
  "description": "Doors and woodwork"
}

json

Example Responses

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Doors and woodwork",
  "description": "Doors and woodwork",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

json

application/json

Get inventory category by ID

GET

https://api.faireplace.com/api

/inventory/categories/{id}

Retrieves a specific inventory category by its identifier

Get inventory category by ID › path Parameters

id

string · uuid · required

Inventory category ID

Get inventory category by ID › Responses

Inventory category retrieved successfully

Inventory category

id

string · uuid · required

Unique identifier of the category

Example: 550e8400-e29b-41d4-a716-446655440000

name

string · maxLength: 255 · required

Category name

Example: Doors and woodwork

created_at

string · date-time · required

Creation date

Example: 2024-01-15T10:30:00Z

updated_at

string · date-time · required

Last modification date

Example: 2024-01-15T10:30:00Z

description

string | null

Category description

Example: Doors and woodwork

GET/inventory/categories/{id}

curl --request GET \
  --url https://api.faireplace.com/api/inventory/categories/:id

shell

Example Responses

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Doors and woodwork",
  "description": "Doors and woodwork",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

json

application/json

Update inventory category

PUT

https://api.faireplace.com/api

/inventory/categories/{id}

Updates an existing inventory category

Update inventory category › path Parameters

id

string · uuid · required

Inventory category ID

Update inventory category › Request Body

Data for updating an inventory category

name

string | null · maxLength: 255

Category name

description

string | null

Category description

Update inventory category › Responses

Inventory category updated successfully

Inventory category

id

string · uuid · required

Unique identifier of the category

Example: 550e8400-e29b-41d4-a716-446655440000

name

string · maxLength: 255 · required

Category name

Example: Doors and woodwork

created_at

string · date-time · required

Creation date

Example: 2024-01-15T10:30:00Z

updated_at

string · date-time · required

Last modification date

Example: 2024-01-15T10:30:00Z

description

string | null

Category description

Example: Doors and woodwork

PUT/inventory/categories/{id}

curl --request PUT \
  --url https://api.faireplace.com/api/inventory/categories/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": {},
  "description": {}
}
'

shell

Example Request Body

{
  "name": {},
  "description": {}
}

json

Example Responses

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Doors and woodwork",
  "description": "Doors and woodwork",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

json

application/json

Delete inventory category

DELETE

https://api.faireplace.com/api

/inventory/categories/{id}

Deletes an inventory category

Delete inventory category › path Parameters

id

string · uuid · required

Inventory category ID

Delete inventory category › Responses

Inventory category deleted successfully

No data returned

DELETE/inventory/categories/{id}

curl --request DELETE \
  --url https://api.faireplace.com/api/inventory/categories/:id

shell

Example Responses

No example specified for this content type

List inventory types

GET

https://api.faireplace.com/api

/inventory/types

Retrieves the list of all inventory types

List inventory types › query Parameters

category_id

string · uuid

Filter by category

List inventory types › Responses

Inventory types list retrieved successfully

object[]

Inventory type

id

string · uuid · required

Unique identifier of the type

Example: 550e8400-e29b-41d4-a716-446655440000

name

string · maxLength: 255 · required

Type name

Example: Main door

is_active

boolean · required

Indicates whether the type is active

Example: true

created_at

string · date-time · required

Creation date

Example: 2024-01-15T10:30:00Z

updated_at

string · date-time · required

Last modification date

Example: 2024-01-15T10:30:00Z

description

string | null

Type description

Example: Main entrance door

category_id

string | null · uuid

Category ID

Example: 550e8400-e29b-41d4-a716-446655440001

GET/inventory/types

curl --request GET \
  --url https://api.faireplace.com/api/inventory/types

shell

Example Responses

[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Main door",
    "description": "Main entrance door",
    "category_id": "550e8400-e29b-41d4-a716-446655440001",
    "is_active": true,
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z"
  }
]

json

application/json

Create a new inventory type

POST

https://api.faireplace.com/api

/inventory/types

Creates a new inventory type

Create a new inventory type › Request Body

Data for creating a new inventory type

name

string · maxLength: 255 · required

Type name

Example: Main door

description

string | null

Type description

Example: Main entrance door

category_id

string | null · uuid

Category ID

Example: 550e8400-e29b-41d4-a716-446655440001

is_active

boolean | null

Indicates whether the type is active

Example: true

Create a new inventory type › Responses

Inventory type created successfully

Inventory type

id

string · uuid · required

Unique identifier of the type

Example: 550e8400-e29b-41d4-a716-446655440000

name

string · maxLength: 255 · required

Type name

Example: Main door

is_active

boolean · required

Indicates whether the type is active

Example: true

created_at

string · date-time · required

Creation date

Example: 2024-01-15T10:30:00Z

updated_at

string · date-time · required

Last modification date

Example: 2024-01-15T10:30:00Z

description

string | null

Type description

Example: Main entrance door

category_id

string | null · uuid

Category ID

Example: 550e8400-e29b-41d4-a716-446655440001

POST/inventory/types

curl --request POST \
  --url https://api.faireplace.com/api/inventory/types \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Main door",
  "description": "Main entrance door",
  "category_id": "550e8400-e29b-41d4-a716-446655440001",
  "is_active": true
}
'

shell

Example Request Body

{
  "name": "Main door",
  "description": "Main entrance door",
  "category_id": "550e8400-e29b-41d4-a716-446655440001",
  "is_active": true
}

json

Example Responses

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Main door",
  "description": "Main entrance door",
  "category_id": "550e8400-e29b-41d4-a716-446655440001",
  "is_active": true,
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

json

application/json

Get inventory type by ID

GET

https://api.faireplace.com/api

/inventory/types/{id}

Retrieves a specific inventory type by its identifier

Get inventory type by ID › path Parameters

id

string · uuid · required

Inventory type ID

Get inventory type by ID › Responses

Inventory type retrieved successfully

Inventory type

id

string · uuid · required

Unique identifier of the type

Example: 550e8400-e29b-41d4-a716-446655440000

name

string · maxLength: 255 · required

Type name

Example: Main door

is_active

boolean · required

Indicates whether the type is active

Example: true

created_at

string · date-time · required

Creation date

Example: 2024-01-15T10:30:00Z

updated_at

string · date-time · required

Last modification date

Example: 2024-01-15T10:30:00Z

description

string | null

Type description

Example: Main entrance door

category_id

string | null · uuid

Category ID

Example: 550e8400-e29b-41d4-a716-446655440001

GET/inventory/types/{id}

curl --request GET \
  --url https://api.faireplace.com/api/inventory/types/:id

shell

Example Responses

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Main door",
  "description": "Main entrance door",
  "category_id": "550e8400-e29b-41d4-a716-446655440001",
  "is_active": true,
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

json

application/json

Update inventory type

PUT

https://api.faireplace.com/api

/inventory/types/{id}

Updates an existing inventory type

Update inventory type › path Parameters

id

string · uuid · required

Inventory type ID

Update inventory type › Request Body

Data for updating an inventory type

name

string | null · maxLength: 255

Type name

description

string | null

Type description

category_id

string | null · uuid

Category ID

is_active

boolean | null

Indicates whether the type is active

Update inventory type › Responses

Inventory type updated successfully

Inventory type

id

string · uuid · required

Unique identifier of the type

Example: 550e8400-e29b-41d4-a716-446655440000

name

string · maxLength: 255 · required

Type name

Example: Main door

is_active

boolean · required

Indicates whether the type is active

Example: true

created_at

string · date-time · required

Creation date

Example: 2024-01-15T10:30:00Z

updated_at

string · date-time · required

Last modification date

Example: 2024-01-15T10:30:00Z

description

string | null

Type description

Example: Main entrance door

category_id

string | null · uuid

Category ID

Example: 550e8400-e29b-41d4-a716-446655440001

PUT/inventory/types/{id}

curl --request PUT \
  --url https://api.faireplace.com/api/inventory/types/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": {},
  "description": {},
  "category_id": "00000000-0000-0000-0000-000000000000",
  "is_active": {}
}
'

shell

Example Request Body

{
  "name": {},
  "description": {},
  "category_id": "00000000-0000-0000-0000-000000000000",
  "is_active": {}
}

json

Example Responses

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Main door",
  "description": "Main entrance door",
  "category_id": "550e8400-e29b-41d4-a716-446655440001",
  "is_active": true,
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

json

application/json

Delete inventory type

DELETE

https://api.faireplace.com/api

/inventory/types/{id}

Deletes an inventory type

Delete inventory type › path Parameters

id

string · uuid · required

Inventory type ID

Delete inventory type › Responses

Inventory type deleted successfully

No data returned

DELETE/inventory/types/{id}

curl --request DELETE \
  --url https://api.faireplace.com/api/inventory/types/:id

shell

Example Responses

No example specified for this content type

List room inventory

GET

https://api.faireplace.com/api

/places/{place_id}/estates/{estate_id}/rooms/{room_id}/inventory

Retrieves the list of all inventory items in a room. Automatically validates that the room belongs to the correct estate.

List room inventory › path Parameters

place_id

string · uuid · required

Place ID

estate_id

string · uuid · required

Property ID

room_id

string · uuid · required

Room ID

List room inventory › Responses

Room inventory list retrieved successfully

object[]

Junction between a room and an inventory item

id

string · uuid · required

Unique identifier of the junction

Example: 550e8400-e29b-41d4-a716-446655440000

room_id

string · uuid · required

Room ID

Example: 550e8400-e29b-41d4-a716-446655440001

inventory_id

string · uuid · required

Inventory item ID

Example: 550e8400-e29b-41d4-a716-446655440002

quantity_in_room

integer · required

Quantity of the item in this room

Example: 1

placed_date

string · date · required

Date placed in the room

Example: 2024-01-15

is_active

boolean · required

Indicates whether the item is currently in this room

Example: true

created_at

string · date-time · required

Creation date

Example: 2024-01-15T10:30:00Z

updated_at

string · date-time · required

Last modification date

Example: 2024-01-15T10:30:00Z

location_description

string | null

Description of the location within the room

Example: Near the window

position_x

number | null · decimal

X position in the room (in meters)

Example: 2.5

position_y

number | null · decimal

Y position in the room (in meters)

Example: 1.2

condition_in_room

string · enum

Condition state of an inventory item

Enum values:

EXCELLENT

GOOD

FAIR

POOR

DAMAGED

NEEDS_REPAIR

BROKEN

MISSING

Example: GOOD

condition_notes_in_room

string | null

Notes on the condition in this room

Example: Works well in this room

removed_date

string | null · date

Date removed from the room

notes

string | null

Notes specific to this room

Example: Near the window

GET/places/{place_id}/estates/{estate_id}/rooms/{room_id}/inventory

curl --request GET \
  --url https://api.faireplace.com/api/places/:place_id/estates/:estate_id/rooms/:room_id/inventory

shell

Example Responses

[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "room_id": "550e8400-e29b-41d4-a716-446655440001",
    "inventory_id": "550e8400-e29b-41d4-a716-446655440002",
    "quantity_in_room": 1,
    "location_description": "Near the window",
    "position_x": 2.5,
    "position_y": 1.2,
    "condition_in_room": "GOOD",
    "condition_notes_in_room": "Works well in this room",
    "placed_date": "2024-01-15",
    "removed_date": "2024-08-25",
    "is_active": true,
    "notes": "Near the window",
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z"
  }
]

json

application/json

Add an inventory item to a room

POST

https://api.faireplace.com/api

/places/{place_id}/estates/{estate_id}/rooms/{room_id}/inventory

Creates a new junction between a room and an existing inventory item. Automatically validates that the room belongs to the correct estate.

Add an inventory item to a room › path Parameters

place_id

string · uuid · required

Place ID

estate_id

string · uuid · required

Property ID

room_id

string · uuid · required

Room ID

Add an inventory item to a room › Request Body

Data for linking an existing inventory item to a room

inventory_id

string · uuid · required

Inventory item ID

Example: 550e8400-e29b-41d4-a716-446655440002

quantity_in_room

integer | null

Quantity of the item in this room

Example: 1

location_description

string | null

Description of the location within the room

Example: Near the window

position_x

number | null · decimal

X position in the room (in meters)

Example: 2.5

position_y

number | null · decimal

Y position in the room (in meters)

Example: 1.2

condition_in_room

string · enum

Condition state of an inventory item

Enum values:

EXCELLENT

GOOD

FAIR

POOR

DAMAGED

NEEDS_REPAIR

BROKEN

MISSING

Example: GOOD

condition_notes_in_room

string | null

Notes on the condition in this room

Example: Works well in this room

placed_date

string | null · date

Date placed in the room

Example: 2024-01-15

removed_date

string | null · date

Date removed from the room

is_active

boolean | null

Indicates whether the item is currently in this room

Example: true

notes

string | null

Notes specific to this room

Example: Near the window

Add an inventory item to a room › Responses

Inventory item added to the room successfully

Junction between a room and an inventory item

id

string · uuid · required

Unique identifier of the junction

Example: 550e8400-e29b-41d4-a716-446655440000

room_id

string · uuid · required

Room ID

Example: 550e8400-e29b-41d4-a716-446655440001

inventory_id

string · uuid · required

Inventory item ID

Example: 550e8400-e29b-41d4-a716-446655440002

quantity_in_room

integer · required

Quantity of the item in this room

Example: 1

placed_date

string · date · required

Date placed in the room

Example: 2024-01-15

is_active

boolean · required

Indicates whether the item is currently in this room

Example: true

created_at

string · date-time · required

Creation date

Example: 2024-01-15T10:30:00Z

updated_at

string · date-time · required

Last modification date

Example: 2024-01-15T10:30:00Z

location_description

string | null

Description of the location within the room

Example: Near the window

position_x

number | null · decimal

X position in the room (in meters)

Example: 2.5

position_y

number | null · decimal

Y position in the room (in meters)

Example: 1.2

condition_in_room

string · enum

Condition state of an inventory item

Enum values:

EXCELLENT

GOOD

FAIR

POOR

DAMAGED

NEEDS_REPAIR

BROKEN

MISSING

Example: GOOD

condition_notes_in_room

string | null

Notes on the condition in this room

Example: Works well in this room

removed_date

string | null · date

Date removed from the room

notes

string | null

Notes specific to this room

Example: Near the window

POST/places/{place_id}/estates/{estate_id}/rooms/{room_id}/inventory

curl --request POST \
  --url https://api.faireplace.com/api/places/:place_id/estates/:estate_id/rooms/:room_id/inventory \
  --header 'Content-Type: application/json' \
  --data '
{
  "inventory_id": "550e8400-e29b-41d4-a716-446655440002",
  "quantity_in_room": 1,
  "location_description": "Near the window",
  "position_x": 2.5,
  "position_y": 1.2,
  "condition_in_room": "GOOD",
  "condition_notes_in_room": "Works well in this room",
  "placed_date": "2024-01-15",
  "removed_date": "2024-08-25",
  "is_active": true,
  "notes": "Near the window"
}
'

shell

Example Request Body

{
  "inventory_id": "550e8400-e29b-41d4-a716-446655440002",
  "quantity_in_room": 1,
  "location_description": "Near the window",
  "position_x": 2.5,
  "position_y": 1.2,
  "condition_in_room": "GOOD",
  "condition_notes_in_room": "Works well in this room",
  "placed_date": "2024-01-15",
  "removed_date": "2024-08-25",
  "is_active": true,
  "notes": "Near the window"
}

json

Example Responses

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "room_id": "550e8400-e29b-41d4-a716-446655440001",
  "inventory_id": "550e8400-e29b-41d4-a716-446655440002",
  "quantity_in_room": 1,
  "location_description": "Near the window",
  "position_x": 2.5,
  "position_y": 1.2,
  "condition_in_room": "GOOD",
  "condition_notes_in_room": "Works well in this room",
  "placed_date": "2024-01-15",
  "removed_date": "2024-08-25",
  "is_active": true,
  "notes": "Near the window",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

json

application/json

Create inventory and link it to a room

POST

https://api.faireplace.com/api

/places/{place_id}/estates/{estate_id}/rooms/{room_id}/inventory/create

Creates a new inventory item and immediately links it to a room in a single operation. Automatically validates that the room belongs to the correct estate.

Create inventory and link it to a room › path Parameters

place_id

string · uuid · required

Place ID

estate_id

string · uuid · required

Property ID

room_id

string · uuid · required

Room ID

Create inventory and link it to a room › Request Body

Data for creating a new inventory item and linking it to a room in one operation

inventory_type_id

string · uuid · required

Inventory type ID

Example: 550e8400-e29b-41d4-a716-446655440001

name

string · maxLength: 255 · required

Specific name of the item

Example: Samsung Refrigerator

condition_status

string · enum · required

Condition state of an inventory item

Enum values:

EXCELLENT

GOOD

FAIR

POOR

DAMAGED

NEEDS_REPAIR

BROKEN

MISSING

Example: GOOD

description

string | null

Detailed description of the item

Example: Samsung 300L refrigerator with freezer

brand

string | null · maxLength: 100

Brand of the item

Example: Samsung

model

string | null · maxLength: 100

Model of the item

Example: RT32K5070S8

serial_number

string | null · maxLength: 100

Serial number

Example: SN123456789

quantity

integer · min: 1

Quantity of items

Example: 1

unit

string · maxLength: 20

Unit of measurement

Example: piece

condition_notes

string | null

Notes on the condition of the item

Example: Works perfectly

last_condition_check

string | null · date

Date of the last condition check

Example: 2024-01-15

next_condition_check

string | null · date

Date of the next scheduled condition check

Example: 2024-07-15

purchase_date

string | null · date

Purchase date

Example: 2023-06-01

purchase_price

number | null · decimal

Purchase price

Example: 899.99

current_value

number | null · decimal

Estimated current value

Example: 750

insured_value

number | null · decimal

Insured value

Example: 800

insurance_policy_number

string | null · maxLength: 100

Insurance policy number

Example: POL123456789

last_maintenance_date

string | null · date

Date of the last maintenance

Example: 2024-01-10

next_maintenance_date

string | null · date

Date of the next scheduled maintenance

Example: 2024-07-10

maintenance_frequency_days

integer | null

Maintenance frequency in days

Example: 180

maintenance_notes

string | null

Maintenance notes

Example: Filter cleaning completed

tags

string[]

Tags for search/filtering

Example: ["kitchen","appliance","cooling"]

object | null

Custom fields per tenant

Example: {"warranty_end":"2025-06-01","supplier":"Darty"}

notes

string | null

General notes

Example: Installed in June 2023

quantity_in_room

integer | null

Quantity of the item in this room

Example: 1

location_description

string | null

Description of the location within the room

Example: Near the window

position_x

number | null · decimal

X position in the room (in meters)

Example: 2.5

position_y

number | null · decimal

Y position in the room (in meters)

Example: 1.2

condition_in_room

string · enum

Condition state of an inventory item

Enum values:

EXCELLENT

GOOD

FAIR

POOR

DAMAGED

NEEDS_REPAIR

BROKEN

MISSING

Example: GOOD

condition_notes_in_room

string | null

Notes on the condition in this room

Example: Works well in this room

placed_date

string | null · date

Date placed in the room

Example: 2024-01-15

removed_date

string | null · date

Date removed from the room

is_active

boolean | null

Indicates whether the item is currently in this room

Example: true

room_notes

string | null

Notes specific to this room

Example: Near the window

Create inventory and link it to a room › Responses

Inventory created and linked to the room successfully

object

Complete inventory item

object

Junction between a room and an inventory item

POST/places/{place_id}/estates/{estate_id}/rooms/{room_id}/inventory/create

curl --request POST \
  --url https://api.faireplace.com/api/places/:place_id/estates/:estate_id/rooms/:room_id/inventory/create \
  --header 'Content-Type: application/json' \
  --data '
{
  "inventory_type_id": "550e8400-e29b-41d4-a716-446655440001",
  "name": "Samsung Refrigerator",
  "description": "Samsung 300L refrigerator with freezer",
  "brand": "Samsung",
  "model": "RT32K5070S8",
  "serial_number": "SN123456789",
  "quantity": 1,
  "unit": "piece",
  "condition_status": "GOOD",
  "condition_notes": "Works perfectly",
  "last_condition_check": "2024-01-15",
  "next_condition_check": "2024-07-15",
  "purchase_date": "2023-06-01",
  "purchase_price": 899.99,
  "current_value": 750,
  "insured_value": 800,
  "insurance_policy_number": "POL123456789",
  "last_maintenance_date": "2024-01-10",
  "next_maintenance_date": "2024-07-10",
  "maintenance_frequency_days": 180,
  "maintenance_notes": "Filter cleaning completed",
  "tags": [
    "kitchen",
    "appliance",
    "cooling"
  ],
  "custom_fields": {
    "warranty_end": "2025-06-01",
    "supplier": "Darty"
  },
  "notes": "Installed in June 2023",
  "quantity_in_room": 1,
  "location_description": "Near the window",
  "position_x": 2.5,
  "position_y": 1.2,
  "condition_in_room": "GOOD",
  "condition_notes_in_room": "Works well in this room",
  "placed_date": "2024-01-15",
  "removed_date": "2024-08-25",
  "is_active": true,
  "room_notes": "Near the window"
}
'

shell

Example Request Body

{
  "inventory_type_id": "550e8400-e29b-41d4-a716-446655440001",
  "name": "Samsung Refrigerator",
  "description": "Samsung 300L refrigerator with freezer",
  "brand": "Samsung",
  "model": "RT32K5070S8",
  "serial_number": "SN123456789",
  "quantity": 1,
  "unit": "piece",
  "condition_status": "GOOD",
  "condition_notes": "Works perfectly",
  "last_condition_check": "2024-01-15",
  "next_condition_check": "2024-07-15",
  "purchase_date": "2023-06-01",
  "purchase_price": 899.99,
  "current_value": 750,
  "insured_value": 800,
  "insurance_policy_number": "POL123456789",
  "last_maintenance_date": "2024-01-10",
  "next_maintenance_date": "2024-07-10",
  "maintenance_frequency_days": 180,
  "maintenance_notes": "Filter cleaning completed",
  "tags": [
    "kitchen",
    "appliance",
    "cooling"
  ],
  "custom_fields": {
    "warranty_end": "2025-06-01",
    "supplier": "Darty"
  },
  "notes": "Installed in June 2023",
  "quantity_in_room": 1,
  "location_description": "Near the window",
  "position_x": 2.5,
  "position_y": 1.2,
  "condition_in_room": "GOOD",
  "condition_notes_in_room": "Works well in this room",
  "placed_date": "2024-01-15",
  "removed_date": "2024-08-25",
  "is_active": true,
  "room_notes": "Near the window"
}

json

Example Responses

{
  "inventory": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "inventory_type_id": "550e8400-e29b-41d4-a716-446655440001",
    "name": "Samsung Refrigerator",
    "description": "Samsung 300L refrigerator with freezer",
    "brand": "Samsung",
    "model": "RT32K5070S8",
    "serial_number": "SN123456789",
    "quantity": 1,
    "unit": "piece",
    "condition_status": "GOOD",
    "condition_notes": "Works perfectly",
    "last_condition_check": "2024-01-15",
    "next_condition_check": "2024-07-15",
    "purchase_date": "2023-06-01",
    "purchase_price": 899.99,
    "current_value": 750,
    "insured_value": 800,
    "insurance_policy_number": "POL123456789",
    "last_maintenance_date": "2024-01-10",
    "next_maintenance_date": "2024-07-10",
    "maintenance_frequency_days": 180,
    "maintenance_notes": "Filter cleaning completed",
    "tags": [
      "kitchen",
      "appliance",
      "cooling"
    ],
    "custom_fields": {
      "warranty_end": "2025-06-01",
      "supplier": "Darty"
    },
    "notes": "Installed in June 2023",
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z"
  },
  "room_inventory": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "room_id": "550e8400-e29b-41d4-a716-446655440001",
    "inventory_id": "550e8400-e29b-41d4-a716-446655440002",
    "quantity_in_room": 1,
    "location_description": "Near the window",
    "position_x": 2.5,
    "position_y": 1.2,
    "condition_in_room": "GOOD",
    "condition_notes_in_room": "Works well in this room",
    "placed_date": "2024-01-15",
    "removed_date": "2024-08-25",
    "is_active": true,
    "notes": "Near the window",
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z"
  }
}

json

application/json

List room inventory with details

GET

https://api.faireplace.com/api

/places/{place_id}/estates/{estate_id}/rooms/{room_id}/inventory/with-details

Retrieves the list of all inventory items in a room with full details. Automatically validates that the room belongs to the correct estate.

List room inventory with details › path Parameters

place_id

string · uuid · required

Place ID

estate_id

string · uuid · required

Property ID

room_id

string · uuid · required

Room ID

List room inventory with details › Responses

Room inventory list with details retrieved successfully

object[]

Room-inventory junction with full inventory item details

id

string · uuid · required

Unique identifier of the junction

Example: 550e8400-e29b-41d4-a716-446655440000

room_id

string · uuid · required

Room ID

Example: 550e8400-e29b-41d4-a716-446655440001

inventory_id

string · uuid · required

Inventory item ID

Example: 550e8400-e29b-41d4-a716-446655440002

quantity_in_room

integer · required

Quantity of the item in this room

Example: 1

placed_date

string · date · required

Date placed in the room

Example: 2024-01-15

is_active

boolean · required

Indicates whether the item is currently in this room

Example: true

created_at

string · date-time · required

Creation date

Example: 2024-01-15T10:30:00Z

updated_at

string · date-time · required

Last modification date

Example: 2024-01-15T10:30:00Z

location_description

string | null

Description of the location within the room

Example: Near the window

position_x

number | null · decimal

X position in the room (in meters)

Example: 2.5

position_y

number | null · decimal

Y position in the room (in meters)

Example: 1.2

condition_in_room

string · enum

Condition state of an inventory item

Enum values:

EXCELLENT

GOOD

FAIR

POOR

DAMAGED

NEEDS_REPAIR

BROKEN

MISSING

Example: GOOD

condition_notes_in_room

string | null

Notes on the condition in this room

Example: Works well in this room

removed_date

string | null · date

Date removed from the room

notes

string | null

Notes specific to this room

Example: Near the window

object

Complete inventory item

GET/places/{place_id}/estates/{estate_id}/rooms/{room_id}/inventory/with-details

curl --request GET \
  --url https://api.faireplace.com/api/places/:place_id/estates/:estate_id/rooms/:room_id/inventory/with-details

shell

Example Responses

[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "room_id": "550e8400-e29b-41d4-a716-446655440001",
    "inventory_id": "550e8400-e29b-41d4-a716-446655440002",
    "quantity_in_room": 1,
    "location_description": "Near the window",
    "position_x": 2.5,
    "position_y": 1.2,
    "condition_in_room": "GOOD",
    "condition_notes_in_room": "Works well in this room",
    "placed_date": "2024-01-15",
    "removed_date": "2024-08-25",
    "is_active": true,
    "notes": "Near the window",
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z",
    "inventory": {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "inventory_type_id": "550e8400-e29b-41d4-a716-446655440001",
      "name": "Samsung Refrigerator",
      "description": "Samsung 300L refrigerator with freezer",
      "brand": "Samsung",
      "model": "RT32K5070S8",
      "serial_number": "SN123456789",
      "quantity": 1,
      "unit": "piece",
      "condition_status": "GOOD",
      "condition_notes": "Works perfectly",
      "last_condition_check": "2024-01-15",
      "next_condition_check": "2024-07-15",
      "purchase_date": "2023-06-01",
      "purchase_price": 899.99,
      "current_value": 750,
      "insured_value": 800,
      "insurance_policy_number": "POL123456789",
      "last_maintenance_date": "2024-01-10",
      "next_maintenance_date": "2024-07-10",
      "maintenance_frequency_days": 180,
      "maintenance_notes": "Filter cleaning completed",
      "tags": [
        "kitchen",
        "appliance",
        "cooling"
      ],
      "custom_fields": {
        "warranty_end": "2025-06-01",
        "supplier": "Darty"
      },
      "notes": "Installed in June 2023",
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z"
    }
  }
]

json

application/json

Update an inventory item in a room

PUT

https://api.faireplace.com/api

/places/{place_id}/estates/{estate_id}/rooms/{room_id}/inventory/{inventory_id}

Updates the information of an inventory item in a room. Also allows moving the inventory to another room if room_id is provided in the body. Automatically validates that the room belongs to the correct estate.

Update an inventory item in a room › path Parameters

place_id

string · uuid · required

Place ID

estate_id

string · uuid · required

Property ID

room_id

string · uuid · required

Room ID

inventory_id

string · uuid · required

Inventory item ID

Update an inventory item in a room › Request Body

Data for updating a room-inventory junction. **Update behavior for optional fields**: - **Field absent**: the existing value is preserved (no modification) - **Field present with `null`**: the value is removed (set to NULL in the database) - **Field present with a value**: the value is updated **Fields affected by this behavior**: - `location_description`: can be set to `null` to remove the value - `removed_date`: can be set to `null` to remove the value - `condition_notes_in_room`: can be set to `null` to remove the value - `notes`: can be set to `null` to remove the value

room_id

string | null · uuid

New room ID (to move the inventory item)

Example: 550e8400-e29b-41d4-a716-446655440001

quantity_in_room

integer | null

Quantity of the item in this room

location_description

string | null · maxLength: 500

Description of the location within the room.

Update behavior:

Field absent: the existing value is preserved
null: the value is removed (set to NULL in the database)
String: the value is updated

position_x

number | null · decimal

X position in the room (in meters)

position_y

number | null · decimal

Y position in the room (in meters)

is_active

boolean | null

Indicates whether the inventory item is currently in this room

placed_date

string | null · date

Date the item was placed in this room

removed_date

string | null · date

Date the item was removed from this room.

Update behavior:

Field absent: the existing value is preserved
null: the value is removed (set to NULL in the database)
Date: the value is updated

condition_in_room

string · enum

Condition state of an inventory item

Enum values:

EXCELLENT

GOOD

FAIR

POOR

DAMAGED

NEEDS_REPAIR

BROKEN

MISSING

Example: GOOD

condition_notes_in_room

string | null · maxLength: 500

Notes on the condition of the item in this room.

Update behavior:

Field absent: the existing value is preserved
null: the value is removed (set to NULL in the database)
String: the value is updated

notes

string | null · maxLength: 1000

General notes about this room-inventory association.

Update behavior:

Field absent: the existing value is preserved
null: the value is removed (set to NULL in the database)
String: the value is updated

Update an inventory item in a room › Responses

Inventory item updated successfully

Junction between a room and an inventory item

id

string · uuid · required

Unique identifier of the junction

Example: 550e8400-e29b-41d4-a716-446655440000

room_id

string · uuid · required

Room ID

Example: 550e8400-e29b-41d4-a716-446655440001

inventory_id

string · uuid · required

Inventory item ID

Example: 550e8400-e29b-41d4-a716-446655440002

quantity_in_room

integer · required

Quantity of the item in this room

Example: 1

placed_date

string · date · required

Date placed in the room

Example: 2024-01-15

is_active

boolean · required

Indicates whether the item is currently in this room

Example: true

created_at

string · date-time · required

Creation date

Example: 2024-01-15T10:30:00Z

updated_at

string · date-time · required

Last modification date

Example: 2024-01-15T10:30:00Z

location_description

string | null

Description of the location within the room

Example: Near the window

position_x

number | null · decimal

X position in the room (in meters)

Example: 2.5

position_y

number | null · decimal

Y position in the room (in meters)

Example: 1.2

condition_in_room

string · enum

Condition state of an inventory item

Enum values:

EXCELLENT

GOOD

FAIR

POOR

DAMAGED

NEEDS_REPAIR

BROKEN

MISSING

Example: GOOD

condition_notes_in_room

string | null

Notes on the condition in this room

Example: Works well in this room

removed_date

string | null · date

Date removed from the room

notes

string | null

Notes specific to this room

Example: Near the window

PUT/places/{place_id}/estates/{estate_id}/rooms/{room_id}/inventory/{inventory_id}

curl --request PUT \
  --url https://api.faireplace.com/api/places/:place_id/estates/:estate_id/rooms/:room_id/inventory/:inventory_id \
  --header 'Content-Type: application/json' \
  --data '
{
  "room_id": "550e8400-e29b-41d4-a716-446655440001",
  "quantity_in_room": {},
  "location_description": {},
  "position_x": {},
  "position_y": {},
  "is_active": {},
  "placed_date": "2024-08-25",
  "removed_date": "2024-08-25",
  "condition_in_room": "GOOD",
  "condition_notes_in_room": {},
  "notes": {}
}
'

shell

Example Request Body

{
  "room_id": "550e8400-e29b-41d4-a716-446655440001",
  "quantity_in_room": {},
  "location_description": {},
  "position_x": {},
  "position_y": {},
  "is_active": {},
  "placed_date": "2024-08-25",
  "removed_date": "2024-08-25",
  "condition_in_room": "GOOD",
  "condition_notes_in_room": {},
  "notes": {}
}

json

Example Responses

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "room_id": "550e8400-e29b-41d4-a716-446655440001",
  "inventory_id": "550e8400-e29b-41d4-a716-446655440002",
  "quantity_in_room": 1,
  "location_description": "Near the window",
  "position_x": 2.5,
  "position_y": 1.2,
  "condition_in_room": "GOOD",
  "condition_notes_in_room": "Works well in this room",
  "placed_date": "2024-01-15",
  "removed_date": "2024-08-25",
  "is_active": true,
  "notes": "Near the window",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

json

application/json

Remove an inventory item from a room

DELETE

https://api.faireplace.com/api

/places/{place_id}/estates/{estate_id}/rooms/{room_id}/inventory/{inventory_id}

Removes the junction between a room and an inventory item. Automatically validates that the room belongs to the correct estate.

Remove an inventory item from a room › path Parameters

place_id

string · uuid · required

Place ID

estate_id

string · uuid · required

Property ID

room_id

string · uuid · required

Room ID

inventory_id

string · uuid · required

Inventory item ID

Remove an inventory item from a room › Responses

Inventory item removed from the room successfully

No data returned

DELETE/places/{place_id}/estates/{estate_id}/rooms/{room_id}/inventory/{inventory_id}

curl --request DELETE \
  --url https://api.faireplace.com/api/places/:place_id/estates/:estate_id/rooms/:room_id/inventory/:inventory_id

shell

Example Responses

No example specified for this content type

List rooms containing an inventory item

GET

https://api.faireplace.com/api

/inventory/{inventory_id}/rooms

Retrieves the list of all rooms containing a specific inventory item

List rooms containing an inventory item › path Parameters

inventory_id

string · uuid · required

Inventory item ID

List rooms containing an inventory item › Responses

Rooms containing the item retrieved successfully

object[]

Junction between a room and an inventory item

id

string · uuid · required

Unique identifier of the junction

Example: 550e8400-e29b-41d4-a716-446655440000

room_id

string · uuid · required

Room ID

Example: 550e8400-e29b-41d4-a716-446655440001

inventory_id

string · uuid · required

Inventory item ID

Example: 550e8400-e29b-41d4-a716-446655440002

quantity_in_room

integer · required

Quantity of the item in this room

Example: 1

placed_date

string · date · required

Date placed in the room

Example: 2024-01-15

is_active

boolean · required

Indicates whether the item is currently in this room

Example: true

created_at

string · date-time · required

Creation date

Example: 2024-01-15T10:30:00Z

updated_at

string · date-time · required

Last modification date

Example: 2024-01-15T10:30:00Z

location_description

string | null

Description of the location within the room

Example: Near the window

position_x

number | null · decimal

X position in the room (in meters)

Example: 2.5

position_y

number | null · decimal

Y position in the room (in meters)

Example: 1.2

condition_in_room

string · enum

Condition state of an inventory item

Enum values:

EXCELLENT

GOOD

FAIR

POOR

DAMAGED

NEEDS_REPAIR

BROKEN

MISSING

Example: GOOD

condition_notes_in_room

string | null

Notes on the condition in this room

Example: Works well in this room

removed_date

string | null · date

Date removed from the room

notes

string | null

Notes specific to this room

Example: Near the window

GET/inventory/{inventory_id}/rooms

curl --request GET \
  --url https://api.faireplace.com/api/inventory/:inventory_id/rooms

shell

Example Responses

[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "room_id": "550e8400-e29b-41d4-a716-446655440001",
    "inventory_id": "550e8400-e29b-41d4-a716-446655440002",
    "quantity_in_room": 1,
    "location_description": "Near the window",
    "position_x": 2.5,
    "position_y": 1.2,
    "condition_in_room": "GOOD",
    "condition_notes_in_room": "Works well in this room",
    "placed_date": "2024-01-15",
    "removed_date": "2024-08-25",
    "is_active": true,
    "notes": "Near the window",
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z"
  }
]

json

application/json

List rooms containing an inventory item with details

GET

https://api.faireplace.com/api

/inventory/{inventory_id}/rooms/with-details

Retrieves the list of all rooms containing an inventory item with full details

List rooms containing an inventory item with details › path Parameters

inventory_id

string · uuid · required

Inventory item ID

List rooms containing an inventory item with details › Responses

Rooms containing the item with details retrieved successfully

object[]

Room-inventory junction with full inventory item details

id

string · uuid · required

Unique identifier of the junction

Example: 550e8400-e29b-41d4-a716-446655440000

room_id

string · uuid · required

Room ID

Example: 550e8400-e29b-41d4-a716-446655440001

inventory_id

string · uuid · required

Inventory item ID

Example: 550e8400-e29b-41d4-a716-446655440002

quantity_in_room

integer · required

Quantity of the item in this room

Example: 1

placed_date

string · date · required

Date placed in the room

Example: 2024-01-15

is_active

boolean · required

Indicates whether the item is currently in this room

Example: true

created_at

string · date-time · required

Creation date

Example: 2024-01-15T10:30:00Z

updated_at

string · date-time · required

Last modification date

Example: 2024-01-15T10:30:00Z

location_description

string | null

Description of the location within the room

Example: Near the window

position_x

number | null · decimal

X position in the room (in meters)

Example: 2.5

position_y

number | null · decimal

Y position in the room (in meters)

Example: 1.2

condition_in_room

string · enum

Condition state of an inventory item

Enum values:

EXCELLENT

GOOD

FAIR

POOR

DAMAGED

NEEDS_REPAIR

BROKEN

MISSING

Example: GOOD

condition_notes_in_room

string | null

Notes on the condition in this room

Example: Works well in this room

removed_date

string | null · date

Date removed from the room

notes

string | null

Notes specific to this room

Example: Near the window

object

Complete inventory item

GET/inventory/{inventory_id}/rooms/with-details

curl --request GET \
  --url https://api.faireplace.com/api/inventory/:inventory_id/rooms/with-details

shell

Example Responses

[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "room_id": "550e8400-e29b-41d4-a716-446655440001",
    "inventory_id": "550e8400-e29b-41d4-a716-446655440002",
    "quantity_in_room": 1,
    "location_description": "Near the window",
    "position_x": 2.5,
    "position_y": 1.2,
    "condition_in_room": "GOOD",
    "condition_notes_in_room": "Works well in this room",
    "placed_date": "2024-01-15",
    "removed_date": "2024-08-25",
    "is_active": true,
    "notes": "Near the window",
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z",
    "inventory": {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "inventory_type_id": "550e8400-e29b-41d4-a716-446655440001",
      "name": "Samsung Refrigerator",
      "description": "Samsung 300L refrigerator with freezer",
      "brand": "Samsung",
      "model": "RT32K5070S8",
      "serial_number": "SN123456789",
      "quantity": 1,
      "unit": "piece",
      "condition_status": "GOOD",
      "condition_notes": "Works perfectly",
      "last_condition_check": "2024-01-15",
      "next_condition_check": "2024-07-15",
      "purchase_date": "2023-06-01",
      "purchase_price": 899.99,
      "current_value": 750,
      "insured_value": 800,
      "insurance_policy_number": "POL123456789",
      "last_maintenance_date": "2024-01-10",
      "next_maintenance_date": "2024-07-10",
      "maintenance_frequency_days": 180,
      "maintenance_notes": "Filter cleaning completed",
      "tags": [
        "kitchen",
        "appliance",
        "cooling"
      ],
      "custom_fields": {
        "warranty_end": "2025-06-01",
        "supplier": "Darty"
      },
      "notes": "Installed in June 2023",
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z"
    }
  }
]

json

application/json

Equipment Keys