Best practices
GraphQL best practices guide for naming queries, parameterizing with variables, fetching only needed data, ensuring input order, batch inserting, handling transactions, and executing long-running operations asynchronously.
How Tos
Guides and best practices for integrating with the Business NXT GraphQL API, including creating orders and managing documents.
We recognize that having learned GraphQL API does not mean you are able to write integrations without further help. Although tools such as GraphiQL, Postman, and Insomnia allow you to browse the schema and discover the Business NXT model and operations with it, writing code to handle your data requires further knowledge.
In this section, we provide a set of recommended practices as well as a series of guides to help you perform some common business operations.
- Best practices for Business NXT API
- How to create and finish an order
- How to add an attachment to an order
- How to invoice an order
- How to create and update a batch
- How to add a document to a voucher
- How to read text from the Text table
How to create and finish an order
Guide to creating, adding lines, and finishing an order using GraphQL mutations. Includes field requirements, example queries, and responses for each step.
How to add an attachment to an order
Instructions on adding attachments to orders using GraphQL, including setting specific document types and handling file size limitations.
How to create and update a batch
Guide on creating and updating a batch using GraphQL. Includes steps for batch creation, determining voucher number, voucher creation, and batch update.
How to invoice an order
Guide on invoicing orders using GraphQL mutation. Includes example query, result, and parameter descriptions for generating invoices and credit note reports.
How to add a document to a voucher
Guide on adding a document to a voucher and transferring it to file service using GraphQL mutations. Includes example queries and notes on limitations.
How to read text from the Text table
Learn how to query and filter text values from the Text table for various fields, including payment and delivery methods, using GraphQL.