People | Indicator

The Indicators end point is used to get diverse information for the dashboards like sales volume, overdue debt.(RESERVED FOR INTERNAL USE.).

Overview

URL	api/{tenantKey}/{orgKey}/people/indicators
Methods Supported	GET

All Operations

This service includes the following operations:

• GET:
  • GET Kpi Card

All Resources

This service uses the following resources:

• KpiCardData

GET Operations

GET Kpi Card

This operation gets the kpi card data by the respective code, company and reference date. If the reference date is not passed the default date is current date (DateTime.Today). RESERVED FOR INTERNAL USE.

The following elements are required:

companyKey	(string) The Company Key.
role	(string) Role.
kpi	(string) The code identify the card result, eg. if the code is E then the card result is EBITDA.

Response:

When successful, the response body contains a resource of type 'KpiCardData'. See KpiCardData.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

Resources

KpiCardData

The following elements are required:

value	(decimal) The Value.
valueType	(string) The value type. Ex: number, percentage, etc.

The following elements are optional:

referenceValue	(decimal) The reference value.
fractionDigits	(int) The fractions digits to be displayed.
currencySymbol	(string) The currency ISO symbol.
result	(int) The card result.
variation	(decimal) The percentage variation in the value.