In a few minutes, test your first request with the API.
Here you find the description of all the resources available for the API.
Simplify your learning thanks to the various tutorials available to you. Discover the sample quote management app too.
Find, grouped in this section, frequently needed information.
Have the right reflex, consult the answers to the main questions referenced by theme.
Directly create a credit note for an invoice, send documents in PDF format via email directly from the API.
Read more ...Directly create a credit note for an invoice, send documents in PDF format via email directly from the API.
Generate Credit Note
This feature allowing you to create a credit note for a sales invoice.
API resources overview / ⚙️Generate Credit Note
Also, addition in the Sales Invoice fields to identify credit notes and their link to the original invoice.
API resources overview / Sales invoices
Document Pdf Email
This feature allows you to send sales documents in PDF format via email directly from the API.
API resources overview / ⚙️Document Pdf Email
Sales Invoices Open Items
This feature will be available soon, allowing you to detail each open item associated with a customer sales invoice.
API resources overview / Sales Invoice Open Items
New Postman collection Sage Active Public API V2 (2024 July)
Download the new Postman collection for July version: Quick start / 5. Test your first query in Postman
Tip: To find out what’s new in the Postman collection, paste this icon in the filter field 🆕
If you are new to the Sage Active Public API V2, it is strongly recommended to fully follow the Quick start guide before beginning to explore the collection.
Directly retrieve the trial balance or third-party balance, direct access to the MarketPlace from Sage Active,
Access to Sage Active production, documentation of soon-to-be-available features.
Directly retrieve the trial balance or third-party balance, direct access to the MarketPlace from Sage Active,
Access to Sage Active production, documentation of soon-to-be-available features.
Trial Balance, Third Party Balance
These features allow you to retrieve an account balance and a third-party balance.
API resources overview / ⚙️Trial Balance
API resources overview / ⚙️Third Party Balance
Delete Employee
It is now possible to delete an employee
API resources overview / Employees
MarketPlace Link
Adding a link to the Marketplace from Sage Active
Key concepts / MarketPlace
Access to Sage Active Production
Since June 10, the old Sage Active stage environment has been replaced with direct access to Your Sage Active.
You will be able to test the API more easily, develop your applications, and make them operational for Sage Active users.
The documentation has been updated to reflect this change:
Key concepts / Environments
Generate Credit Note
This feature will be available soon, allowing you to create a credit note for a sales invoice . Here is a preview of their documentation.
API resources overview / ⚙️Generate Credit Note
Also, upcoming features in the Sales Invoice fields to identify credit notes and their link to the original invoice.
API resources overview / Sales invoices
Document Pdf Email
This feature will be available soon, service allows you to send sales documents in PDF format via email directly from the API.
API resources overview / ⚙️Document Pdf Email
New Postman collection Sage Active Public API V2 (2024 June)
Download the new Postman collection for June version: Quick start / 5. Test your first query in Postman
If you are new to the Sage Active Public API V2, it is strongly recommended to fully follow the Quick start guide before beginning to explore the collection.
Data Loaders for optimized query performance, automatic tax register creation.
Open Items for payment due dates.
Data Loaders for optimized query performance, automatic tax register creation.
Open Items for payment due dates.
Explore May's Release: Enhanced Data Loaders & Efficient Payment Tracking!
Watch this brief video to discover how our latest API updates can streamline your data operations and improve payment tracking. Get ready to enhance your integration experience!
Data Loaders
Data Loaders are now implemented to optimize query performance by batching and caching requests.
This reduces the number of database hits required for complex queries that involve fetching related data, such as user profiles or transaction details.
Data Loaders ensure that data loading is handled efficiently, preventing redundant database queries and speeding up the API’s response times.
API resources overview / Benefits of DataLoaders
Automatic Creation of Tax Registers for createAccountingEntryUsingCodes & createAccountingEntryUsingIds
The Public API now automatically creates tax registers for purchase and sales invoices, ensuring compliance without manual intervention.
This automation only occurs if specific prerequisites are met; otherwise, the entry is processed without creating tax registers to prevent transaction rejections due to non-compliance.
API resources overview / Create by using codes
API resources overview / Create by using Ids
Open Items
The Open Items functionality has been improved to provide detailed information about each open item associated with customer or supplier invoices.
Open Items now include details such as the total amount, accumulated amount paid, and payment due date.
Open Items are structured as an array to accommodate multiple payment installments per invoice, offering a comprehensive view of payment statuses and methods used for settling each item.
API resources overview / Accounting Entries
Breaking Changes
The latest updates involve significant changes that might affect existing implementations.
We strongly recommend reviewing the detailed descriptions of these changes on the Breaking Changes page to understand their impact and adjust your applications accordingly.
API resources overview / Breaking changes
DataLoaders
This feature, now available, enhances GraphQL queries with DataLoaders to efficiently fetch complex data across different tenants, significantly simplifying data retrieval without direct dependency on main query IDs.
Key concepts / Benefits of DataLoaders
Object Schema and Relationships
This 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
Trial Balance, Third Party Balance
These features will be available soon, allowing you to retrieve an account balance and a third-party balance. Here is a preview of their documentation.
API resources overview / ⚙️Trial Balance
API resources overview / ⚙️Third Party Balance
New Postman collection Sage Active Public API V2 (2024 May)
Discover the new section dedicated to business query examples now possible thanks to Data Loaders.
We highly recommend transitioning to the latest May Postman collection, considering the new Data Loaders features.
Download the new Postman collection for May version: Quick start / 5. Test your first query in Postman
If you are new to the Sage Active Public API V2, it is strongly recommended to fully follow the Quick start guide before beginning to explore the collection.
User Management, explore the next level of secure, role-based access control for users.
Import Demo Data with just one click.
User Management, explore the next level of secure, role-based access control for users.
Import Demo Data with just one click.
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!
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
Explore the next level of secure, role-based access control with Sage Active's Public API.
A new era of intuitive application development awaits.
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!
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 V2 (2024 March /April)
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
If you are new to the Sage Active Public API V2, it is strongly recommended to fully follow the Quick start guide before beginning to explore the collection.
Elevate your API experience with the latest update!
Featuring advanced tools for Product and Sales Document Management and an intuitive Quotes Management sample.
Elevate your API experience with the latest update!
Featuring advanced tools for Product and Sales Document Management and an intuitive Quotes Management sample.
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!
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
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 V2.
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 V2 (2024 January /February)
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
If you are new to the Sage Active Public API V2, it is strongly recommended to fully follow the Quick start guide before beginning to explore the collection.
Some improvements in the documentation.
Also, don’t forget that the API has been in production since the September version.
Some improvements in the documentation.
Also, don’t forget that the API has been in production since the September version.
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
If you are new to the Sage Active Public API V2, it is strongly recommended to fully follow the Quick start guide before beginning to explore the collection.
Some improvements in the documentation, minor corrections.
Also, don’t forget that the API has been in production since the September version.
Some improvements in the documentation, minor corrections.
Also, don’t forget that the API has been in production since the September version.
Addition of chapters to the “API Overview” menu:
API resources overview / Common to All Organizations
API resources overview / Specific to an organization
API resources overview / Accounting
API resources overview / Third parties
New page explaining the purpose of the DTO names present in the description of each resource:
New Postman collection Sage Active Public API V2 (10 October)
You can continue to use the September version as it remains compatible.
However, you can opt to switch to the October version, which contains only minor updates.
Download the new Postman collection for October version: Quick start / 5. Test your first query in Postman
If you are new to the Sage Active Public API V2, it is strongly recommended to fully follow the Quick start guide before beginning to explore the collection.
FR, Spain ES, and Germany DEFR, Spain ES, and Germany DENew Postman collection Sage Active Public API V2 (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
If you are new to the Sage Active Public API V2, it is strongly recommended to fully follow the Quick start guide before beginning to explore the collection.