SalesKpis | Sage Active Developer

Quick Links

Accounts Accounting Entries Products Customers Sales quotes Sales invoices Suppliers Purchase invoices

COMING SOON This feature is currently in development and will be available in the next version. It’s already documented to keep you informed about its upcoming availability

This feature is currently under development and, although not available in the current version, its preliminary documentation is provided to give you a preview of the enhancements that will be included in an upcoming update.

HTTP	Operation	Type	Object	DTO Why-DTOs?
POST	Read	⚙️ ActionThe action resource represents a type of object that differs from standard queries or mutations. For a query, it returns a result already prepared by Sage Active, with no possibility to add filters, sorts, or explore the data further, or it executes an action (e.g., sending an email). For a mutation, it executes a specific business action, also carried out by Sage Active, which will impact the data (e.g., generating a credit note from an invoice). (Query)	`salesKpis`	`SalesKpiInput`

The Sales KPIs service provides a set of commercial indicators (Key Performance Indicators) that can be retrieved for a given organization.
Each KPI corresponds to a standardized calculation based on the organization’s sales and related data.

Provides sales performance indicators such as incoming and outgoing payments, value of open quotes, number of customers, etc.
Includes KPIs related to quotes conversion through their related sales documents.
Supports retrieval of one or multiple KPIs in a single call.

Input Parameters

kpiTypes – Mandatory. One or several values from the enumeration SalesIndicatorType (see table below).

Response

The service returns a structured list of KPIs. Each KPI contains:

type – The KPI identifier (enum).
value – The numeric value of the KPI.
currency – The currency code (e.g. EUR).

Example response for MONEY_IN

{
  "data": {
    "salesKpis": [
      {
        "type": "MONEY_IN",
        "value": 79566.8,
        "currency": "EUR"
      }
    ]
  }
}

How to use the Sales KPIs service?

Query

query($kpis: [SalesIndicatorType!]!) {
  salesKpis(kpiTypes: $kpis) {
    type
    value
    currency
  }
}

Variable for a single KPI

{
  "kpis": ["MONEY_IN"]
}

Response

{
  "data": {
    "salesKpis": [
      {
        "type": "MONEY_IN",
        "value": 79566.8,
        "currency": "EUR"
      }
    ]
  }
}

Variable for multiple KPIs

{
  "kpis": ["MONEY_IN", "MONEY_OUT"]
}

Response

{
  "data": {
    "salesKpis": [
      {
        "type": "MONEY_IN",
        "value": 79566.8,
        "currency": "EUR"
      },
      {
        "type": "MONEY_OUT",
        "value": 23415.25,
        "currency": "EUR"
      }
    ]
  }
}

Available KPIs

	Kpi	Description
1	MONEY_IN	Incoming payments (cash received)
2	MONEY_OUT	Outgoing payments (cash paid)
3	QUOTES_WITH_RELATED_DOCUMENTS	Quotes linked to subsequent documents
4	TOTAL_CUSTOMERS	Total number of customers
5	TOTAL_FROM_OPEN_QUOTES	Total value of open quotes

Do you want to see all the KPI responses?

[
  // 1
  {
    "type": "MONEY_IN",
    "value": 79566.8,
    "currency": "EUR"
  },

  // 2
  {
    "type": "MONEY_OUT",
    "value": 23415.25,
    "currency": "EUR"
  },

  // 3
  {
    "type": "QUOTES_WITH_RELATED_DOCUMENTS",
    "value": 0,
    "currency": null
  },

  // 4
  {
    "type": "TOTAL_CUSTOMERS",
    "value": 340,
    "currency": null
  },

  // 5
  {
    "type": "TOTAL_FROM_OPEN_QUOTES",
    "value": 48102.94,
    "currency": "EUR"
  }
]

salesKpis Input parameters

Fields	Type	Description
kpiTypes *The value of the field or object is mandatory	MONEY_IN MONEY_OUT QUOTES_WITH_RELATED_DOCUMENTS TOTAL_CUSTOMERS TOTAL_FROM_OPEN_QUOTES	One or more KPI types (array)

salesKpis Response

Fields	Type	Description
type	Enum	KPI type (AccountingIndicatorType)
value	Decimal	Numeric value
currency	String	Currency code (e.g. EUR). May be null if N/A