10 Essential Insights to Kickstart Click to watch the video

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 & Samples

Simplify your learning thanks to the various tutorials available to you. Discover the sample quote management app too.

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

  • 2024 March / April

    User Management / Import Demo Data  

    User Management, explore the next level of secure, role-based access control for users.
    Import Demo Data with just one click.

    Read more ...

    User Management, explore the next level of secure, role-based access control for users.
    Import Demo Data with just one click.

    Apr 24 Release Notes Video Highlight

    Discover the Next Level of Secure, Role-Based Access Control & Effortless Data Import with our Latest Release!
    This brief video guide showcases cutting-edge security features and the simplicity of importing demo data. Watch now to elevate your experience!

    Public API Improvements

    • User Management

      • Data access restrictions Enhanced role management and access control in the Public API now mirrors Sage Active’s policies, enabling data access restrictions based on user roles and ensuring alignment with application behavior.
        API resources overview / Users & User Management

      • User Access Policy Check
        Introduced the UserAccessPolicyCheck service to validate user permissions for specific actions within the application, enhancing security and user experience by dynamically adjusting UI elements according to roles and access rights.
        API resources overview / User Access Policy Check

      • User Multi tenants
        With the ability now to have organizations on different tenants for a same user, the list of organizations no longer requires passing an X-TenantId in the header, and now exposes the tenantId field for each organization returned.
        Instead, as in previous versions, of passing an X-TenantId in the header of other queries and mutations obtained from the ActiveTenantId value of userProfile, assign the tenantId retrieved from the record of the desired organization in X-TenantId.
        API resources overview / Organizations
        API resources overview / User profile

      • Users The User object now supports multi-tenant capabilities and enhanced user roles, necessitating the inclusion of both X-OrganizationId and X-TenantId in the request header to accurately retrieve user lists according to the current organization.
        API resources overview / Users

    User Management Unleashed: Sage Active Public API's Role-Based Innovation

    Explore the next level of secure, role-based access control with Sage Active's Public API.

    A new era of intuitive application development awaits.

    Import Demo Data

    • Now, the Sample quotes application also allows you to import a complete set of demo data into the current company if it does not yet have any data.
      Launching the Sample Quotes app and logging in allows you to select your desired organization.
      If this organization lacks data (verified by the absence of customers, accounting accounts, fiscal years), the app will automatically offer to import demo data, including accounting plans, products, clients, suppliers, employees, fiscal years, and accounting entries.
      Sample quotes / 6. Import Demo Data

    Import demo data

    Discover how then sample quotes app now seamlessly enables the importation of a comprehensive set of demo data into your current company, should it find the data vaults empty.

    A simple, streamlined process to kickstart your experience with fully populated data!

    Documentation Improvements

    • DataLoaders
      This feature, currently in development, enhances GraphQL queries with DataLoaders to efficiently fetch complex data across different tenants, significantly simplifying data retrieval without direct dependency on main query ids, and will be available soon.
      Key concepts / Benefits of DataLoaders

    • Object Schema and Relationships
      This upcoming feature introduces an advanced schema overview, detailing API object relationships and field mappings, even as we continue to expand the resources available within the schema, offering a comprehensive preview for more informed future integrations.
      API resources overview / Object Schema and Relationships

    • New Postman collection Sage Active Public API V1 (2024 March /April)

      Embrace the future with our March / April Postman collection update!

      We highly recommend transitioning to the latest March / April Postman collection, considering the new multi-tenant management features.
      Download the new Postman collection for March / April 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.

  • 2024 January / February

    Sales documents

    Elevate your API experience with the latest update!
    Featuring advanced tools for Product and Sales Document Management and an intuitive Quotes Management sample.

    Read more ...

    Elevate your API experience with the latest update!
    Featuring advanced tools for Product and Sales Document Management and an intuitive Quotes Management sample.

    Jan 24 Release Notes Video Highlight

    Explore the Sage Active Public API & Sales Management Module in Action!
    This concise video guide highlights the latest Public API features for the Sales module, complemented by a front-end application example.
    Watch now to enhance your Sage Active experience!

    Sample of Quotes Management

    Explore the Must-See Sage Active Public API V1 Quoting Example!

    Dive into the invaluable resource of our front-end app example!
    This example showcases the practical use of Sage Active Public API for efficient quote management.

    It’s a perfect demonstration of how you can leverage the API’s capabilities in real-world scenarios, significantly simplifying the quoting process.

    Now, this application also allows you to import a complete set of demo data into the current company if it does not yet have any data.

    Click here to access the example : Sample quotes

    img

    Public API Improvements

    Documentation Improvements

    • Filtered by Id Instead of ById
      The shift from specific <object>ById queries to more generalized <object> queries with a where clause for ID filtering marks an significative change in the Sage Active Public API V1.
      This new approach streamlines the querying process and aligns with the overall GraphQL philosophy.
      Key concepts / Filtered by Id instead of ById

    • New page compiling all videos
      On this page, you can find all our videos, arranged from the most recent to the oldest.
      Directly access the page where this video is included. Conversely, from pages featuring a video, you can directly reach the videos page.
      Videos

    • Generate a query with an AI prompt
      This assistant will assist you in defining your queries, including filters, by generating a prompt that you can submit to the AI of your choice to generate the GraphQL Hot Chocolate query syntax.
      Generate a query with an AI prompt

    • New Postman collection Sage Active Public API V1 (2024 January /February)

      Embrace the future with our January / February update!

      While the November version remains fully compatible, we highly recommend transitioning to the latest January release.
      It’s packed with all the newly added features for Product Management and Sales Document Management, ensuring you have the most advanced tools at your fingertips.
      Upgrade now to maximize your capabilities and stay ahead in the game!”
      Download the new Postman collection for January / February 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.

  • 2023 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.

  • 2023 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.

  • 2023 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.

  • 2023 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.

  • 2023 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.

  • 2023 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