Every GraphQL schema has a root type for both queries and mutations. The query type defines GraphQL operations that retrieve data from the server.

categories

Type: CategoriesConnection

Reads and enables pagination through a set of Category.

Args

NameDescription
first ( Int )Only read the first n values of the set.
last ( Int )Only read the last n values of the set.
offset ( Int )Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last.
before ( Cursor )Read all values in the set before (above) this cursor.
after ( Cursor )Read all values in the set after (below) this cursor.
orderBy ( CategoriesOrderBy! )The method to use when ordering Category.
condition ( CategoryCondition )A condition to be used in determining which values should be returned by the collection.
filter ( CategoryFilter )A filter to be used in determining which values should be returned by the collection.
includeArchived ( IncludeArchivedOption )Indicates whether archived items should be included in the results or not.

categoriesList

Type: Category!

Reads a set of Category.

Args

NameDescription
first ( Int )Only read the first n values of the set.
offset ( Int )Skip the first n values.
orderBy ( CategoriesOrderBy! )The method to use when ordering Category.
condition ( CategoryCondition )A condition to be used in determining which values should be returned by the collection.
filter ( CategoryFilter )A filter to be used in determining which values should be returned by the collection.
includeArchived ( IncludeArchivedOption )Indicates whether archived items should be included in the results or not.

category

Type: Category

Args

NameDescription
categoryId ( BigInt! )no description provided

categoryById

Type: Category

Reads a single Category using its globally unique ID.

Args

NameDescription
id ( ID! )The globally unique ID to be used in selecting a single Category.

categoryByLocationIdAndXCategoryId

Type: Category

Args

NameDescription
locationId ( BigInt! )no description provided
xCategoryId ( String! )no description provided

employees

Type: EmployeesConnection

Reads and enables pagination through a set of Employee.

Args

NameDescription
first ( Int )Only read the first n values of the set.
last ( Int )Only read the last n values of the set.
offset ( Int )Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last.
before ( Cursor )Read all values in the set before (above) this cursor.
after ( Cursor )Read all values in the set after (below) this cursor.
orderBy ( EmployeesOrderBy! )The method to use when ordering Employee.
condition ( EmployeeCondition )A condition to be used in determining which values should be returned by the collection.
filter ( EmployeeFilter )A filter to be used in determining which values should be returned by the collection.
includeArchived ( IncludeArchivedOption )Indicates whether archived items should be included in the results or not.

employeesList

Type: Employee!

Reads a set of Employee.

Args

NameDescription
first ( Int )Only read the first n values of the set.
offset ( Int )Skip the first n values.
orderBy ( EmployeesOrderBy! )The method to use when ordering Employee.
condition ( EmployeeCondition )A condition to be used in determining which values should be returned by the collection.
filter ( EmployeeFilter )A filter to be used in determining which values should be returned by the collection.
includeArchived ( IncludeArchivedOption )Indicates whether archived items should be included in the results or not.

guests

Type: GuestsConnection

Reads and enables pagination through a set of Guest.

Args

NameDescription
first ( Int )Only read the first n values of the set.
last ( Int )Only read the last n values of the set.
offset ( Int )Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last.
before ( Cursor )Read all values in the set before (above) this cursor.
after ( Cursor )Read all values in the set after (below) this cursor.
orderBy ( GuestsOrderBy! )The method to use when ordering Guest.
condition ( GuestCondition )A condition to be used in determining which values should be returned by the collection.
filter ( GuestFilter )A filter to be used in determining which values should be returned by the collection.

guestsList

Type: Guest!

Reads a set of Guest.

Args

NameDescription
first ( Int )Only read the first n values of the set.
offset ( Int )Skip the first n values.
orderBy ( GuestsOrderBy! )The method to use when ordering Guest.
condition ( GuestCondition )A condition to be used in determining which values should be returned by the collection.
filter ( GuestFilter )A filter to be used in determining which values should be returned by the collection.

id

