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

FieldTypeConstraints
amount_minorintegerrequired
currencystringrequiredmin length 3 · max length 3
symbolstringrequired

MoneyFormatted

FieldTypeConstraints
amount_minorintegerrequired
currencystringrequiredmin length 3 · max length 3
symbolstringrequired
formattedstringrequired

Guardian

FieldTypeConstraints
account_idstring (uuid)required
namestringrequired
phonestring | nullrequired
relationshipstring | nullrequired
is_primarybooleanrequired

Dropoff

FieldTypeConstraints
latnumberrequired
lngnumberrequired

WalletSummary

FieldTypeConstraints
idstring (uuid)required
codestring | nullrequired
namestringrequired
kindstringrequired
statusstringrequired
balanceMoneyrequired
spending_profileanyrequired

Student

FieldTypeConstraints
idstring (uuid)required
first_namestringoptional
middle_namestring | nulloptional
last_namestring | nulloptional
genderstring | nulloptional
dobstring | nulloptional
gradestring | nulloptional
statusstringoptional
external_refstring | nulloptional
alert_notestring | nulloptional
account_idstring | nulloptional
photoanyoptional
created_atstring (date-time)optional
tagsobject[]optional
guardiansGuardian[]optional
dropoffanyoptional
updated_atstring (date-time)required
deletedbooleanrequired

Band

FieldTypeConstraints
idstring (uuid)required
serial_numberstringoptional
earth_codestring | nulloptional
statusstringoptional
student_idstring | nulloptional
account_idstring | nulloptional
wallet_idstring | nulloptional
band_typeanyoptional
expires_atstring | nulloptional
tagsobject[]optional
updated_atstring (date-time)required
deletedbooleanrequired

WebSpendingProfile

FieldTypeConstraints
idstring (uuid)required
namestringrequired
descriptionstring | nullrequired
daily_limit_minorinteger | nullrequired
weekly_limit_minorinteger | nullrequired
per_txn_limit_minorinteger | nullrequired
daily_txn_limitinteger | nullrequired
weekly_txn_limitinteger | nullrequired
allowed_zone_kindsarray | nullrequired
time_windowsarrayrequired
walletsintegerrequired

MessageQueued

FieldTypeConstraints
queuedintegerrequired

SpendingProfileAssignment

FieldTypeConstraints
wallet_idstring (uuid)required
spending_profile_idstring | nullrequired

BandDetail

FieldTypeConstraints
idstring (uuid)required
serial_numberstringrequired
earth_codestring | nullrequired
batch_numberstring | nullrequired
colorstring | nullrequired
band_type_idstring | nullrequired
statusstringrequired
student_idstring | nullrequired
account_idstring | nullrequired
wallet_idstring | nullrequired
assigned_atstring | nullrequired
expires_atstring | nullrequired
tagsobject[]required
weareranyrequired
walletanyrequired

BandAssignedToSchool

FieldTypeConstraints
idstring (uuid)required
serial_numberstringrequired
earth_codestring | nullrequired
batch_numberstring | nullrequired
colorstring | nullrequired
band_type_idstring | nullrequired
statusstringrequired
student_idstring | nullrequired
account_idstring | nullrequired
wallet_idstring | nullrequired
assigned_atstring | nullrequired
expires_atstring | nullrequired
tagsobject[]required
weareranyrequired
walletanyrequired
school_idstring (uuid)required
school_namestringrequired

BandMovedToOrganizer

FieldTypeConstraints
serial_numberstringrequired
statusstringrequired
organizer_idstring (uuid)required

VendorListProposal

FieldTypeConstraints
itemsobject[]required
skippedintegerrequired

Zone

FieldTypeConstraints
idstring (uuid)required
namestringoptional
kindstringoptional
statusstringoptional
descriptionstring | nulloptional
parent_zone_idstring | nulloptional
centroidanyoptional
expires_atstring | nulloptional
tagsobject[]optional
updated_atstring (date-time)required
deletedbooleanrequired

Route

FieldTypeConstraints
idstring (uuid)required
zone_idstring (uuid)optional
namestringoptional
descriptionstring | nulloptional
statusstringoptional
est_durationstring | nulloptional
expected_occupancyinteger | nulloptional
updated_atstring (date-time)required
deletedbooleanrequired

Trip

FieldTypeConstraints
idstring (uuid)required
trip_plan_idstring | nulloptional
route_idstring | nulloptional
zone_idstring | nulloptional
bus_zone_idstring | nulloptional
driver_user_idstring | nulloptional
statusstringoptional
directionstringoptional
labelstring | nulloptional
route_namestring | nulloptional
started_atstring | nulloptional
ended_atstring | nulloptional
expected_ridersinteger | nulloptional
boarded_ridersinteger | nulloptional
absent_countinteger | nulloptional
issues_countinteger | nulloptional
bus_capacityinteger | nulloptional
updated_atstring (date-time)required
deletedbooleanrequired

TripRider

FieldTypeConstraints
idstring (uuid)required
trip_idstring (uuid)optional
student_idstring (uuid)optional
statusstringoptional
boarded_atstring | nulloptional
boarded_sourcestring | nulloptional
dropped_atstring | nulloptional
dropped_sourcestring | nulloptional
updated_atstring (date-time)required
deletedbooleanrequired

TripPlanRider

FieldTypeConstraints
idstring (uuid)required
trip_plan_idstring (uuid)optional
student_idstring (uuid)optional
boarding_orderinteger | nulloptional
alighting_orderinteger | nulloptional
pickup_stop_idstring | nulloptional
dropoff_stop_idstring | nulloptional
updated_atstring (date-time)required
deletedbooleanrequired

TripPlan

FieldTypeConstraints
idstring (uuid)required
route_idstring | nulloptional
labelstring | nulloptional
directionstringoptional
schedulestringoptional
start_timestring | nulloptional
scheduled_onstring | nulloptional
recurring_daysarray | nulloptional
checkout_counts_as_rollcallbooleanoptional
statusstringoptional
updated_atstring (date-time)required
deletedbooleanrequired

TripWrite

FieldTypeConstraints
idstring (uuid)required
statusstringrequired
directionstringrequired
started_atstring | nullrequired
ended_atstring | nullrequired
expected_ridersintegerrequired
boarded_ridersintegerrequired
polylinestring | nullrequired
planned_polylinestring | nullrequired
ridersobject[]required

TripEvent

FieldTypeConstraints
idstring (uuid)required
kindstringrequired
severitystring | nullrequired
messagestring | nullrequired
student_idstring | nullrequired
occurred_atstring (date-time)required

PositionBatch

FieldTypeConstraints
acceptedintegerrequired
duplicatesintegerrequired
staleintegeroptional
next_position_secondsintegerrequired

TripHandover

FieldTypeConstraints
moved_ridersintegerrequired
target_trip_idstring (uuid)required
dead_trip_statusstringrequired

TripLive

FieldTypeConstraints
trip_idstring (uuid)required
statusstringrequired
boarded_ridersinteger | nulloptional
expected_ridersinteger | nulloptional
last_positionanyoptional
eta_schoolstring | nulloptional
planned_polylinestring | nulloptional
stop_etasobject[]optional
next_poll_secondsintegeroptional

TripPosition

FieldTypeConstraints
latnumberrequired
lngnumberrequired
speed_kphnumber | nulloptional
headingnumber | nulloptional
recorded_atstring | nulloptional

Account

