Sales | Indicator
The Indicators endpoint is used to get indicators data for the aplication cards, like the churn rate, kpi, etc.
Overview
| URL | api/{tenantKey}/{orgKey}/sales/indicators |
| Methods Supported | GET |
All Operations
This service includes the following operations:
All Resources
This service uses the following resources:
GET Kpi Card
Custom operation 'KpiCard'.
The following elements are required:
| company | (string) Company. |
| 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:
api/{tenantKey}/{orgKey}/sales/indicators/kpiCard/{company}/{code}
GET /sales/indicators/kpiCard/{company}/{code}
GET Kpi Chart
Custom operation 'KpiChart'.
The following elements are required:
| company | (string) Company. |
| 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:
api/{tenantKey}/{orgKey}/sales/indicators/kpiChart/{company}/{code}
GET /sales/indicators/kpiChart/{company}/{code}
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. |