Type: ID!

The root query type must be a Node to work well with Relay 1 mutations. This just resolves to query.

Args

NameDescription

inventories

Type: InventoriesConnection

Reads and enables pagination through a set of Inventory.

Args

NameDescription
first ( Int )Only read the first n values of the set.
last ( Int )Only read the last n values of the set.
offset ( Int )Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last.
before ( Cursor )Read all values in the set before (above) this cursor.
after ( Cursor )Read all values in the set after (below) this cursor.
orderBy ( InventoriesOrderBy! )The method to use when ordering Inventory.
condition ( InventoryCondition )A condition to be used in determining which values should be returned by the collection.
filter ( InventoryFilter )A filter to be used in determining which values should be returned by the collection.
includeArchived ( IncludeArchivedOption )Indicates whether archived items should be included in the results or not.

inventoriesList

Type: Inventory!

Reads a set of Inventory.

Args

NameDescription
first ( Int )Only read the first n values of the set.
offset ( Int )Skip the first n values.
orderBy ( InventoriesOrderBy! )The method to use when ordering Inventory.
condition ( InventoryCondition )A condition to be used in determining which values should be returned by the collection.
filter ( InventoryFilter )A filter to be used in determining which values should be returned by the collection.
includeArchived ( IncludeArchivedOption )Indicates whether archived items should be included in the results or not.

inventory

Type: Inventory

Args

NameDescription
inventoryId ( BigInt! )no description provided

inventoryById

Type: Inventory

Reads a single Inventory using its globally unique ID.

Args

NameDescription
id ( ID! )The globally unique ID to be used in selecting a single Inventory.

item

Type: Item

Args

NameDescription
itemId ( BigInt! )no description provided

itemAdjustment

Type: ItemAdjustment

Args

NameDescription
itemAdjustmentId ( BigInt! )no description provided

itemAdjustmentById

Type: ItemAdjustment

Reads a single ItemAdjustment using its globally unique ID.

Args

NameDescription
id ( ID! )The globally unique ID to be used in selecting a single ItemAdjustment.

itemAdjustments

Type: ItemAdjustmentsConnection

Reads and enables pagination through a set of ItemAdjustment.

Args

NameDescription
first ( Int )Only read the first n values of the set.
last ( Int )Only read the last n values of the set.
offset ( Int )Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last.
before ( Cursor )Read all values in the set before (above) this cursor.
after ( Cursor )Read all values in the set after (below) this cursor.
orderBy ( ItemAdjustmentsOrderBy! )The method to use when ordering ItemAdjustment.
condition ( ItemAdjustmentCondition )A condition to be used in determining which values should be returned by the collection.
filter ( ItemAdjustmentFilter )A filter to be used in determining which values should be returned by the collection.

itemAdjustmentsList

Type: ItemAdjustment!

Reads a set of ItemAdjustment.

Args

NameDescription
first ( Int )Only read the first n values of the set.
offset ( Int )Skip the first n values.
orderBy ( ItemAdjustmentsOrderBy! )The method to use when ordering ItemAdjustment.
condition ( ItemAdjustmentCondition )A condition to be used in determining which values should be returned by the collection.
filter ( ItemAdjustmentFilter )A filter to be used in determining which values should be returned by the collection.

itemById

Type: Item

Reads a single Item using its globally unique ID.

Args

NameDescription
id ( ID! )The globally unique ID to be used in selecting a single Item.

items

Type: ItemsConnection

Reads and enables pagination through a set of Item.

Args

NameDescription
first ( Int )Only read the first n values of the set.
last ( Int )Only read the last n values of the set.
offset ( Int )Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last.
before ( Cursor )Read all values in the set before (above) this cursor.
after ( Cursor )Read all values in the set after (below) this cursor.
orderBy ( ItemsOrderBy! )The method to use when ordering Item.
condition ( ItemCondition )A condition to be used in determining which values should be returned by the collection.
filter ( ItemFilter )A filter to be used in determining which values should be returned by the collection.

