Payroll | Create Batch Extra Earning
Overview
| URL | api/{tenantKey}/{orgKey}/payrollCore/createBatchExtraEarnings |
| Methods Supported | GET, POST |
All Operations
This service includes the following operations:
All Resources
This service uses the following resources:
GET Create Batch Extra Earning
Returns the list of entity records that can be processed by the 'BatchExtraEarnings' 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. |
| timing | (Timing) Timing. |
| valueKind | (EarningValueKind) Value Kind. |
The following elements are optional:
| period | (DateTime?) Period This is a query string parameter. |
| referenceDate | (DateTime?) Reference Date This is a query string parameter. |
| quantity | (decimal?) Quantity This is a query string parameter. |
| valueMoney | (decimal?) Value Money This is a query string parameter. |
| valueFormula | (string) Value Formula This is a query string parameter. |
| company | (string) Company This is a query string parameter. |
| batchExtraEarningDescription | (string) Batch Extra Earning Description This is a query string parameter. |
| workLocation | (string) Work Location This is a query string parameter. |
| position | (string) Position This is a query string parameter. |
Response:
| When successful, the response body contains the list of entity records available for processing. See BatchExtraEarningLine. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/payrollCore/createBatchExtraEarnings/{pageIndex}/{pageSize}?period={period}&referenceDate={referenceDate}&quantity={quantity}&valueMoney={valueMoney}&valueFormula={valueFormula}&company={company}&batchExtraEarningDescription={batchExtraEarningDescription}&workLocation={workLocation}&position={position}
GET /payrollCore/createBatchExtraEarnings/{pageIndex}/{pageSize}?period={period}&referenceDate={referenceDate}&quantity={quantity}&valueMoney={valueMoney}&valueFormula={valueFormula}&company={company}&batchExtraEarningDescription={batchExtraEarningDescription}&workLocation={workLocation}&position={position}
POST Create Batch Extra Earning
Instructs the 'BatchExtraEarnings' service to process the specified entity records.
The following elements are required:
| list | (BatchExtraEarningLine) List of the entity records that should be processed. See BatchExtraEarningLine. |
| 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/createBatchExtraEarnings/{companyKey}
POST /payrollCore/createBatchExtraEarnings/{companyKey}
Resources
BatchExtraEarningLine
The following elements are required:
| selected | (bool) Selected. |
The following elements are optional:
| contract | (string) Contract. |
| employee | (string) Employee. |
| quantity | (decimal) Quantity. |
| valueMoney | (decimal) Value Money. |
| company | (string) Company. |
BatchExtraEarningMain
The following elements are required:
| selectedCount | (int) Selected Count. |
| earning | (string) Earning. |
| timing | (enum Timing) Timing.
See Timing. |
| valueKind | (enum EarningValueKind) Value Kind.
See EarningValueKind. |
The following elements are optional:
| period | (DateTime) Period. |
| referenceDate | (DateTime) Reference Date. |
| quantity | (decimal) Quantity. |
| valueMoney | (decimal) Value Money. |
| valueFormula | (string) Value Formula. |
| company | (string) Company. |
| batchExtraEarningDescription | (string) Batch Extra Earning Description. |
| workLocation | (string) Work Location. |
| position | (string) Position. |