Contract Management | Create Contract Cessation
Overview
| URL | api/{tenantKey}/{orgKey}/contractManagement/createContractCessations |
| Methods Supported | GET, POST |
All Operations
This service includes the following operations:
All Resources
This service uses the following resources:
GET Create Contract Cessation
Returns the list of entity records that can be processed by the 'ContractCessationEarningModels' 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). |
| contract | (string) Contract. |
| endDate | (DateTime) End Date. |
| leavingReason | (string) Leaving Reason. |
| contractCessationModel | (string) Contract Cessation Model. |
The following elements are optional:
| 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 ContractCessationEarnings. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
POST Create Contract Cessation
Instructs the 'ContractCessationEarningModels' service to process the specified entity records.
The following elements are required:
| list | (ContractCessationEarnings) List of the entity records that should be processed. See ContractCessationEarnings. |
| 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
ContractCessation
The following elements are required:
| selectedCount | (int) Selected Count. |
| contract | (string) Contract. |
| endDate | (DateTime) End Date. |
| leavingReason | (string) Leaving Reason. |
| contractCessationModel | (string) Contract Cessation Model. |
The following elements are optional:
| company | (string) Company. |
ContractCessationEarnings
The following elements are required:
| selected | (bool) Selected. |
The following elements are optional:
| earning | (string) Earning. |
| quantityValue | (decimal) Quantity Value. |
| unitValue | (decimal) Unit Value. |
| value | (decimal) Value. |