itemsList

Type: Item!

Reads a set of Item.

Args

NameDescription
first ( Int )Only read the first n values of the set.
offset ( Int )Skip the first n values.
orderBy ( ItemsOrderBy! )The method to use when ordering Item.
condition ( ItemCondition )A condition to be used in determining which values should be returned by the collection.
filter ( ItemFilter )A filter to be used in determining which values should be returned by the collection.

location

Type: Location

Args

NameDescription
locationId ( BigInt! )no description provided

locationById

Type: Location

Reads a single Location using its globally unique ID.

Args

NameDescription
id ( ID! )The globally unique ID to be used in selecting a single Location.

locationByUrlName

Type: Location

Args

NameDescription
urlName ( String! )no description provided

locations

Type: LocationsConnection

Reads and enables pagination through a set of Location.

Args

NameDescription
first ( Int )Only read the first n values of the set.
last ( Int )Only read the last n values of the set.
offset ( Int )Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last.
before ( Cursor )Read all values in the set before (above) this cursor.
after ( Cursor )Read all values in the set after (below) this cursor.
orderBy ( LocationsOrderBy! )The method to use when ordering Location.
condition ( LocationCondition )A condition to be used in determining which values should be returned by the collection.
filter ( LocationFilter )A filter to be used in determining which values should be returned by the collection.
includeArchived ( IncludeArchivedOption )Indicates whether archived items should be included in the results or not.

locationsList

Type: Location!

Reads a set of Location.

Args

NameDescription
first ( Int )Only read the first n values of the set.
offset ( Int )Skip the first n values.
orderBy ( LocationsOrderBy! )The method to use when ordering Location.
condition ( LocationCondition )A condition to be used in determining which values should be returned by the collection.
filter ( LocationFilter )A filter to be used in determining which values should be returned by the collection.
includeArchived ( IncludeArchivedOption )Indicates whether archived items should be included in the results or not.

menu

Type: Menu

Args

NameDescription
menuId ( BigInt! )no description provided

menuById

Type: Menu

Reads a single Menu using its globally unique ID.

Args

NameDescription
id ( ID! )The globally unique ID to be used in selecting a single Menu.

menuCategories

Type: MenuCategoriesConnection

Reads and enables pagination through a set of MenuCategory.

Args

NameDescription
first ( Int )Only read the first n values of the set.
last ( Int )Only read the last n values of the set.
offset ( Int )Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last.
before ( Cursor )Read all values in the set before (above) this cursor.
after ( Cursor )Read all values in the set after (below) this cursor.
orderBy ( MenuCategoriesOrderBy! )The method to use when ordering MenuCategory.
condition ( MenuCategoryCondition )A condition to be used in determining which values should be returned by the collection.
filter ( MenuCategoryFilter )A filter to be used in determining which values should be returned by the collection.

menuCategoriesList

Type: MenuCategory!

Reads a set of MenuCategory.

Args

NameDescription
first ( Int )Only read the first n values of the set.
offset ( Int )Skip the first n values.
orderBy ( MenuCategoriesOrderBy! )The method to use when ordering MenuCategory.
condition ( MenuCategoryCondition )A condition to be used in determining which values should be returned by the collection.
filter ( MenuCategoryFilter )A filter to be used in determining which values should be returned by the collection.

menuCategory

Type: MenuCategory

Args

NameDescription
menuCategoryId ( BigInt! )no description provided

menuCategoryById

Type: MenuCategory

Reads a single MenuCategory using its globally unique ID.

Args

NameDescription
id ( ID! )The globally unique ID to be used in selecting a single MenuCategory.

menuProduct

Type: MenuProduct

Args

NameDescription
productId ( BigInt! )no description provided

menuProductById

Type: MenuProduct

Reads a single MenuProduct using its globally unique ID.

Args

NameDescription
id ( ID! )The globally unique ID to be used in selecting a single MenuProduct.

