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.
New fields have been introduced in various entities.
Management of quantities with decimals and units of measurement has been improved for Sales Documents, providing more precise control over product attributes.
The online Sample Quotes app has been updated to reflect this new feature.
New fields have been introduced in various entities.
Management of quantities with decimals and units of measurement has been improved for Sales Documents, providing more precise control over product attributes.
The online Sample Quotes app has been updated to reflect this new feature.
API resources overview / Sales invoices
The input field operationDate of type DateTime is added to the input object type SalesInvoiceCreateGLDtoInput.
The input field operationDate of type DateTime is also added to the input object type SalesInvoiceUpdateGLDtoInput.
In the interface, operationDate corresponds to the field fulfillmentDate. The fulfillmentDate represents the date when the delivery of goods or services associated with the invoice is completed.
It is possible to specify an operationDate when it differs from the invoice date, allowing more flexibility in tracking the actual operation date separately from the invoicing date.
OrganizationAccountingSetupGLDto:
defaultBankAccountId, defaultBankJournalTypeId, defaultCashAccountIddefaultCashJournalTypeId, defaultInputVATAccountId, defaultOutputVATAccountIddefaultPurchaseProductsAccountId, defaultSaleProductsAccountId, defaultProfitAccountCFIddefaultLossAccountCFId, defaultOpeningAccountCFId, defaultOpeningJournalCFIdintracommunityAccountId, foreignAccountId, openItemsAutomaticAllocationpaymentTermLines.Unit of Measurement Consultation
The Unit of Measurement Consultation service provides access to view existing units of measurement and their attributes, such as abbreviation, number of decimals, and category. It enables detailed examination of how quantities with decimals are represented for various product categories.
API resources overview / Unit of Measurements
API resources overview / Unit of measurement Sales Setup
ProductGLDto:
unitOfMeasurement of type Unit of Measurement allows retrieval of detailed information about the associated unit of measurement, including attributes like abbreviation, decimals, and category.unitOfMeasurementId of type UUID is used to link the product or item to a specific unit of measurement.These fields are also added in the lines of:
organizationSalesSetupByOrgId operation allows developers to fetch detailed sales setup information for a specific organization.salesQuotes, salesOrders, and salesDeliveryNotes.Discover DATA LOADER Query Samples section.
Download the new Postman collection for January version: Quick start / 5. Test your first query in Postman
Tips
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.
New fields have been introduced in various entities.
Explanations regarding the next version include improved management of quantities with decimals and units of measurement, providing more precise control over product attributes.
New fields have been introduced in various entities.
Explanations regarding the next version include improved management of quantities with decimals and units of measurement, providing more precise control over product attributes.
API resources overview / Suppliers
The new field defaultPurchaseAccount is added to the Supplier object type.
The new field defaultPurchaseAccountId is also added to the Supplier object type.
API resources overview / Accounting Entries
The new field documentDate is added to the AccountingEntry object type.
API resources overview / Purchase invoices
To simplify the creation of purchase invoices, the new input field vatPercentage of type Decimal is added to the input object type PurchaseInvoiceLineCreateGLDtoInput and the input field taxGroupId is removed.
API resources overview / ⚙️Post Purchase Invoice
To improve accounting of purchase invoices, the new input field postingDate of type DateTime is added to the input object type PostPurchaseInvoiceGLDtoInput.
API resources overview / 📝Sales documents
For all types of sales documents, the field length of productName in document lines has been increased from 100 to 2500 characters, allowing the creation of documents where the product line’s name can now match the value of the lineDescription field, which permits up to 2500 characters.
Closed status.Draft status.New Page for Organization Accounting Setup
The Organization Accounting Setup operation now has its own dedicated page within the Accounting section of the documentation.
API resources overview / Organization Accounting Setup
Introducing Dark Mode
New GraphQL schema diagram using GraphQL Voyager. Added a new page detailing the schema history, highlighting version differences and breaking changes.
Read more ...New GraphQL schema diagram using GraphQL Voyager. Added a new page detailing the schema history, highlighting version differences and breaking changes.
API resources overview / Purchase invoices
The input field lines has been removed from the input object type PurchaseInvoiceCreateGLDtoInput.
The input field vatLines of type [PurchaseInvoiceLineCreateGLDtoInput!]! has been added to the input object type PurchaseInvoiceCreateGLDtoInput.
API resources overview / Organizations
New enum values DATEV_SKR03 and DATEV_SKR04 have been added to the enum BalanceCategory.
GraphQL schema is now available, including the latest version diagram and historical schema documentation.
This update features detailed comparisons between versions, emphasizing breaking changes.
GraphQL Schema History: Access to the Schema and Version Changes
A new page now allows you to download the GraphQL schema for the current production version, as well as a preview schema for the upcoming release and schemas from previous versions.
This page also displays automatically detected differences between schema versions using GraphQL Inspector diff.
In addition to the API resources overview / 📝Breaking changes page, this new feature provides precise details about changes between versions, helping you stay up-to-date with schema modifications.
API resources overview / 📝Schemas History
New Schema Diagram by GraphQL Voyager
New objects to manage a workflow include creating a Purchase invoice, locking it for edits, posting to account for entries, tracking payment due dates, processing payments.
Read more ...New objects to manage a workflow include creating a Purchase invoice, locking it for edits, posting to account for entries, tracking payment due dates, processing payments.
Purchase Invoice
Allowing you to manage and record purchase invoices within the system.
API resources overview / Purchase invoices
Post Purchase Invoice
Enabling you to post purchase invoices to generate corresponding ledger entries.
API resources overview / ⚙️Post Purchase Invoice
Purchase Invoice Open Item
Providing details on open items associated with purchase invoices.
API resources overview / Purchase Invoice Open Items
Purchase Open Item Settlement
Allowing for the settlement of open items on purchase invoices.
API resources overview / ⚙️Purchase Open Items Settlement
onboardingCompleted has been added to organizations.true once the onboarding process of this organization has been completed.
false it assigns an empty GUID to organizationId and TenantId to prevent API use.
Code can be retrieved in addition to the ID,Number of the entry can be retrieved in addition to the ID,OperationalNumber can be retrieved in addition to the ID.accountingEntryId and accountingEntryNumber can be retrieved.Existing Fields Missing from Documentation in AccountingEntries
New fields that existed but were previously undocumented have now been officially added to the Accounting Entries resource:
creationDate, modificationDate, documentNumber, accountingExercise, accountingExerciseId,
accountingPeriod, accountingPeriodId.
New Feature: Enhanced Filter for Resources
New objects to manage a workflow include creating an invoice, locking it for edits, posting to account for entries, tracking payment due dates, processing payments, and potentially issuing a credit note.
Read more ...New objects to manage a workflow include creating an invoice, locking it for edits, posting to account for entries, tracking payment due dates, processing payments, and potentially issuing a credit note.
Close the Invoice to Prevent Further Modifications
Lock the invoice against further changes using the CloseSalesInvoice service, securing its details before posting.
API resources overview / ⚙️Close Sales Invoice
Post the Invoice to Generate Accounting Entries
After closing, post the invoice with the PostSalesInvoice service to generate necessary accounting entries.
API resources overview / ⚙️Post Sales Invoice
View the Invoice’s Payment Due Dates
Check payment due dates and manage outstanding amounts with the SalesInvoiceOpenItems service.
API resources overview / Sales Invoice Open Items
Read Payment Methods
Represents various bank accounts and cash methods, each method is linked to a Journal Type and a bank account. Payment methods are notably utilized by the Open Items Settlement action.
API resources overview / Payment methods
Apply Partial or Full Payments to the Invoice
Manage invoice payments using the SalesOpenItemSettlement service, for both partial and full payments.
API resources overview / ⚙️Sales Open Items Settlement
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
Declined value for the status field to indicate that a quote was not won, the declinedReason field has also been added and can contain the reason why the quote was declined.firstDueDate indicates the first payment due date of the invoice.PartiallyCollected, Collected, provide information on the payment status of the invoice.sourceEntityId: ID that can refer to a sales invoice, purchase invoice, collected payment, or issued payment; may be null.sourceType=SALES.sourceType: Identifies the origin of the entry, such as sales, purchases, payments, or imports, clarifying the source and purpose of each entry.salesInvoice object relate directly to sales invoices when sourceType contains SALES.sessionId and session: used only for DE legislation, not used for FR and ES. These fields add identifiable information to accounting entries and facilitate retrieving session data, such as the identifier, name, name and timestamp, and the activation status of the session.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
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
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 / 📝Schema Diagram with 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
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!
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
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.
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:
FR, Spain ES, and Germany DEFR, Spain ES, and Germany DE