Payroll | Dimensions Analysis

Overview

URL	api/{tenantKey}/{orgKey}/payroll/dimensionsAnalysisReports
Methods Supported	GET

All Operations

This service includes the following operations:

• GET:
  • GET Get Dimension Analysis Data
  • GET Get Dimension Analysis Pivot Config
  • GET Get Processing Variables Analysis Data
  • GET Get Processing Variables Analysis Pivot Config

All Resources

This service uses the following resources:

• PivotConfiguration
• PivotConfigurationFormat

GET Operations

GET Get Dimension Analysis Data

This operation gets the information about contract dimensions. (RESERVED FOR INTERNAL USE.).

The following elements are required:

companyKey	(string) The company.
periodKind	(int) The period kind.
contractKind	(int) The contract kind.
startPeriod	(DateTime?) The Start Period.
endPeriod	(DateTime?) The End Period.

Response:

When successful, the response body contains a string.

Response status codes:

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

Resource URL:

GET Get Dimension Analysis Pivot Config

This operation gets the Dimension Analysis Configurations. (RESERVED FOR INTERNAL USE.).

The following elements are required:

companyKey

(string) The Company Key.

Response:

When successful, the response body contains a list of resources of type 'PivotConfiguration'. See PivotConfiguration.

Response status codes:

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

Resource URL:

GET Get Processing Variables Analysis Data

This operation gets the information about processing variables. (RESERVED FOR INTERNAL USE.).

The following elements are required:

companyKey	(string) The company.
periodKind	(int) The period kind.
contractKind	(int) The contract kind.
startPeriod	(DateTime?) The Start Period.
endPeriod	(DateTime?) The End Period.

Response:

When successful, the response body contains a string.

Response status codes:

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

Resource URL:

GET Get Processing Variables Analysis Pivot Config

This operation gets the Processing Variables Analysis Configurations. (RESERVED FOR INTERNAL USE.).

The following elements are required:

companyKey

(string) The Company Key.

Response:

When successful, the response body contains a list of resources of type 'PivotConfiguration'. See PivotConfiguration.

Response status codes:

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

Resource URL:

Resources

PivotConfiguration

The following elements are optional:

caption	(string) The Caption.
dataField	(string) The data field.
area	(string) The area.
dataType	(string) The data type.
summaryType	(string) Summary Type.

PivotConfigurationFormat

The following elements are optional:

type	(string) Type.
currency	(string) Currency.
precision	(int) Precision.