Purchases | Indicator
This endpoint is to get indicators data for the aplication cards, like the churn rate, kpi, etc.
Overview
| URL | api/{tenantKey}/{orgKey}/purchases/indicators |
| Methods Supported | GET |
All Operations
This service includes the following operations:
All Resources
This service uses the following resources:
GET Kpi Chart
This endpoint is used to retrived the charts data.
The following elements are required:
| company | (string) The company key. |
| code | (string) The code of type of data to retrived. LT (LeadTime), DOTP (DeliveryOnTime), RIP (ReliabilityIninvoice). |
| referenceDate | (DateTime?) The reference data. |
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}/purchases/indicators/kpiChart/{company}/{code}
GET /purchases/indicators/kpiChart/{company}/{code}
GET Kpi Card
This endpoint is used to retrived the cards data.
The following elements are required:
| company | (string) The company key. |
| code | (string) The code of type of data to retrived. LT (LeadTime), DOTP (DeliveryOnTimeCard), RIP (ReliabilityIninvoiceCard). |
| referenceDate | (DateTime?) The reference data. |
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}/purchases/indicators/kpiCard/{company}/{code}
GET /purchases/indicators/kpiCard/{company}/{code}
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 required:
| period | (string) The period number. |
The following elements are optional:
| value | (decimal) The value. |
| homologous | (decimal) The homologous amount value. |
| budget | (decimal) The budget amount value. |
| forecast | (decimal) The forecast amount value. |