Purchases | Metric

This endpoint is to get metrics data for the aplication, like the new customers, sales closing ratio, etc.

Overview

URL	api/{tenantKey}/{orgKey}/purchases/metrics
Methods Supported	GET

All Operations

This service includes the following operations:

• GET:
  • GET Get Reliability In Invoice Card
  • GET Get Delivery On Time Card
  • GET Get Reliability In Invoice
  • GET Get Lead Time
  • GET Get Delivery On Time

All Resources

This service uses the following resources:

• MetricData

GET Operations

GET Get Reliability In Invoice Card

This end point is used the get the realiability in invoices metric. This service is used on to return to be display on a card data.

The following elements are required:

companyKey	(string) The company key.
referenceDate	(DateTime?) The reference date.

Response:

When successful, the response body contains a resource of type 'MetricData'. See MetricData.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

GET Get Delivery On Time Card

This end point is used the get the delivery on time metric. This service is used on to return to be display on a card data.

The following elements are required:

companyKey	(string) The company key.
referenceDate	(DateTime?) The reference date.

Response:

When successful, the response body contains a resource of type 'MetricData'. See MetricData.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

GET Get Reliability In Invoice

This end point is used the get the realiability in invoices. This service is used on to return to be display on a chart.

The following elements are required:

companyKey	(string) The company key.
referenceDate	(DateTime?) The reference date.

Response:

When successful, the response body contains a resource of type 'MetricData'. See MetricData.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

GET Get Lead Time

This end point is used the get the lead time metric. This service is used on to return to be display on a card data.

The following elements are required:

companyKey	(string) The company key.
referenceDate	(DateTime?) The reference date.

Response:

When successful, the response body contains a resource of type 'MetricData'. See MetricData.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

GET Get Delivery On Time

This end point is used the get the delivery on time. This service is used on to return to be display on a chart.

The following elements are required:

companyKey	(string) The company key.
referenceDate	(DateTime?) The reference date.

Response:

When successful, the response body contains a resource of type 'MetricData'. See MetricData.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

Resources

MetricData

The following elements are optional:

referenceDate	(DateTime) Reference Date.
value	(decimal) Value.
valueReporting	(decimal) Value Reporting.
homologous	(decimal) Homologous.
homologousReporting	(decimal) Homologous Reporting.
budget	(decimal) Budget.
budgetReporting	(decimal) Budget Reporting.
baseCurrency	(string) Base Currency.
reportingCurrency	(string) Reporting Currency.