Financials | 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}/financialCore/indicators |
| Methods Supported | GET |
All Operations
This service includes the following operations:
All Resources
This service uses the following resources:
GET Kpi Chart
This operation gets the kpi chart 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. |
| code | (string) The code identify the chart result, eg. if the code is E then the chart result is EBITDA. |
| referenceDate | (DateTime?) The Reference Date. |
Response:
| When successful, the response body contains a list of resources of type 'KpiChartData'. See KpiChartData. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
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. |
| code | (string) The code identify the card result, eg. if the code is E then the card result is EBITDA. |
| referenceDate | (DateTime?) The Reference Date. |
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. |
| valueFractionDigits | (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. |
KpiChartData
The following elements are optional:
| period | (string) The period number. |
| value | (decimal) The value. |
| homologous | (decimal) The homologous value. |
| budget | (decimal) The budget value. |
| forecast | (decimal) The forecast value. |