Sage Active Public API V1 documentation

Quick start

In a few minutes, test your first request with the API.

API resources overview

Here you find the description of all the resources available for the API.

Tutorials

Simplify your learning thanks to the various tutorials available to you

Key Concepts

Find, grouped in this section, frequently needed information.

FAQ - Frequently Asked Questions

Have the right reflex, consult the answers to the main questions referenced by theme.

What's new

  • 21 november

    Documentation improvements

    Some improvements in the documentation.
    Also, don’t forget that the API has been in production since the September version.

    Read more ...

    Some improvements in the documentation.
    Also, don’t forget that the API has been in production since the September version.

    API in production

    • Since September, launching the Public API for Production Environments in France, Spain, and Germany (How to find ?)

    Documentation Improvements

    • Improvement authentication Documentation for web server app, mobile, desktop Apps and single page app (How to find?)
      • Comprehensive guides have been improved to explain how to implement authentication applications within our system.
    • New Postman collection Sage Active Public API V1 (11 November)

      The September or October version remains compatible and may continue to be used.
      However, you can opt to switch to the November version, which contains only minor updates.
      Download the new Postman collection for October version: Quick start / 5. Test your first query in Postman

      Caution

      If you are new to the Sage Active Public API V1, it is strongly recommended to fully follow the Quick start guide before beginning to explore the collection.

  • 19 october

    Documentation improvements

    Some improvements in the documentation, minor corrections.
    Also, don’t forget that the API has been in production since the September version.

    Read more ...

    Some improvements in the documentation, minor corrections.
    Also, don’t forget that the API has been in production since the September version.

    API in production

    • Since September, launching the Public API for Production Environments in France, Spain, and Germany (How to find ?)

    Documentation Improvements

    Bugs

    • Fixed the display of tiles in the ‘Application Keys’ interface when the title or description were long, as they overflowed the tile.
    • In the Solutions tab of Application Keys, the on/off toggle button was ambiguous as it could suggest that the solution was not activated; it has been replaced by a chevron.
    • Clarification of the message returned by the API when an authenticated user is not a Sage Active user.

  • 26 September

    Launching the Public API in production

    • Launching the public API for Sage Active in production for France FR, Spain ES, and Germany DE
    • Authentication Documentation for Mobile and Desktop Apps
    • New Mutations to Simplify the Addition of Accounting Entries, Customers, Suppliers.
    Read more ...
    • Launching the public API for Sage Active in production for France FR, Spain ES, and Germany DE
    • Authentication Documentation for Mobile and Desktop Apps
    • New Mutations to Simplify the Addition of Accounting Entries, Customers, Suppliers.

    API Improvements

    • Launching the Public API for Production Environments in France, Spain, and Germany (How to find ?)
      • The public API is now live for the production environments of the three legislations: France, Spain, and Germany.
      • The staging environment remains accessible and allows you to test all three legislations.
    • New Mutations to Simplify the Addition of Accounting Entries (How to find?)
      • We’ve introduced new mutations that make it easier for you to add accounting entries to your records.
      • These enhancements streamline the process and reduce complexity.
    • Simplification of the Creation of Customer and Supplier Third Parties (How to find?)
      • We have made enhancements to streamline the process of creating customer and supplier third-party records.

    Documentation Improvements

    • Addition of an Index of Important Terms:
      • A comprehensive index page has been added to help users quickly find and understand crucial terms used within the application.
        Index of Important Terms
    • Improvements in Resource Descriptions with Thumbnails
      • We’ve enhanced the descriptions for each resource and added thumbnails, providing a more intuitive way to identify resources through the application’s interface.
      • Example API resources overview / Accounting Accounts
    • Inclusion of “How to Find?” in Key Locations
      • To facilitate easy navigation and information retrieval, “How to Find?” links have been added at key locations.
      • These links guide you to the specific sections where they can obtain necessary information.
    • Authentication Documentation for Mobile and Desktop Apps (How to find?)
      • Comprehensive guides have been added to explain how to implement authentication for mobile and desktop applications within our system.
    • Dedicated Page for Updating Records Logic:
      • We are excited to introduce a dedicated page that thoroughly explains the logic and methods for updating records using the GraphQL patch-like approach. Visit the page to delve into the intricacies of efficiently modifying specific fields within records.
        Key concepts / Updating records

    • New Postman collection Sage Active Public API V1 (09 September)

      Please replace the previous one as some examples are no longer compatible.
      Download the new Postman collection for September version: Quick start / 5. Test your first query in Postman

      Caution

      If you are new to the Sage Active Public API V1, it is strongly recommended to fully follow the Quick start guide before beginning to explore the collection.

  • 7 August

    New Postman collection

    New Postman collection (08 August)

    Read more ...

    New Postman collection (08 August)

    Improvements

    • New Postman collection Sage Active Public API V0 (08 August)

      • The collection can be utilized for Sage Active in either FR legislation or ES legislation.
      • The Postman collection has been upgraded to make its application more efficient under the ES legislation. This includes value assignments that are custom-fit to the current legislation.

  • 7 July

    Sage Active July compatibility for FR and ES

    Sage Active July compatibility for FR and ES

    Read more ...

    Sage Active July compatibility for FR and ES

    Improvements

    • New Postman collection Sage Active Public API V0 (07 July)

      • The collection can be utilized for Sage Active in either FR legislation or ES legislation.
      • The Postman collection has been upgraded to make its application more efficient under the ES legislation. This includes value assignments that are custom-fit to the current legislation.
      • For example, a suggested identification number for an organization, client, or supplier is automatically provided, aligned with the existing legislation.
      • In a similar vein, when an accounting entry is created, relevant account numbers are automatically generated, ensuring adherence to the prevailing legislation.
      • Additionally, the userProfile object now exposes a new property named activeLegisLationCode.
        This addition enables the determination of the tenant’s legislation.
        It’s important to remember that the legislation helps differentiate between Sage Active versions such as FR, ES, DE, and their respective business rules.

  • 15 June

    New Postman collection, help to test thirds & organizations

    New Postman collection (06 June), Sage Active June compatibility for FR and ES

    Read more ...

    New Postman collection (06 June), Sage Active June compatibility for FR and ES

    Improvements

    • New Postman collection Sage Active Public API V0 (06 June)

      • The collection can be used for Sage Active in FR legislation or in ES legislation.
      • The Postman collection has been enhanced to streamline its use in the context of ES legislation, with value assignments specifically tailored to the current legislation.
      • For instance, an identification number for an organization, client, or supplier, which is consistent with the current legislation, is automatically suggested.
      • Similarly, when creating an accounting entry, relevant account numbers are automatically generated, ensuring compliance with the current legislation.

    • The objects related to Payment Means and Payment Terms have been modified to account for the simplifications introduced in the June version of Sage Active.
      API resources overview / Payment means
      API resources overview / Payment terms

    • Help to test the creation of organizations with valid Id documents API resources overview / Organizations

      DocumentId generator for your tests in legislation

    • Help to test the creation of customers/suppliers with valid Id documents API resources overview / Customers

      DocumentId generator for your tests in legislation

  • 15 May

    New userProfile object

    New Postman collection (05 May), Sage Active May compatibility for FR and ES

    Read more ...

    New Postman collection (05 May), Sage Active May compatibility for FR and ES

    Improvements

  • 3 April

    New Postman collection

    New Postman collection (04 April), new branding of screens and documentation, Sage Active April compatibility

    Read more ...

    New Postman collection (04 April), new branding of screens and documentation, Sage Active April compatibility

    Improvements