menuProducts

Type: MenuProductsConnection

Reads and enables pagination through a set of MenuProduct.

Args

NameDescription
first ( Int )Only read the first n values of the set.
last ( Int )Only read the last n values of the set.
offset ( Int )Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last.
before ( Cursor )Read all values in the set before (above) this cursor.
after ( Cursor )Read all values in the set after (below) this cursor.
orderBy ( MenuProductsOrderBy! )The method to use when ordering MenuProduct.
condition ( MenuProductCondition )A condition to be used in determining which values should be returned by the collection.
filter ( MenuProductFilter )A filter to be used in determining which values should be returned by the collection.

menuProductsList

Type: MenuProduct!

Reads a set of MenuProduct.

Args

NameDescription
first ( Int )Only read the first n values of the set.
offset ( Int )Skip the first n values.
orderBy ( MenuProductsOrderBy! )The method to use when ordering MenuProduct.
condition ( MenuProductCondition )A condition to be used in determining which values should be returned by the collection.
filter ( MenuProductFilter )A filter to be used in determining which values should be returned by the collection.

menus

Type: MenusConnection

Reads and enables pagination through a set of Menu.

Args

NameDescription
first ( Int )Only read the first n values of the set.
last ( Int )Only read the last n values of the set.
offset ( Int )Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last.
before ( Cursor )Read all values in the set before (above) this cursor.
after ( Cursor )Read all values in the set after (below) this cursor.
orderBy ( MenusOrderBy! )The method to use when ordering Menu.
condition ( MenuCondition )A condition to be used in determining which values should be returned by the collection.
filter ( MenuFilter )A filter to be used in determining which values should be returned by the collection.

menusList

Type: Menu!

Reads a set of Menu.

Args

NameDescription
first ( Int )Only read the first n values of the set.
offset ( Int )Skip the first n values.
orderBy ( MenusOrderBy! )The method to use when ordering Menu.
condition ( MenuCondition )A condition to be used in determining which values should be returned by the collection.
filter ( MenuFilter )A filter to be used in determining which values should be returned by the collection.

node

Type: Node

Fetches an object given its globally unique ID.

Args

NameDescription
id ( ID! )The globally unique ID.

payment

Type: Payment

Args

NameDescription
paymentId ( BigInt! )no description provided

paymentById

Type: Payment

Reads a single Payment using its globally unique ID.

Args

NameDescription
id ( ID! )The globally unique ID to be used in selecting a single Payment.

paymentByTabIdAndPaymentTypeAndXPaymentId

Type: Payment

Args

NameDescription
tabId ( BigInt! )no description provided
paymentType ( String! )no description provided
xPaymentId ( String! )no description provided

payments

Type: PaymentsConnection

Reads and enables pagination through a set of Payment.

Args

NameDescription
first ( Int )Only read the first n values of the set.
last ( Int )Only read the last n values of the set.
offset ( Int )Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last.
before ( Cursor )Read all values in the set before (above) this cursor.
after ( Cursor )Read all values in the set after (below) this cursor.
orderBy ( PaymentsOrderBy! )The method to use when ordering Payment.
condition ( PaymentCondition )A condition to be used in determining which values should be returned by the collection.
filter ( PaymentFilter )A filter to be used in determining which values should be returned by the collection.

paymentsList

Type: Payment!

Reads a set of Payment.

Args

NameDescription
first ( Int )Only read the first n values of the set.
offset ( Int )Skip the first n values.
orderBy ( PaymentsOrderBy! )The method to use when ordering Payment.
condition ( PaymentCondition )A condition to be used in determining which values should be returned by the collection.
filter ( PaymentFilter )A filter to be used in determining which values should be returned by the collection.

product

Type: Product

Args

NameDescription
productId ( BigInt! )no description provided

productById

Type: Product

Reads a single Product using its globally unique ID.

Args

NameDescription
id ( ID! )The globally unique ID to be used in selecting a single Product.

