Payroll | Reprocess Contract Period
Overview
| URL | api/{tenantKey}/{orgKey}/payroll/reprocessContractPeriods |
| Methods Supported | GET, POST |
All Operations
This service includes the following operations:
All Resources
This service uses the following resources:
GET Reprocess Contract Period
Returns the list of entity records that can be processed by the 'EmployeeReceipts' 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:
| contract | (string) Contract This is a query string parameter. |
| workLocation | (string) Work Location This is a query string parameter. |
| company | (string) Company This is a query string parameter. |
| includeOutgoings | (bool?) Include Outgoings This is a query string parameter. |
| startPeriod | (DateTime?) Start Period This is a query string parameter. |
Response:
| When successful, the response body contains the list of entity records available for processing. See ContractsPeriodLine. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/payroll/reprocessContractPeriods/{pageIndex}/{pageSize}?contract={contract}&workLocation={workLocation}&company={company}&includeOutgoings={includeOutgoings}&startPeriod={startPeriod}
GET /payroll/reprocessContractPeriods/{pageIndex}/{pageSize}?contract={contract}&workLocation={workLocation}&company={company}&includeOutgoings={includeOutgoings}&startPeriod={startPeriod}
POST Reprocess Contract Period
Instructs the 'EmployeeReceipts' service to process the specified entity records.
The following elements are required:
| list | (ContractsPeriodLine) List of the entity records that should be processed. See ContractsPeriodLine. |
| 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}/payroll/reprocessContractPeriods/{companyKey}
POST /payroll/reprocessContractPeriods/{companyKey}
Resources
ContractsPeriod
The following elements are required:
| selectedCount | (int) Selected Count. |
The following elements are optional:
| contract | (string) Contract. |
| workLocation | (string) Work Location. |
| company | (string) Company. |
| includeOutgoings | (bool) Include Outgoings. |
| startPeriod | (DateTime) Start Period. |
ContractsPeriodLine
The following elements are required:
| selected | (bool) Selected. |
The following elements are optional:
| contract | (string) Contract. |
| employee | (string) Employee. |
| workLocation | (string) Work Location. |
| hiringDate | (DateTime) Hiring Date. |
| company | (string) Company. |
| contractStateId | (Guid) Contract State Id. |
| contractState | (string) Contract State. |
| startPeriod | (DateTime) Start Period. |