Property Management

Copy page

Equipment API

Track appliances, fixtures, and safety equipment in your properties. Equipment records are useful for furnished leases, maintenance scheduling, and inventory management.

Quick Example

Code
 
curl -X POST https://api.faireplace.com/api/equipment \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Lave-vaisselle Bosch",
    "equipment_type": "Dishwasher",
    "brand": "Bosch",
    "model": "SMS46GI55E",
    "purchase_date": "2024-03-15",
    "warranty_expiry": "2027-03-15"
  }'

Common Workflows

Set up a furnished apartment inventory

1. POST /api/equipment — Create each item (refrigerator, washing machine, etc.)
2. POST /api/equipment/{id}/estates/{estate_id} — Link to the apartment
3. POST /api/equipment/{id}/rooms/{room_id} — Assign to specific rooms

---

Overview

Equipment management includes:

• Appliances: Refrigerators, ovens, washing machines, etc.
• Fixtures: Built-in equipment and installations
• HVAC Systems: Heating, ventilation, and air conditioning
• Safety Equipment: Smoke detectors, fire extinguishers
• Maintenance Tracking: Equipment servicing and lifecycle management

Authentication

Requires PropertiesRead, PropertiesWrite, or PropertiesDelete permissions.

Base URL

Equipment endpoints: /api/equipment

---

Core Operations

List Equipment

GET /api/equipment

Create Equipment

POST /api/equipment

Request:

Code
 
{
  "name": "Refrigerateur Samsung",
  "equipment_type": "Refrigerator",
  "brand": "Samsung",
  "model": "RB38T7519SR",
  "serial_number": "ABC123456",
  "purchase_date": "2024-03-15",
  "warranty_expiry": "2027-03-15",
  "maintenance_frequency": "Annual"
}

Get Equipment

GET /api/equipment/{id}

Update Equipment

PUT /api/equipment/{id}

Delete Equipment

DELETE /api/equipment/{id}

---

Equipment Types

• Refrigerator, Oven, Dishwasher, WashingMachine
• Boiler, HeatPump, AirConditioner
• SmokeDetector, FireExtinguisher
• SecuritySystem, IntercomSystem

---

Equipment Associations

Link Equipment to Room

POST /api/equipment/{id}/rooms/{room_id}

Link Equipment to Estate

POST /api/equipment/{id}/estates/{estate_id}

---

Common Use Cases

• Asset Management: Track property equipment inventory
• Maintenance Scheduling: Plan servicing based on equipment types
• Warranty Tracking: Monitor warranty status and expiry dates
• Replacement Planning: Track equipment age and lifecycle