FieldTypeConstraints
idstring (uuid)required
first_namestringoptional
middle_namestring | nulloptional
last_namestring | nulloptional
phonestring | nulloptional
emailstring | nulloptional
genderstring | nulloptional
kyc_statusstring | nulloptional
statusstringoptional
external_refstring | nulloptional
created_atstring (date-time)optional
walletsWalletSummary[]optional
updated_atstring (date-time)required
deletedbooleanrequired

AccountDetail

FieldTypeConstraints
idstring (uuid)required
first_namestringrequired
middle_namestring | nullrequired
last_namestring | nullrequired
phonestring | nullrequired
kyc_statusstring | nullrequired
statusstringrequired
external_refstring | nullrequired
studentsobject[]required
walletsobject[]required

GraphAccount

FieldTypeConstraints
idstring (uuid)required
first_namestringoptional
middle_namestring | nulloptional
last_namestring | nulloptional
phonestring | nulloptional
emailstring | nulloptional
genderstring | nulloptional
kyc_statusstring | nulloptional
statusstringoptional
external_refstring | nulloptional
created_atstring (date-time)optional
walletsWalletSummary[]optional
studentsGraphStudentRef[]optional
updated_atstring (date-time)required
deletedbooleanrequired

GraphStudentRef

FieldTypeConstraints
idstring (uuid)required
first_namestringrequired
middle_namestring | nullrequired
last_namestring | nullrequired
genderstring | nullrequired
dobstring | nullrequired
gradestring | nullrequired
statusstringrequired
photoanyrequired
presenceanyrequired

GraphStudent

FieldTypeConstraints
idstring (uuid)required
deletedbooleanrequired
updated_atstring (date-time)required
first_namestringoptional
middle_namestring | nulloptional
last_namestring | nulloptional
genderstring | nulloptional
dobstring | nulloptional
gradestring | nulloptional
statusstringoptional
rider_statusRiderStatusoptional
presenceanyoptional
external_refstring | nulloptional
photoanyoptional
tagsobject[]optional
guardiansGraphGuardian[]optional
walletsGraphWallet[]optional
bandsGraphBand[]optional
trip_plansGraphTripPlan[]optional
dropoffanyoptional
homeanyoptional
home_locationsHomeLocation[]optional

HomeLocation

FieldTypeConstraints
idstring (uuid)required
labelstring | nulloptional
latnumber | nulloptional
lngnumber | nulloptional
is_defaultbooleanrequired

GraphWallet

FieldTypeConstraints
idstring (uuid)required
balance_minorintegerrequired
currency_codestringrequired
statusstringrequired
spending_profileanyoptional

GraphSpendingProfile

FieldTypeConstraints
namestringrequired
daily_limit_minorinteger | nulloptional
weekly_limit_minorinteger | nulloptional
per_txn_limit_minorinteger | nulloptional
allowed_zone_kindsstring[]optional

GraphGuardian

FieldTypeConstraints
idstring (uuid)required
account_idstring | nullrequired
first_namestring | nullrequired
last_namestring | nullrequired
phonestring | nullrequired
relationstring | nullrequired
is_primarybooleanrequired

GraphBand

FieldTypeConstraints
idstring (uuid)required
serial_numberstringrequired
earth_codestring | nullrequired
statusstringrequired

GraphTripPlan

FieldTypeConstraints
idstring (uuid)required
labelstringrequired
directionstringrequired
schedulestringrequired
start_timestring | nulloptional
route_namestring | nulloptional
pickup_stopanyoptional
dropoff_stopanyoptional

TripStop

FieldTypeConstraints
namestringrequired
latnumber | nulloptional
lngnumber | nulloptional

Transaction

FieldTypeConstraints
idstring (uuid)required
wallet_idstring | nulloptional
typestringoptional
statestringoptional
directionstring | nulloptional
amountMoneyFormattedoptional
balance_afteranyoptional
descriptionstring | nulloptional
categorystring | nulloptional
payment_methodstring | nulloptional
created_atstring (date-time)optional
updated_atstring (date-time)required
deletedbooleanrequired

WalletBalance

FieldTypeConstraints
wallet_idstring (uuid)required
balanceMoneyFormattedrequired

WalletStatementRow

FieldTypeConstraints
idstring (uuid)required
typestringrequired
statestringrequired
directionstring | nulloptional
amountMoneyFormattedrequired
balance_afterMoneyFormattedrequired
descriptionstring | nulloptional
studentanyoptional
created_atstring (date-time)required

WalletStatementSummary

FieldTypeConstraints
currencystringrequired
totalsobjectrequired
net_minorintegerrequired
opening_minorintegerrequired
closing_minorintegerrequired

SpendingProfile

FieldTypeConstraints
idstring (uuid)required
namestringrequired
descriptionstring | nulloptional
daily_limitanyoptional
weekly_limitanyoptional
per_txn_limitanyoptional
allowed_zone_kindsstring[]optional
time_windowsobject[]optional

PinStatus

FieldTypeConstraints
setbooleanrequired
requiredbooleanrequired

Tombstone

FieldTypeConstraints
idstring (uuid)required
deletedbooleanrequired
updated_atstring (date-time)required

GraphTombstone

FieldTypeConstraints
idstring (uuid)required
kindstringrequiredstudent account
deletedbooleanrequired
updated_atstring (date-time)required

TapVerdict

FieldTypeConstraints
resultstringrequiredallowed denied noop
reasonstringoptional
detailstringoptional
holderstringoptional
admitsstring[]optional
chargeobjectoptional
charge.transaction_idstring (uuid)required
charge.amountobjectrequired
charge.balance_afterobjectrequired

TapBatch

FieldTypeConstraints
resultsTapBatchItem[]required

TapBatchItem

FieldTypeConstraints
client_event_idstringrequired
resultstringrequiredapplied duplicate rejected
codestringoptional
tapTapVerdictoptional

RiderResult

FieldTypeConstraints
client_event_idstringrequired
resultstringrequiredapplied duplicate rejected
codestringoptional
rider_statusstringoptional
chargeobjectoptional
charge.transaction_idstring (uuid)required
charge.amountobjectrequired

RiderCounters

FieldTypeConstraints
boarded_ridersintegerrequired
expected_ridersintegerrequired
absentintegerrequired

RiderEventInput

FieldTypeConstraints
client_event_idstringrequired
student_idstringrequired
statusstringrequiredboarded dropped_off absent
sourcestringrequirednfc manual geofence auto
band_serialstringoptional
latnumberoptional
lngnumberoptional
occurred_atstringrequired

TapInput

FieldTypeConstraints
client_event_idstringrequired
zone_idstringrequired
device_idstringoptional
band_serialstringoptional
student_idstringoptional
directionstringrequiredcheck_in check_out
methodstringrequirednfc manual qr
occurred_atstringrequired
pickup_codestringoptional

Photo

FieldTypeConstraints
urlstringrequired
mediumstringrequired
thumbstringrequired

Problem

FieldTypeConstraints
typestringoptional
codestringrequired
titlestringrequired
statusintegerrequired
detailstringoptional
violationsobject[]optional
missing_capabilitystringoptional

CursorPageMeta

FieldTypeConstraints
next_cursorstring | nullrequired
max_updated_atstring | nulloptional
full_resyncbooleanoptional
countintegeroptional

BootstrapEnvelope

FieldTypeConstraints
server_timestring (date-time)required
audiencestringrequired
productstringrequired
appBootstrapAppoptional
consoleBootstrapConsoleoptional
passBootstrapPassoptional

BootstrapApp

