OBJECT

Query

This is the root query

link GraphQL Schema definition

  • type Query {
  • # Arguments
  • # id: The public id identifying the Account (ie:
  • # dgm9bnk8-0437xqry-ejpvzeol-jdayw5re)
  • # slug: The slug identifying the Account (ie: babel for
  • # https://opencollective.com/babel)
  • # githubHandle: The githubHandle attached to the Account (ie:
  • # babel for https://opencollective.com/babel)
  • # throwIfMissing: If false, will return null instead of an error
  • # if the Account is not found
  • account(id: String, slug: String, githubHandle: String, throwIfMissing: Boolean): Account
  • # Arguments
  • # id: The public id identifying the Collective (ie:
  • # dgm9bnk8-0437xqry-ejpvzeol-jdayw5re)
  • # slug: The slug identifying the Collective (ie: babel for
  • # https://opencollective.com/babel)
  • # githubHandle: The githubHandle attached to the Collective (ie:
  • # babel for https://opencollective.com/babel)
  • # throwIfMissing: If false, will return null instead of an error
  • # if the Collective is not found
  • collective(
  • id: String,
  • slug: String,
  • githubHandle: String,
  • throwIfMissing: Boolean
  • ): Collective
  • # Arguments
  • # id: The public id identifying the Host (ie:
  • # dgm9bnk8-0437xqry-ejpvzeol-jdayw5re)
  • # slug: The slug identifying the Host (ie: babel for
  • # https://opencollective.com/babel)
  • # githubHandle: The githubHandle attached to the Host (ie: babel
  • # for https://opencollective.com/babel)
  • # throwIfMissing: If false, will return null instead of an error
  • # if the Host is not found
  • host(id: String, slug: String, githubHandle: String, throwIfMissing: Boolean): Host
  • # Arguments
  • # id: The public id identifying the Individual (ie:
  • # dgm9bnk8-0437xqry-ejpvzeol-jdayw5re)
  • # slug: The slug identifying the Individual (ie: babel for
  • # https://opencollective.com/babel)
  • # githubHandle: The githubHandle attached to the Individual (ie:
  • # babel for https://opencollective.com/babel)
  • # throwIfMissing: If false, will return null instead of an error
  • # if the Individual is not found
  • individual(
  • id: String,
  • slug: String,
  • githubHandle: String,
  • throwIfMissing: Boolean
  • ): Individual
  • # Arguments
  • # id: The id identifying the conversation
  • conversation(id: String!): Conversation
  • # Arguments
  • # limit: The number of results to fetch (default 10, max 1000)
  • # offset: The offset to use to fetch
  • # fromAccount: Reference of the account that submitted this
  • # expense
  • # account: Reference of the account where this expense was
  • # submitted
  • # host: Return expenses only for this host
  • # status: Use this field to filter expenses on their statuses
  • # type: Use this field to filter expenses on their type
  • # (RECEIPT/INVOICE)
  • # tags: Only expenses that match these tags
  • # orderBy: The order of results
  • # minAmount: Only return expenses where the amount is greater
  • # than or equal to this value (in cents)
  • # maxAmount: Only return expenses where the amount is lower than
  • # or equal to this value (in cents)
  • # payoutMethodType: Only return expenses that use the given type
  • # as payout method
  • # dateFrom: Only return expenses that were created after this
  • # date
  • # searchTerm: The term to search
  • expenses(
  • limit: Int,
  • offset: Int,
  • fromAccount: AccountReferenceInput,
  • account: AccountReferenceInput,
  • host: AccountReferenceInput,
  • status: ExpenseStatusFilter,
  • type: ExpenseType,
  • tags: [String],
  • orderBy: ChronologicalOrderInput!,
  • minAmount: Int,
  • maxAmount: Int,
  • payoutMethodType: PayoutMethodType,
  • dateFrom: ISODateTime,
  • searchTerm: String
  • ): ExpenseCollection
  • # Arguments
  • # id: Public expense identifier
  • # expense: Identifiers to retrieve the expense.
  • # draftKey: Submit-on-behalf key to access drafted Expenses
  • expense(id: String, expense: ExpenseReferenceInput, draftKey: String): Expense
  • # Arguments
  • # limit: The number of results to fetch (default 10, max 1000)
  • # offset: The offset to use to fetch
  • # tags: Filter hosts by tags (multiple = OR)
  • hosts(limit: Int, offset: Int, tags: [String]): HostCollection
  • # Arguments
  • # order: Identifiers to retrieve the Order
  • order(order: OrderReferenceInput!): Order
  • # Arguments
  • # limit: The number of results to fetch (default 10, max 1000)
  • # offset: The offset to use to fetch
  • # account: Return only orders made from/to account
  • # includeHostedAccounts: If account is a host, also include
  • # hosted accounts orders
  • # filter: Account orders filter (INCOMING or OUTGOING)
  • # status: Use this field to filter orders on their statuses
  • # orderBy: The order of results
  • # minAmount: Only return orders where the amount is greater than
  • # or equal to this value (in cents)
  • # maxAmount: Only return orders where the amount is lower than or
  • # equal to this value (in cents)
  • # dateFrom: Only return orders that were created after this date
  • # searchTerm: The term to search
  • orders(
  • limit: Int,
  • offset: Int,
  • account: AccountReferenceInput,
  • includeHostedAccounts: Boolean,
  • filter: AccountOrdersFilter,
  • status: OrderStatus,
  • orderBy: ChronologicalOrderInput!,
  • minAmount: Int,
  • maxAmount: Int,
  • dateFrom: ISODateTime,
  • searchTerm: String
  • ): OrderCollection!
  • # Arguments
  • # tier: Identifiers to retrieve the tier
  • # throwIfMissing: If true, an error will be returned if the tier
  • # is missing
  • tier(tier: TierReferenceInput!, throwIfMissing: Boolean!): Tier
  • # Arguments
  • # limit: The number of results to fetch (default 10, max 1000)
  • # offset: The offset to use to fetch
  • # type: The transaction type (DEBIT or CREDIT)
  • # fromAccount: Reference of the account that submitted this
  • # expense
  • # account: Reference of the account where this expense was
  • # submitted
  • # host: Reference of the host where this expense was submitted
  • # tags: Only expenses that match these tags
  • # orderBy: The order of results
  • # minAmount: Only return expenses where the amount is greater
  • # than or equal to this value (in cents)
  • # maxAmount: Only return expenses where the amount is lower than
  • # or equal to this value (in cents)
  • # dateFrom: Only return expenses that were created after this
  • # date
  • # dateTo: Only return expenses that were created after this date
  • # searchTerm: The term to search
  • # hasExpense: Transaction is attached to Expense
  • # hasOrder: Transaction is attached to Order
  • # includeIncognitoTransactions: If the account is a user and this
  • # field is true, contributions from the incognito profile will be included too
  • # (admins only)
  • transactions(
  • limit: Int,
  • offset: Int,
  • type: TransactionType,
  • fromAccount: AccountReferenceInput,
  • account: AccountReferenceInput,
  • host: AccountReferenceInput,
  • tags: [String],
  • orderBy: ChronologicalOrderInput!,
  • minAmount: Int,
  • maxAmount: Int,
  • dateFrom: ISODateTime,
  • dateTo: ISODateTime,
  • searchTerm: String,
  • hasExpense: Boolean,
  • hasOrder: Boolean,
  • includeIncognitoTransactions: Boolean!
  • ): TransactionCollection
  • loggedInAccount: Account
  • }

link Require by

This element is not required by anyone