Comment on page
We improve our API continuously, but in some cases, we need to make changes that are not fully compatible with the current interface. Recently we improved validation that should help both to unify rules for the entities and to maintain better integrity of the user data.
We want to make the implementation of the new API changes as simple as possible. You can start using the planned changes right now just by adding the
Allow-Versionkey with the BC tag into your request headers and test the improved API ahead of the forced rollout.
Planned rollout date: 2023-06-01
Before the rollout date, you can send requests with the HTTP header
Allow-Version: BC1to enable BC1. After this date, the API2 will behave as if the flag BC1 was set by default and it will not be needed in the headers. For backward compatibility, you will be able to use BC0 flag to switch back to previous behavior.
The BC1 affects GET endpoints returning paginated list of entities. If there are no entities matching the filter or there are no entities at all, the response can be one of these:
For backward compatibility, the flag BC1 will not be applied on paginated endpoints by default after the rollout date. Nevertheless you can still use BC1 in the headers to change the validation after the rollout date.
The BC1 changes the validation of the field
flags. This must be considered when creating a new customer by the POST method.
The BC1 changes the validation if the employee is an administrator (i.e. if
Employee.id == 0). Regardless of the BC1 flag, the administrator cannot be deleted (error:
The BC1 changes validation of the VAT (field
vat) for the Category and Product entities when the Cloud is configured for a tax-payer.