Financials | Metric

The Metrics end point is used to get diverse information like sales volume or overdue debt. This information will be used to generate information about the business (insights).(RESERVED FOR INTERNAL USE.).

Overview

api/{tenantKey}/{orgKey}/financialCore/metrics

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

All Operations

This service includes the following operations:

GET:

All Resources

This service uses the following resources:

MetricData

GET Operations

GET Get Pendings Value

This operation gets the information data about the pending receivables and payables. RESERVED FOR INTERNAL USE.

The following elements are required:

companyKey	(string) The Company Key.
weeksAhead	(int) Number of weeks ahead of the reference date. Setting the parameter to -1 will return the pendings value of the reference date, 0 will return pendings value until the end of the week. Setting the parameter to any other integer will return the respective pendings value.
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:

api/{tenantKey}/{orgKey}/financialCore/metrics/getPendingsValue/{companyKey}

GET /financialCore/metrics/getPendingsValue/{companyKey}

GET Get Maintenance Costs

This operation gets the information data about the overall costs. RESERVED FOR INTERNAL USE.

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:

api/{tenantKey}/{orgKey}/financialCore/metrics/getMaintenanceCosts/{companyKey}

GET /financialCore/metrics/getMaintenanceCosts/{companyKey}

GET Get Goods Sold And Materials Consumed Costs

This operation gets the information data about Cost of Goods Sold and Materials Consumed. RESERVED FOR INTERNAL USE.

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:

api/{tenantKey}/{orgKey}/financialCore/metrics/getGoodsSoldAndMaterialsConsumedCosts/{companyKey}

GET /financialCore/metrics/getGoodsSoldAndMaterialsConsumedCosts/{companyKey}

GET Get Financial Autonomy

This operation gets the information data about Financial Autonomy. RESERVED FOR INTERNAL USE.

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:

api/{tenantKey}/{orgKey}/financialCore/metrics/getFinancialAutonomy/{companyKey}

GET /financialCore/metrics/getFinancialAutonomy/{companyKey}

GET Get General Liquidity

This operation gets the information data about general liquidity. RESERVED FOR INTERNAL USE.

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:

api/{tenantKey}/{orgKey}/financialCore/metrics/getGeneralLiquidity/{companyKey}

GET /financialCore/metrics/getGeneralLiquidity/{companyKey}

GET Get Obligations VAT

This operation gets the information data about VAT obligations. RESERVED FOR INTERNAL USE.

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:

api/{tenantKey}/{orgKey}/financialCore/metrics/getObligationsVAT/{companyKey}

GET /financialCore/metrics/getObligationsVAT/{companyKey}

GET Get Obligations SS

This operation gets the information data about SS obligations. RESERVED FOR INTERNAL USE.

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:

api/{tenantKey}/{orgKey}/financialCore/metrics/getObligationsSS/{companyKey}

GET /financialCore/metrics/getObligationsSS/{companyKey}

GET Get Obligations Withholding

This operation gets the information data about withholding obligations. RESERVED FOR INTERNAL USE.

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:

api/{tenantKey}/{orgKey}/financialCore/metrics/getObligationsWithholding/{companyKey}

GET /financialCore/metrics/getObligationsWithholding/{companyKey}

GET Get Obligations Compensation Fund

This operation gets the information data about compensation fund obligations. RESERVED FOR INTERNAL USE.

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:

api/{tenantKey}/{orgKey}/financialCore/metrics/getObligationsCompensationFund/{companyKey}

GET /financialCore/metrics/getObligationsCompensationFund/{companyKey}

GET Get Last Metrics Update Date

This operation gets the last date the metrics keys was updated.

The following elements are required:

companyKey	(string) CompanyKey.
metricKeys	(string) MetricKeys.

Response:

When successful, the response body contains a string.

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/metrics/getLastMetricsUpdateDate

GET /financialCore/metrics/getLastMetricsUpdateDate

Resources

MetricData

The following elements are optional:

referenceDate	(DateTime) The reference date.
value	(decimal) The value.
valueReporting	(decimal) The reporting value.
homologous	(decimal) The homologous value.
homologousReporting	(decimal) The homologous reporting value.
budget	(decimal) The budget value.
budgetReporting	(decimal) The budget reporting value.
baseCurrency	(string) The base currency.
reportingCurrency	(string) The reporting currency.
paymentDate	(DateTime) The payment date.