Inventory

Manage maintenance inventory parts, units, and providers. Requires premium, unlimited, or club subscription plan.

Available Items (dropdown selector)

GET /maintenance/inventory/available.json

Returns a flat list of inventory items that have at least one InventoryUnit not yet assigned to a work order (i.e. inventory_units.workorder_id IS NULL). Intended for populating dropdown selectors when picking parts to add to a work order — items whose units are all already attached to some work order are omitted.

Scoped to the authenticated user's company. No request body, no pagination.

Response

{
  "items": [
    { "id": "d4e5f6a7-b8c9-0123-defg-h12345678901", "name": "Oil filter", "category": "Engine" },
    { "id": "e5f6a7b8-c9d0-1234-efgh-i12345678901", "name": "Spark plug",  "category": "Engine" }
  ]
}

Field	Type	Description
id	string	Inventory UUID
name	string	Part name
category	string	Part category (used as the "type" label in selectors)

Items are ordered by name ASC.

---

List Inventory

POST /maintenance/inventory/index.json

Retrieve a paginated list of inventory parts for the company.

Request Body (optional filters)

Parameter	Type	Description
category	string	Filter by part category
status	string	Filter by approval status
name	string	Search in part number, name, and manufacturer

Response

{
  "items": [
    {
      "Inventory": {
        "id": "d4e5f6a7-b8c9-0123-defg-h12345678901",
        "company_id": "c1d2e3f4-a5b6-7890-abcd-ef1234567890",
        "part_number": "CH48110-1",
        "name": "Oil filter",
        "mfr_name": "Champion Aerospace",
        "category": "Engine",
        "approval_status": "Approved",
        "description": "Standard oil filter for Lycoming engines.",
        "deleted": false
      },
      "InventoryUnit": [
        {
          "id": "e5f6a7b8-c9d0-1234-efgh-i12345678901",
          "aircraft_id": "45"
        }
      ]
    }
  ],
  "paginate": {
    "page": 1,
    "current": 10,
    "count": 85,
    "prevPage": false,
    "nextPage": true,
    "pageCount": 2,
    "limit": 50
  }
}

---

Selectables

GET /maintenance/inventory/selectables.json

Retrieve available status and category values for building forms.

Response

{
  "status": {
    "Pending": "Pending",
    "Approved": "Approved",
    "Rejected": "Rejected",
    "Quarantined": "Quarantined",
    "Certified": "Certified",
    "Non-certified": "Non-certified",
    "Under-review": "Under review",
    "Expired": "Expired",
    "Unapproved": "Unapproved"
  },
  "categories": {
    "Avionics": "Avionics",
    "Hydraulics": "Hydraulics",
    "Engine": "Engine",
    "Landing Gear": "Landing Gear",
    "Electrical": "Electrical",
    "Fuel System": "Fuel System",
    "Flight Controls": "Flight Controls",
    "Cabin Interior": "Cabin Interior",
    "Propulsion": "Propulsion",
    "Navigation": "Navigation",
    "Pneumatics": "Pneumatics",
    "Airframe": "Airframe",
    "Communication": "Communication",
    "Lighting": "Lighting",
    "Braking System": "Braking System",
    "Oxygen System": "Oxygen System",
    "Environmental Control System": "Environmental Control System",
    "Emergency Equipment": "Emergency Equipment",
    "Structure": "Structure",
    "Consumables": "Consumables",
    "Miscellaneous": "Miscellaneous"
  }
}

---

View Inventory Part

GET /maintenance/inventory/view/{id}.json

Retrieve full details for a single inventory part, including units, providers, and change history.

Path Parameters

Parameter	Type	Description
id	string	Inventory UUID

Response

{
  "inventory": {
    "Inventory": {
      "id": "d4e5f6a7-b8c9-0123-defg-h12345678901",
      "company_id": "c1d2e3f4-a5b6-7890-abcd-ef1234567890",
      "part_number": "CH48110-1",
      "name": "Oil filter",
      "mfr_name": "Champion Aerospace",
      "category": "Engine",
      "approval_status": "Approved",
      "description": "Standard oil filter for Lycoming engines."
    },
    "InventoryProvider": {
      "id": "f6a7b8c9-d0e1-2345-fghi-j12345678901",
      "name": "Aviation Parts Inc.",
      "email": "[e-mail]",
      "phone": "[phone]"
    },
    "InventoryChange": [
      {
        "id": "a7b8c9d0-e1f2-3456-ghij-k12345678901",
        "action": "ADD",
        "created": "1714003200",
        "User": {
          "id": "123",
          "UserDetail": {
            "name": "John",
            "surname": "Doe"
          }
        }
      }
    ],
    "InventoryUnit": [
      {
        "id": "e5f6a7b8-c9d0-1234-efgh-i12345678901",
        "serial_number": "SN-001234",
        "status": "installed",
        "condition": "SV",
        "Base": {
          "name": "LEBL"
        },
        "Aircraft": {
          "id": "45",
          "registration": "EC-ABC",
          "active": true,
          "maintenance": true,
          "flight_count": "1200",
          "AircraftModel": {
            "name": "C172",
            "AircraftManufacturer": {
              "name": "Cessna"
            }
          }
        }
      }
    ]
  }
}

