Payroll | Create Payment
Overview
| URL | api/{tenantKey}/{orgKey}/payroll/createProcessingsPayments |
| Methods Supported | GET, POST |
All Operations
This service includes the following operations:
- GET:
- POST:
All Resources
This service uses the following resources:
GET Create Payment
Returns the list of entity records that can be processed by the 'Payments' 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). |
| contractKind | (ContractKind) Contract Kind. |
The following elements are optional:
| paymentDate | (DateTime?) Date This is a query string parameter. |
| period | (DateTime?) End Period This is a query string parameter. |
| 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. |
| paymentName | (string) Designation This is a query string parameter. |
| isAdvance | (bool?) Advance This is a query string parameter. |
| isRegular | (bool?) Regular This is a query string parameter. |
| isPosterior | (bool?) Posterior This is a query string parameter. |
| isRetroactive | (bool?) Retroactive This is a query string parameter. |
| isProcessingsGrouped | (bool?) Processings Grouped This is a query string parameter. |
| isAddToPayment | (bool?) Add To Existing Payment This is a query string parameter. |
| payment | (string) Payment This is a query string parameter. |
Response:
| When successful, the response body contains the list of entity records available for processing. See ProcessingsPaymentLine. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/payroll/createProcessingsPayments/{pageIndex}/{pageSize}?paymentDate={paymentDate}&period={period}&contract={contract}&workLocation={workLocation}&company={company}&paymentName={paymentName}&isAdvance={isAdvance}&isRegular={isRegular}&isPosterior={isPosterior}&isRetroactive={isRetroactive}&isProcessingsGrouped={isProcessingsGrouped}&isAddToPayment={isAddToPayment}&payment={payment}
GET /payroll/createProcessingsPayments/{pageIndex}/{pageSize}?paymentDate={paymentDate}&period={period}&contract={contract}&workLocation={workLocation}&company={company}&paymentName={paymentName}&isAdvance={isAdvance}&isRegular={isRegular}&isPosterior={isPosterior}&isRetroactive={isRetroactive}&isProcessingsGrouped={isProcessingsGrouped}&isAddToPayment={isAddToPayment}&payment={payment}
POST Create Payment
Instructs the 'Payments' service to process the specified entity records.
The following elements are required:
| list | (ProcessingsPaymentLine) List of the entity records that should be processed. See ProcessingsPaymentLine. |
| 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/createProcessingsPayments/{companyKey}
POST /payroll/createProcessingsPayments/{companyKey}
Resources
ProcessingsPayment
The following elements are required:
| selectedCount | (int) Selected Count. |
| contractKind | (enum ContractKind) Contract Kind.
See ContractKind. |
The following elements are optional:
| paymentDate | (DateTime) Date. |
| period | (DateTime) End Period. |
| contract | (string) Contract. |
| workLocation | (string) Work Location. |
| company | (string) Company. |
| paymentName | (string) Designation. |
| isAdvance | (bool) Advance. |
| isRegular | (bool) Regular. |
| isPosterior | (bool) Posterior. |
| isRetroactive | (bool) Retroactive. |
| isProcessingsGrouped | (bool) Processings Grouped. |
| isAddToPayment | (bool) Add To Existing Payment. |
| payment | (string) Payment. |
ProcessingsPaymentLine
The following elements are required:
| selected | (bool) Selected. |
The following elements are optional:
| processing | (string) Processing. |
| contract | (string) Contract. |
| employee | (string) Employee. |
| company | (string) Company. |
| processingType | (enum ProcessingType) Processing Type.
See ProcessingType. |
| periodAsText | (string) Period. |
| date | (DateTime) Date. |
| closed | (bool) Closed. |
| number | (int) Number. |
| totalEarnings | (decimal) Total Earnings. |
| totalDeductions | (decimal) Total Deductions. |
| netValue | (decimal) Net Value. |
| totalCompanyDeductions | (decimal) Total Company Deductions. |
| isTimeSheetCompleted | (bool) Is Time Sheet Completed. |