Here is a list of recent breaking changes that you may need to adapt to:

• Resource: Organizations

  October 15 version

  • Change: The Status field of organizations is no longer relevant and should not be used to check the status of organizations.
  • Reason: Access permission management for an organization now depends on business management, which allows, for example, the termination of a business’s use.
  • Solution: Simply remove the Status field if it was referenced in queries on organization.

• Resource: SalesInvoice Post Sales Invoice, Sales Open Items settlement

  October 15 version

  • Change: The Id field in response use by PostSalesInvoice service and SalesOpentItemSettlment service is removed and change by AccountingEntryId.
  • Reason: AccountingEntryIdindicates that it is the ID of the accountingEntry and not Id of SalesInvoice.
  • Solution: Simply replace the Id field by the AccountingEntryId field when it was referenced in actions on PostSalesInvoice or SalesOpenItemSettlement.

• Resource: Userprofile

  September 30 version

  • Change: The isBlocked field and the expirationDate field are removed of userprofile.
  • Reason: Access permission management for users now depends on business management, which allows, for example, manage role of user.
  • Solution: Simply remove the isBlocked field and the expirationDate field if are referenced in queries on userprofile.

• Resource: Product

  May 24 version

  • Change: The comments field length has been reduced from 65536 characters to 250.
  • Reason: This change was implemented to mitigate performance impact risks if large volumes are added.
  • Solution: Ensure during the creation and modification of products that the length of comment values does not exceed 250 characters. Replace overly lengthy content with a hyperlink that leads to a page displaying detailed comments.

  

• Resource: sales Documents

  May 24 version

  • Change: The mainAddress and deliveryAddress for salesDocuments were previously exposed as arrays. Now, they are presented in a simple format.
  • Reason: These objects contained only one element, and simplifying their structure facilitates filtering, such as retrieving sales quotes from clients in Brussels.
  • Solution: When retrieving data, remove the index [0].
    For example, use salesQuoteNode.mainAddress instead of salesQuoteNode.mainAddress[0].

  

• Resource: sales Documents

  May 24 version

  • Change: The id field has been removed from mainAddress and deliveryAddress in salesDocuments because it contained a non-significant value.
  • Reason: This change was made to streamline the data structure, as the id was not providing useful information.
  • Solution: Remove the id field from queries involving mainAddress and deliveryAddress.

  

• Resources: Customer, Supplier

  May 24 Version

  • Change: The defaultAccountingAccountId field in Customers and Suppliers is no longer filterable or sortable.
  • Reason: The introduction of dataloaders has currently prevented filtering on this field, which was possible in previous versions. A solution is being studied for a future version.
  • Solution: Remove the filter or sort from the query and perform local filtering on the response data.

  

• Resource: All Resources

  May 24 version

  • Change: In the syntax of queries using fragments, the DTO used to qualify fragment fields is no longer compatible due to the transition to data loaders.
  • Reason: This update is part of a move to simplify query writing and to enhance performance with the use of data loaders.
  • Solution: Replace the DTO name in the fragment syntax with the name of the resource in singular form, starting with a capital letter.
    Example for a query users, fragment UserProps on UserGLDto becomes fragment UserProps on User.

• Resource: Other removed fields

  May 24 version

  • Changes: All of these fields are REMOVEDThis feature has been removed and will cause a compatibility break if it was previously in use.
    • salesQuotes -> action
    • salesOrders -> action
    • salesDeliveryNotes -> action
    • salesInvoices -> action
    • salesTariffs -> calculationBase
    • suppliers / thirdCollectorName
    • paymentMeans -> inactive
    • paymentMeans -> paymentMethodId
    • paymentMeans -> paymentMethodReferenceName
    • organizations -> isDefaultDeliveryAddress
    • organizations -> isDeliveryAddress
    • organizations -> isMainAddress
    • zipcode -> code
  • Reason: These fields were historically present but became inconsistent with the developments in Sage Active. They have been removed to avoid the implication that they may contain incoherent data.
  • Solution: Remove these fields from queries and modify the code responsible for retrieving data from the affected queries.

• Resource: userProfile

  April 24 version

  • Change: The activeOrganizationId field no longer returns the current user’s active organization in Sage Active, but instead returns the first organization assigned to the user.
  • Reason: The information returned was no longer relevant, leading to its removal from the documentation, though the field still exists to prevent query errors.
  • Solution: Manage the current user’s organization in a local cache to retrieve it upon the user’s next login.