10 Essential Insights to Kickstart Click to watch the video

Sage Active Public API V2 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

  • 2025 June

    Aggregations, new fields to streamline data updates  

    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.

    Read more ...

    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.

    • Extended Aggregations Syntax


      API resources overview / 📝Aggregations

      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.

    • New Fields or Values


    • New Fields or Values


      • API resources overview / Accounting Entries
        The following changes will be introduced to the sub-resources accountingEntryLines / accountingEntryPayment :
        • matchId – Groups reconciled lines sharing the same matching letter, particularly when duplicates exist for the same third party.
        • accountingEntryPayments can now be queried directly.
          Use the 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.

        • API resources overview / Accounting Entries
          A new sub-resource will be introduced under accountingEntryLines:
          • accountingEntryDimensionTags – Enables linking analytic dimension tags to individual accounting lines.
        • API resources overview / Accounting Accounts
          A new sub-resource will be introduced under accountingAccounts:
          • accountingAccountDimensionTags – Allows configuring default analytic dimensions and tags for each account, which can be used to pre-fill analytic allocations when posting accounting entries.
        • API resources overview / Analytic Dimensions
          a new resource ill be introduced to manage analytic dimension settings:
          • dimensions with dimensionTags – Defines the analytic axes available in the company.
    • ReplaceAll in Update Mutations


      Key concepts / Updating records

      • The requestedAction mechanism and the full patch-style update logic are already available in the current version of the API.
      • Support for the new replaceAll logic is included in the upcoming release.
      • This feature allows full replacement of sub-resource collections by specifying which collections should be replaced using an array of enum values (e.g. ["CONTACTS"], ["PHONES", "EMAILS"]).
      • The 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.
      • It enables use cases such as:
        • Replacing a customer’s entire list of contacts and addresses.
        • Replacing only a specific contact’s phones, emails, or social medias.
        • Replacing all salesInvoiceLines within a sales invoice.
      • This hybrid approach — patch by default, with optional explicit replaceAll per collection — allows both fine-grained updates and full structure replacement, depending on the integrator’s capabilities.

    • Documentation Improvements


      • Improved syntax highlighting for GraphQL queries and JavaScript code examples, making them easier to read and understand.
      • A copy-to-clipboard icon has been added to the top right corner of every code block, allowing users to quickly copy example code with a single click.
      • Quick Links now appear at the top right of each documentation page, offering direct access to the most frequently used API resources.
      • A table of contents is available at the bottom right of each page, enabling quick navigation to different sections. As you scroll, a scroll spy mechanism highlights your current position within the page for better orientation.
        See an example of these improvements here: Sample

      img

    • Other Documentation Improvements


      • New Postman collection Sage Active Public API V2 (2025 June)
        The collection has been enhanced with new examples showcasing the latest operations and newly added fields.

        Embrace the future with our June Postman collection update!

        Download the new Postman collection for June version: Quick start / 5. Test your first query in Postman

        Tips

        • To find out what’s new in the Postman collection, paste this icon in the filter field  🆕
        • To find out what has changed in the Postman collection, paste this icon in the filter field  ✏️
        • To find out all Actions in the Postman collection, paste this icon in the filter field  ⚙️

        img

        Caution

        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.

  • 2025 May

    Extended aggregations, automated account selection, new compliance fields, and Postman updates

    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.

    Read more ...

    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.

    • Extended Aggregations Syntax

      API resources overview / 📝Aggregations

      • The aggregation feature supports specifying aggregation types directly per field.

      • 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
    • Sales Ledger Account Selection Logic Update

      API resources overview / ⚙️Post Sales Invoice

      • The logic for automatically selecting the sales ledger account during invoice posting has been updated.
      • Until now, the account was always based on the product’s salesAccountingAccountId, or if not set, the defaultSaleProductsAccountId from the organization’s setup.
      • With the new logic, the selection dynamically depends on the customer’s country:
        • National customer → Product account or default sales account.
        • Customer from another VIES country → intracommunityAccountId.
        • Customer from a non-VIES country → foreignAccountId.
      • This change enables better alignment with VAT rules and international invoicing requirements, without any required changes on your side.
    • New Fields or Values
      • API resources overview / Organizations
        The following field has been added to the organization object:
        • onboardingDateCompleted – Date when onboarding was completed.
      • API resources overview / Accounting Accounts
        The following fields have been added to the accountingAccount object:
        • datevAccountNumber – DATEV account number used for German bookkeeping.
        • applyVat – Indicates whether VAT is applied based on the nature of the account.
        • transitionalPrepaymentAccountId – UUID of the prepayment account for specific advance payment scenarios in France.
        • transitionalPrepaymentAccount – Linked account used for prepayments in France.
      • Sales Documents
        The following fields have been added to the salesDocuments objects:
        • documentTypeId – Identifier of the document type, used to validate customer or supplier identity.
        • documentType – Dataloader exposing information related to the selected document type.

  • 2025 April

    Aggregations, new accounting fields for compliance, corrective invoice support, and documentation enhancements

    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.

    Read more ...

    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.

    • Aggregations

      API resources overview / 📝Aggregations

      • Aggregations are a powerful feature of the public API, allowing users to compute summary statistics such as totals, averages, and counts directly on the server. This reduces the amount of data transferred to the client, optimizing performance and ensuring efficiency in data analysis.
      • The API enables aggregations through grouping and aggregation functions. By leveraging these capabilities, users can obtain pre-aggregated data in a structured manner, which is particularly useful in financial and accounting applications.
    • Accounting Report Positions

      API resources overview / ⚙️Accounting Report Positions

      • Account Position Retrieval: The API allows retrieving the position of accounts in the balance sheet or profit & loss report, based on predefined balance guides.
      • Legislation-Based Categorization: Account positioning is determined according to local accounting rules, adapting automatically to France, Spain, and Germany.
      • Detailed or Summary View: Users can choose between detailed positions (including subcategories) or a summary view.
      • Account Filtering: The API supports retrieving all accounts or filtering by a specific account ID.
      • Multiple Position Handling: If an account appears in multiple positions, its main position is identified, and details can be included on request.
      • Undefined Accounts: If an account is not found in the balance guide, it is returned as “undefined”.
    • Localized Enum Values
      • API resources overview / ⚙️ Get localized Enum Values
        • Dynamic Localization Support: The API allows retrieving localized labels for enum values based on a given language code, making it easier to display user-friendly dropdowns in multiple languages.
        • Language Parameter Requirement: A language code will be required in either short form (fr, en, es, de) or full form (fr-FR, etc.), ensuring precise localization.
        • Schema-Based Enum Access: Developers will be able to retrieve enum names directly from the GraphQL schema, with values mapped through this service.
        • UI Integration Readiness: This will be especially useful for front-end components such as filters, dropdowns, and localized forms, enabling dynamic and consistent UI behavior.
        • Optional Global Enum List: A complete list of enums and their values could be made available in documentation, depending on developer needs.
    • New Fields or Values
      • API resources overview / Accounting Entries
        The following fields are added to the accountingEntries/accountingEntryLines/accountingEntryInvoice object for Spanish Corrective Invoices:
        • creditNoteReason – Specifies the reason for a credit note.
        • originalAccountingEntryInvoice – References the original invoice linked to a credit note.
        • originalAccountingEntryInvoiceId – Unique identifier of the original accounting entry invoice.
        • originalEntryInvoiceTaxesBaseSum – Sum of tax bases from the original invoice.
        • originalEntryInvoiceTaxesSurchargeAmountSum – Sum of tax surcharges from the original invoice.
        • originalEntryInvoiceTaxesTaxAmountSum – Sum of tax amounts from the original invoice.
      • API resources overview / Employees
        The following fields are added to the employees/addresses object:
        • creationDate – Stores the timestamp of when the employee address was created.
        • modificationDate – Stores the timestamp of the last modification to the employee address.
      • API resources overview / Organizations
        • The following fields are added to the Organization object for the German legislation:
          • datevClientNumber – Stores the DATEV client identification number, used for accounting integration in Germany.
          • datevConsultantNumber – Stores the DATEV consultant identification number, assigned to tax advisors and accounting firms in Germany.
          • taxAuditExportNotes – Allows adding specific notes for tax audit export purposes.
        • Additional fields related to email configuration are also available:
          • emailSubject – The text that appears in the email header and provides an overview of the message content.
          • emailMessage – The text that appears in the email body.
          • sendEmailCopy – Define if a copy email is sent.
      • API resources overview / Sales invoices
        The following field is added to the Sales Invoices object:
        • createdInSoftwareVersion – Links an invoice to the software release version that generated it. This field ensures compliance with anti-fraud regulations by providing traceability of the software version used for invoice creation.
          The following field is added to the Sales Invoice Lines object:
        • AvailableForCreditNoteQuantity – Represents the quantity from this sales invoice line that is still available to be credited via a credit note.
      • API resources overview / Sales Invoice Open Items
        The following field is added to the Sales Invoice Open Items object:
        • IsAdvanceInvoicePayment – Indicates whether the invoice is an Advance Invoice Payment.
      • API resources overview / 📝Sales documents
        All total fields already available at the document header level are now also published at the Document Lines level.
        • For example, in addition to totalNet, the following fields are accessible on a document line: totalLiquid, totalVat, etc.

  • 2025 March

    Partial Credit Notes, new Fields.

    The Public API now supports currencies and taxGroups resources for better data consistency.
    The generateCreditNote operation has been enhanced to support partial credit notes.
    New fields enhance accounting exports, including datevAutomaticAccount and tanNumber for German compliance, isCashVat for France and Germany, vatCriterion for organizations and suppliers, and other fields.

    Read more ...

    The Public API now supports currencies and taxGroups resources for better data consistency.
    The generateCreditNote operation has been enhanced to support partial credit notes.
    New fields enhance accounting exports, including datevAutomaticAccount and tanNumber for German compliance, isCashVat for France and Germany, vatCriterion for organizations and suppliers, and other fields.

    Public API Improvements

    • New Operations
    • Generate Partial Credit Note

      API resources overview / ⚙️Generate Credit Note
      The generatecreditnote function allows users to create credit notes based on existing invoices, either fully or partially, depending on the request parameters.

      • Partial Credit Note: If a lines block is provided in the request, a partial credit note can be generated, specifying the affected products, quantities, and amounts. This enables more granular adjustments by selecting specific items from the original invoice rather than issuing a full credit.
      • The API validates that the credited amounts do not exceed the original invoice values and will handle tax and discount calculations accordingly.
    • New Fields or Values
      • API resources overview / Accounting Accounts
        The datevAutomaticAccount field is added to the accounting export data structure. This field indicates whether an account is automatically managed by DATEV.
        • If true, the account is controlled by DATEV and should not be manually modified.
        • If false, the account can be manually managed.
          This ensures compliance with DATEV standards and improves integration with German accounting processes.

      • The collectiveAccount field is introduced for customer and supplier accounts. This boolean field will indicate whether an account is a collective account (shared by multiple customers or suppliers).

      • API resources overview / Accounting Entries
        • The tanNumber field is introduced for accounting entries in Germany. This decimal field will serve as an automatic counter that increments by 1 for each new accounting entry.
        • The isCashVat field is introduced for accounting entries in France and Germany. This boolean field will indicate whether the transaction is subject to Cash VAT accounting.

      • API resources overview / Journal Types
        For Spanish legislation, and only if the journal type is PURCHASE_INVOICE or SALES_INVOICE, the isCreditNote field allows specifying that the journal is used for credit notes. In this case, the creditNoteReason field is mandatory.

      • API resources overview / Organizations
        API resources overview / Suppliers
        The vatCriterion field is introduced for organizations and suppliers in France and Germany. This boolean field will indicate whether the entity is subject to Cash VAT accounting. When true, VAT is accounted for at the time of payment rather than at the time of invoicing, ensuring compliance with local tax regulations.

      • API resources overview / Customers
        The defaultPrepaymentAccountingAccount field has been added to the API resources overview for Customers, allowing the definition or retrieval of the default prepayment accounting account associated with a customer.

      • API resources overview / Organization Accounting Setup
        The defaultPrepaymentCustomerAccountId field has been added to the API resources overview for Organization Accounting Setup, enabling the configuration or retrieval of the default prepayment customer account at the organization level.

    Documentation Improvements

    • New Filtering Option in History


      • API resources overview / 📝Schemas History
        Added a toggle button to filter the history list, displaying only added fields, queries, enums, and types (excluding Filter, Sort, Edge, Connection, Input, Output and other changes).

      img

  • 2025 February

    Simplified accounting account creation, identification of the creation source, sales document status changes.

    It is now easier to create accounting accounts, either by entering only the code and name or just the code.
    It is now possible to identify the Source Type of third-party creation, accounting entries, and sales and purchase documents, for example, determining that these data were created by the public API.
    Sales document statuses can now be changed.

    Read more ...

    It is now easier to create accounting accounts, either by entering only the code and name or just the code.
    It is now possible to identify the Source Type of third-party creation, accounting entries, and sales and purchase documents, for example, determining that these data were created by the public API.
    Sales document statuses can now be changed.

    Public API Improvements

    • New Operations

      • API resources overview / Accounting Accounts
        It is now possible to create an account easily by simply providing its code and name.
        You can even create an account using only its code. In this case, a generic localized label will be generated based on the legislation, following the format: Automatically created account for code: nnnnnn.

      • API resources overview / 📝 Update Document Status
        It is now possible to change the status of salesQuotes from Pending to Declined or Closed, and the status of salesOrders and salesDeliveryNotes from Pending to Closed.
        The new page summarizes all possible status changes for sales documents.

      • API resources overview / Organization Sales Setup
        The organizationSalesSetupByOrgId operation allows developers to fetch detailed sales setup information for a specific organization.
        This setup includes essential parameters for effectively managing sales, purchase invoices, inventory, and discount configurations.

      • API resources overview / Operational Number Preset Texts
        Represents the Operational Number Preset Texts in the API context, used for defining numbering prefixes for different types of sales documents.
        These presets provide flexibility in customizing document numbering and include key parameters to tailor prefixes based on document types such as Quotes, Orders, Delivery Notes, or Invoices.

      • API resources overview
        German Legislation only: Represents the sessions management used to add identifiable information to your journal entries.
        It provides key information such as default status, name, stamp, and whether it has been deactivated.

  • 2025 January

    New Fields & Quantities with decimals and unit of measurement management for Sales Documents

    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.

    Read more ...

    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.

    Public API Improvements

    • New Fields or Values

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

      • API resources overview / Organization Accounting Setup
        The following are added to the object type OrganizationAccountingSetupGLDto:
        • defaultBankAccountId, defaultBankJournalTypeId, defaultCashAccountId
        • defaultCashJournalTypeId, defaultInputVATAccountId, defaultOutputVATAccountId
        • defaultPurchaseProductsAccountId, defaultSaleProductsAccountId, defaultProfitAccountCFId
        • defaultLossAccountCFId, defaultOpeningAccountCFId, defaultOpeningJournalCFId
        • intracommunityAccountId, foreignAccountId, openItemsAutomaticAllocation
      • API resources overview / Sales invoices
        After posting a sales invoice, the payment terms become permanently recorded in the invoice through the newly added paymentTermLines.
    • Quantities with decimals and unit of measurement management

      • 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

      • The following new fields are added to the object type ProductGLDto:
        • The field unitOfMeasurement of type Unit of Measurement allows retrieval of detailed information about the associated unit of measurement, including attributes like abbreviation, decimals, and category.
        • The field unitOfMeasurementId of type UUID is used to link the product or item to a specific unit of measurement.
          In the interface, these fields ensure accurate representation of quantities and their associated units, supporting more precise inventory and transaction management.
          API resources overview / Products

        These fields are also added in the lines of:

      • The Sample Quotes app has been updated to account for quantities with decimals and units of measurement:
        • During the import of products, some products are assigned a specific unit of measurement and a defined number of decimals.
        • When selecting a product in the sample quote entry form, the unit of measurement and the number of decimals are displayed in the Description section. The Quantity field is then adjusted to reflect the appropriate number of decimals accordingly.
        • Sample quotes / 2. Test the app Online

  • 2024 December

    New Fields

    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.

    Read more ...

    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.

    Public API Improvements

    • New Fields or Values

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

    • Other Improvements
      • Import of External Invoices with Original Number
        It is now possible to set the invoice number using the operationalNumber field during invoice creation.
        This enhancement allows users to import an invoice already issued by another software while keeping its original number.
        • If operationalNumber is provided with a non-empty value, the invoice is automatically set to Closed status.
        • If operationalNumber is not specified or left empty, the invoice is created without a number and remains in Draft status.

        API resources overview / Sales invoices

      • Get Localized Error Message
        The GetLocalizedErrorMessage service retrieves a localized error message based on a given error code and optional language parameter, providing enhanced user experience with clear and specific error information.
        API resources overview / ⚙️Get Localized Error Message

    Documentation Improvements

    • New pages and new Dark Mode


      • 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

        You can now enable Dark Mode for a more comfortable reading experience in low-light environments. Activate it from the top content by clicking on the Dark/Light button, which allows you to switch seamlessly between light and dark modes.
        img

  • 2024 November

    New Schema Diagram and Schemas history

    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.

    Public API Improvements

    • Changes to Input Fields and Enums

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

    Documentation Improvements

    • GraphQL schema now available

      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

        GraphQL Voyager is a tool that provides an interactive visualization of a GraphQL schema.
        It generates a visual graph that allows developers and stakeholders to explore the schema’s structure, relationships, and data flow.
        It automatically maps out all the types, queries, mutations, and connections between entities, helping users understand the API’s capabilities and navigate complex schemas easily.
        API resources overview / 📝Schema Diagram with Relationships
        img

    • Other Documentation Improvements
      • New Page for Identifying Key API Errors
        The error management system in the public API provides detailed feedback on various issues encountered during requests.
        Errors are categorized into business logic errors, validation errors, and authorization-related errors.
        These error codes and messages align with the Sage Active interface, helping developers quickly identify and resolve issues.
        API resources overview / 📝API Error Management

  • 2024 October

    Purchase Invoices Workflow

    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.

    Public API Improvements

    New Fields or Values

    Documentation Improvements

    • 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

      We’ve introduced a new filtering system for the resource list, allowing users to filter items by title or tags.
      When a filter is applied, only items that match the search criteria will be displayed, improving navigation and access to relevant content.
      API resources overview
      img

  • 2024 September

    Sales Invoices Workflow

    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.

    Public API Improvements

    • 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

    New Fields or Values

    • API resources overview / Sales quotes New 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.
    • API resources overview / Sales invoices New field firstDueDate indicates the first payment due date of the invoice.
      New statuses PartiallyCollected, Collected, provide information on the payment status of the invoice.
    • API resources overview / Accounting Entries
      • sourceEntityId: ID that can refer to a sales invoice, purchase invoice, collected payment, or issued payment; may be null.
        When provided, it identifies the source entity in conjunction with 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.

    Documentation Improvements

    • New Page: Some Filter vs. Direct Line Filtering
      This page explains the two primary methods for querying documents such as Sales Quotes, Sales Orders, Sales Delivery Notes, and Sales Invoices in GraphQL: using a ‘some’ filter within the document query and querying document lines directly with a filter. Each approach has distinct use cases and outcomes.
      API resources overview / 📝some Filter vs. Direct Line Filtering

  • 2024 July

    Generate Credit Note, Document Pdf Email

    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.

    Public API Improvements

    Documentation Improvements

    • Icon
      Add the icon in front of the API objects that correspond to business actions directly managed by Sage Active.