Payroll | Update Contract Earning
Overview
| URL | api/{tenantKey}/{orgKey}/payroll/updateContractEarnings |
| Methods Supported | GET, POST |
All Operations
This service includes the following operations:
All Resources
This service uses the following resources:
GET Update Contract Earning
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). |
| earning | (string) Earning. |
| startPeriod | (DateTime) Start Period. |
The following elements are optional:
| workLocation | (string) Work Location This is a query string parameter. |
| company | (string) Company This is a query string parameter. |
Response:
| When successful, the response body contains the list of entity records available for processing. See ContractsEarningPickingLine. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/payroll/updateContractEarnings/{pageIndex}/{pageSize}?workLocation={workLocation}&company={company}
GET /payroll/updateContractEarnings/{pageIndex}/{pageSize}?workLocation={workLocation}&company={company}
POST Update Contract Earning
Instructs the 'EmployeeReceipts' service to process the specified entity records.
The following elements are required:
| list | (ContractsEarningPickingLine) List of the entity records that should be processed. See ContractsEarningPickingLine. |
| 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/updateContractEarnings/{companyKey}
POST /payroll/updateContractEarnings/{companyKey}
Resources
ContractsEarningPicking
The following elements are required:
| selectedCount | (int) Selected Count. |
| earning | (string) Earning. |
| startPeriod | (DateTime) Start Period. |
The following elements are optional:
| workLocation | (string) Work Location. |
| company | (string) Company. |
ContractsEarningPickingLine
The following elements are required:
| selected | (bool) Selected. |
| contract | (string) Contract. |
The following elements are optional:
| company | (string) Company. |
| currentConfiguration | (string) Current Configuration. |
| quantityKind | (enum QuantityKind) Quantity Kind.
See QuantityKind. |
| quantityValue | (decimal) Quantity Value. |
| quantityFormula | (string) Quantity Formula. |
| valueKind | (enum EarningValueKind) Value Kind.
See EarningValueKind. |
| valueMoney | (decimal) Value Money. |
| valueFormula | (string) Value Formula. |