---

Edit Inventory Part

POST /maintenance/inventory/edit.json

Create or update an inventory part. When creating, an initial inventory unit is also created.

Request Body

Parameter	Type	Required	Description
Inventory[id]	string	no	Inventory UUID (omit to create new)
Inventory[part_number]	string	yes (create)	Part number (unique per company)
Inventory[name]	string	yes (create)	Part name
Inventory[mfr_name]	string	yes (create)	Manufacturer name
Inventory[category]	string	yes (create)	Part category (see categories list)
Inventory[approval_status]	string	no	Approval status
Inventory[description]	string	no	Part description
InventoryProvider[name]	string	no	Provider name (creates or links provider)
InventoryUnit[serial_number]	string	no	Initial unit serial number
InventoryUnit[status]	string	no	Unit status
InventoryUnit[condition]	string	no	Unit condition
InventoryUnit[base_id]	string	no	Base UUID
InventoryUnit[aircraft_id]	number	no	Aircraft ID

Response

{
  "result": {
    "Inventory": {
      "id": "d4e5f6a7-b8c9-0123-defg-h12345678901",
      "part_number": "CH48110-1",
      "name": "Oil filter"
    }
  },
  "message": "Inventory item saved",
  "errors": null,
  "data": { ... }
}

On validation failure:

{
  "result": null,
  "message": "Could not save the inventory item due to validation errors",
  "errors": {
    "part_number": ["This part number is already registered"]
  },
  "data": { ... }
}

---

Delete Inventory Part

POST /maintenance/inventory/delete.json

Delete an inventory part. Requires manager role.

Request Body

Parameter	Type	Required	Description
id	string	yes	Inventory UUID

Response

{
  "result": true,
  "part": {
    "Inventory": {
      "id": "d4e5f6a7-b8c9-0123-defg-h12345678901",
      "part_number": "CH48110-1",
      "name": "Oil filter"
    }
  }
}

---

List Providers

POST /maintenance/inventory/providers.json

List inventory providers for the company, optionally filtered by search.

Request Body (optional)

Parameter	Type	Description
search	string	Search in provider name, email, and phone

Response

{
  "providers": [
    {
      "InventoryProvider": {
        "id": "f6a7b8c9-d0e1-2345-fghi-j12345678901",
        "company_id": "c1d2e3f4-a5b6-7890-abcd-ef1234567890",
        "name": "Aviation Parts Inc.",
        "email": "[e-mail]",
        "phone": "[phone]"
      }
    }
  ]
}

---

View Provider

GET /maintenance/inventory/provider/{id}.json

Retrieve details for a single provider.

Path Parameters

Parameter	Type	Description
id	string	Provider ID

Response

{
  "provider": {
    "InventoryProvider": {
      "id": "f6a7b8c9-d0e1-2345-fghi-j12345678901",
      "company_id": "c1d2e3f4-a5b6-7890-abcd-ef1234567890",
      "name": "Aviation Parts Inc.",
      "email": "[e-mail]",
      "phone": "[phone]"
    }
  }
}

---

Enumerations Reference

Category

Value
Avionics
Hydraulics
Engine
Landing Gear
Electrical
Fuel System
Flight Controls
Cabin Interior
Propulsion
Navigation
Pneumatics
Airframe
Communication
Lighting
Braking System
Oxygen System
Environmental Control System
Emergency Equipment
Structure
Consumables
Miscellaneous

Approval Status

Value	Description
Pending	Awaiting inspection, documentation, or approval
Approved	Passed inspections, meets regulatory requirements
Rejected	Failed inspection, cannot be used
Quarantined	Held pending further investigation
Certified	Officially certified (e.g. FAA 8130-3, EASA Form 1)
Non-certified	Lacks necessary certification
Under-review	Being evaluated, no decision yet
Expired	Certification lapsed or shelf life ended
Unapproved	Explicitly not suitable for use