FieldTypeConstraints
appobjectrequired
app.updateobjectoptional
app.flagsobjectrequired
app.batchobjectrequired
schoolobjectoptional
school.idstring (uuid)required
school.namestringrequired
school.locationobjectoptional
userobjectrequired
user.idstring (uuid)required
user.first_namestringrequired
user.middle_namestring | nulloptional
user.last_namestring | nulloptional
user.phonestring | nulloptional
user.staff_kindstring | nulloptional
user.tenantobjectoptional
user.zonesBootstrapZoneRef[]optional
user.active_zone_idstring | nulloptional
user.pending_tasksTrip[]optional
permissionsobjectrequired
permissions.capabilitiesstring[]required
permissions.zonesstring[]required
permissions.tagsstring[]required
includedobjectrequired
included.trip-planobjectrequired
included.trip-plan-riderobjectrequired
metadata_fieldsobject[]optional
spending_profilesobject[]optional
filtersobjectoptional
filters.account_tagsstring[]required
filters.wallet_tagsstring[]required
filters.dependant_tagsstring[]required
templatesobject[]optional

BootstrapZoneRef

FieldTypeConstraints
idstring (uuid)required
namestringrequired
kindZoneKindrequired
is_defaultbooleanrequired
main_zone_namestring | nulloptional
descriptionstring | nulloptional
locationobjectoptional
location.latnumberrequired
location.lngnumberrequired
tagsobject[]required
vehicleobjectoptional
vehicle.registrationstring | nullrequired
vehicle.makestring | nullrequired
vehicle.modelstring | nullrequired
vehicle.capacityinteger | nullrequired
routesRoute[]optional

DeviceInput

FieldTypeConstraints
fingerprintstringrequired
serialstringrequired
modelstring | nulloptional
app_versionstring | nulloptional
push_tokenstring | nulloptional

Profile

FieldTypeConstraints
idstring (uuid)required
first_namestringrequired
middle_namestring | nullrequired
last_namestring | nullrequired
phonestringrequired
emailstring | nullrequired
staff_kindstring | nullrequired
statusstringrequired
tenant_idstring | nullrequired
audienceApiAudiencerequired

AccessLog

FieldTypeConstraints
idstring (uuid)required
directionanyrequired
methodanyrequired
resultanyrequired
reasonstring | nullrequired
occurred_atstring (date-time)required
zoneobjectrequired
zone.idstring (uuid)required
zone.namestringrequired
zone.kindstring | nullrequired
studentanyrequired
guardiananyrequired
verified_byanyrequired
band_serialstring | nullrequired
trip_idstring | nullrequired

AuthSession

FieldTypeConstraints
otp_requiredbooleanrequired
access_tokenstringoptional
token_typestringoptional
expires_inintegeroptional
refresh_tokenstringoptional
must_set_passwordbooleanoptional
bootstrapanyoptional
challenge_idstringoptional
otp_deliverystringoptional
otp_masked_tostringoptional
debug_otpstringoptional

AuthTokens

FieldTypeConstraints
access_tokenstringrequired
token_typestringrequired
expires_inintegerrequired
refresh_tokenstringrequired

AuditEntry

FieldTypeConstraints
idstring (uuid)required
actionstringrequired
entity_typestringrequired
entity_idstring | nullrequired
changesanyrequired
school_idstring | nullrequired
school_namestring | nullrequired
actor_namestringrequired
shadow_operator_namestring | nullrequired
ipstring | nullrequired
created_atstringrequired

ShadowSession

FieldTypeConstraints
access_tokenstringrequired
token_typestringrequired
expires_inintegerrequired
school_idstring (uuid)required
school_namestringrequired

TenantSwitched

FieldTypeConstraints
access_tokenstringrequired
token_typestringrequired
expires_inintegerrequired
tenant_idstring (uuid)required

Ack

FieldTypeConstraints
okbooleanrequired

ApiClient

FieldTypeConstraints
idstring (uuid)required
tenant_idstring | nullrequired
audiencestringrequired
namestringrequired
scopesstring[]required
rate_tierstringrequired
statusstringrequired
created_atstringrequired

ApiClientCreated

FieldTypeConstraints
idstring (uuid)required
tenant_idstring | nullrequired
audiencestringrequired
namestringrequired
scopesstring[]required
rate_tierstringrequired
statusstringrequired
created_atstringrequired
client_secretstringrequired

ClientToken

FieldTypeConstraints
access_tokenstringrequired
token_typestringrequired
expires_inintegerrequired
scopesstring[]required

MachinePersonSync

FieldTypeConstraints
account_idstring (uuid)required
createdbooleanrequired
wallet_openedbooleanrequired

MachinePinSet

FieldTypeConstraints
wallets_updatedintegerrequired

MachineWalletCredit

FieldTypeConstraints
transaction_idstring (uuid)required
wallet_idstring (uuid)required

MachineWalletDebit

FieldTypeConstraints
transaction_idstring (uuid)required
wallet_idstring (uuid)required

Presence

FieldTypeConstraints
statestringrequiredpresent away none
pathobject[]optional
sincestring | nulloptional
last_zoneobjectoptional
last_zone.idstringrequired
last_zone.namestring | nulloptional
last_seenstring | nulloptional

PresenceEntry

FieldTypeConstraints
student_idstringrequired
statestringrequiredpresent away none
pathobject[]optional
sincestring | nulloptional
last_zoneobjectoptional
last_zone.idstringrequired
last_zone.namestring | nulloptional
last_seenstring | nulloptional

TimelineEntry

FieldTypeConstraints
kindstringrequiredtap trip_boarded trip_dropped transaction
atstringrequired
detailTimelineDetailrequired

TimelineDetail

FieldTypeConstraints
zonestring | nulloptional
directionstring | nulloptional
methodstring | nulloptional
resultstring | nulloptional
reasonstring | nulloptional
trip_idstring | nulloptional
routestring | nulloptional
stopstring | nulloptional
typestring | nulloptional
amountanyoptional
descriptionstring | nulloptional

HeartbeatAck

FieldTypeConstraints
okbooleanrequired
presencestringrequiredonline low_battery
next_heartbeat_secondsintegerrequired

Tag

FieldTypeConstraints
idstring (uuid)required
namestringrequired
entitystring | nullrequired
color_hexstring | nullrequired

Group

FieldTypeConstraints
idstring (uuid)required
namestringrequired
is_defaultbooleanrequired
statusstringrequired
member_countintegerrequired

BandType

FieldTypeConstraints
idstring (uuid)required
namestringrequired

BandWrite

FieldTypeConstraints
idstring (uuid)required
serial_numberstringrequired
earth_codestring | nullrequired
batch_numberstring | nullrequired
colorstring | nullrequired
band_type_idstring | nullrequired
statusstringrequired
student_idstring | nullrequired
account_idstring | nullrequired
wallet_idstring | nullrequired
assigned_atstring | nullrequired
expires_atstring | nullrequired
event_idstring | nullrequired

BandBulkIntake

FieldTypeConstraints
registeredintegerrequired
duplicateintegerrequired
invalidintegerrequired
resultsobject[]required

BandEdited

FieldTypeConstraints
idstring (uuid)required
serial_numberstringrequired
earth_codestring | nullrequired
batch_numberstring | nullrequired
colorstring | nullrequired
band_type_idstring | nullrequired
statusstringrequired
student_idstring | nullrequired
account_idstring | nullrequired
wallet_idstring | nullrequired
assigned_atstring | nullrequired
expires_atstring | nullrequired
school_idstring | nullrequired
school_namestring | nullrequired

SetupProgress

FieldTypeConstraints
school_locationbooleanrequired
create_locationsbooleanrequired
add_fleetbooleanrequired
plan_routesbooleanrequired
trip_planbooleanrequired
invite_staffbooleanrequired
register_peoplebooleanrequired
required_completebooleanrequired
completebooleanrequired
trips_blockedbooleanrequired

