Payroll | Processing Requests Validation
Overview
| URL | api/{tenantKey}/{orgKey}/payrollCore/processingRequestsValidations |
| Methods Supported | GET, POST |
All Operations
This service includes the following operations:
All Resources
This service uses the following resources:
GET Processing Requests Validation
Returns the list of entity records that can be processed by the 'Processings' service.
The following elements are required:
| pageIndex | (int) The index of the page of the list that should be returned. |
| pageSize | (int) The number of page elements that should be returned (max. is 1000). |
The following elements are optional:
| selectedSourceType | (ProcessingRequestSourceType?) Selected Source Type This is a query string parameter. |
Response:
| When successful, the response body contains the list of entity records available for processing. See ProcessingRequestsValidationLine. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/payrollCore/processingRequestsValidations/{pageIndex}/{pageSize}?selectedSourceType={selectedSourceType}
GET /payrollCore/processingRequestsValidations/{pageIndex}/{pageSize}?selectedSourceType={selectedSourceType}
POST Processing Requests Validation
Instructs the 'Processings' service to process the specified entity records.
The following elements are required:
| list | (ProcessingRequestsValidationLine) List of the entity records that should be processed. See ProcessingRequestsValidationLine. |
| companyKey | (string) The company key. |
Response:
| When successful, the response body is empty. The URL of the processed items is returned in the response location header. |
Response status codes:
| 201 | Created. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/payrollCore/processingRequestsValidations/{companyKey}
POST /payrollCore/processingRequestsValidations/{companyKey}
Resources
ProcessingRequestsValidationLine
The following elements are required:
| selected | (bool) Selected. |
| contract | (string) Contract. |
| employee | (string) Employee. |
| period | (string) Period. |
The following elements are optional:
| company | (string) Company. |
| periodAsDate | (DateTime) Period As Date. |
| sourceType | (enum ProcessingRequestSourceType) Source.
See ProcessingRequestSourceType. |
ProcessingRequestValidation
The following elements are required:
| selectedCount | (int) Selected Count. |
The following elements are optional:
| selectedSourceType | (enum ProcessingRequestSourceType) Selected Source Type.
See ProcessingRequestSourceType. |