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.
This release adds unreconcileBankMovement so you can undo reconciliation for a bank movement using bankTransactionId only.
It also introduces Public API fields for simplified invoices in Spain (organization defaults, customer flags, and per-invoice PDF options).
This release adds unreconcileBankMovement so you can undo reconciliation for a bank movement using bankTransactionId only.
It also introduces Public API fields for simplified invoices in Spain (organization defaults, customer flags, and per-invoice PDF options).
unreconcileBankMovement to undo reconciliation for a movement (bankTransactionId only).New fields will support simplified invoices for the Spanish market (non-identified customers): organization-level defaults, customer-level defaults for new invoices, and per-invoice PDF options.
true, the customer name is printed on the simplified invoice PDF for this document (can be pre-filled from the customer default).true, simplified invoices are used for individual customers by default.BOTH, RECEIVED, or ISSUED).Download the new Postman collection for May 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.
This release focuses on clearer bank reconciliation documentation and a new Sales Invoices field to manage operational number presets.
It also announces upcoming support for simplified invoices in Spain with organization, customer, and document-level options.
This release focuses on clearer bank reconciliation documentation and a new Sales Invoices field to manage operational number presets.
It also announces upcoming support for simplified invoices in Spain with organization, customer, and document-level options.
Sales Documents The following field will be added:
The Banks documentation has been restructured: shared description blocks (overview and detail pages use the same text) so connected accounts, imported movements, reconciliation, and rules are easier to follow end to end. Use these entry points:
reconcileBankMovement to tie movements to accounting entries.bankingRuleId on movements.This release introduces new APIs to explore and query resources, enhanced aggregation capabilities, and new accounting and reporting endpoints.
It also includes improvements to customer and supplier contacts management, along with new configuration services.
This release introduces new APIs to explore and query resources, enhanced aggregation capabilities, and new accounting and reporting endpoints.
It also includes improvements to customer and supplier contacts management, along with new configuration services.
The Accounting KPIs service exposes a set of accounting indicators (Key Performance Indicators) that can be retrieved for a given organization.
API resources overview / Accounting Kpis
Each KPI corresponds to a standardized calculation on accounting balances, adapted per legislation (FR, ES, or DE).
The Sales KPIs service provides a set of commercial indicators (Key Performance Indicators) that can be retrieved for a given organization.
API resources overview / Sales Kpis
Each KPI corresponds to a standardized calculation based on the organization’s sales and related data.
The February release introduces online payments for sales invoices, email templates for automated document communication, and a sales document transformation flow. It also adds new API fields to improve payment mean management and document email behavior.
Read more ...The February release introduces online payments for sales invoices, email templates for automated document communication, and a sales document transformation flow. It also adds new API fields to improve payment mean management and document email behavior.
API resources overview / 📝Invoice with Online Payment
Online payment capability will be introduced for Sales Invoices.
It will be possible to:
PAYMENT_IN to activate online payment.This enables:
The origin document must be in Pending status in order to be referenced by another document.
The January release simplifies the API by removing tenant-based logic, introduces new services such as ThirdPartyIdentification and File Management, and adds the Bank Account resource along with new fields across multiple entities.
Read more ...The January release simplifies the API by removing tenant-based logic, introduces new services such as ThirdPartyIdentification and File Management, and adds the Bank Account resource along with new fields across multiple entities.
A dedicated File Management section has been introduced as part of the federated schema.
API resources overview / 📝Files Management
Upload scalar type.files query.downloadPath, previewPath) for secure file download or in-browser preview.
The December release introduces a major functional milestone with the release of Advanced Invoices and the integration of the new Ask AI assistant into the documentation.
It extends the Public API with improved interoperability between sales documents, the introduction of advance payment management, and the upcoming integration of File Management and KPI services.
The December release introduces a major functional milestone with the release of Advanced Invoices and the integration of the new Ask AI assistant into the documentation.
It extends the Public API with improved interoperability between sales documents, the introduction of advance payment management, and the upcoming integration of File Management and KPI services.
The Advanced Invoices feature provides full support for creating advance invoices and applying advance payment deductions when generating final invoices. API resources overview / 📝Advance Invoice
ACOMPTE in France) to represent advance payment lines.
The November / October release focuses on consolidating the latest evolutions of the Public API and extending its functional coverage.
It brings enhanced interoperability between sales documents, improved file management integration, and additional fields now available in production.
These improvements strengthen the foundation for future releases while maintaining backward compatibility and performance.
The November / October release focuses on consolidating the latest evolutions of the Public API and extending its functional coverage.
It brings enhanced interoperability between sales documents, improved file management integration, and additional fields now available in production.
These improvements strengthen the foundation for future releases while maintaining backward compatibility and performance.
Related sales documents, known as RelatedSalesDocument in the API context and Related documents in the product interface.
API resources overview / Related sales documents
This resource is used to represent relationships between sales documents (for example, when a quote is converted into an order or an invoice).
It stores both the link (originId) and the type of the origin document (originDocumentType), enabling you to navigate between related sales flows.
The LinkRelatedSalesDocument service allows you to establish a relationship between two existing sales documents, when the transformation is allowed.
API resources overview / ⚙️ Link related sales documents
As soon as a sales document is created, an entry is automatically added in RelatedSalesDocument for it.
This action updates the related record by setting the originId with the identifier of the origin document.
The October release does not introduce new features yet available in production.
Instead, it focuses on upcoming capabilities that are currently in progress and will soon be part of the public API.
The October release does not introduce new features yet available in production.
Instead, it focuses on upcoming capabilities that are currently in progress and will soon be part of the public API.
A dedicated File Management section will be introduced as part of the federated schema.
API resources overview / 📝Files Management
Upload scalar type.files query.downloadPath, previewPath) for secure file download or in-browser preview.
The Accounting KPIs service exposes a set of accounting indicators (Key Performance Indicators) that can be retrieved for a given organization.
API resources overview / Accounting Kpis
Each KPI corresponds to a standardized calculation on accounting balances, adapted per legislation (FR, ES, or DE).
The Sales KPIs service provides a set of commercial indicators (Key Performance Indicators) that can be retrieved for a given organization.
API resources overview / Sales Kpis
Each KPI corresponds to a standardized calculation based on the organization’s sales and related data.
Related sales documents, known as RelatedSalesDocument in the API context and Related documents in the product interface.
API resources overview / Related sales documents
This resource is used to represent relationships between sales documents (for example, when a quote is converted into an order or an invoice).
It stores both the link (originId) and the type of the origin document (originDocumentType), enabling you to navigate between related sales flows.
The LinkRelatedSalesDocument service allows you to establish a relationship between two existing sales documents, when the transformation is allowed.
API resources overview / ⚙️ Link related sales documents
As soon as a sales document is created, an entry is automatically added in RelatedSalesDocument for it.
This action updates the related record by setting the originId with the identifier of the origin document.
API resources overview / Organization Accounting Setup The following field will be added:
Download the new Postman collection for September/October 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.
The September release introduces analytic dimensions, delivers major runtime and federation upgrades with HotChocolate 15, and continues the rollout of the replaceAll logic for precise control over sub-resource updates.
It also includes several new fields across core entities, further strengthening consistency of the public schema.
The September release introduces analytic dimensions, delivers major runtime and federation upgrades with HotChocolate 15, and continues the rollout of the replaceAll logic for precise control over sub-resource updates.
It also includes several new fields across core entities, further strengthening consistency of the public schema.
accountingEntries/accountingEntryLines/accountingEntryInvoice/accountingEntryTaxes:
Key concepts / Updating records
requestedAction mechanism and the full patch-style update logic are already available in the current version of the API.replaceAll logic is included in the upcoming release.["CONTACTS"], ["PHONES", "EMAILS"]).replaceAll directive is declared at the same level as the entity being updated (e.g. on a customer or a contact) and applies to its child collections.The new version of the API adopts HotChocolate 15, replacing the previous HotChocolate 13 runtime.
This technical upgrade is a key enabler for integration with the GraphQL federation gateway, powered by HotChocolate Fusion.
It allows multiple distinct APIs to be exposed through a single unified schema, providing a seamless experience for clients consuming resources from different domains.
One immediate benefit is the ability to introduce new specialized APIs, such as File Management, without changing existing entry points.
These APIs can be independently deployed and scaled, while remaining fully integrated at schema level.
The migration to HotChocolate 15 also improves compatibility with modern tooling, enforces stronger schema consistency, and simplifies the introduction of advanced features like directive-based caching, custom scalar enhancements, and better schema stitching options.
No changes are required in client queries for now. However, integrators should monitor announcements as new federated modules become available.
The July release focuses on schema consistency and prepares the ground for upcoming improvements in update operations.
It includes new support for analytic dimensions, significant clean-up of obsolete schema elements, and continued rollout of the replaceAll logic for precise control over sub-resource updates.
The July release focuses on schema consistency and prepares the ground for upcoming improvements in update operations.
It includes new support for analytic dimensions, significant clean-up of obsolete schema elements, and continued rollout of the replaceAll logic for precise control over sub-resource updates.
accountingEntryLines / accountingEntryPayment :
accountingEntryLines dataloader to navigate back to the parent entry.Analytic dimensions and tags are now supported throughout accounting entries and account setup.
These new features allow you to allocate amounts across analytic axes (e.g. Warehouse, Department) at line level, and define default allocation rules at account level.
accountingEntryLines:
accountingAccounts:
The June release adds support for new aggregation types, such as __count and DISTINCTCOUNT, and prepares upcoming changes with the introduction of the replaceAll logic for updates.
It also includes new fields for suppliers, customers, and sales documents, supporting improved data handling and integration flexibility.
The June release adds support for new aggregation types, such as __count and DISTINCTCOUNT, and prepares upcoming changes with the introduction of the replaceAll logic for updates.
It also includes new fields for suppliers, customers, and sales documents, supporting improved data handling and integration flexibility.
API resources overview / 📝Aggregations (historical approach)
Two new aggregation types are added: __count and DISTINCTCOUNT.
__count counts records in each group, regardless of field:
aggregateFields: ["__count"]
DISTINCTCOUNT counts distinct values of a field in each group:
aggregateFields: ["customerId|DISTINCTCOUNT"]
For example, to get the number of unique customers per product sold through sales invoices.
The May release introduces support for extended aggregations, enabling developers to apply aggregation types such as AVG, MIN, and MAX directly to each field.
It also brings updates across accounting, invoicing, and organizational data to support local compliance, including VAT account logic by customer origin, DATEV fields for Germany, and corrective invoice handling for Spain.
The May release introduces support for extended aggregations, enabling developers to apply aggregation types such as AVG, MIN, and MAX directly to each field.
It also brings updates across accounting, invoicing, and organizational data to support local compliance, including VAT account logic by customer origin, DATEV fields for Germany, and corrective invoice handling for Spain.
API resources overview / 📝Aggregations (historical approach)
To use a specific aggregation, you can append a | followed by the aggregation keyword to the field name:
aggregateFields: ["creditAmount|AVG", "debitAmount|MAX"]
Supported aggregation types:
| Aggregation Type | Keyword | Description |
|---|---|---|
| Sum | SUM |
Default if no keyword is specified |
| Average | AVG |
Returns the arithmetic mean |
| Minimum | MIN |
Returns the smallest value |
| Maximum | MAX |
Returns the largest value |
API resources overview / ⚙️Post Sales Invoice
The April release introduces support for aggregations, allowing server-side computation of totals and summaries.
A new accounting report positions endpoint provides account classifications per local legislation.
New fields improve compliance and traceability, including DATEV identifiers for Germany, corrective invoice support for Spain, and software version tracking for invoices.
The April release introduces support for aggregations, allowing server-side computation of totals and summaries.
A new accounting report positions endpoint provides account classifications per local legislation.
New fields improve compliance and traceability, including DATEV identifiers for Germany, corrective invoice support for Spain, and software version tracking for invoices.
API resources overview / 📝Aggregations (historical approach)
API resources overview / ⚙️Accounting Report Positions
fr, en, es, de) or full form (fr-FR, etc.), ensuring precise localization.