Contract Management | Renewals

Overview

URL	api/{tenantKey}/{orgKey}/contractManagement/processContractRenovations
Methods Supported	GET, POST

All Operations

This service includes the following operations:

• GET:
  • GET Renewals
• POST:
  • POST Renewals

All Resources

This service uses the following resources:

• ContractRenovation
• ContractRenovationLine

GET Operations

GET Renewals

Returns the list of entity records that can be processed by the 'ContractualPlanModels' 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:

referenceDate	(DateTime?) Reference Date This is a query string parameter.
workLocation	(string) Work Location This is a query string parameter.
employee	(string) Employee This is a query string parameter.
contractType	(TypeContractRenewal?) Current contract Type 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 ContractRenovationLine.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

POST Operations

POST Renewals

Instructs the 'ContractualPlanModels' service to process the specified entity records.

The following elements are required:

list	(ContractRenovationLine) List of the entity records that should be processed. See ContractRenovationLine.
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:

Resources

ContractRenovation

The following elements are required:

selectedCount

(int) Selected Count.

The following elements are optional:

referenceDate	(DateTime) Reference Date.
workLocation	(string) Work Location.
employee	(string) Employee.
contractType	(enum TypeContractRenewal) Current contract Type. See TypeContractRenewal.
company	(string) Company.

ContractRenovationLine

The following elements are required:

selected

(bool) Selected.

The following elements are optional:

contract	(string) Contract.
company	(string) Company.
employee	(string) Employee.
hiringDate	(DateTime) Hiring Date.
estimatedEndDate	(DateTime) Est. End Date.
endDate	(DateTime) End Date.
trialPeriod	(bool) Trial Period.
renovationsNumber	(int) Renovations No.
antiguity	(int) Antiguity.
nextStage	(string) Next Stage.
nextStageDuration	(int) Next Stage Est. Duration.
newEstimatedEndDate	(string) New Est. End Date.
companyExpiryPriorNoticeDate	(DateTime) Comp. EPN.
remarks	(string) Remarks.