Query

GraphQL Schema definition

type Query {
#   Returns the currently logged in user (if authenticated as a user) or null if you 
#   are not logged in or if you are authenticated with a grant.
# 
# Arguments
#   JWT: If authenticated with a grant, returns the user identified 
#   by the JWT.
User(JWT: String): User 
#   If you are an admin, returns users in your account
# 
# Arguments
#   Term: [Not documented]
Users(Term: String): UserConnection 
#   Returns all companies you have access to.
# 
# Arguments
#   ID: If provided, only the company identified by this ID will be 
#   returned.
#   Term: If provided, only companies whose name contains $term 
#   will be returned.
#   first: Returns the first N items.
#   after: Returns items that happened after the cursor.
#   startCursor: 
#   endCursor: 
#   field: 
Company(
ID: ID,
Term: String,
first: Int,
after: ID,
startCursor: String,
endCursor: String,
field: String
): CompanyConnection 
#   Returns schools in your district (including ones you do not have access to).
# 
# Arguments
#   ID: If provided, only the company identified by this ID will be 
#   returned.
#   Term: If provided, only companies whose name contains $term 
#   will be returned.
#   first: Returns the first N items.
#   after: Returns items that happened after the cursor.
#   startCursor: 
#   endCursor: 
#   field: 
District(
ID: ID,
Term: String,
first: Int,
after: ID,
startCursor: String,
endCursor: String,
field: String
): SchoolConnection 
# Arguments
#   type: [Not documented]
#   Term: If provided, only items whose name contains $term will be 
#   returned.
#   term: If provided, only items whose name contains $term will be 
#   returned.
#   Type: [Not documented]
#   OnlyAvailable: [Not documented]
#   Category: [Not documented]
#   CompanyID: [Not documented]
#   sort: [Not documented]
#   first: Returns the first N items.
#   after: Returns items that happened after the cursor.
#   startCursor: 
#   endCursor: 
#   field: 
PaymentItems(
type: ItemTypeEnum,
Term: String,
term: String,
Type: ItemTypeEnum,
OnlyAvailable: Boolean,
Category: ID,
CompanyID: ID,
sort: String,
first: Int,
after: ID,
startCursor: String,
endCursor: String,
field: String
): PaymentItemConnection 
#   Returns the company configuration for the specified ID.
# 
# Arguments
#   ID: The internal company ID.
CompanyConfiguration(ID: ID): CompanyConfiguration 
#   Returns the transient items for the specified StudentID.
# 
# Arguments
#   StudentID: The student ID.
#   PluginName: If provided, only items whose name contains 
#   PluginName will be returned.
#   CompanyID: The company ID.
#   first: Returns the first N items.
#   after: Returns items that happened after the cursor.
#   startCursor: 
#   endCursor: 
#   field: 
ItemProviderItems(
StudentID: ID,
PluginName: String,
CompanyID: ID,
first: Int,
after: ID,
startCursor: String,
endCursor: String,
field: String
): ItemProviderItemConnection 
#   Transaction report. Returns all transactions paid to *all subcompanies* in the 
#   given time frame. If no time frame is given, it only reports the last two weeks 
#   of data.
# 
# Arguments
#   Search: [Not documented]
#   first: Returns the first N items.
#   after: Returns items that happened after the cursor.
#   startCursor: 
#   endCursor: 
#   field: 
Txn(
Search: TxnSearchInputType,
first: Int,
after: ID,
startCursor: String,
endCursor: String,
field: String
): TxnConnection 
#   Batch report. Returns all batches paid to *all subcompanies* in the given time 
#   frame. If no time frame is given, it only reports the last month of data..
# 
# Arguments
#   Payee: [Not documented]
#   PaymentMethod: [Not documented]
#   first: Returns the first N items.
#   after: Returns items that happened after the cursor.
#   startCursor: 
#   endCursor: 
#   field: 
Batch(
Payee: ID,
PaymentMethod: PaymentMethodEnum,
first: Int,
after: ID,
startCursor: String,
endCursor: String,
field: String
): BatchConnection 
#   Recurring series
# 
# Arguments
#   SeriesID: [Not documented]
#   first: Returns the first N items.
#   after: Returns items that happened after the cursor.
#   startCursor: 
#   endCursor: 
#   field: 
Series(
SeriesID: ID,
first: Int,
after: ID,
startCursor: String,
endCursor: String,
field: String
): SeriesConnection 
# Arguments
#   Type: [Not documented]
#   PayeeID: [Not documented]
#   Keyword: [Not documented]
#   first: Returns the first N items.
#   after: Returns items that happened after the cursor.
#   startCursor: 
#   endCursor: 
#   field: 
GLAccounts(
Type: GLAccountTypeEnum,
PayeeID: ID,
Keyword: String,
first: Int,
after: ID,
startCursor: String,
endCursor: String,
field: String
): GLAccountConnection 
# Arguments
#   first: Returns the first N items.
#   after: Returns items that happened after the cursor.
#   startCursor: 
#   endCursor: 
#   field: 
Images(first: Int, after: ID, startCursor: String, endCursor: String, field: String): ImageConnection 
#   Retrieves the stored payment cards on this users account
StoredCards: [StoredCard] 
#   Retrieves the grades available to this user
Grades: [String] 
#   Retrieves the teachers available to this user
# 
# Arguments
#   Term: [Not documented]
#   first: Returns the first N items.
#   after: Returns items that happened after the cursor.
#   startCursor: 
#   endCursor: 
#   field: 
Teachers(
Term: String,
first: Int,
after: ID,
startCursor: String,
endCursor: String,
field: String
): StringConnection 
#   Retrieves the custom student groups available to this user
# 
# Arguments
#   Term: [Not documented]
#   first: Returns the first N items.
#   after: Returns items that happened after the cursor.
#   startCursor: 
#   endCursor: 
#   field: 
Groups(
Term: String,
first: Int,
after: ID,
startCursor: String,
endCursor: String,
field: String
): GroupConnection 
}
Require by

This element is not required by anyone
GraphQL Schema

Schema

Scalars

Enums

Objects

Input Objects

Directives

Query

GraphQL Schema definition

Require by

Schema

Scalars

Enums

Objects

Input Objects

Directives

Query

link GraphQL Schema definition

link Require by

GraphQL Schema definition

Require by