products

Type: ProductsConnection

Reads and enables pagination through a set of Product.

Args

NameDescription
first ( Int )Only read the first n values of the set.
last ( Int )Only read the last n values of the set.
offset ( Int )Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last.
before ( Cursor )Read all values in the set before (above) this cursor.
after ( Cursor )Read all values in the set after (below) this cursor.
orderBy ( ProductsOrderBy! )The method to use when ordering Product.
condition ( ProductCondition )A condition to be used in determining which values should be returned by the collection.
filter ( ProductFilter )A filter to be used in determining which values should be returned by the collection.
includeArchived ( IncludeArchivedOption )Indicates whether archived items should be included in the results or not.

productsList

Type: Product!

Reads a set of Product.

Args

NameDescription
first ( Int )Only read the first n values of the set.
offset ( Int )Skip the first n values.
orderBy ( ProductsOrderBy! )The method to use when ordering Product.
condition ( ProductCondition )A condition to be used in determining which values should be returned by the collection.
filter ( ProductFilter )A filter to be used in determining which values should be returned by the collection.
includeArchived ( IncludeArchivedOption )Indicates whether archived items should be included in the results or not.

query

Type: Query!

Exposes the root query type nested one level down. This is helpful for Relay 1
which can only query top level fields if they are in a particular form.

Args

NameDescription

tab

Type: Tab

Args

NameDescription
tabId ( BigInt! )no description provided

tabById

Type: Tab

Reads a single Tab using its globally unique ID.

Args

NameDescription
id ( ID! )The globally unique ID to be used in selecting a single Tab.

tabByTabUuid

Type: Tab

Args

NameDescription
tabUuid ( String! )no description provided

tabs

Type: TabsConnection

Reads and enables pagination through a set of Tab.

Args

NameDescription
first ( Int )Only read the first n values of the set.
last ( Int )Only read the last n values of the set.
offset ( Int )Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last.
before ( Cursor )Read all values in the set before (above) this cursor.
after ( Cursor )Read all values in the set after (below) this cursor.
orderBy ( TabsOrderBy! )The method to use when ordering Tab.
condition ( TabCondition )A condition to be used in determining which values should be returned by the collection.
filter ( TabFilter! )A filter to be used in determining which values should be returned by the collection.

tabsList

Type: Tab!

Reads a set of Tab.

Args

NameDescription
first ( Int )Only read the first n values of the set.
offset ( Int )Skip the first n values.
orderBy ( TabsOrderBy! )The method to use when ordering Tab.
condition ( TabCondition )A condition to be used in determining which values should be returned by the collection.
filter ( TabFilter! )A filter to be used in determining which values should be returned by the collection.

timeEntries

Type: TimeEntriesConnection

Reads and enables pagination through a set of TimeEntry.

Args

NameDescription
first ( Int )Only read the first n values of the set.
last ( Int )Only read the last n values of the set.
offset ( Int )Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last.
before ( Cursor )Read all values in the set before (above) this cursor.
after ( Cursor )Read all values in the set after (below) this cursor.
orderBy ( TimeEntriesOrderBy! )The method to use when ordering TimeEntry.
condition ( TimeEntryCondition )A condition to be used in determining which values should be returned by the collection.
filter ( TimeEntryFilter )A filter to be used in determining which values should be returned by the collection.
includeArchived ( IncludeArchivedOption )Indicates whether archived items should be included in the results or not.

timeEntriesList

Type: TimeEntry!

Reads a set of TimeEntry.

Args

NameDescription
first ( Int )Only read the first n values of the set.
offset ( Int )Skip the first n values.
orderBy ( TimeEntriesOrderBy! )The method to use when ordering TimeEntry.
condition ( TimeEntryCondition )A condition to be used in determining which values should be returned by the collection.
filter ( TimeEntryFilter )A filter to be used in determining which values should be returned by the collection.
includeArchived ( IncludeArchivedOption )Indicates whether archived items should be included in the results or not.

