Contract Management | Create Contract
Overview
| URL | api/{tenantKey}/{orgKey}/contractManagement/createEmployeeContracts |
| Methods Supported | GET, POST |
All Operations
This service includes the following operations:
- GET:
- POST:
All Resources
This service uses the following resources:
GET Create Contract
Returns the list of entity records that can be processed by the 'EarningModels' 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). |
| employee | (string) Employee. |
| hiringDate | (DateTime) Hiring Date. |
| contractKind | (ContractKind) Contract Kind. |
The following elements are optional:
| earningsModel | (string) Earnings Model This is a query string parameter. |
| deductionsModel | (string) Deductions Model This is a query string parameter. |
| contractualPlanModel | (string) Contractual Plan Model This is a query string parameter. |
| benefitAccountsModel | (string) Benefit Accounts Model This is a query string parameter. |
| isContractActive | (bool?) Active contracts 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 CreateEmployeeContractLine. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/contractManagement/createEmployeeContracts/{pageIndex}/{pageSize}?earningsModel={earningsModel}&deductionsModel={deductionsModel}&contractualPlanModel={contractualPlanModel}&benefitAccountsModel={benefitAccountsModel}&isContractActive={isContractActive}&company={company}
GET /contractManagement/createEmployeeContracts/{pageIndex}/{pageSize}?earningsModel={earningsModel}&deductionsModel={deductionsModel}&contractualPlanModel={contractualPlanModel}&benefitAccountsModel={benefitAccountsModel}&isContractActive={isContractActive}&company={company}
POST Create Contract
Instructs the 'EarningModels' service to process the specified entity records.
The following elements are required:
| list | (CreateEmployeeContractLine) List of the entity records that should be processed. See CreateEmployeeContractLine. |
| 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}/contractManagement/createEmployeeContracts/{companyKey}
POST /contractManagement/createEmployeeContracts/{companyKey}
Resources
CreateEmployeeContractLine
The following elements are required:
| selected | (bool) Selected. |
CreateEmployeeContracts
The following elements are required:
| selectedCount | (int) Selected Count. |
| employee | (string) Employee. |
| hiringDate | (DateTime) Hiring Date. |
| contractKind | (enum ContractKind) Contract Kind.
See ContractKind. |
The following elements are optional:
| earningsModel | (string) Earnings Model. |
| deductionsModel | (string) Deductions Model. |
| contractualPlanModel | (string) Contractual Plan Model. |
| benefitAccountsModel | (string) Benefit Accounts Model. |
| isContractActive | (bool) Active contracts. |
| company | (string) Company. |