ListCatalog

Description

The listCatalog operation exposes a ready-to-use catalog of business list definitions available in Sage Active.

It is designed to simplify how lists are discovered, configured, and executed by providing a predefined set of business-driven list capabilities, including:

• available lists
• allowed business filters
• allowed sorting rules
• associated query models
• date range support for list execution

This approach allows clients to retrieve consistent and meaningful lists without building custom GraphQL queries or understanding the underlying schema.

Each list definition represents a stable business contract, aligned with Sage Active domains such as:

• Accounting
• Sales
• Purchases
• Master data (Customers, Suppliers, Products)

Functionality

• Discover available business lists
• Identify supported filters for each list
• Identify allowed sorting rules
• Understand which business domains are covered
• Determine whether a list supports date range filtering
• Drive generic list screens and exports
• Secure list execution by design

Input Parameters

• contextContains
  Optional filter allowing to return only lists whose context contains the provided value.

Response

The service returns the catalog entries in the definitions field.
Each definition describes exactly how a list can be executed.

Header

query {
  listCatalog(contextContains: "Invoice") {
    definitions {
      entityKey
      context
      filters
      orderBy
      supportsDateRange
    }
  }
}

{
  "data": {
    "listCatalog": {
      "definitions": [
        {
          "entityKey": "salesInvoices",
          "context": "Sales Invoices",
          "filters": [
            "All invoices",
            "Validated invoices",
            "Draft",
            "Unpaid - upcoming",
            "Unpaid - overdue",
            "Partially paid - upcoming",
            "Partially paid - overdue",
            "Paid",
            "Credit notes",
            "Payment in advance",
            "National invoices",
            "Foreign invoices",
            "Search by customer id"
          ],
          "orderBy": [
            "Invoice date desc",
            "Invoice number"
          ],
          "supportsDateRange": true
        },
        {
          "entityKey": "salesInvoiceLines",
          "context": "Sales Invoice Lines",
          "filters": [
            "All invoice lines",
            "Validated invoices",
            "Credit note lines",
            "Standard invoice lines",
            "National invoice lines",
            "Foreign invoice lines",
            "Search by customer id",
            "Search by product id"
          ],
          "orderBy": [
            "Invoice date desc",
            "Invoice number",
            "Product",
            "Quantity desc"
          ],
          "supportsDateRange": true
        }
      ]
    }
  }
}

listCatalog Input parameters

listCatalog Response

Definition fields