Business NXT API
Introduction
GraphQL is a query an manipulation language for API as well as a runtime for fulfilling queries. Business NXT is providing a GraphQL server-side runtime to execute queries using a type system based on the data model.
Although this document explains how to use the Business NXT API it does not provide learning materials for the GraphQL language. If you are not already familiar with GraphQL, we recommend you first take the Introduction to GraphQL tutorial (from the official GraphQL page) or other learning materials.
Business NXT supports Visma Connect Webhooks. With webhooks, your application gets a notification whenever there is a change in a companies database. The notifications will only contain a table identifier and a primary key - so it can be used in combination with graphql API to get the latest version of the changed row.
You can learn more about using Business NXT from the documentation. See Business NXT documentation.
Endpoints
The Business NXT GraphQL endpoints are:
| URL | Description |
|---|---|
| https://business.visma.net/api/graphql | For querying from a Visma.net user context (authentication using Authentication Code with PKCE). See Web applications for more. |
| https://business.visma.net/api/graphql-service | For querying from a service context (authentication using Client credentials). See Services for more. |
Quick start
Resources
We recommend the following resources for learning more about GraphQL:
Section Content
Getting started with GraphQL queries
We will explore the schema shortly. However, to get started with the API and understand how easy it is to query data from Business NXT, we will look at several simple examples.
Exploring the API
This section introduces testing GraphQL endpoint queries using tools like GraphiQL and Postman, and details the POST request structure with a “GetCustomers” query example.
Authentication
Authentication to Business NXT API via Visma Connect involves multi-tenant identity providers. Requires creating an app in Visma Developer Portal.
GraphQL Schema
Details the Business NXT GraphQL schema, Relay-like, exposing system and company databases with types named after tables, supporting queries and mutations.
GraphQL Features
Comprehensive GraphQL features - filtering, sorting, pagination, fragments, aliases, directives, error handling, unoptimized queries, batch requests.
GraphQL Extensions
GraphQL schema for data model extensions.
Webhooks
Webhooks notify changes in table rows, enabling your app to retrieve updates via GraphQL. Notifications include table ID, primary key, change type, and can be verified using a shared key.
How Tos
Guides and best practices for integrating with the Business NXT GraphQL API, including creating orders and managing documents.
Interactive GraphiQL IDE
Link to an external Interactive GraphiQL IDE
Deprecated features
Description of deprecated features and their replacements, including sortOrder, suggest, and aggregate fetching.