PosItem

FieldTypeConstraints
idstring (uuid)required
namestringoptional
skustring | nulloptional
activebooleanoptional
category_idstring | nulloptional
beneficiary_wallet_idstring | nulloptional
priceMoneyFormattedoptional
min_order_qtyintegeroptional
photoanyoptional
updated_atstring (date-time)required
deletedbooleanrequired

PosItemWrite

FieldTypeConstraints
idstring (uuid)required
namestringrequired
skustring | nullrequired
activebooleanrequired
category_idstring | nullrequired
beneficiary_wallet_idstring | nullrequired
priceMoneyFormattedrequired
min_order_qtyintegerrequired

PosCategory

FieldTypeConstraints
idstring (uuid)required
namestringoptional
activebooleanoptional
colorstring | nulloptional
photoanyoptional
updated_atstring (date-time)required
deletedbooleanrequired

PosCategoryWrite

FieldTypeConstraints
idstring (uuid)required
namestringrequired
activebooleanrequired
colorstring | nullrequired

PosCategoryAdmin

FieldTypeConstraints
idstring (uuid)required
namestringrequired
activebooleanrequired
colorstring | nullrequired
photoanyrequired
created_atstring (date-time)required
updated_atstring (date-time)required

PosItemAdmin

FieldTypeConstraints
idstring (uuid)required
namestringrequired
skustring | nullrequired
activebooleanrequired
category_idstring | nullrequired
beneficiary_wallet_idstring | nullrequired
priceMoneyFormattedrequired
min_order_qtyintegerrequired
cost_priceanyrequired
photoanyrequired
created_atstring (date-time)required
updated_atstring (date-time)required

PosItemCopyReceipt

FieldTypeConstraints
targetsintegerrequired
createdintegerrequired
updatedintegerrequired

WebSurvey

FieldTypeConstraints
idstring (uuid)required
namestringrequired
statusstringrequired
template_namestringrequired
template_languagestringrequired
closing_messagestring | nullrequired
sentintegerrequired
completedintegerrequired
created_atstring (date-time)required
updated_atstring (date-time)required

WebSurveyDetail

FieldTypeConstraints
idstring (uuid)required
namestringrequired
statusstringrequired
template_namestringrequired
template_languagestringrequired
closing_messagestring | nullrequired
sentintegerrequired
completedintegerrequired
created_atstring (date-time)required
updated_atstring (date-time)required
questionsWebSurveyQuestion[]optional

WebSurveyQuestion

FieldTypeConstraints
idstring (uuid)required
positionintegerrequired
kindstringrequired
promptstringrequired
hintstring | nullrequired
optionsobject[]required

WebSurveyRun

FieldTypeConstraints
idstring (uuid)required
survey_idstring (uuid)required
school_idstring | nullrequired
audiencestringrequired
recipientsintegerrequired
created_atstring (date-time)required

WabaTemplate

FieldTypeConstraints
namestringrequired
languagestringrequired
statusstringrequired
categorystringrequired
bodystring | nullrequired
buttonsstring[]required

WebSurveyResponseRow

FieldTypeConstraints
idstring (uuid)required
phonestringrequired
statestringrequired
started_atstring | nullrequired
completed_atstring | nullrequired
answersobject[]required

WebSurveySummary

FieldTypeConstraints
sentintegerrequired
completedintegerrequired
questionsobject[]required

StudentWrite

FieldTypeConstraints
idstring (uuid)required
first_namestringrequired
last_namestring | nullrequired
gradestring | nullrequired
statusstringrequired

PayReceipt

FieldTypeConstraints
transaction_idstring (uuid)required
typestringrequired
statestringrequired
studentanyrequired
balance_afteranyrequired

WalletChargeReceipt

FieldTypeConstraints
transaction_idstring (uuid)required
typestringrequired
statestringrequired
customeranyrequired
amountMoneyFormattedrequired
balance_afteranyrequired

PaymentIntent

FieldTypeConstraints
payment_intent_idstring (uuid)required
statestringrequired
gatewaystringrequired
amountobjectrequired
amount.amount_minorintegerrequired
amount.currencystringrequiredmin length 3 · max length 3
instructionsstringoptional

PaymentIntentDetail

FieldTypeConstraints
payment_intent_idstring (uuid)required
statestringrequired
gatewaystringrequired
amountobjectrequired
amount.amount_minorintegerrequired
amount.currencystringrequiredmin length 3 · max length 3
transaction_idstring | nullrequired
provider_refstring | nullrequired
failure_reasonstring | nullrequired

BootstrapConsole

FieldTypeConstraints
tenantanyrequired
schoolsobject[]required
userobjectrequired
user.idstring (uuid)required
user.first_namestringrequired
user.last_namestring | nullrequired
user.emailstring | nullrequired
user.phonestring | nullrequired
user.staff_kindstring | nullrequired
user.surfacestringrequired
user.scopesstring[]required
shadowanyrequired
tagsobject[]required
zonesobject[]required
routesobject[]required
gradesstring[]required
permissionsobjectrequired
permissions.capabilitiesstring[]required
countsobjectrequired
counts.unread_notificationsintegerrequired
includedobjectrequired
included.studentobjectrequired
included.zoneobjectrequired
included.deviceobjectrequired
included.tripobjectrequired
included.overviewOverviewrequired

WebStudent

FieldTypeConstraints
idstring (uuid)required
first_namestringrequired
middle_namestring | nullrequired
last_namestring | nullrequired
genderstring | nullrequired
dobstring | nullrequired
gradestring | nullrequired
statusstringrequired
external_refstring | nullrequired
photoanyrequired
row_versionintegerrequired
school_idstring | nullrequired
school_namestring | nullrequired
guardiansGuardian[]required
bandanyrequired
routeanyrequired
todayobjectrequired
today.checked_inbooleanrequired
today.checked_in_atstring | nullrequired

WebStudentDetail

FieldTypeConstraints
idstring (uuid)required
first_namestringrequired
middle_namestring | nullrequired
last_namestring | nullrequired
genderstring | nullrequired
dobstring | nullrequired
gradestring | nullrequired
statusstringrequired
external_refstring | nullrequired
photoanyrequired
row_versionintegerrequired
school_idstring | nullrequired
school_namestring | nullrequired
guardiansGuardian[]required
bandanyrequired
routeanyrequired
todayobjectrequired
today.checked_inbooleanrequired
today.checked_in_atstring | nullrequired
metadataobjectrequired
tagsobject[]required
walletanyrequired
band_historyobject[]required
trip_plansobject[]required
home_locationanyrequired
recent_timelineTimelineEntry[]required

WebUser

FieldTypeConstraints
idstring (uuid)required
kindstringoptional
first_namestringrequired
middle_namestring | nulloptional
last_namestring | nulloptional
emailstring | nulloptional
phonestring | nulloptional
staff_kindstring | nulloptional
tenant_role_idstring | nulloptional
statusstringrequired
school_idstring | nulloptional
school_namestring | nulloptional
report_subscriptionsstring[]optional
receive_notificationsbooleanoptional
receive_email_notificationsbooleanoptional
receive_sms_notificationsbooleanoptional
receive_whatsapp_notificationsbooleanoptional
zonesobject[]optional
has_loginbooleanoptional
students_countintegeroptional
subscriptionanyoptional
last_login_atstring | nulloptional
created_atstring (date-time)optional
row_versionintegerrequired

WebUserDetail

