Docs
← Back to Docs
Last updated: 2026-07-08

Getting Started (Quickstart)

This is the fastest “happy path” to get value from InvyMate in under 30 minutes.

On the first login, InvyMate shows a short welcome screen with three start paths: Explore sample data (recommended), Create first asset, or Import inventory. The welcome also has a Skip for now button if you want to close it and continue later. The selection is persisted for that user and reflected in the nested onboarding state.

On the account record, onboarding progress is tracked as a nested onboarding object with a status, the selected path, completed steps, and optional completion or dismissal timestamps.

What you’ll accomplish

  • Import (or create) a clean asset register
  • Add people and assignments
  • Print QR labels
  • Run your first inventory session and download a report

Step 1 — Set up your workspace (Owner)

Go to Configuration → Workspace:

  • (Optional) Enforce assigning a person when creating an item
  • (Optional) Automatically complete a session when all items are scanned
  • (Optional) Mark unscanned items as Lost when a session is completed
  • (Optional) Allow reactivating retired assets back to in_stock (Owner/Admin)

Configuration pages also include a short Usage note under the page title so you can quickly see what each section is for.

Step 2 — Create categories and locations

Go to Configuration → Categories:

  • Add categories (e.g., Laptops, Monitors, Phones)
  • Set a default category (optional)
  • Set a prefix for tags (if you use a prefix-based convention)

Go to Configuration → Locations:

  • Add locations (e.g., HQ, Warehouse, Remote)
  • Set a default location (optional)
  • Long location names and descriptions are constrained in the list so the default-state column stays visible

Optional (recommended before import): define any Custom Fields you plan to use in CSV files (for example cost center, serial, or department code).

Step 3 — Add assets

Go to Assets → Import (/assets/upload) and upload a CSV.

Mandatory columns:

  • name
  • category
  • location

Optional columns:

  • status (e.g., in_stock, active, maintenance, lost, retired)
  • description
  • assignedTo (person email)
  • custom fields

Tip: if your CSV includes custom columns, create those Custom Fields first so mapping is straightforward.

Option B: Create assets manually

Go to Assets → Add New Item and fill in:

  • Name, Category, Location
  • Status + Condition
  • (Optional) Purchase date, warranty end date, price + currency
  • (Optional) Description, images, custom fields

If you start from the onboarding chooser, this path opens the same quick-add form with the minimum required fields first.

If you want to explore the app before loading real records, choose Explore sample data. InvyMate will seed a five-item starter set of assets and return you to the dashboard so you can browse lists, search, and open asset detail views.

The demo set now includes five items across three categories and two locations:

  • 3 laptops
  • 1 screen
  • 1 USB hub
  • 2 locations: Open Space and Meeting Room

The assets are distributed across those categories and locations with a mix of statuses so you can see how the list behaves before you add real data. Demo items are seeded with the same create-item fields the API accepts, so the onboarding seed stays aligned with validation.

Step 4 — Add people

Option A: Import people via CSV

Go to People → Upload CSV (/people/upload).

Mandatory columns:

  • fullName
  • email

Optional:

  • phone, department, notes
  • custom fields

Tip: create people Custom Fields before upload if you want to map extra columns in one pass.

Option B: Add people manually

Go to People → Add Person.

Step 5 — Assign assets

You can assign during asset creation/editing, import assignment by email, or assign from an asset/person view.

Step 6 — Print QR labels

Go to Configuration → QR Labels:

  • Create or edit a label template
  • Set a default template

Then open an asset and use the QR/label action to download/print labels, or use bulk actions on the Assets page by selecting multiple items.

If onboarding is still in progress and the QR label step has not been viewed yet, the QR label card is available on the asset detail page for manual download. The tour flow is currently disabled.

Step 7 — Run an inventory session

Go to Inventory Checks:

  1. Create a session
  2. Start it to generate the expected list
  3. Scan items and capture updates
  4. Complete the session to apply changes

When completed, request a report download.

Roles & Permissions →