SchoolAide
Help Center
Reference
Reference · Updated Mar 27, 2026

Field Reference — Counter Form

1 min read 62 views

Field Reference — Counter Form

This reference covers every field in the Create Counter and Edit Counter forms.

UI Label Backend Variable Type Required Validation Notes
Name name string Yes max:100 e.g., "Counter 1", "Window A"
Code code string Yes max:10, uppercase e.g., "C1", "WIN-A"
Office office_id ULID Yes exists:offices (tenant-scoped) Which office this counter belongs to
Sort Order sort_order int min:0 Display order on the counter panel and display board
Active is_active bool Inactive counters do not appear to staff or on display

Counter Status Reference

Status Meaning
Offline No staff logged in
Online Staff is actively serving
Paused Staff is on break

Was this article helpful?

Let us know so we can improve our documentation.

Related articles