FieldTypeConstraints
idstring (uuid)required
kindstringoptional
first_namestringrequired
middle_namestring | nulloptional
last_namestring | nulloptional
emailstring | nulloptional
phonestring | nulloptional
staff_kindstring | nulloptional
tenant_role_idstring | nulloptional
statusstringrequired
school_idstring | nulloptional
school_namestring | nulloptional
report_subscriptionsstring[]optional
receive_notificationsbooleanoptional
receive_email_notificationsbooleanoptional
receive_sms_notificationsbooleanoptional
receive_whatsapp_notificationsbooleanoptional
zonesobject[]optional
has_loginbooleanoptional
students_countintegeroptional
subscriptionanyoptional
last_login_atstring | nulloptional
created_atstring (date-time)optional
row_versionintegerrequired
studentsobject[]optional

WebReportDigest

FieldTypeConstraints
idstring (uuid)required
namestringrequired
export_kindstringrequired
frequencystringrequired
day_of_weekinteger | nullrequired
day_of_monthinteger | nullrequired
send_atstringrequired
enabledbooleanrequired
role_idsstring (uuid)[]required
user_idsstring (uuid)[]required
row_versionintegerrequired

WebRole

FieldTypeConstraints
idstring (uuid)required
namestringrequired
capabilitiesCapability[]required
created_atstring | nullrequired

WebSchool

FieldTypeConstraints
idstring (uuid)required
namestringrequired
codestringrequired
statusstringrequired
is_activebooleanrequired
onboarding_stagestringrequired
citystring | nullrequired
regionstring | nullrequired
contact_namestring | nullrequired
contact_phonestring | nullrequired
contact_emailstring | nullrequired
student_countintegerrequired
parent_countintegerrequired
band_countintegerrequired
device_countintegerrequired
group_idstring | nullrequired
group_namestring | nullrequired
row_versionintegerrequired
created_atstring (date-time)required

WebSchoolDetail

FieldTypeConstraints
idstring (uuid)required
namestringrequired
codestringrequired
statusstringrequired
is_activebooleanrequired
onboarding_stagestringrequired
country_codestringrequired
default_currencystringrequired
student_capinteger | nullrequired
citystring | nullrequired
regionstring | nullrequired
contact_namestring | nullrequired
contact_phonestring | nullrequired
contact_emailstring | nullrequired
notesstring | nullrequired
student_countintegerrequired
parent_countintegerrequired
band_countintegerrequired
device_countintegerrequired
group_idstring | nullrequired
group_namestring | nullrequired
row_versionintegerrequired
created_atstring (date-time)required

WebSchoolGroup

FieldTypeConstraints
idstring (uuid)required
namestringrequired
notesstring | nullrequired
campus_countintegerrequired
campusesobject[]required
row_versionintegerrequired
created_atstring (date-time)required

WebDeviceStats

FieldTypeConstraints
total_wearablesintegerrequired
wearables_assignedintegerrequired
total_scannersintegerrequired
scanners_assignedintegerrequired

WebChildBulkUploadOptions

FieldTypeConstraints
schoolsobject[]required

BandRow

FieldTypeConstraints
idstring (uuid)required
serial_numberstringrequired
earth_codestring | nullrequired
batch_numberstring | nullrequired
colorstring | nullrequired
band_type_idstring | nullrequired
typestring | nullrequired
band_typeanyrequired
statusstringrequired
event_idstring | nullrequired
wearerstring | nullrequired
student_idstring | nullrequired
account_idstring | nullrequired
wallet_idstring | nullrequired
school_idstring | nullrequired
school_namestring | nullrequired
assigned_atstring | nullrequired
expires_atstring | nullrequired
created_atstring (date-time)required

MetadataField

FieldTypeConstraints
idstring (uuid)required
entitystringrequired
namestringrequired
descriptionstring | nullrequired
created_atstringoptional

ImportOutcome

FieldTypeConstraints
rowintegerrequired
okbooleanrequired
idstring (uuid)optional
codestringoptional

Written

FieldTypeConstraints
idstring (uuid)required

PasswordReset

FieldTypeConstraints
must_set_passwordbooleanrequired

PickupCodeMinted

FieldTypeConstraints
codestringrequired
expires_atstring (date-time)required

PreferenceDocument

No declared fields.

PlatformNotificationSettings

FieldTypeConstraints
sms_enabledbooleanrequired
whatsapp_enabledbooleanrequired
suffix_enabledbooleanrequired
suffix_textstring | nullrequired
suffix_scopestringrequired
suffix_school_idsstring (uuid)[]required
templatesobjectrequired
row_versionintegerrequired

NotificationRow

FieldTypeConstraints
idstring (uuid)required
kindstringrequired
titlestringrequired
bodystring | nullrequired
payloadobjectrequired
read_atstring | nullrequired
created_atstring (date-time)required

ParentStudent

FieldTypeConstraints
idstring (uuid)required
first_namestringrequired
last_namestring | nullrequired
gradestring | nullrequired
statusstringrequired
photoanyrequired
relationstring | nullrequired
is_primary_guardianbooleanrequired
bandanyrequired
walletanyrequired
todayobjectrequired
today.checked_inbooleanrequired
today.checked_in_atstring | nullrequired
today.on_active_tripbooleanrequired
today.trip_idstring | nullrequired

ZoneProfile

FieldTypeConstraints
periodsobject[]required
menu_itemsobject[]required

ImpactMetric

FieldTypeConstraints
keystringrequired
unitstringrequired
currentnumber | nullrequired
baselinenumber | nullrequired
currencystring | nullrequired

GrowthMonth

FieldTypeConstraints
monthstringrequired
studentsintegerrequired
ridersintegerrequired
messagesintegerrequired

DeviceUsageRow

FieldTypeConstraints
deviceobjectrequired
device.idstring (uuid)required
device.namestring | nullrequired
tapsintegerrequired
last_seen_atstring | nullrequired
battery_pctinteger | nullrequired
statusstringrequired

ZoneAssignment

FieldTypeConstraints
zone_idsstring (uuid)[]required

WebRoute

FieldTypeConstraints
idstring (uuid)required
zone_idstring (uuid)required
namestringrequired
descriptionstring | nullrequired
statusstringrequired
est_durationinteger | nullrequired
est_distance_mnumber | nullrequired
rider_countintegerrequired
row_versionintegerrequired

WebRouteDetail

FieldTypeConstraints
idstring (uuid)required
zone_idstring (uuid)required
namestringrequired
descriptionstring | nullrequired
statusstringrequired
est_durationinteger | nullrequired
est_distance_mnumber | nullrequired
row_versionintegerrequired
alert_settingsobjectrequired
alert_settings.high_delay_minutesintegerrequired
alert_settings.medium_delay_minutesintegerrequired
rider_countintegerrequired
stopsRouteStopRow[]required
trip_plansobject[]required

RouteStopRow

FieldTypeConstraints
idstring (uuid)required
namestringrequired
latnumber | nullrequired
lngnumber | nullrequired
positionintegerrequired

WebTripPlan

FieldTypeConstraints
idstring (uuid)required
route_idstring | nullrequired
labelstring | nullrequired
directionstringrequired
schedulestringrequired
start_timestring | nullrequired
scheduled_onstring | nullrequired
recurring_daysarray | nullrequired
checkout_counts_as_rollcallbooleanrequired
statusstringrequired
row_versionintegerrequired
stops_stalebooleanrequired

WebTrip

