Schemas
The wire shapes every response is built from. These are the same components
the generated SDKs are typed against, and the live responses are pinned to them by the
contract test — a field here is a field the server sends.
AccessDirection
No declared fields.
AccessMethod
No declared fields.
AccessResult
No declared fields.
ActorStatus
No declared fields.
ApiAudience
No declared fields.
AttendanceSource
No declared fields.
BandStatus
No declared fields.
Capability
No declared fields.
ChargeFrequency
No declared fields.
ChargeSubjectScope
No declared fields.
DeadLetterKind
No declared fields.
DenialReason
No declared fields.
DeviceKind
No declared fields.
DeviceStatus
No declared fields.
EntryDirection
No declared fields.
EventStatus
No declared fields.
ExportKind
No declared fields.
ExportStatus
No declared fields.
Gender
No declared fields.
GuardianRelation
No declared fields.
IntelligenceInsightSeverity
No declared fields.
IntelligenceMessageRole
No declared fields.
IntentDirection
No declared fields.
IntentState
No declared fields.
InvoiceStatus
No declared fields.
KycStatus
No declared fields.
LoanInterestType
No declared fields.
LoanStatus
No declared fields.
MemberVia
No declared fields.
MessageChannel
No declared fields.
MessageState
No declared fields.
OnboardingStage
No declared fields.
OtpPurpose
No declared fields.
PassHolderChange
No declared fields.
PassTicketStatus
No declared fields.
PaymentGateway
No declared fields.
PlanSchedule
No declared fields.
ReachDimension
No declared fields.
RiderStatus
No declared fields.
RouteStatus
No declared fields.
RuleFrequency
No declared fields.
Severity
No declared fields.
ShiftStatus
No declared fields.
ShortLinkKind
No declared fields.
StaffKind
No declared fields.
SubscriptionStatus
No declared fields.
SurveyQuestionKind
No declared fields.
SurveyResponseState
No declared fields.
SurveyStatus
No declared fields.
TenantProduct
No declared fields.
TripDirection
No declared fields.
TripEventKind
No declared fields.
TripStatus
No declared fields.
TxnState
No declared fields.
TxnType
No declared fields.
VehicleFuelType
No declared fields.
VoucherKind
No declared fields.
WaitlistStatus
No declared fields.
WalletHolder
No declared fields.
WalletKind
No declared fields.
WalletStatus
No declared fields.
WhatsappInboundType
No declared fields.
ZoneAccessMode
No declared fields.
ZoneKind
No declared fields.
ZoneServiceKind
No declared fields.
Money
| Field | Type | | Constraints |
|---|
amount_minor | integer | required | — |
currency | string | required | min length 3 · max length 3 |
symbol | string | required | — |
Guardian
| Field | Type | | Constraints |
|---|
account_id | string (uuid) | required | — |
name | string | required | — |
phone | string | null | required | — |
relationship | string | null | required | — |
is_primary | boolean | required | — |
Dropoff
| Field | Type | | Constraints |
|---|
lat | number | required | — |
lng | number | required | — |
WalletSummary
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
code | string | null | required | — |
name | string | required | — |
kind | string | required | — |
status | string | required | — |
balance | Money | required | — |
spending_profile | any | required | — |
Student
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
first_name | string | optional | — |
middle_name | string | null | optional | — |
last_name | string | null | optional | — |
gender | string | null | optional | — |
dob | string | null | optional | — |
grade | string | null | optional | — |
status | string | optional | — |
external_ref | string | null | optional | — |
alert_note | string | null | optional | — |
account_id | string | null | optional | — |
photo | any | optional | — |
created_at | string (date-time) | optional | — |
tags | object[] | optional | — |
guardians | Guardian[] | optional | — |
dropoff | any | optional | — |
updated_at | string (date-time) | required | — |
deleted | boolean | required | — |
Band
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
serial_number | string | optional | — |
earth_code | string | null | optional | — |
status | string | optional | — |
student_id | string | null | optional | — |
account_id | string | null | optional | — |
wallet_id | string | null | optional | — |
band_type | any | optional | — |
expires_at | string | null | optional | — |
tags | object[] | optional | — |
updated_at | string (date-time) | required | — |
deleted | boolean | required | — |
WebSpendingProfile
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
name | string | required | — |
description | string | null | required | — |
daily_limit_minor | integer | null | required | — |
weekly_limit_minor | integer | null | required | — |
per_txn_limit_minor | integer | null | required | — |
daily_txn_limit | integer | null | required | — |
weekly_txn_limit | integer | null | required | — |
allowed_zone_kinds | array | null | required | — |
time_windows | array | required | — |
wallets | integer | required | — |
MessageQueued
| Field | Type | | Constraints |
|---|
queued | integer | required | — |
SpendingProfileAssignment
| Field | Type | | Constraints |
|---|
wallet_id | string (uuid) | required | — |
spending_profile_id | string | null | required | — |
BandDetail
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
serial_number | string | required | — |
earth_code | string | null | required | — |
batch_number | string | null | required | — |
color | string | null | required | — |
band_type_id | string | null | required | — |
status | string | required | — |
student_id | string | null | required | — |
account_id | string | null | required | — |
wallet_id | string | null | required | — |
assigned_at | string | null | required | — |
expires_at | string | null | required | — |
tags | object[] | required | — |
wearer | any | required | — |
wallet | any | required | — |
BandAssignedToSchool
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
serial_number | string | required | — |
earth_code | string | null | required | — |
batch_number | string | null | required | — |
color | string | null | required | — |
band_type_id | string | null | required | — |
status | string | required | — |
student_id | string | null | required | — |
account_id | string | null | required | — |
wallet_id | string | null | required | — |
assigned_at | string | null | required | — |
expires_at | string | null | required | — |
tags | object[] | required | — |
wearer | any | required | — |
wallet | any | required | — |
school_id | string (uuid) | required | — |
school_name | string | required | — |
BandMovedToOrganizer
| Field | Type | | Constraints |
|---|
serial_number | string | required | — |
status | string | required | — |
organizer_id | string (uuid) | required | — |
VendorListProposal
| Field | Type | | Constraints |
|---|
items | object[] | required | — |
skipped | integer | required | — |
Zone
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
name | string | optional | — |
kind | string | optional | — |
status | string | optional | — |
description | string | null | optional | — |
parent_zone_id | string | null | optional | — |
centroid | any | optional | — |
expires_at | string | null | optional | — |
tags | object[] | optional | — |
updated_at | string (date-time) | required | — |
deleted | boolean | required | — |
Route
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
zone_id | string (uuid) | optional | — |
name | string | optional | — |
description | string | null | optional | — |
status | string | optional | — |
est_duration | string | null | optional | — |
expected_occupancy | integer | null | optional | — |
updated_at | string (date-time) | required | — |
deleted | boolean | required | — |
Trip
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
trip_plan_id | string | null | optional | — |
route_id | string | null | optional | — |
zone_id | string | null | optional | — |
bus_zone_id | string | null | optional | — |
driver_user_id | string | null | optional | — |
status | string | optional | — |
direction | string | optional | — |
label | string | null | optional | — |
route_name | string | null | optional | — |
started_at | string | null | optional | — |
ended_at | string | null | optional | — |
expected_riders | integer | null | optional | — |
boarded_riders | integer | null | optional | — |
absent_count | integer | null | optional | — |
issues_count | integer | null | optional | — |
bus_capacity | integer | null | optional | — |
updated_at | string (date-time) | required | — |
deleted | boolean | required | — |
TripRider
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
trip_id | string (uuid) | optional | — |
student_id | string (uuid) | optional | — |
status | string | optional | — |
boarded_at | string | null | optional | — |
boarded_source | string | null | optional | — |
dropped_at | string | null | optional | — |
dropped_source | string | null | optional | — |
updated_at | string (date-time) | required | — |
deleted | boolean | required | — |
TripPlanRider
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
trip_plan_id | string (uuid) | optional | — |
student_id | string (uuid) | optional | — |
boarding_order | integer | null | optional | — |
alighting_order | integer | null | optional | — |
pickup_stop_id | string | null | optional | — |
dropoff_stop_id | string | null | optional | — |
updated_at | string (date-time) | required | — |
deleted | boolean | required | — |
TripPlan
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
route_id | string | null | optional | — |
label | string | null | optional | — |
direction | string | optional | — |
schedule | string | optional | — |
start_time | string | null | optional | — |
scheduled_on | string | null | optional | — |
recurring_days | array | null | optional | — |
checkout_counts_as_rollcall | boolean | optional | — |
status | string | optional | — |
updated_at | string (date-time) | required | — |
deleted | boolean | required | — |
TripWrite
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
status | string | required | — |
direction | string | required | — |
started_at | string | null | required | — |
ended_at | string | null | required | — |
expected_riders | integer | required | — |
boarded_riders | integer | required | — |
polyline | string | null | required | — |
planned_polyline | string | null | required | — |
riders | object[] | required | — |
TripEvent
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
kind | string | required | — |
severity | string | null | required | — |
message | string | null | required | — |
student_id | string | null | required | — |
occurred_at | string (date-time) | required | — |
PositionBatch
| Field | Type | | Constraints |
|---|
accepted | integer | required | — |
duplicates | integer | required | — |
stale | integer | optional | — |
next_position_seconds | integer | required | — |
TripHandover
| Field | Type | | Constraints |
|---|
moved_riders | integer | required | — |
target_trip_id | string (uuid) | required | — |
dead_trip_status | string | required | — |
TripLive
| Field | Type | | Constraints |
|---|
trip_id | string (uuid) | required | — |
status | string | required | — |
boarded_riders | integer | null | optional | — |
expected_riders | integer | null | optional | — |
last_position | any | optional | — |
eta_school | string | null | optional | — |
planned_polyline | string | null | optional | — |
stop_etas | object[] | optional | — |
next_poll_seconds | integer | optional | — |
TripPosition
| Field | Type | | Constraints |
|---|
lat | number | required | — |
lng | number | required | — |
speed_kph | number | null | optional | — |
heading | number | null | optional | — |
recorded_at | string | null | optional | — |
Account
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
first_name | string | optional | — |
middle_name | string | null | optional | — |
last_name | string | null | optional | — |
phone | string | null | optional | — |
email | string | null | optional | — |
gender | string | null | optional | — |
kyc_status | string | null | optional | — |
status | string | optional | — |
external_ref | string | null | optional | — |
created_at | string (date-time) | optional | — |
wallets | WalletSummary[] | optional | — |
updated_at | string (date-time) | required | — |
deleted | boolean | required | — |
AccountDetail
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
first_name | string | required | — |
middle_name | string | null | required | — |
last_name | string | null | required | — |
phone | string | null | required | — |
kyc_status | string | null | required | — |
status | string | required | — |
external_ref | string | null | required | — |
students | object[] | required | — |
wallets | object[] | required | — |
GraphAccount
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
first_name | string | optional | — |
middle_name | string | null | optional | — |
last_name | string | null | optional | — |
phone | string | null | optional | — |
email | string | null | optional | — |
gender | string | null | optional | — |
kyc_status | string | null | optional | — |
status | string | optional | — |
external_ref | string | null | optional | — |
created_at | string (date-time) | optional | — |
wallets | WalletSummary[] | optional | — |
students | GraphStudentRef[] | optional | — |
updated_at | string (date-time) | required | — |
deleted | boolean | required | — |
GraphStudentRef
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
first_name | string | required | — |
middle_name | string | null | required | — |
last_name | string | null | required | — |
gender | string | null | required | — |
dob | string | null | required | — |
grade | string | null | required | — |
status | string | required | — |
photo | any | required | — |
presence | any | required | — |
GraphStudent
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
deleted | boolean | required | — |
updated_at | string (date-time) | required | — |
first_name | string | optional | — |
middle_name | string | null | optional | — |
last_name | string | null | optional | — |
gender | string | null | optional | — |
dob | string | null | optional | — |
grade | string | null | optional | — |
status | string | optional | — |
rider_status | RiderStatus | optional | — |
presence | any | optional | — |
external_ref | string | null | optional | — |
photo | any | optional | — |
tags | object[] | optional | — |
guardians | GraphGuardian[] | optional | — |
wallets | GraphWallet[] | optional | — |
bands | GraphBand[] | optional | — |
trip_plans | GraphTripPlan[] | optional | — |
dropoff | any | optional | — |
home | any | optional | — |
home_locations | HomeLocation[] | optional | — |
HomeLocation
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
label | string | null | optional | — |
lat | number | null | optional | — |
lng | number | null | optional | — |
is_default | boolean | required | — |
GraphWallet
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
balance_minor | integer | required | — |
currency_code | string | required | — |
status | string | required | — |
spending_profile | any | optional | — |
GraphSpendingProfile
| Field | Type | | Constraints |
|---|
name | string | required | — |
daily_limit_minor | integer | null | optional | — |
weekly_limit_minor | integer | null | optional | — |
per_txn_limit_minor | integer | null | optional | — |
allowed_zone_kinds | string[] | optional | — |
GraphGuardian
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
account_id | string | null | required | — |
first_name | string | null | required | — |
last_name | string | null | required | — |
phone | string | null | required | — |
relation | string | null | required | — |
is_primary | boolean | required | — |
GraphBand
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
serial_number | string | required | — |
earth_code | string | null | required | — |
status | string | required | — |
GraphTripPlan
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
label | string | required | — |
direction | string | required | — |
schedule | string | required | — |
start_time | string | null | optional | — |
route_name | string | null | optional | — |
pickup_stop | any | optional | — |
dropoff_stop | any | optional | — |
TripStop
| Field | Type | | Constraints |
|---|
name | string | required | — |
lat | number | null | optional | — |
lng | number | null | optional | — |
Transaction
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
wallet_id | string | null | optional | — |
type | string | optional | — |
state | string | optional | — |
direction | string | null | optional | — |
amount | MoneyFormatted | optional | — |
balance_after | any | optional | — |
description | string | null | optional | — |
category | string | null | optional | — |
payment_method | string | null | optional | — |
created_at | string (date-time) | optional | — |
updated_at | string (date-time) | required | — |
deleted | boolean | required | — |
WalletBalance
| Field | Type | | Constraints |
|---|
wallet_id | string (uuid) | required | — |
balance | MoneyFormatted | required | — |
WalletStatementRow
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
type | string | required | — |
state | string | required | — |
direction | string | null | optional | — |
amount | MoneyFormatted | required | — |
balance_after | MoneyFormatted | required | — |
description | string | null | optional | — |
student | any | optional | — |
created_at | string (date-time) | required | — |
WalletStatementSummary
| Field | Type | | Constraints |
|---|
currency | string | required | — |
totals | object | required | — |
net_minor | integer | required | — |
opening_minor | integer | required | — |
closing_minor | integer | required | — |
SpendingProfile
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
name | string | required | — |
description | string | null | optional | — |
daily_limit | any | optional | — |
weekly_limit | any | optional | — |
per_txn_limit | any | optional | — |
allowed_zone_kinds | string[] | optional | — |
time_windows | object[] | optional | — |
PinStatus
| Field | Type | | Constraints |
|---|
set | boolean | required | — |
required | boolean | required | — |
Tombstone
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
deleted | boolean | required | — |
updated_at | string (date-time) | required | — |
GraphTombstone
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
kind | string | required | student account |
deleted | boolean | required | — |
updated_at | string (date-time) | required | — |
TapVerdict
| Field | Type | | Constraints |
|---|
result | string | required | allowed denied noop |
reason | string | optional | — |
detail | string | optional | — |
holder | string | optional | — |
admits | string[] | optional | — |
charge | object | optional | — |
charge.transaction_id | string (uuid) | required | — |
charge.amount | object | required | — |
charge.balance_after | object | required | — |
TapBatchItem
| Field | Type | | Constraints |
|---|
client_event_id | string | required | — |
result | string | required | applied duplicate rejected |
code | string | optional | — |
tap | TapVerdict | optional | — |
RiderResult
| Field | Type | | Constraints |
|---|
client_event_id | string | required | — |
result | string | required | applied duplicate rejected |
code | string | optional | — |
rider_status | string | optional | — |
charge | object | optional | — |
charge.transaction_id | string (uuid) | required | — |
charge.amount | object | required | — |
RiderCounters
| Field | Type | | Constraints |
|---|
boarded_riders | integer | required | — |
expected_riders | integer | required | — |
absent | integer | required | — |
Photo
| Field | Type | | Constraints |
|---|
url | string | required | — |
medium | string | required | — |
thumb | string | required | — |
Problem
| Field | Type | | Constraints |
|---|
type | string | optional | — |
code | string | required | — |
title | string | required | — |
status | integer | required | — |
detail | string | optional | — |
violations | object[] | optional | — |
missing_capability | string | optional | — |
CursorPageMeta
| Field | Type | | Constraints |
|---|
next_cursor | string | null | required | — |
max_updated_at | string | null | optional | — |
full_resync | boolean | optional | — |
count | integer | optional | — |
BootstrapApp
| Field | Type | | Constraints |
|---|
app | object | required | — |
app.update | object | optional | — |
app.flags | object | required | — |
app.batch | object | required | — |
school | object | optional | — |
school.id | string (uuid) | required | — |
school.name | string | required | — |
school.location | object | optional | — |
user | object | required | — |
user.id | string (uuid) | required | — |
user.first_name | string | required | — |
user.middle_name | string | null | optional | — |
user.last_name | string | null | optional | — |
user.phone | string | null | optional | — |
user.staff_kind | string | null | optional | — |
user.tenant | object | optional | — |
user.zones | BootstrapZoneRef[] | optional | — |
user.active_zone_id | string | null | optional | — |
user.pending_tasks | Trip[] | optional | — |
permissions | object | required | — |
permissions.capabilities | string[] | required | — |
permissions.zones | string[] | required | — |
permissions.tags | string[] | required | — |
included | object | required | — |
included.trip-plan | object | required | — |
included.trip-plan-rider | object | required | — |
metadata_fields | object[] | optional | — |
spending_profiles | object[] | optional | — |
filters | object | optional | — |
filters.account_tags | string[] | required | — |
filters.wallet_tags | string[] | required | — |
filters.dependant_tags | string[] | required | — |
templates | object[] | optional | — |
BootstrapZoneRef
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
name | string | required | — |
kind | ZoneKind | required | — |
is_default | boolean | required | — |
main_zone_name | string | null | optional | — |
description | string | null | optional | — |
location | object | optional | — |
location.lat | number | required | — |
location.lng | number | required | — |
tags | object[] | required | — |
vehicle | object | optional | — |
vehicle.registration | string | null | required | — |
vehicle.make | string | null | required | — |
vehicle.model | string | null | required | — |
vehicle.capacity | integer | null | required | — |
routes | Route[] | optional | — |
Profile
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
first_name | string | required | — |
middle_name | string | null | required | — |
last_name | string | null | required | — |
phone | string | required | — |
email | string | null | required | — |
staff_kind | string | null | required | — |
status | string | required | — |
tenant_id | string | null | required | — |
audience | ApiAudience | required | — |
AccessLog
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
direction | any | required | — |
method | any | required | — |
result | any | required | — |
reason | string | null | required | — |
occurred_at | string (date-time) | required | — |
zone | object | required | — |
zone.id | string (uuid) | required | — |
zone.name | string | required | — |
zone.kind | string | null | required | — |
student | any | required | — |
guardian | any | required | — |
verified_by | any | required | — |
band_serial | string | null | required | — |
trip_id | string | null | required | — |
AuthSession
| Field | Type | | Constraints |
|---|
otp_required | boolean | required | — |
access_token | string | optional | — |
token_type | string | optional | — |
expires_in | integer | optional | — |
refresh_token | string | optional | — |
must_set_password | boolean | optional | — |
bootstrap | any | optional | — |
challenge_id | string | optional | — |
otp_delivery | string | optional | — |
otp_masked_to | string | optional | — |
debug_otp | string | optional | — |
AuthTokens
| Field | Type | | Constraints |
|---|
access_token | string | required | — |
token_type | string | required | — |
expires_in | integer | required | — |
refresh_token | string | required | — |
AuditEntry
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
action | string | required | — |
entity_type | string | required | — |
entity_id | string | null | required | — |
changes | any | required | — |
school_id | string | null | required | — |
school_name | string | null | required | — |
actor_name | string | required | — |
shadow_operator_name | string | null | required | — |
ip | string | null | required | — |
created_at | string | required | — |
ShadowSession
| Field | Type | | Constraints |
|---|
access_token | string | required | — |
token_type | string | required | — |
expires_in | integer | required | — |
school_id | string (uuid) | required | — |
school_name | string | required | — |
TenantSwitched
| Field | Type | | Constraints |
|---|
access_token | string | required | — |
token_type | string | required | — |
expires_in | integer | required | — |
tenant_id | string (uuid) | required | — |
Ack
| Field | Type | | Constraints |
|---|
ok | boolean | required | — |
ApiClient
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
tenant_id | string | null | required | — |
audience | string | required | — |
name | string | required | — |
scopes | string[] | required | — |
rate_tier | string | required | — |
status | string | required | — |
created_at | string | required | — |
ApiClientCreated
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
tenant_id | string | null | required | — |
audience | string | required | — |
name | string | required | — |
scopes | string[] | required | — |
rate_tier | string | required | — |
status | string | required | — |
created_at | string | required | — |
client_secret | string | required | — |
ClientToken
| Field | Type | | Constraints |
|---|
access_token | string | required | — |
token_type | string | required | — |
expires_in | integer | required | — |
scopes | string[] | required | — |
MachinePersonSync
| Field | Type | | Constraints |
|---|
account_id | string (uuid) | required | — |
created | boolean | required | — |
wallet_opened | boolean | required | — |
MachinePinSet
| Field | Type | | Constraints |
|---|
wallets_updated | integer | required | — |
MachineWalletCredit
| Field | Type | | Constraints |
|---|
transaction_id | string (uuid) | required | — |
wallet_id | string (uuid) | required | — |
MachineWalletDebit
| Field | Type | | Constraints |
|---|
transaction_id | string (uuid) | required | — |
wallet_id | string (uuid) | required | — |
Presence
| Field | Type | | Constraints |
|---|
state | string | required | present away none |
path | object[] | optional | — |
since | string | null | optional | — |
last_zone | object | optional | — |
last_zone.id | string | required | — |
last_zone.name | string | null | optional | — |
last_seen | string | null | optional | — |
PresenceEntry
| Field | Type | | Constraints |
|---|
student_id | string | required | — |
state | string | required | present away none |
path | object[] | optional | — |
since | string | null | optional | — |
last_zone | object | optional | — |
last_zone.id | string | required | — |
last_zone.name | string | null | optional | — |
last_seen | string | null | optional | — |
TimelineEntry
| Field | Type | | Constraints |
|---|
kind | string | required | tap trip_boarded trip_dropped transaction |
at | string | required | — |
detail | TimelineDetail | required | — |
TimelineDetail
| Field | Type | | Constraints |
|---|
zone | string | null | optional | — |
direction | string | null | optional | — |
method | string | null | optional | — |
result | string | null | optional | — |
reason | string | null | optional | — |
trip_id | string | null | optional | — |
route | string | null | optional | — |
stop | string | null | optional | — |
type | string | null | optional | — |
amount | any | optional | — |
description | string | null | optional | — |
HeartbeatAck
| Field | Type | | Constraints |
|---|
ok | boolean | required | — |
presence | string | required | online low_battery |
next_heartbeat_seconds | integer | required | — |
Tag
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
name | string | required | — |
entity | string | null | required | — |
color_hex | string | null | required | — |
Group
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
name | string | required | — |
is_default | boolean | required | — |
status | string | required | — |
member_count | integer | required | — |
BandType
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
name | string | required | — |
BandWrite
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
serial_number | string | required | — |
earth_code | string | null | required | — |
batch_number | string | null | required | — |
color | string | null | required | — |
band_type_id | string | null | required | — |
status | string | required | — |
student_id | string | null | required | — |
account_id | string | null | required | — |
wallet_id | string | null | required | — |
assigned_at | string | null | required | — |
expires_at | string | null | required | — |
event_id | string | null | required | — |
BandBulkIntake
| Field | Type | | Constraints |
|---|
registered | integer | required | — |
duplicate | integer | required | — |
invalid | integer | required | — |
results | object[] | required | — |
BandEdited
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
serial_number | string | required | — |
earth_code | string | null | required | — |
batch_number | string | null | required | — |
color | string | null | required | — |
band_type_id | string | null | required | — |
status | string | required | — |
student_id | string | null | required | — |
account_id | string | null | required | — |
wallet_id | string | null | required | — |
assigned_at | string | null | required | — |
expires_at | string | null | required | — |
school_id | string | null | required | — |
school_name | string | null | required | — |
SetupProgress
| Field | Type | | Constraints |
|---|
school_location | boolean | required | — |
create_locations | boolean | required | — |
add_fleet | boolean | required | — |
plan_routes | boolean | required | — |
trip_plan | boolean | required | — |
invite_staff | boolean | required | — |
register_people | boolean | required | — |
required_complete | boolean | required | — |
complete | boolean | required | — |
trips_blocked | boolean | required | — |
PosItem
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
name | string | optional | — |
sku | string | null | optional | — |
active | boolean | optional | — |
category_id | string | null | optional | — |
beneficiary_wallet_id | string | null | optional | — |
price | MoneyFormatted | optional | — |
min_order_qty | integer | optional | — |
photo | any | optional | — |
updated_at | string (date-time) | required | — |
deleted | boolean | required | — |
PosItemWrite
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
name | string | required | — |
sku | string | null | required | — |
active | boolean | required | — |
category_id | string | null | required | — |
beneficiary_wallet_id | string | null | required | — |
price | MoneyFormatted | required | — |
min_order_qty | integer | required | — |
PosCategory
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
name | string | optional | — |
active | boolean | optional | — |
color | string | null | optional | — |
photo | any | optional | — |
updated_at | string (date-time) | required | — |
deleted | boolean | required | — |
PosCategoryWrite
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
name | string | required | — |
active | boolean | required | — |
color | string | null | required | — |
PosCategoryAdmin
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
name | string | required | — |
active | boolean | required | — |
color | string | null | required | — |
photo | any | required | — |
created_at | string (date-time) | required | — |
updated_at | string (date-time) | required | — |
PosItemAdmin
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
name | string | required | — |
sku | string | null | required | — |
active | boolean | required | — |
category_id | string | null | required | — |
beneficiary_wallet_id | string | null | required | — |
price | MoneyFormatted | required | — |
min_order_qty | integer | required | — |
cost_price | any | required | — |
photo | any | required | — |
created_at | string (date-time) | required | — |
updated_at | string (date-time) | required | — |
PosItemCopyReceipt
| Field | Type | | Constraints |
|---|
targets | integer | required | — |
created | integer | required | — |
updated | integer | required | — |
WebSurvey
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
name | string | required | — |
status | string | required | — |
template_name | string | required | — |
template_language | string | required | — |
closing_message | string | null | required | — |
sent | integer | required | — |
completed | integer | required | — |
created_at | string (date-time) | required | — |
updated_at | string (date-time) | required | — |
WebSurveyDetail
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
name | string | required | — |
status | string | required | — |
template_name | string | required | — |
template_language | string | required | — |
closing_message | string | null | required | — |
sent | integer | required | — |
completed | integer | required | — |
created_at | string (date-time) | required | — |
updated_at | string (date-time) | required | — |
questions | WebSurveyQuestion[] | optional | — |
WebSurveyQuestion
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
position | integer | required | — |
kind | string | required | — |
prompt | string | required | — |
hint | string | null | required | — |
options | object[] | required | — |
WebSurveyRun
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
survey_id | string (uuid) | required | — |
school_id | string | null | required | — |
audience | string | required | — |
recipients | integer | required | — |
created_at | string (date-time) | required | — |
WabaTemplate
| Field | Type | | Constraints |
|---|
name | string | required | — |
language | string | required | — |
status | string | required | — |
category | string | required | — |
body | string | null | required | — |
buttons | string[] | required | — |
WebSurveyResponseRow
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
phone | string | required | — |
state | string | required | — |
started_at | string | null | required | — |
completed_at | string | null | required | — |
answers | object[] | required | — |
WebSurveySummary
| Field | Type | | Constraints |
|---|
sent | integer | required | — |
completed | integer | required | — |
questions | object[] | required | — |
StudentWrite
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
first_name | string | required | — |
last_name | string | null | required | — |
grade | string | null | required | — |
status | string | required | — |
PayReceipt
| Field | Type | | Constraints |
|---|
transaction_id | string (uuid) | required | — |
type | string | required | — |
state | string | required | — |
student | any | required | — |
balance_after | any | required | — |
WalletChargeReceipt
| Field | Type | | Constraints |
|---|
transaction_id | string (uuid) | required | — |
type | string | required | — |
state | string | required | — |
customer | any | required | — |
amount | MoneyFormatted | required | — |
balance_after | any | required | — |
PaymentIntent
| Field | Type | | Constraints |
|---|
payment_intent_id | string (uuid) | required | — |
state | string | required | — |
gateway | string | required | — |
amount | object | required | — |
amount.amount_minor | integer | required | — |
amount.currency | string | required | min length 3 · max length 3 |
instructions | string | optional | — |
PaymentIntentDetail
| Field | Type | | Constraints |
|---|
payment_intent_id | string (uuid) | required | — |
state | string | required | — |
gateway | string | required | — |
amount | object | required | — |
amount.amount_minor | integer | required | — |
amount.currency | string | required | min length 3 · max length 3 |
transaction_id | string | null | required | — |
provider_ref | string | null | required | — |
failure_reason | string | null | required | — |
BootstrapConsole
| Field | Type | | Constraints |
|---|
tenant | any | required | — |
schools | object[] | required | — |
user | object | required | — |
user.id | string (uuid) | required | — |
user.first_name | string | required | — |
user.last_name | string | null | required | — |
user.email | string | null | required | — |
user.phone | string | null | required | — |
user.staff_kind | string | null | required | — |
user.surface | string | required | — |
user.scopes | string[] | required | — |
shadow | any | required | — |
tags | object[] | required | — |
zones | object[] | required | — |
routes | object[] | required | — |
grades | string[] | required | — |
permissions | object | required | — |
permissions.capabilities | string[] | required | — |
counts | object | required | — |
counts.unread_notifications | integer | required | — |
included | object | required | — |
included.student | object | required | — |
included.zone | object | required | — |
included.device | object | required | — |
included.trip | object | required | — |
included.overview | Overview | required | — |
WebStudent
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
first_name | string | required | — |
middle_name | string | null | required | — |
last_name | string | null | required | — |
gender | string | null | required | — |
dob | string | null | required | — |
grade | string | null | required | — |
status | string | required | — |
external_ref | string | null | required | — |
photo | any | required | — |
row_version | integer | required | — |
school_id | string | null | required | — |
school_name | string | null | required | — |
guardians | Guardian[] | required | — |
band | any | required | — |
route | any | required | — |
today | object | required | — |
today.checked_in | boolean | required | — |
today.checked_in_at | string | null | required | — |
WebStudentDetail
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
first_name | string | required | — |
middle_name | string | null | required | — |
last_name | string | null | required | — |
gender | string | null | required | — |
dob | string | null | required | — |
grade | string | null | required | — |
status | string | required | — |
external_ref | string | null | required | — |
photo | any | required | — |
row_version | integer | required | — |
school_id | string | null | required | — |
school_name | string | null | required | — |
guardians | Guardian[] | required | — |
band | any | required | — |
route | any | required | — |
today | object | required | — |
today.checked_in | boolean | required | — |
today.checked_in_at | string | null | required | — |
metadata | object | required | — |
tags | object[] | required | — |
wallet | any | required | — |
band_history | object[] | required | — |
trip_plans | object[] | required | — |
home_location | any | required | — |
recent_timeline | TimelineEntry[] | required | — |
WebUser
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
kind | string | optional | — |
first_name | string | required | — |
middle_name | string | null | optional | — |
last_name | string | null | optional | — |
email | string | null | optional | — |
phone | string | null | optional | — |
staff_kind | string | null | optional | — |
tenant_role_id | string | null | optional | — |
status | string | required | — |
school_id | string | null | optional | — |
school_name | string | null | optional | — |
report_subscriptions | string[] | optional | — |
receive_notifications | boolean | optional | — |
receive_email_notifications | boolean | optional | — |
receive_sms_notifications | boolean | optional | — |
receive_whatsapp_notifications | boolean | optional | — |
zones | object[] | optional | — |
has_login | boolean | optional | — |
students_count | integer | optional | — |
subscription | any | optional | — |
last_login_at | string | null | optional | — |
created_at | string (date-time) | optional | — |
row_version | integer | required | — |
WebUserDetail
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
kind | string | optional | — |
first_name | string | required | — |
middle_name | string | null | optional | — |
last_name | string | null | optional | — |
email | string | null | optional | — |
phone | string | null | optional | — |
staff_kind | string | null | optional | — |
tenant_role_id | string | null | optional | — |
status | string | required | — |
school_id | string | null | optional | — |
school_name | string | null | optional | — |
report_subscriptions | string[] | optional | — |
receive_notifications | boolean | optional | — |
receive_email_notifications | boolean | optional | — |
receive_sms_notifications | boolean | optional | — |
receive_whatsapp_notifications | boolean | optional | — |
zones | object[] | optional | — |
has_login | boolean | optional | — |
students_count | integer | optional | — |
subscription | any | optional | — |
last_login_at | string | null | optional | — |
created_at | string (date-time) | optional | — |
row_version | integer | required | — |
students | object[] | optional | — |
WebReportDigest
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
name | string | required | — |
export_kind | string | required | — |
frequency | string | required | — |
day_of_week | integer | null | required | — |
day_of_month | integer | null | required | — |
send_at | string | required | — |
enabled | boolean | required | — |
role_ids | string (uuid)[] | required | — |
user_ids | string (uuid)[] | required | — |
row_version | integer | required | — |
WebRole
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
name | string | required | — |
capabilities | Capability[] | required | — |
created_at | string | null | required | — |
WebSchool
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
name | string | required | — |
code | string | required | — |
status | string | required | — |
is_active | boolean | required | — |
onboarding_stage | string | required | — |
city | string | null | required | — |
region | string | null | required | — |
contact_name | string | null | required | — |
contact_phone | string | null | required | — |
contact_email | string | null | required | — |
student_count | integer | required | — |
parent_count | integer | required | — |
band_count | integer | required | — |
device_count | integer | required | — |
group_id | string | null | required | — |
group_name | string | null | required | — |
row_version | integer | required | — |
created_at | string (date-time) | required | — |
WebSchoolDetail
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
name | string | required | — |
code | string | required | — |
status | string | required | — |
is_active | boolean | required | — |
onboarding_stage | string | required | — |
country_code | string | required | — |
default_currency | string | required | — |
student_cap | integer | null | required | — |
city | string | null | required | — |
region | string | null | required | — |
contact_name | string | null | required | — |
contact_phone | string | null | required | — |
contact_email | string | null | required | — |
notes | string | null | required | — |
student_count | integer | required | — |
parent_count | integer | required | — |
band_count | integer | required | — |
device_count | integer | required | — |
group_id | string | null | required | — |
group_name | string | null | required | — |
row_version | integer | required | — |
created_at | string (date-time) | required | — |
WebSchoolGroup
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
name | string | required | — |
notes | string | null | required | — |
campus_count | integer | required | — |
campuses | object[] | required | — |
row_version | integer | required | — |
created_at | string (date-time) | required | — |
WebDeviceStats
| Field | Type | | Constraints |
|---|
total_wearables | integer | required | — |
wearables_assigned | integer | required | — |
total_scanners | integer | required | — |
scanners_assigned | integer | required | — |
WebChildBulkUploadOptions
| Field | Type | | Constraints |
|---|
schools | object[] | required | — |
BandRow
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
serial_number | string | required | — |
earth_code | string | null | required | — |
batch_number | string | null | required | — |
color | string | null | required | — |
band_type_id | string | null | required | — |
type | string | null | required | — |
band_type | any | required | — |
status | string | required | — |
event_id | string | null | required | — |
wearer | string | null | required | — |
student_id | string | null | required | — |
account_id | string | null | required | — |
wallet_id | string | null | required | — |
school_id | string | null | required | — |
school_name | string | null | required | — |
assigned_at | string | null | required | — |
expires_at | string | null | required | — |
created_at | string (date-time) | required | — |
ImportOutcome
| Field | Type | | Constraints |
|---|
row | integer | required | — |
ok | boolean | required | — |
id | string (uuid) | optional | — |
code | string | optional | — |
Written
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
PasswordReset
| Field | Type | | Constraints |
|---|
must_set_password | boolean | required | — |
PickupCodeMinted
| Field | Type | | Constraints |
|---|
code | string | required | — |
expires_at | string (date-time) | required | — |
PreferenceDocument
No declared fields.
NotificationRow
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
kind | string | required | — |
title | string | required | — |
body | string | null | required | — |
payload | object | required | — |
read_at | string | null | required | — |
created_at | string (date-time) | required | — |
ParentStudent
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
first_name | string | required | — |
last_name | string | null | required | — |
grade | string | null | required | — |
status | string | required | — |
photo | any | required | — |
relation | string | null | required | — |
is_primary_guardian | boolean | required | — |
band | any | required | — |
wallet | any | required | — |
today | object | required | — |
today.checked_in | boolean | required | — |
today.checked_in_at | string | null | required | — |
today.on_active_trip | boolean | required | — |
today.trip_id | string | null | required | — |
ZoneProfile
| Field | Type | | Constraints |
|---|
periods | object[] | required | — |
menu_items | object[] | required | — |
ImpactMetric
| Field | Type | | Constraints |
|---|
key | string | required | — |
unit | string | required | — |
current | number | null | required | — |
baseline | number | null | required | — |
currency | string | null | required | — |
GrowthMonth
| Field | Type | | Constraints |
|---|
month | string | required | — |
students | integer | required | — |
riders | integer | required | — |
messages | integer | required | — |
DeviceUsageRow
| Field | Type | | Constraints |
|---|
device | object | required | — |
device.id | string (uuid) | required | — |
device.name | string | null | required | — |
taps | integer | required | — |
last_seen_at | string | null | required | — |
battery_pct | integer | null | required | — |
status | string | required | — |
ZoneAssignment
| Field | Type | | Constraints |
|---|
zone_ids | string (uuid)[] | required | — |
WebRoute
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
zone_id | string (uuid) | required | — |
name | string | required | — |
description | string | null | required | — |
status | string | required | — |
est_duration | integer | null | required | — |
est_distance_m | number | null | required | — |
rider_count | integer | required | — |
row_version | integer | required | — |
WebRouteDetail
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
zone_id | string (uuid) | required | — |
name | string | required | — |
description | string | null | required | — |
status | string | required | — |
est_duration | integer | null | required | — |
est_distance_m | number | null | required | — |
row_version | integer | required | — |
alert_settings | object | required | — |
alert_settings.high_delay_minutes | integer | required | — |
alert_settings.medium_delay_minutes | integer | required | — |
rider_count | integer | required | — |
stops | RouteStopRow[] | required | — |
trip_plans | object[] | required | — |
RouteStopRow
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
name | string | required | — |
lat | number | null | required | — |
lng | number | null | required | — |
position | integer | required | — |
WebTripPlan
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
route_id | string | null | required | — |
label | string | null | required | — |
direction | string | required | — |
schedule | string | required | — |
start_time | string | null | required | — |
scheduled_on | string | null | required | — |
recurring_days | array | null | required | — |
checkout_counts_as_rollcall | boolean | required | — |
status | string | required | — |
row_version | integer | required | — |
stops_stale | boolean | required | — |
WebTrip
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
status | string | required | — |
direction | string | required | — |
started_at | string | null | required | — |
ended_at | string | null | required | — |
route | any | required | — |
vehicle | any | required | — |
driver | string | required | — |
riders | object | required | — |
riders.expected | integer | required | — |
riders.boarded | integer | required | — |
alerts_open | integer | required | — |
locations | object[] | required | — |
WebTripDetail
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
status | string | required | — |
direction | string | required | — |
started_at | string | null | required | — |
ended_at | string | null | required | — |
route | any | required | — |
driver | string | null | required | — |
riders | object[] | required | — |
events | object[] | required | — |
checkpoints | RouteStopRow[] | required | — |
polyline | string | null | required | — |
planned_polyline | string | null | required | — |
TripReplay
| Field | Type | | Constraints |
|---|
polyline | string | required | — |
timestamps | string | null[] | required | — |
metadata | array | required | — |
points_count | integer | required | — |
snapped | boolean | required | — |
generated_at | string (date-time) | required | — |
TripEndResult
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
status | string | required | — |
ended_at | string (date-time) | required | — |
RouteComparison
| Field | Type | | Constraints |
|---|
optimal_order | string[] | required | — |
stop_locations | RouteComparisonStop[] | required | — |
optimal_distance_m | number | null | required | — |
optimal_duration_s | number | null | required | — |
optimal_polyline | string | null | required | — |
actual_distance_m | number | required | — |
actual_duration_s | number | required | — |
distance_saved_m | number | required | — |
duration_saved_s | number | required | — |
RouteComparisonStop
| Field | Type | | Constraints |
|---|
id | string | required | — |
lat | number | required | — |
lng | number | required | — |
RouteSegments
| Field | Type | | Constraints |
|---|
segments | object[] | required | — |
WebZone
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
parent_zone_id | string | null | required | — |
name | string | required | — |
kind | string | required | — |
status | string | required | — |
description | string | null | required | — |
metadata | object | required | — |
centroid | any | required | — |
geofence_radius_m | integer | null | required | — |
occupancy | integer | required | — |
assignees | object[] | required | — |
charges | object[] | required | — |
vehicle | any | required | — |
row_version | integer | required | — |
PassEvent
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
organizer_id | string (uuid) | required | — |
name | string | required | — |
slug | string | required | — |
zone_id | string | null | required | — |
status | string | required | — |
starts_at | string | null | required | — |
ends_at | string | null | required | — |
timezone | string | required | — |
currency_code | string | required | — |
balance_carries | boolean | required | — |
credential_grace_minutes | integer | required | — |
settings | object | required | — |
created_at | string | required | — |
row_version | integer | required | — |
BootstrapPass
| Field | Type | | Constraints |
|---|
organizer | any | required | — |
events | PassEvent[] | required | — |
update | object | null | required | — |
user | any | required | — |
capabilities | string[] | required | — |
PassTier
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
event_id | string (uuid) | required | — |
name | string | required | — |
slug | string | required | — |
position | integer | required | — |
colour | string | null | required | — |
zone_ids | string (uuid)[] | required | — |
created_at | string | required | — |
updated_at | string | required | — |
row_version | integer | required | — |
PassGuest
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
account_id | string (uuid) | required | — |
name | string | required | — |
phone | string | null | required | — |
email | string | null | required | — |
ticket_ref | string | required | — |
ticket_type | string | null | required | — |
tier_id | string | null | required | — |
tier_name | string | null | required | — |
status | string | required | issued blocked refunded |
source | string | required | — |
holder_confirmed | boolean | required | — |
holder_confirmed_at | string | null | required | — |
band_serial | string | null | required | — |
band_status | string | null | required | — |
checked_in | boolean | required | — |
wallet | any | required | — |
notes | string | null | required | — |
created_at | string | required | — |
row_version | integer | required | — |
PassTicketHolderParty
| Field | Type | | Constraints |
|---|
account_id | string (uuid) | required | — |
name | string | required | — |
PassTicketHolderMove
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
kind | string | required | claim transfer correction |
channel | string | null | required | — |
note | string | null | required | — |
from | any | required | — |
to | PassTicketHolderParty | required | — |
at | string | required | — |
PassTicketScan
| Field | Type | | Constraints |
|---|
verdict | string | required | ok ok_unverified already_used invalid unknown not_configured |
ticket | any | required | — |
redeemed_at | string | null | required | — |
PassOrganizer
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
name | string | required | — |
code | string | null | required | — |
product | string | required | — |
PassShift
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
event_id | string (uuid) | required | — |
zone_id | string | null | required | — |
user_id | string (uuid) | required | — |
device_serial | string | null | required | — |
status | string | required | — |
opened_at | string | required | — |
closed_at | string | null | required | — |
takings_minor | integer | required | — |
sales | integer | required | — |
ledgered_takings_minor | integer | required | — |
ledgered_sales | integer | required | — |
entries_granted | integer | required | — |
entries_denied | integer | required | — |
by_method | object[] | required | — |
PassCashDesk
| Field | Type | | Constraints |
|---|
taken_minor | integer | required | — |
topups | integer | required | — |
refunds_minor | integer | required | — |
currency | string | required | — |
PassCatalogue
| Field | Type | | Constraints |
|---|
categories | object[] | required | — |
items | object[] | required | — |
PassHistory
| Field | Type | | Constraints |
|---|
sales | object[] | required | — |
scans | object[] | required | — |
PassReport
| Field | Type | | Constraints |
|---|
currency | string | required | — |
net_minor | integer | required | — |
sales_count | integer | required | — |
items_sold | integer | required | — |
buckets | object[] | required | — |
top_sellers | object[] | required | — |
PassEventOverview
| Field | Type | | Constraints |
|---|
tickets_total | integer | required | — |
tickets_banded | integer | required | — |
scans_allowed | integer | required | — |
scans_denied | integer | required | — |
sales_count | integer | required | — |
sales_minor | integer | required | — |
currency | string | required | — |
PassDevice
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
serial_number | string | required | — |
name | string | required | — |
zone_id | string | null | required | — |
status | string | required | — |
registered | boolean | required | — |
PassDeviceRow
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
name | string | required | — |
serial_number | string | required | — |
kind | DeviceKind | required | — |
status | DeviceStatus | required | — |
zone | object | null | required | — |
zone.id | string (uuid) | required | — |
zone.name | string | required | — |
battery_pct | integer | null | required | — |
signal_strength | integer | null | required | — |
sim_present | boolean | null | required | — |
firmware | string | null | required | — |
presence | string | required | — |
last_seen_at | string | null | required | — |
row_version | integer | required | — |
PassZone
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
name | string | required | — |
kind | ZoneKind | required | — |
parent_zone_id | string | null | required | — |
Occupancy
| Field | Type | | Constraints |
|---|
zone_id | string (uuid) | required | — |
name | string | required | — |
container | object | required | — |
container.id | string (uuid) | required | — |
container.name | string | required | — |
open_sessions | integer | required | — |
as_of | string | required | — |
TicketingStatus
| Field | Type | | Constraints |
|---|
connected | boolean | required | — |
provider | string | required | — |
id | string | null | required | — |
display_name | string | null | required | — |
status | string | null | required | — |
enabled | boolean | required | — |
environment | string | null | required | — |
key_type | string | null | required | — |
webhook_url | string | null | required | — |
last_synced_at | string | null | required | — |
counts | object | null | required | — |
counts.events | integer | required | — |
counts.tickets | integer | required | — |
counts.webhook_events_24h | integer | required | — |
last_sync | object | null | required | — |
last_sync.status | string | required | — |
last_sync.started_at | string | null | required | — |
last_sync.finished_at | string | null | required | — |
last_sync.events_synced | integer | required | — |
last_sync.tickets_synced | integer | required | — |
last_sync.error | string | null | required | — |
TicketingSyncLog
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
status | string | required | — |
started_at | string | null | required | — |
finished_at | string | null | required | — |
events_synced | integer | required | — |
tickets_synced | integer | required | — |
error | string | null | required | — |
TicketingWebhookDelivery
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
received_at | string | null | required | — |
event_type | string | null | required | — |
external_id | string | null | required | — |
signature_valid | boolean | required | — |
processed_at | string | null | required | — |
error | string | null | required | — |
PassSettlements
| Field | Type | | Constraints |
|---|
currency | string | required | — |
total_minor | integer | required | — |
outlets | object[] | required | — |
PassVendor
| Field | Type | | Constraints |
|---|
wallet_id | string (uuid) | required | — |
name | string | required | — |
number | string | null | required | — |
phone | string | null | required | — |
email | string | null | required | — |
note | string | null | required | — |
taken_minor | integer | required | — |
currency_code | string | required | — |
status | WalletStatus | required | — |
created_at | string (date-time) | required | — |
PassFanClaim
| Field | Type | | Constraints |
|---|
sent | boolean | required | — |
challenge_id | string | null | required | — |
expires_in | integer | null | required | — |
PassFanHome
| Field | Type | | Constraints |
|---|
account | object | required | — |
account.id | string (uuid) | required | — |
account.name | string | required | — |
account.phone | string | null | required | — |
account.email | string | null | required | — |
wallet | any | required | — |
tickets | PassFanTicket[] | required | — |
PassFanTicket
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
ticket_ref | string | required | — |
ticket_type | string | null | required | — |
status | string | required | issued blocked refunded |
tier_name | string | null | required | — |
band_serial | string | null | required | — |
band_status | string | null | required | — |
checked_in | boolean | required | — |
event | object | required | — |
event.id | string (uuid) | required | — |
event.name | string | required | — |
event.slug | string | required | — |
event.starts_at | string | null | required | — |
event.timezone | string | required | — |
event.settings | object | required | — |
created_at | string | required | — |
PassFanBand
| Field | Type | | Constraints |
|---|
serial_number | string | required | — |
status | BandStatus | required | — |
PasswordDone
| Field | Type | | Constraints |
|---|
reset | boolean | required | — |
StaffInvite
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
name | string | required | — |
email | string | null | required | — |
phone | string | null | required | — |
role_name | string | null | required | — |
staff_kind | string | null | required | — |
invited_by_name | string | null | required | — |
expires_at | string | required | — |
created_at | string | required | — |
StaffInviteMinted
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
token | string | required | — |
expires_at | string | required | — |
StaffInviteAccepted
| Field | Type | | Constraints |
|---|
accepted | boolean | required | — |
email | string | null | required | — |
phone | string | null | required | — |
TicketingProbe
| Field | Type | | Constraints |
|---|
ok | boolean | required | — |
reason | string | null | required | — |
environment | string | null | required | — |
key_type | string | null | required | — |
display_name | string | null | required | — |
event_count | integer | null | required | — |
detected_environment | string | null | required | — |
error | string | null | required | — |
TicketingConnected
| Field | Type | | Constraints |
|---|
integration_id | string (uuid) | required | — |
display_name | string | required | — |
key_type | string | required | — |
events_synced | integer | required | — |
tickets_synced | integer | required | — |
TicketingSyncReport
| Field | Type | | Constraints |
|---|
events_synced | integer | required | — |
tickets_synced | integer | required | — |
ServiceLog
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
kind | string | required | — |
occurred_on | string | null | required | — |
amount_minor | integer | null | required | — |
currency | string | null | required | — |
quantity_liters | number | null | required | — |
odometer_km | integer | null | required | — |
description | string | null | required | — |
WebDevice
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
name | string | null | required | — |
serial_number | string | required | — |
batch_number | string | null | required | — |
kind | string | required | — |
status | string | required | — |
zone | any | required | — |
school | any | required | — |
imei | string | null | required | — |
sim_msisdn | string | null | required | — |
sim_present | boolean | null | required | — |
battery_pct | integer | null | required | — |
signal_strength | integer | null | required | — |
firmware | string | null | required | — |
data_used_bytes | integer | null | required | — |
presence | string | required | — |
last_seen_at | string | null | required | — |
row_version | integer | required | — |
DeviceHistoryEntry
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
kind | string | required | — |
changes | object | required | — |
actor_user_id | string | null | required | — |
at | string (date-time) | required | — |
WebRoster
| Field | Type | | Constraints |
|---|
zone_id | string (uuid) | required | — |
access_mode | string | required | — |
members | object[] | required | — |
rules | object[] | required | — |
AccessModeSet
| Field | Type | | Constraints |
|---|
zone_id | string (uuid) | required | — |
access_mode | string | required | — |
VehicleFields
| Field | Type | | Constraints |
|---|
zone_id | string (uuid) | required | — |
capacity | integer | null | required | — |
fuel_type | string | null | required | — |
fuel_consumption_km_per_l | number | null | required | — |
Deleted
| Field | Type | | Constraints |
|---|
deleted | boolean | required | — |
RollcallRow
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
name | string | required | — |
grade | string | null | required | — |
present | boolean | required | — |
checked_in_at | string | null | required | — |
zone | string | null | required | — |
zone_kind | string | null | required | — |
Overview
| Field | Type | | Constraints |
|---|
date | string | required | — |
scope | string | required | platform tenant |
parents | object | required | — |
parents.total | integer | required | — |
parents.this_week | integer | required | — |
parents.last_week | integer | required | — |
parents.delta_pct | number | null | required | — |
parents.mapped | integer | required | — |
parents.unmapped | integer | required | — |
schools | object | required | — |
schools.total | integer | required | — |
schools.this_week | integer | required | — |
schools.last_week | integer | required | — |
schools.delta_pct | number | null | required | — |
kids | object | required | — |
kids.total | integer | required | — |
kids.this_week | integer | required | — |
kids.last_week | integer | required | — |
kids.delta_pct | number | null | required | — |
buses | object | required | — |
buses.total | integer | required | — |
buses.this_week | integer | required | — |
buses.last_week | integer | required | — |
buses.delta_pct | number | null | required | — |
bands | object | required | — |
bands.total | integer | required | — |
devices | object | required | — |
devices.total | integer | required | — |
devices.online | integer | required | — |
devices.offline | integer | required | — |
daily_taps | object | required | — |
daily_taps.unique_students | integer | required | — |
daily_taps.total_students | integer | required | — |
daily_taps.percentage | number | required | — |
daily_taps.period_start | string | required | — |
daily_taps.period_end | string | required | — |
Export
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
kind | string | required | — |
status | string | required | — |
error | string | null | required | — |
created_at | string (date-time) | required | — |
file_url | string | null | required | — |
WebAlert
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
kind | string | required | — |
severity | string | null | required | — |
message | string | null | required | — |
details | string | null | optional | — |
trip_id | string | null | required | — |
route | string | null | required | — |
raised_by | any | required | — |
occurred_at | string (date-time) | required | — |
WebMessage
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
channel | string | required | — |
to_msisdn | string | null | required | — |
student_id | string | null | required | — |
trip_id | string | null | required | — |
body | string | null | required | — |
state | string | required | — |
error | string | null | required | — |
school_id | string | null | required | — |
school_name | string | null | required | — |
created_at | string (date-time) | required | — |
MessageSendResult
| Field | Type | | Constraints |
|---|
students | integer | required | — |
queued | integer | required | — |
WebTemplate
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
name | string | required | — |
channel | string | required | — |
locale | string | null | required | — |
subject | string | null | required | — |
body | string | required | — |
provider_template | string | null | required | — |
is_active | boolean | required | — |
is_platform | boolean | required | — |
WebWallet
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
holder | string | required | — |
type | object | required | — |
type.name | string | required | — |
type.kind | string | required | — |
balance | Money | required | — |
status | string | required | — |
student | any | required | — |
account | any | required | — |
spending_profile_id | string | null | required | — |
holder_phone | string | null | required | — |
created_at | string (date-time) | required | — |
WebWalletDetail
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
holder | string | required | — |
type | object | required | — |
type.id | string (uuid) | required | — |
type.name | string | required | — |
type.kind | string | required | — |
balance | Money | required | — |
status | string | required | — |
student | any | required | — |
account | any | required | — |
spending_profile | any | required | — |
created_at | string (date-time) | required | — |
WalletType
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
name | string | required | — |
kind | string | required | — |
currency | string | required | — |
is_default | boolean | required | — |
allow_negative | boolean | required | — |
status | string | required | — |
wallets | integer | required | — |
WebTransaction
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
type | string | required | — |
state | string | required | — |
amount | Money | required | — |
description | string | null | required | — |
reverses_transaction_id | string | null | required | — |
school_id | string | null | required | — |
school_name | string | null | required | — |
created_at | string (date-time) | required | — |
WebAccountWallet
| Field | Type | | Constraints |
|---|
account | object | required | — |
account.id | string (uuid) | required | — |
account.name | string | required | — |
wallets | object[] | required | — |
children | object[] | required | — |
recent_transactions | WebTransaction[] | required | — |
Credits
| Field | Type | | Constraints |
|---|
wallet_id | string (uuid) | required | — |
balance | Money | required | — |
used | Money | required | — |
WebLoan
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
wallet_id | string (uuid) | required | — |
borrower | string | null | required | — |
principal | Money | required | — |
outstanding | Money | required | — |
interest_rate_bps | integer | required | — |
penalty_rate_bps | integer | required | — |
interest_period | string | required | — |
status | string | required | — |
term_ends_on | string | null | required | — |
next_accrual_at | string | null | required | — |
paid_at | string | null | required | — |
WebVoucher
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
code | string | required | — |
amount | Money | required | — |
status | string | required | — |
state | string | required | — |
merchant_wallet_id | string (uuid) | required | — |
issued_to_wallet_id | string | null | required | — |
issued_to | any | required | — |
redeemed | boolean | required | — |
expires_at | string (date-time) | required | — |
created_at | string (date-time) | required | — |
VoucherCodes
| Field | Type | | Constraints |
|---|
codes | string[] | required | — |
ChargeRule
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
name | string | required | — |
note | string | null | required | — |
frequency | string | required | — |
amount | Money | required | — |
destination_wallet_id | string (uuid) | required | — |
subject_scope | string | required | — |
subjects | object[] | required | — |
status | string | required | — |
last_processed_at | string | null | required | — |
WebhookEndpoint
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
name | string | required | — |
url | string | required | — |
event_types | string[] | required | — |
status | string | required | — |
last_at | string | null | required | — |
last_ok | boolean | null | required | — |
ok_24h | integer | required | — |
failed_24h | integer | required | — |
tenant_name | string | null | required | — |
WebhookDelivery
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
endpoint_id | string (uuid) | required | — |
endpoint_name | string | required | — |
endpoint_url | string | required | — |
event_id | string | required | — |
event_type | string | required | — |
attempt | integer | required | — |
ok | boolean | required | — |
status_code | integer | null | required | — |
error | string | null | required | — |
response_body | string | null | required | — |
duration_ms | integer | required | — |
created_at | string (date-time) | required | — |
tenant_name | string | null | required | — |
can_retry | boolean | required | — |
WebhookSecret
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
secret | string | required | — |
WebhookRetry
| Field | Type | | Constraints |
|---|
id | string (uuid) | required | — |
status | string | required | — |
GuardianCreated
| Field | Type | | Constraints |
|---|
account_id | string (uuid) | required | — |
already_existed | boolean | required | — |
GuardianLinked
| Field | Type | | Constraints |
|---|
account_id | string (uuid) | required | — |
name | string | required | — |
already_linked | boolean | required | — |
PickupValidation
| Field | Type | | Constraints |
|---|
student | object | required | — |
student.id | string (uuid) | required | — |
student.name | string | required | — |
student.grade | string | null | required | — |
student.photo | any | required | — |
guardian | object | required | — |
guardian.account_id | string (uuid) | required | — |
guardian.name | string | required | — |
guardian.phone | string | null | required | — |
guardian.relationship | string | null | required | — |
PlanRider
| Field | Type | | Constraints |
|---|
student_id | string (uuid) | required | — |
name | string | required | — |
grade | string | null | required | — |
position | integer | required | — |
pickup_stop_id | string | null | required | — |
dropoff_stop_id | string | null | required | — |
lat | number | null | required | — |
lng | number | null | required | — |
SuggestedOrder
| Field | Type | | Constraints |
|---|
riders | PlanRider[] | required | — |
optimal_distance_m | number | required | — |
optimal_duration_s | number | required | — |
optimal_polyline | string | null | required | — |
saved_distance_m | number | null | required | — |
saved_duration_s | number | null | required | — |
distance_saved_m | number | null | required | — |
duration_saved_s | number | null | required | — |
depot | object | required | — |
depot.lat | number | required | — |
depot.lng | number | required | — |
MeasuredOrder
| Field | Type | | Constraints |
|---|
distance_m | number | required | — |
duration_s | number | required | — |
polyline | string | null | required | — |
depot | object | required | — |
depot.lat | number | required | — |
depot.lng | number | required | — |
RouteAssignmentSuggestion
| Field | Type | | Constraints |
|---|
assignments | object[] | required | — |
skipped_vehicles | object[] | required | — |
skipped_students | object[] | required | — |
savings | any | required | — |
depot | object | required | — |
depot.lat | number | required | — |
depot.lng | number | required | — |
student_locations | object[] | required | — |
computed_at | string (date-time) | required | — |
RouteAssignmentApply
| Field | Type | | Constraints |
|---|
applied | string (uuid)[] | required | — |
applied_routes | object[] | required | — |
failed | object[] | required | — |
RouteAssignmentMeasure
| Field | Type | | Constraints |
|---|
assignments | object[] | required | — |
savings | any | required | — |
RouteAssignmentDraft
| Field | Type | | Constraints |
|---|
found | boolean | required | — |
computed_at | string | null | required | — |
assignments | object[] | required | — |
skipped_vehicles | object[] | required | — |
skipped_students | object[] | required | — |
savings | any | required | — |
depot | any | required | — |
student_locations | object[] | required | — |
applied_at | string | null | required | — |
applied_result | any | required | — |
RouteAssignmentDraftPatchResult
| Field | Type | | Constraints |
|---|
ok | boolean | required | — |
FuelPrice
| Field | Type | | Constraints |
|---|
diesel | object | null | required | — |
diesel.price_kes_per_l | number | required | — |
diesel.effective_date | string | required | — |
petrol | object | null | required | — |
petrol.price_kes_per_l | number | required | — |
petrol.effective_date | string | required | — |
stale | boolean | required | — |
IntelligenceAskResult
| Field | Type | | Constraints |
|---|
conversation_id | string (uuid) | required | — |
message | object | required | — |
message.id | string (uuid) | required | — |
message.role | string | required | assistant |
message.text | string | required | — |
message.created_at | string (date-time) | required | — |
usage | object | required | — |
usage.tokens_used | integer | required | — |
usage.cost_usd | number | required | — |
usage.tool_calls | string[] | required | — |
IntelligenceUsage
| Field | Type | | Constraints |
|---|
used | integer | required | — |
allowance | integer | required | — |
month_key | string | required | — |
bonus | integer | required | — |
IntelligenceInsightList
| Field | Type | | Constraints |
|---|
insights | object[] | required | — |
IntelligenceConversationList
| Field | Type | | Constraints |
|---|
conversations | object[] | required | — |
IntelligenceConversationMessages
| Field | Type | | Constraints |
|---|
messages | object[] | required | — |
TenantSettingsDoc
| Field | Type | | Constraints |
|---|
flags | object | optional | — |
notify_requires_subscription | boolean | null | required | — |
notify_delay_seconds | integer | null | required | — |
metered_messaging | boolean | required | — |
attendance | any | required | — |
vocabulary | object | required | — |
menu_hidden | string[] | required | — |
school_profile | any | required | — |
help_center | any | required | — |
company_info | any | optional | — |
impact_baselines | ImpactBaseline[] | required | — |
ImpactBaseline
| Field | Type | | Constraints |
|---|
domain | string | required | transport meals activities safety |
strategy | string | required | manual first_14_days rolling |
manual_values | object | optional | — |
updated_at | string | null | optional | — |