Financials | Indicator
Custom service that return indicator summary values.
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
Get 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).
The following elements are required:
| companyKey | (string) CompanyKey. |
| code | (string) Code. |
| referenceDate | (DateTime?) ReferenceDate. |
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
Get 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).
The following elements are required:
| companyKey | (string) CompanyKey. |
| code | (string) Code. |
| referenceDate | (DateTime?) ReferenceDate. |
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. |
| secondValue | (decimal) Second Value. |
KpiChartData
The following elements are optional:
| period | (string) Period. |
| value | (decimal) Value. |
| homologous | (decimal) Homologous. |
| budget | (decimal) Budget. |
| forecast | (decimal) Forecast. |
| revenue | (decimal) Revenue. |
| expense | (decimal) Expense. |