FieldTypeConstraints
idstring (uuid)required
statusstringrequired
directionstringrequired
started_atstring | nullrequired
ended_atstring | nullrequired
routeanyrequired
vehicleanyrequired
driverstringrequired
ridersobjectrequired
riders.expectedintegerrequired
riders.boardedintegerrequired
alerts_openintegerrequired
locationsobject[]required

WebTripDetail

FieldTypeConstraints
idstring (uuid)required
statusstringrequired
directionstringrequired
started_atstring | nullrequired
ended_atstring | nullrequired
routeanyrequired
driverstring | nullrequired
ridersobject[]required
eventsobject[]required
checkpointsRouteStopRow[]required
polylinestring | nullrequired
planned_polylinestring | nullrequired

TripReplay

FieldTypeConstraints
polylinestringrequired
timestampsstring | null[]required
metadataarrayrequired
points_countintegerrequired
snappedbooleanrequired
generated_atstring (date-time)required

TripEndResult

FieldTypeConstraints
idstring (uuid)required
statusstringrequired
ended_atstring (date-time)required

RouteComparison

FieldTypeConstraints
optimal_orderstring[]required
stop_locationsRouteComparisonStop[]required
optimal_distance_mnumber | nullrequired
optimal_duration_snumber | nullrequired
optimal_polylinestring | nullrequired
actual_distance_mnumberrequired
actual_duration_snumberrequired
distance_saved_mnumberrequired
duration_saved_snumberrequired

RouteComparisonStop

FieldTypeConstraints
idstringrequired
latnumberrequired
lngnumberrequired

RouteSegments

FieldTypeConstraints
segmentsobject[]required

WebZone

FieldTypeConstraints
idstring (uuid)required
parent_zone_idstring | nullrequired
namestringrequired
kindstringrequired
statusstringrequired
descriptionstring | nullrequired
metadataobjectrequired
centroidanyrequired
geofence_radius_minteger | nullrequired
occupancyintegerrequired
assigneesobject[]required
chargesobject[]required
vehicleanyrequired
row_versionintegerrequired

PassEvent

FieldTypeConstraints
idstring (uuid)required
organizer_idstring (uuid)required
namestringrequired
slugstringrequired
zone_idstring | nullrequired
statusstringrequired
starts_atstring | nullrequired
ends_atstring | nullrequired
timezonestringrequired
currency_codestringrequired
balance_carriesbooleanrequired
credential_grace_minutesintegerrequired
settingsobjectrequired
created_atstringrequired
row_versionintegerrequired

BootstrapPass

FieldTypeConstraints
organizeranyrequired
eventsPassEvent[]required
updateobject | nullrequired
useranyrequired
capabilitiesstring[]required

PassTier

FieldTypeConstraints
idstring (uuid)required
event_idstring (uuid)required
namestringrequired
slugstringrequired
positionintegerrequired
colourstring | nullrequired
zone_idsstring (uuid)[]required
created_atstringrequired
updated_atstringrequired
row_versionintegerrequired

PassGuest

FieldTypeConstraints
idstring (uuid)required
account_idstring (uuid)required
namestringrequired
phonestring | nullrequired
emailstring | nullrequired
ticket_refstringrequired
ticket_typestring | nullrequired
tier_idstring | nullrequired
tier_namestring | nullrequired
statusstringrequiredissued blocked refunded
sourcestringrequired
holder_confirmedbooleanrequired
holder_confirmed_atstring | nullrequired
band_serialstring | nullrequired
band_statusstring | nullrequired
checked_inbooleanrequired
walletanyrequired
notesstring | nullrequired
created_atstringrequired
row_versionintegerrequired

PassTicketHolderParty

FieldTypeConstraints
account_idstring (uuid)required
namestringrequired

PassTicketHolderMove

FieldTypeConstraints
idstring (uuid)required
kindstringrequiredclaim transfer correction
channelstring | nullrequired
notestring | nullrequired
fromanyrequired
toPassTicketHolderPartyrequired
atstringrequired

PassTicketScan

FieldTypeConstraints
verdictstringrequiredok ok_unverified already_used invalid unknown not_configured
ticketanyrequired
redeemed_atstring | nullrequired

PassOrganizer

FieldTypeConstraints
idstring (uuid)required
namestringrequired
codestring | nullrequired
productstringrequired

PassShift

FieldTypeConstraints
idstring (uuid)required
event_idstring (uuid)required
zone_idstring | nullrequired
user_idstring (uuid)required
device_serialstring | nullrequired
statusstringrequired
opened_atstringrequired
closed_atstring | nullrequired
takings_minorintegerrequired
salesintegerrequired
ledgered_takings_minorintegerrequired
ledgered_salesintegerrequired
entries_grantedintegerrequired
entries_deniedintegerrequired
by_methodobject[]required

PassCashDesk

FieldTypeConstraints
taken_minorintegerrequired
topupsintegerrequired
refunds_minorintegerrequired
currencystringrequired

PassCatalogue

FieldTypeConstraints
categoriesobject[]required
itemsobject[]required

PassHistory

FieldTypeConstraints
salesobject[]required
scansobject[]required

PassReport

FieldTypeConstraints
currencystringrequired
net_minorintegerrequired
sales_countintegerrequired
items_soldintegerrequired
bucketsobject[]required
top_sellersobject[]required

PassEventOverview

FieldTypeConstraints
tickets_totalintegerrequired
tickets_bandedintegerrequired
scans_allowedintegerrequired
scans_deniedintegerrequired
sales_countintegerrequired
sales_minorintegerrequired
currencystringrequired

PassDevice

FieldTypeConstraints
idstring (uuid)required
serial_numberstringrequired
namestringrequired
zone_idstring | nullrequired
statusstringrequired
registeredbooleanrequired

PassDeviceRow

FieldTypeConstraints
idstring (uuid)required
namestringrequired
serial_numberstringrequired
kindDeviceKindrequired
statusDeviceStatusrequired
zoneobject | nullrequired
zone.idstring (uuid)required
zone.namestringrequired
battery_pctinteger | nullrequired
signal_strengthinteger | nullrequired
sim_presentboolean | nullrequired
firmwarestring | nullrequired
presencestringrequired
last_seen_atstring | nullrequired
row_versionintegerrequired

PassZone

FieldTypeConstraints
idstring (uuid)required
namestringrequired
kindZoneKindrequired
parent_zone_idstring | nullrequired

Occupancy

FieldTypeConstraints
zone_idstring (uuid)required
namestringrequired
containerobjectrequired
container.idstring (uuid)required
container.namestringrequired
open_sessionsintegerrequired
as_ofstringrequired

TicketingStatus

FieldTypeConstraints
connectedbooleanrequired
providerstringrequired
idstring | nullrequired
display_namestring | nullrequired
statusstring | nullrequired
enabledbooleanrequired
environmentstring | nullrequired
key_typestring | nullrequired
webhook_urlstring | nullrequired
last_synced_atstring | nullrequired
countsobject | nullrequired
counts.eventsintegerrequired
counts.ticketsintegerrequired
counts.webhook_events_24hintegerrequired
last_syncobject | nullrequired
last_sync.statusstringrequired
last_sync.started_atstring | nullrequired
last_sync.finished_atstring | nullrequired
last_sync.events_syncedintegerrequired
last_sync.tickets_syncedintegerrequired
last_sync.errorstring | nullrequired

TicketingSyncLog

FieldTypeConstraints
idstring (uuid)required
statusstringrequired
started_atstring | nullrequired
finished_atstring | nullrequired
events_syncedintegerrequired
tickets_syncedintegerrequired
errorstring | nullrequired

TicketingWebhookDelivery

