Accounting | Indicator
The Indicator Service end point is used to get the values to display in the kpi cards or charts used on product dashboards.
Overview
| URL | api/{tenantKey}/{orgKey}/accounting/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 all the values needed to create a chart for specific kpi based on the supplied code.
The following elements are required:
| company | (string) The company code "abbreviation" as defined on the company setup. |
| code | (string) The code to get the kpi value. For example if the code is "SV" you will get the sales volume for the supplied reference date. |
| referenceDate | (DateTime?) The reference date to get the kpi value. If not supplied the current date will be used. |
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 get the value for a speficique kpi card based on the kpi suplied code.
The following elements are required:
| company | (string) The company code "abbreviation" as defined on the company setup. |
| code | (string) The code to get the kpi value. For example if the code is "SV" you will get the sales volume for the supplied reference date. |
| referenceDate | (DateTime?) The reference date to get the kpi value. If not supplied the current date will be used. |
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) Value. |
| valueType | (string) Value Type. |
The following elements are optional:
| referenceValue | (decimal) Reference Value. |
| valueFractionDigits | (int) Value Fraction Digits. |
| currencySymbol | (string) Currency Symbol. |
| result | (int) Result. |
| variation | (decimal) Variation. |
KpiChartData
The following elements are required:
| period | (string) Period. |
The following elements are optional:
| value | (decimal) Value. |
| homologous | (decimal) Homologous. |
| budget | (decimal) Budget. |
| forecast | (decimal) Forecast. |