AccountingKpis | Sage Active Developer

Quick Links

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

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)	`accountingKpis`	`AccountingKpiInput`

The Accounting KPIS service exposes a set of accounting indicators (Key Performance Indicators) that can be retrieved for a given organization.
Each KPI corresponds to a standardized calculation on accounting balances, adapted per legislation (FR, ES, or DE).

Provides accounting ratios and indicators such as turnover, purchases, trade margin, equity, etc.
Adapts the calculation logic to the organization’s legislation.
Supports retrieval of one or multiple KPIs in a single call.

Input Parameters

kpiTypes – Mandatory. One or several values from the enumeration AccountingIndicatorType (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 RESULT (Operating result)

{
  "data": {
    "accountingKpis": [
      {
        "type": "RESULT",
        "value": 7591496.65,
        "currency": "EUR"
      }
    ]
  }
}

How to use the Accounting KPIs service?

Query

query ($kpis: [AccountingIndicatorType!]!) {
  accountingKpis(input: { kpiTypes: $kpis }) {
    type
    value
    currency
  }
}

Variable for a single KPI

{
  "kpis": ["RESULT"]
}

Response

{
  "data": {
    "accountingKpis": [
      {
        "type": "RESULT",
        "value": 7591496.65,
        "currency": "EUR"
      }
    ]
  }
}

Variable for multiple KPIs

{
  "kpis": ["RESULT", "FINANCIAL_RESULT", "EXCEPTIONAL_RESULT"]
}

Response

{
  "data": {
    "accountingKpis": [   
      {
        "type": "RESULT",
        "value": 7591496.65,
        "currency": "EUR"
      },
      {
        "type": "FINANCIAL_RESULT",
        "value": 0.00,
        "currency": "EUR"
      },
      {
        "type": "EXCEPTIONAL_RESULT",
        "value": -138.88,
        "currency": "EUR"
      }
    ]
  }
}

Available KPIs

		Kpi	Description
	1	ASSETS	Total assets
	2	EQUITY	Equity
	3	EXCEPTIONAL_RESULT	Exceptional result
	4	FINANCIAL_RESULT	Accounting result (interests, accounting income/expenses)
	5	NET_RESULT	Net result
	6	OTHER_EXPENSES	Other operating expenses
	7	PURCHASES	Purchases (goods & raw materials)
	8	RESULT	Operating result (profit/loss)
	9	STAFF_COST	Staff costs (wages, social charges)
	10	TAXES	Taxes and duties
	11	TRADE_MARGIN	Trade margin (turnover – purchases)
	12	TREASURY_BALANCE	Treasury balance (cash position)
	13	TURNOVER	Turnover (Sales revenue)
	14	WORKING_CAPITAL	Working capital

Do you want to see all the KPI responses?

[
  // 1
  {
    "type": "ASSETS",
    "value": 10481868.79,
    "currency": "EUR"
  },

  // 2
  {
    "type": "EQUITY",
    "value": 7591496.65,
    "currency": "EUR"
  },

  // 3
  {
    "type": "EXCEPTIONAL_RESULT",
    "value": -138.88,
    "currency": "EUR"
  },

  // 4
  {
    "type": "FINANCIAL_RESULT",
    "value": 0,
    "currency": "EUR"
  },

  // 5
  {
    "type": "NET_RESULT",
    "value": 7591357.77,
    "currency": "EUR"
  },

  // 6
  {
    "type": "OTHER_EXPENSES",
    "value": 18000,
    "currency": "EUR"
  },

  // 7
  {
    "type": "PURCHASES",
    "value": 4612065.98,
    "currency": "EUR"
  },

  // 8
  {
    "type": "RESULT",
    "value": 7591496.65,
    "currency": "EUR"
  },

  // 9
  {
    "type": "STAFF_COST",
    "value": 36836,
    "currency": "EUR"
  },

  // 10
  {
    "type": "TAXES",
    "value": 25000.00,
    "currency": "EUR"
  },

  // 11
  {
    "type": "TRADE_MARGIN",
    "value": 7805590.65,
    "currency": "EUR"
  },

  // 12
  {
    "type": "TREASURY_BALANCE",
    "value": 95267.84,
    "currency": "EUR"
  },

  // 13
  {
    "type": "TURNOVER",
    "value": 12417656.63,
    "currency": "EUR"
  },

  // 14
  {
    "type": "WORKING_CAPITAL",
    "value": 7735825.94,
    "currency": "EUR"
  }
]

Key	Value
`Authorization`	Bearer Current access Token How to find?
~~`X-TenantId`~~ DeprThis field is now deprecated, and we recommend using an alternative solution	Current tenant id Why deprecated ?
`X-OrganizationId`	Current organization Id How to find?
`x-api-key`	Primary or secondary subscription key of your app How to find?

accountingKpis Input parameters

Fields	Type	Description
kpiTypes *The value of the field or object is mandatory	ASSETS EQUITY EXCEPTIONAL_RESULT FINANCIAL_RESULT NET_RESULT OTHER_EXPENSES PURCHASES RESULT STAFF_COST TAXES TRADE_MARGIN TREASURY_BALANCE TURNOVER WORKING_CAPITAL	One or more KPI types (array)

accountingKpis Response

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