FieldTypeConstraints
idstring (uuid)required
received_atstring | nullrequired
event_typestring | nullrequired
external_idstring | nullrequired
signature_validbooleanrequired
processed_atstring | nullrequired
errorstring | nullrequired

TicketingActivity

FieldTypeConstraints
sync_logsTicketingSyncLog[]required
webhook_eventsTicketingWebhookDelivery[]required

PassSettlements

FieldTypeConstraints
currencystringrequired
total_minorintegerrequired
outletsobject[]required

PassVendor

FieldTypeConstraints
wallet_idstring (uuid)required
namestringrequired
numberstring | nullrequired
phonestring | nullrequired
emailstring | nullrequired
notestring | nullrequired
taken_minorintegerrequired
currency_codestringrequired
statusWalletStatusrequired
created_atstring (date-time)required

PassFanClaim

FieldTypeConstraints
sentbooleanrequired
challenge_idstring | nullrequired
expires_ininteger | nullrequired

PassFanHome

FieldTypeConstraints
accountobjectrequired
account.idstring (uuid)required
account.namestringrequired
account.phonestring | nullrequired
account.emailstring | nullrequired
walletanyrequired
ticketsPassFanTicket[]required

PassFanTicket

FieldTypeConstraints
idstring (uuid)required
ticket_refstringrequired
ticket_typestring | nullrequired
statusstringrequiredissued blocked refunded
tier_namestring | nullrequired
band_serialstring | nullrequired
band_statusstring | nullrequired
checked_inbooleanrequired
eventobjectrequired
event.idstring (uuid)required
event.namestringrequired
event.slugstringrequired
event.starts_atstring | nullrequired
event.timezonestringrequired
event.settingsobjectrequired
created_atstringrequired

PassFanBand

FieldTypeConstraints
serial_numberstringrequired
statusBandStatusrequired

PasswordDone

FieldTypeConstraints
resetbooleanrequired

StaffInvite

FieldTypeConstraints
idstring (uuid)required
namestringrequired
emailstring | nullrequired
phonestring | nullrequired
role_namestring | nullrequired
staff_kindstring | nullrequired
invited_by_namestring | nullrequired
expires_atstringrequired
created_atstringrequired

StaffInviteMinted

FieldTypeConstraints
idstring (uuid)required
tokenstringrequired
expires_atstringrequired

StaffInviteAccepted

FieldTypeConstraints
acceptedbooleanrequired
emailstring | nullrequired
phonestring | nullrequired

TicketingProbe

FieldTypeConstraints
okbooleanrequired
reasonstring | nullrequired
environmentstring | nullrequired
key_typestring | nullrequired
display_namestring | nullrequired
event_countinteger | nullrequired
detected_environmentstring | nullrequired
errorstring | nullrequired

TicketingConnected

FieldTypeConstraints
integration_idstring (uuid)required
display_namestringrequired
key_typestringrequired
events_syncedintegerrequired
tickets_syncedintegerrequired

TicketingSyncReport

FieldTypeConstraints
events_syncedintegerrequired
tickets_syncedintegerrequired

ServiceLog

FieldTypeConstraints
idstring (uuid)required
kindstringrequired
occurred_onstring | nullrequired
amount_minorinteger | nullrequired
currencystring | nullrequired
quantity_litersnumber | nullrequired
odometer_kminteger | nullrequired
descriptionstring | nullrequired

WebDevice

FieldTypeConstraints
idstring (uuid)required
namestring | nullrequired
serial_numberstringrequired
batch_numberstring | nullrequired
kindstringrequired
statusstringrequired
zoneanyrequired
schoolanyrequired
imeistring | nullrequired
sim_msisdnstring | nullrequired
sim_presentboolean | nullrequired
battery_pctinteger | nullrequired
signal_strengthinteger | nullrequired
firmwarestring | nullrequired
data_used_bytesinteger | nullrequired
presencestringrequired
last_seen_atstring | nullrequired
row_versionintegerrequired

DeviceHistoryEntry

FieldTypeConstraints
idstring (uuid)required
kindstringrequired
changesobjectrequired
actor_user_idstring | nullrequired
atstring (date-time)required

WebRoster

FieldTypeConstraints
zone_idstring (uuid)required
access_modestringrequired
membersobject[]required
rulesobject[]required

AccessModeSet

FieldTypeConstraints
zone_idstring (uuid)required
access_modestringrequired

VehicleFields

FieldTypeConstraints
zone_idstring (uuid)required
capacityinteger | nullrequired
fuel_typestring | nullrequired
fuel_consumption_km_per_lnumber | nullrequired

Deleted

FieldTypeConstraints
deletedbooleanrequired

RollcallRow

FieldTypeConstraints
idstring (uuid)required
namestringrequired
gradestring | nullrequired
presentbooleanrequired
checked_in_atstring | nullrequired
zonestring | nullrequired
zone_kindstring | nullrequired

Overview

FieldTypeConstraints
datestringrequired
scopestringrequiredplatform tenant
parentsobjectrequired
parents.totalintegerrequired
parents.this_weekintegerrequired
parents.last_weekintegerrequired
parents.delta_pctnumber | nullrequired
parents.mappedintegerrequired
parents.unmappedintegerrequired
schoolsobjectrequired
schools.totalintegerrequired
schools.this_weekintegerrequired
schools.last_weekintegerrequired
schools.delta_pctnumber | nullrequired
kidsobjectrequired
kids.totalintegerrequired
kids.this_weekintegerrequired
kids.last_weekintegerrequired
kids.delta_pctnumber | nullrequired
busesobjectrequired
buses.totalintegerrequired
buses.this_weekintegerrequired
buses.last_weekintegerrequired
buses.delta_pctnumber | nullrequired
bandsobjectrequired
bands.totalintegerrequired
devicesobjectrequired
devices.totalintegerrequired
devices.onlineintegerrequired
devices.offlineintegerrequired
daily_tapsobjectrequired
daily_taps.unique_studentsintegerrequired
daily_taps.total_studentsintegerrequired
daily_taps.percentagenumberrequired
daily_taps.period_startstringrequired
daily_taps.period_endstringrequired

Export

FieldTypeConstraints
idstring (uuid)required
kindstringrequired
statusstringrequired
errorstring | nullrequired
created_atstring (date-time)required
file_urlstring | nullrequired

WebAlert

FieldTypeConstraints
idstring (uuid)required
kindstringrequired
severitystring | nullrequired
messagestring | nullrequired
detailsstring | nulloptional
trip_idstring | nullrequired
routestring | nullrequired
raised_byanyrequired
occurred_atstring (date-time)required

WebMessage

FieldTypeConstraints
idstring (uuid)required
channelstringrequired
to_msisdnstring | nullrequired
student_idstring | nullrequired
trip_idstring | nullrequired
bodystring | nullrequired
statestringrequired
errorstring | nullrequired
school_idstring | nullrequired
school_namestring | nullrequired
created_atstring (date-time)required

MessageSendResult

FieldTypeConstraints
studentsintegerrequired
queuedintegerrequired

WebTemplate

FieldTypeConstraints
idstring (uuid)required
namestringrequired
channelstringrequired
localestring | nullrequired
subjectstring | nullrequired
bodystringrequired
provider_templatestring | nullrequired
is_activebooleanrequired
is_platformbooleanrequired

WebWallet

FieldTypeConstraints
idstring (uuid)required
holderstringrequired
typeobjectrequired
type.namestringrequired
type.kindstringrequired
balanceMoneyrequired
statusstringrequired
studentanyrequired
accountanyrequired
spending_profile_idstring | nullrequired
holder_phonestring | nullrequired
created_atstring (date-time)required