timeEntry

Type: TimeEntry

Args

NameDescription
timeEntryId ( BigInt! )no description provided

timeEntryById

Type: TimeEntry

Reads a single TimeEntry using its globally unique ID.

Args

NameDescription
id ( ID! )The globally unique ID to be used in selecting a single TimeEntry.

timePunchType

Type: TimePunchType

Args

NameDescription
timePunchTypeId ( BigInt! )no description provided

timePunchTypeById

Type: TimePunchType

Reads a single TimePunchType using its globally unique ID.

Args

NameDescription
id ( ID! )The globally unique ID to be used in selecting a single TimePunchType.

timePunchTypeByTimePunchTypeUuid

Type: TimePunchType

Args

NameDescription
timePunchTypeUuid ( String! )no description provided

timePunchTypes

Type: TimePunchTypesConnection

Reads and enables pagination through a set of TimePunchType.

Args

NameDescription
first ( Int )Only read the first n values of the set.
last ( Int )Only read the last n values of the set.
offset ( Int )Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last.
before ( Cursor )Read all values in the set before (above) this cursor.
after ( Cursor )Read all values in the set after (below) this cursor.
orderBy ( TimePunchTypesOrderBy! )The method to use when ordering TimePunchType.
condition ( TimePunchTypeCondition )A condition to be used in determining which values should be returned by the collection.
filter ( TimePunchTypeFilter )A filter to be used in determining which values should be returned by the collection.
includeArchived ( IncludeArchivedOption )Indicates whether archived items should be included in the results or not.

timePunchTypesList

Type: TimePunchType!

Reads a set of TimePunchType.

Args

NameDescription
first ( Int )Only read the first n values of the set.
offset ( Int )Skip the first n values.
orderBy ( TimePunchTypesOrderBy! )The method to use when ordering TimePunchType.
condition ( TimePunchTypeCondition )A condition to be used in determining which values should be returned by the collection.
filter ( TimePunchTypeFilter )A filter to be used in determining which values should be returned by the collection.
includeArchived ( IncludeArchivedOption )Indicates whether archived items should be included in the results or not.

userRole

Type: UserRole

Args

NameDescription
userRoleId ( BigInt! )no description provided

userRoleById

Type: UserRole

Reads a single UserRole using its globally unique ID.

Args

NameDescription
id ( ID! )The globally unique ID to be used in selecting a single UserRole.

userRoleByLocationIdAndRoleName

Type: UserRole

Args

NameDescription
locationId ( BigInt! )no description provided
roleName ( String! )no description provided

userRoleByUserRoleUuid

Type: UserRole

Args

NameDescription
userRoleUuid ( String! )no description provided

userRoles

Type: UserRolesConnection

Reads and enables pagination through a set of UserRole.

Args

NameDescription
first ( Int )Only read the first n values of the set.
last ( Int )Only read the last n values of the set.
offset ( Int )Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last.
before ( Cursor )Read all values in the set before (above) this cursor.
after ( Cursor )Read all values in the set after (below) this cursor.
orderBy ( UserRolesOrderBy! )The method to use when ordering UserRole.
condition ( UserRoleCondition )A condition to be used in determining which values should be returned by the collection.
filter ( UserRoleFilter )A filter to be used in determining which values should be returned by the collection.
includeArchived ( IncludeArchivedOption )Indicates whether archived items should be included in the results or not.

userRolesList

Type: UserRole!

Reads a set of UserRole.

Args

NameDescription
first ( Int )Only read the first n values of the set.
offset ( Int )Skip the first n values.
orderBy ( UserRolesOrderBy! )The method to use when ordering UserRole.
condition ( UserRoleCondition )A condition to be used in determining which values should be returned by the collection.
filter ( UserRoleFilter )A filter to be used in determining which values should be returned by the collection.
includeArchived ( IncludeArchivedOption )Indicates whether archived items should be included in the results or not.