Queries
The Business NXT schema supports reading data (with a query
request) as well as modifying data (with a mutation
request). These two operations are exposed at the top of the schema with the query
and mutation
fields, as shown in the following image:
Here, you will learn about reading data. For inserts, updates, and deletes, see The Mutation Type.
Section Content
The Query Type
GraphQL Query type enables querying various tables with fields like useCompany for company data and useCustomer for system information.
Grouping
API documentation on grouping data, including SQL examples, GraphQL equivalents, and parameters for filtering, sorting, paginating, and applying aggregate functions.
Aggregates
Aggregate functions in GraphQL for computing values in table fields. Supports sum, average, count, min, max, variance, and more.
Distinct values
Guide to fetch distinct table values using distinct argument, translating into SQL. Examples include account groups, customers, and order types, with equivalent groupBy queries.
Fetching user's available customers
Fetch multiple customers linked to a user via GraphQL, using the availableCustomers query field with optional pagination and sorting.
Fetching user's available companies
Retrieve a list of companies available to an authenticated user using the availableCompanies GraphQL field, with optional filtering and sorting arguments.
Model information
Query model information using useModel to retrieve details on tables, columns, relations, domains, processings, reports, and folders.