Null values

In PUT and POST requests, do not set any fields unless you have a reason to do so. As a base rule you don't need to set strings to null or empty string, numbers to 0 etc. - doing so can and will cause unintended consequences or errors.

Id fields

In most endpoints there is an id field. Please note that this is usually a DB identity field that is assigned automatically. Also, this id field is not visible in the Next Project UI. So, for example, it is not the customerno in a /customer/ endpoint. If you want to get a customer using customerno you should instead use List endpoints and filtering, as described here

Active fields

Many endpoints have an active field (datatype bool) which indicates if the post/row is disabled or enabled. In these cases List endpoints by default only return rows where active is true. If you want to return both active and inactive posts/rows in such List endpoints you need to use the filter: {"active__in":["true","false"]} . An example of a List endpoint with active is List Suppliers. Normal GET endpoints where you get a row/post by id always return active as well as inactive rows/posts.

Updating values

Updates to existing records can be made using PUT calls to the correct endpoints. All PUT actions perform partial updates of the records. Only those fields that are explicitly in the call body are modified, all others fields are left unchanged.

Required fields

In POST operations, request schema fields marked as required mean that the field has to be included in the request. If the field is missing you will receive a HTTP 422 Unprocessable Entity response code.

Fields in the response schema for a GET request that are marked as required indicate that those fields will always have a value in the returned response message. This means that you as an integrator can rely on the value being set when processing the response.