WebWalletDetail

FieldTypeConstraints
idstring (uuid)required
holderstringrequired
typeobjectrequired
type.idstring (uuid)required
type.namestringrequired
type.kindstringrequired
balanceMoneyrequired
statusstringrequired
studentanyrequired
accountanyrequired
spending_profileanyrequired
created_atstring (date-time)required

WalletType

FieldTypeConstraints
idstring (uuid)required
namestringrequired
kindstringrequired
currencystringrequired
is_defaultbooleanrequired
allow_negativebooleanrequired
statusstringrequired
walletsintegerrequired

WebTransaction

FieldTypeConstraints
idstring (uuid)required
typestringrequired
statestringrequired
amountMoneyrequired
descriptionstring | nullrequired
reverses_transaction_idstring | nullrequired
school_idstring | nullrequired
school_namestring | nullrequired
created_atstring (date-time)required

WebAccountWallet

FieldTypeConstraints
accountobjectrequired
account.idstring (uuid)required
account.namestringrequired
walletsobject[]required
childrenobject[]required
recent_transactionsWebTransaction[]required

Credits

FieldTypeConstraints
wallet_idstring (uuid)required
balanceMoneyrequired
usedMoneyrequired

WebLoan

FieldTypeConstraints
idstring (uuid)required
wallet_idstring (uuid)required
borrowerstring | nullrequired
principalMoneyrequired
outstandingMoneyrequired
interest_rate_bpsintegerrequired
penalty_rate_bpsintegerrequired
interest_periodstringrequired
statusstringrequired
term_ends_onstring | nullrequired
next_accrual_atstring | nullrequired
paid_atstring | nullrequired

WebVoucher

FieldTypeConstraints
idstring (uuid)required
codestringrequired
amountMoneyrequired
statusstringrequired
statestringrequired
merchant_wallet_idstring (uuid)required
issued_to_wallet_idstring | nullrequired
issued_toanyrequired
redeemedbooleanrequired
expires_atstring (date-time)required
created_atstring (date-time)required

VoucherCodes

FieldTypeConstraints
codesstring[]required

ChargeRule

FieldTypeConstraints
idstring (uuid)required
namestringrequired
notestring | nullrequired
frequencystringrequired
amountMoneyrequired
destination_wallet_idstring (uuid)required
subject_scopestringrequired
subjectsobject[]required
statusstringrequired
last_processed_atstring | nullrequired

WebhookEndpoint

FieldTypeConstraints
idstring (uuid)required
namestringrequired
urlstringrequired
event_typesstring[]required
statusstringrequired
last_atstring | nullrequired
last_okboolean | nullrequired
ok_24hintegerrequired
failed_24hintegerrequired
tenant_namestring | nullrequired

WebhookDelivery

FieldTypeConstraints
idstring (uuid)required
endpoint_idstring (uuid)required
endpoint_namestringrequired
endpoint_urlstringrequired
event_idstringrequired
event_typestringrequired
attemptintegerrequired
okbooleanrequired
status_codeinteger | nullrequired
errorstring | nullrequired
response_bodystring | nullrequired
duration_msintegerrequired
created_atstring (date-time)required
tenant_namestring | nullrequired
can_retrybooleanrequired

WebhookSecret

FieldTypeConstraints
idstring (uuid)required
secretstringrequired

WebhookRetry

FieldTypeConstraints
idstring (uuid)required
statusstringrequired

GuardianCreated

FieldTypeConstraints
account_idstring (uuid)required
already_existedbooleanrequired

GuardianLinked

FieldTypeConstraints
account_idstring (uuid)required
namestringrequired
already_linkedbooleanrequired

PickupValidation

FieldTypeConstraints
studentobjectrequired
student.idstring (uuid)required
student.namestringrequired
student.gradestring | nullrequired
student.photoanyrequired
guardianobjectrequired
guardian.account_idstring (uuid)required
guardian.namestringrequired
guardian.phonestring | nullrequired
guardian.relationshipstring | nullrequired

PlanRider

FieldTypeConstraints
student_idstring (uuid)required
namestringrequired
gradestring | nullrequired
positionintegerrequired
pickup_stop_idstring | nullrequired
dropoff_stop_idstring | nullrequired
latnumber | nullrequired
lngnumber | nullrequired

SuggestedOrder

FieldTypeConstraints
ridersPlanRider[]required
optimal_distance_mnumberrequired
optimal_duration_snumberrequired
optimal_polylinestring | nullrequired
saved_distance_mnumber | nullrequired
saved_duration_snumber | nullrequired
distance_saved_mnumber | nullrequired
duration_saved_snumber | nullrequired
depotobjectrequired
depot.latnumberrequired
depot.lngnumberrequired

MeasuredOrder

FieldTypeConstraints
distance_mnumberrequired
duration_snumberrequired
polylinestring | nullrequired
depotobjectrequired
depot.latnumberrequired
depot.lngnumberrequired

RouteAssignmentSuggestion

FieldTypeConstraints
assignmentsobject[]required
skipped_vehiclesobject[]required
skipped_studentsobject[]required
savingsanyrequired
depotobjectrequired
depot.latnumberrequired
depot.lngnumberrequired
student_locationsobject[]required
computed_atstring (date-time)required

RouteAssignmentApply

FieldTypeConstraints
appliedstring (uuid)[]required
applied_routesobject[]required
failedobject[]required

RouteAssignmentMeasure

FieldTypeConstraints
assignmentsobject[]required
savingsanyrequired

RouteAssignmentDraft

FieldTypeConstraints
foundbooleanrequired
computed_atstring | nullrequired
assignmentsobject[]required
skipped_vehiclesobject[]required
skipped_studentsobject[]required
savingsanyrequired
depotanyrequired
student_locationsobject[]required
applied_atstring | nullrequired
applied_resultanyrequired

RouteAssignmentDraftPatchResult

FieldTypeConstraints
okbooleanrequired

FuelPrice

FieldTypeConstraints
dieselobject | nullrequired
diesel.price_kes_per_lnumberrequired
diesel.effective_datestringrequired
petrolobject | nullrequired
petrol.price_kes_per_lnumberrequired
petrol.effective_datestringrequired
stalebooleanrequired

IntelligenceAskResult

FieldTypeConstraints
conversation_idstring (uuid)required
messageobjectrequired
message.idstring (uuid)required
message.rolestringrequiredassistant
message.textstringrequired
message.created_atstring (date-time)required
usageobjectrequired
usage.tokens_usedintegerrequired
usage.cost_usdnumberrequired
usage.tool_callsstring[]required

IntelligenceUsage

FieldTypeConstraints
usedintegerrequired
allowanceintegerrequired
month_keystringrequired
bonusintegerrequired

IntelligenceInsightList

FieldTypeConstraints
insightsobject[]required

IntelligenceConversationList

FieldTypeConstraints
conversationsobject[]required

IntelligenceConversationMessages

FieldTypeConstraints
messagesobject[]required

TenantSettingsDoc

FieldTypeConstraints
flagsobjectoptional
notify_requires_subscriptionboolean | nullrequired
notify_delay_secondsinteger | nullrequired
metered_messagingbooleanrequired
attendanceanyrequired
vocabularyobjectrequired
menu_hiddenstring[]required
school_profileanyrequired
help_centeranyrequired
company_infoanyoptional
impact_baselinesImpactBaseline[]required

ImpactBaseline

FieldTypeConstraints
domainstringrequiredtransport meals activities safety
strategystringrequiredmanual first_14_days rolling
manual_valuesobjectoptional
updated_atstring | nulloptional