Contract Management | Contract Cessation Model
Service to manage entities of type 'ContractCessationEarningModel'.
Overview
| URL | api/{tenantKey}/{orgKey}/contractManagement/contractCessationEarningModels |
| Methods Supported | GET, POST, PUT, DELETE |
All Operations
This service includes the following operations:
-
GET:
- GET ContractCessationEarningModels
- GET ContractCessationEarningModels (paged)
- GET ContractCessationEarningModel by identifier
- GET ContractCessationEarningModel by key
- GET Print ContractCessationEarningModel by identifier
- GET Print ContractCessationEarningModel by key
- GET Original Print ContractCessationEarningModelOriginal by identifier
- GET Original Print ContractCessationEarningModel by key
- POST:
-
PUT:
- PUT Set IsActive ContractCessationEarningModel
- PUT Set ContractCessationEarningModelKey ContractCessationEarningModel
- PUT Set Name ContractCessationEarningModel
- PUT Set LeavingReasons ContractCessationEarningModel
- PUT Set Earning ContractCessationEarningModelDetail
- PUT Set QuantityKind ContractCessationEarningModelDetail
- PUT Set QuantityValue ContractCessationEarningModelDetail
- PUT Set QuantityFormula ContractCessationEarningModelDetail
- PUT Set ValueKind ContractCessationEarningModelDetail
- PUT Set ValueMoney ContractCessationEarningModelDetail
- PUT Set ValueFormula ContractCessationEarningModelDetail
- PUT Set Currency ContractCessationEarningModelDetail
- DELETE:
All Resources
This service uses the following resources:
- ApiContractCessationEarningModelContractCessationEarningModelDetailsResource
- ApiContractCessationEarningModelResource
- ContractCessationEarningModelDetailResource
- ContractCessationEarningModelResource
- MoneyResource
All Enumerations
This service uses the following enumerations:
GET ContractCessationEarningModels
Returns the list of all the entity records available.
Response:
| When successful, the response body contains the list of records available. See ContractCessationEarningModelResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/contractManagement/contractCessationEarningModels
GET /contractManagement/contractCessationEarningModels
GET ContractCessationEarningModels (paged)
Returns a page of the list of all the entity records available.
The following elements are optional:
| page | (int) The index of the page of the list that should be returned. This is a query string parameter. |
| pageSize | (int) The number of page elements that should be returned (max. is 1000). This is a query string parameter. |
Response:
| When successful, the response body contains the list of records available. See ContractCessationEarningModelResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/contractManagement/contractCessationEarningModels?page={page}&pageSize={pageSize}
GET /contractManagement/contractCessationEarningModels?page={page}&pageSize={pageSize}
GET ContractCessationEarningModel by identifier
Returns the entity record that matches the specified identifier.
The following elements are required:
| id | (string) The record identifier. |
Response:
| When successful, the response body contains the entity record. See ContractCessationEarningModelResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
api/{tenantKey}/{orgKey}/contractManagement/contractCessationEarningModels/{id}
GET /contractManagement/contractCessationEarningModels/{id}
GET ContractCessationEarningModel by key
Returns the entity record that matches the specified key.
The following elements are required:
| contractCessationEarningModelKey | (string) Contract Cessation Earning Model. |
Response:
| When successful, the response body contains the entity record. See ContractCessationEarningModelResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
api/{tenantKey}/{orgKey}/contractManagement/contractCessationEarningModels/{contractCessationEarningModelKey}
GET /contractManagement/contractCessationEarningModels/{contractCessationEarningModelKey}
GET Print ContractCessationEarningModel by identifier
Prints the specified entity record.
The following elements are required:
| id | (string) The record identifier. |
The following elements are optional:
| template | (string) The report template that should be used. This is a query string parameter. |
Response:
| When successful, the response body contains a stream with the printed file. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 404 | NotFound. The specified resord does not exist. |
Resource URL:
api/{tenantKey}/{orgKey}/contractManagement/contractCessationEarningModels/{id}/print?template={template}
GET /contractManagement/contractCessationEarningModels/{id}/print?template={template}
GET Print ContractCessationEarningModel by key
Prints the specified entity record.
The following elements are required:
| contractCessationEarningModelKey | (string) Contract Cessation Earning Model. |
The following elements are optional:
| template | (string) The report template that should be used. This is a query string parameter. |
Response:
| When successful, the response body contains a stream with the printed file. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
api/{tenantKey}/{orgKey}/contractManagement/contractCessationEarningModels/{contractCessationEarningModelKey}/print
GET /contractManagement/contractCessationEarningModels/{contractCessationEarningModelKey}/print
GET Original Print ContractCessationEarningModelOriginal by identifier
Prints the specified entity record.
The following elements are required:
| id | (string) The record identifier. |
The following elements are optional:
| template | (string) The report template that should be used. This is a query string parameter. |
Response:
| When successful, the response body contains a stream with the printed file. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 404 | NotFound. The specified resord does not exist. |
Resource URL:
api/{tenantKey}/{orgKey}/contractManagement/contractCessationEarningModels/{id}/printOriginal?template={template}
GET /contractManagement/contractCessationEarningModels/{id}/printOriginal?template={template}
GET Original Print ContractCessationEarningModel by key
Prints the specified entity record.
The following elements are required:
| contractCessationEarningModelKey | (string) Contract Cessation Earning Model. |
The following elements are optional:
| template | (string) The report template that should be used. This is a query string parameter. |
Response:
| When successful, the response body contains a stream with the printed file. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
api/{tenantKey}/{orgKey}/contractManagement/contractCessationEarningModels/{contractCessationEarningModelKey}/printOriginal
GET /contractManagement/contractCessationEarningModels/{contractCessationEarningModelKey}/printOriginal
POST ContractCessationEarningModels
Creates a new entity record.
The following elements are required:
| contractCessationEarningModelResource | (ApiContractCessationEarningModelResource) The request body should contain the entity record that should be created. See ApiContractCessationEarningModelResource. |
Response:
| When successful, the response body contains the new entity record identifier. The resource header location property contains the URL for the new entity record. See ApiContractCessationEarningModelResource. |
Response status codes:
| 201 | Created. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/contractManagement/contractCessationEarningModels
POST /contractManagement/contractCessationEarningModels
POST Contract Cessation Model
Inserts a new 'Contract Cessation Model Detail' in the 'Contract Cessation Model'.
The following elements are required:
| contractCessationEarningModelKey | (string) Contract Cessation Earning Model. |
| value | (ApiContractCessationEarningModelContractCessationEarningModelDetailsResource) The ApiContractCessationEarningModelContractCessationEarningModelDetailsResource instance. See ApiContractCessationEarningModelContractCessationEarningModelDetailsResource. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 204 | NoContent. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/contractManagement/contractCessationEarningModels/{contractCessationEarningModelKey}/contractCessationEarningModelDetails
POST /contractManagement/contractCessationEarningModels/{contractCessationEarningModelKey}/contractCessationEarningModelDetails
PUT Set ContractCessationEarningModelKey ContractCessationEarningModel
Updates the value of attribute 'ContractCessationEarningModelKey' in the specified entity record.
The following elements are required:
| contractCessationEarningModelKey | (string) Contract Cessation Earning Model. |
| value | (string) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/contractManagement/contractCessationEarningModels/{contractCessationEarningModelKey}/contractCessationEarningModelKey
PUT /contractManagement/contractCessationEarningModels/{contractCessationEarningModelKey}/contractCessationEarningModelKey
PUT Set Currency ContractCessationEarningModelDetail
Updates the value of attribute 'Currency' in the specified entity record.
The following elements are required:
| contractCessationEarningModelKey | (string) Contract Cessation Earning Model. |
| lineId | (string) The detail identifier. |
| value | (string) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/contractManagement/contractCessationEarningModels/{contractCessationEarningModelKey}/contractCessationEarningModelDetails/{lineId}/currency
PUT /contractManagement/contractCessationEarningModels/{contractCessationEarningModelKey}/contractCessationEarningModelDetails/{lineId}/currency
PUT Set Earning ContractCessationEarningModelDetail
Updates the value of attribute 'Earning' in the specified entity record.
The following elements are required:
| contractCessationEarningModelKey | (string) Contract Cessation Earning Model. |
| lineId | (string) The detail identifier. |
| value | (string) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/contractManagement/contractCessationEarningModels/{contractCessationEarningModelKey}/contractCessationEarningModelDetails/{lineId}/earning
PUT /contractManagement/contractCessationEarningModels/{contractCessationEarningModelKey}/contractCessationEarningModelDetails/{lineId}/earning
PUT Set IsActive ContractCessationEarningModel
Updates the value of attribute 'IsActive' in the specified entity record.
The following elements are required:
| contractCessationEarningModelKey | (string) Contract Cessation Earning Model. |
| value | (bool) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
api/{tenantKey}/{orgKey}/contractManagement/contractCessationEarningModels/{contractCessationEarningModelKey}/isActive
PUT /contractManagement/contractCessationEarningModels/{contractCessationEarningModelKey}/isActive
PUT Set LeavingReasons ContractCessationEarningModel
Updates the value of attribute 'LeavingReasons' in the specified entity record.
The following elements are required:
| contractCessationEarningModelKey | (string) Contract Cessation Earning Model. |
| value | (LeavingReason) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/contractManagement/contractCessationEarningModels/{contractCessationEarningModelKey}/leavingReasons
PUT /contractManagement/contractCessationEarningModels/{contractCessationEarningModelKey}/leavingReasons
PUT Set Name ContractCessationEarningModel
Updates the value of attribute 'Name' in the specified entity record.
The following elements are required:
| contractCessationEarningModelKey | (string) Contract Cessation Earning Model. |
| value | (string) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/contractManagement/contractCessationEarningModels/{contractCessationEarningModelKey}/name
PUT /contractManagement/contractCessationEarningModels/{contractCessationEarningModelKey}/name
PUT Set QuantityFormula ContractCessationEarningModelDetail
Updates the value of attribute 'QuantityFormula' in the specified entity record.
The following elements are required:
| contractCessationEarningModelKey | (string) Contract Cessation Earning Model. |
| lineId | (string) The detail identifier. |
| value | (string) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/contractManagement/contractCessationEarningModels/{contractCessationEarningModelKey}/contractCessationEarningModelDetails/{lineId}/quantityFormula
PUT /contractManagement/contractCessationEarningModels/{contractCessationEarningModelKey}/contractCessationEarningModelDetails/{lineId}/quantityFormula
PUT Set QuantityKind ContractCessationEarningModelDetail
Updates the value of attribute 'QuantityKind' in the specified entity record.
The following elements are required:
| contractCessationEarningModelKey | (string) Contract Cessation Earning Model. |
| lineId | (string) The detail identifier. |
| value | (enum QuantityKind) The request body should contain the new value for the attribute. See QuantityKind. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/contractManagement/contractCessationEarningModels/{contractCessationEarningModelKey}/contractCessationEarningModelDetails/{lineId}/quantityKind
PUT /contractManagement/contractCessationEarningModels/{contractCessationEarningModelKey}/contractCessationEarningModelDetails/{lineId}/quantityKind
PUT Set QuantityValue ContractCessationEarningModelDetail
Updates the value of attribute 'QuantityValue' in the specified entity record.
The following elements are required:
| contractCessationEarningModelKey | (string) Contract Cessation Earning Model. |
| lineId | (string) The detail identifier. |
| value | (decimal) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/contractManagement/contractCessationEarningModels/{contractCessationEarningModelKey}/contractCessationEarningModelDetails/{lineId}/quantityValue
PUT /contractManagement/contractCessationEarningModels/{contractCessationEarningModelKey}/contractCessationEarningModelDetails/{lineId}/quantityValue
PUT Set ValueFormula ContractCessationEarningModelDetail
Updates the value of attribute 'ValueFormula' in the specified entity record.
The following elements are required:
| contractCessationEarningModelKey | (string) Contract Cessation Earning Model. |
| lineId | (string) The detail identifier. |
| value | (string) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/contractManagement/contractCessationEarningModels/{contractCessationEarningModelKey}/contractCessationEarningModelDetails/{lineId}/valueFormula
PUT /contractManagement/contractCessationEarningModels/{contractCessationEarningModelKey}/contractCessationEarningModelDetails/{lineId}/valueFormula
PUT Set ValueKind ContractCessationEarningModelDetail
Updates the value of attribute 'ValueKind' in the specified entity record.
The following elements are required:
| contractCessationEarningModelKey | (string) Contract Cessation Earning Model. |
| lineId | (string) The detail identifier. |
| value | (enum EarningValueKind) The request body should contain the new value for the attribute. See EarningValueKind. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/contractManagement/contractCessationEarningModels/{contractCessationEarningModelKey}/contractCessationEarningModelDetails/{lineId}/valueKind
PUT /contractManagement/contractCessationEarningModels/{contractCessationEarningModelKey}/contractCessationEarningModelDetails/{lineId}/valueKind
PUT Set ValueMoney ContractCessationEarningModelDetail
Updates the value of attribute 'ValueMoney' in the specified entity record.
The following elements are required:
| contractCessationEarningModelKey | (string) Contract Cessation Earning Model. |
| lineId | (string) The detail identifier. |
| value | (decimal) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/contractManagement/contractCessationEarningModels/{contractCessationEarningModelKey}/contractCessationEarningModelDetails/{lineId}/valueMoney
PUT /contractManagement/contractCessationEarningModels/{contractCessationEarningModelKey}/contractCessationEarningModelDetails/{lineId}/valueMoney
DELETE Contract Cessation Model Detail by identifier
Deletes the entity record that matches the specified identifier.
The following elements are required:
| contractCessationEarningModelKey | (string) Contract Cessation Earning Model. |
| lineId | (string) The line identifier. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 204 | NoContent. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
api/{tenantKey}/{orgKey}/contractManagement/contractCessationEarningModels/{contractCessationEarningModelKey}/contractCessationEarningModelDetails/{lineId}
DELETE /contractManagement/contractCessationEarningModels/{contractCessationEarningModelKey}/contractCessationEarningModelDetails/{lineId}
DELETE ContractCessationEarningModel by identifier
Deletes the entity record that matches the specified identifier.
The following elements are required:
| id | (string) The record identifier. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 204 | Deleted. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
api/{tenantKey}/{orgKey}/contractManagement/contractCessationEarningModels/{id}
DELETE /contractManagement/contractCessationEarningModels/{id}
DELETE ContractCessationEarningModel by key
Deletes the entity record that matches the specified key.
The following elements are required:
| contractCessationEarningModelKey | (string) Contract Cessation Earning Model. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 204 | Deleted. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
api/{tenantKey}/{orgKey}/contractManagement/contractCessationEarningModels/{contractCessationEarningModelKey}
DELETE /contractManagement/contractCessationEarningModels/{contractCessationEarningModelKey}
Resources
ApiContractCessationEarningModelContractCessationEarningModelDetailsResource
The following elements are required:
| earning | (string) Earning. |
| valueMoney | (MoneyResource) Value Money.
See MoneyResource . |
| currency | (string) Currency. |
The following elements are optional:
| quantityKind | (enum QuantityKind) Quantity Kind.
See QuantityKind. |
| quantityValue | (decimal) Quantity Value. |
| quantityFormula | (string) Quantity Formula. |
| valueKind | (enum EarningValueKind) Value Kind.
See EarningValueKind. |
| valueFormula | (string) Value Formula. |
ApiContractCessationEarningModelResource
The following elements are required:
| contractCessationEarningModelKey | (string) Contract Cessation Earning Model. |
| name | (string) Name. |
The following elements are optional:
| contractCessationEarningModelDetails | (List of ApiContractCessationEarningModelContractCessationEarningModelDetailsResource) Cessation Earning Model Details.
See ApiContractCessationEarningModelContractCessationEarningModelDetailsResource. |
| leavingReasons | (LeavingReason) Leaving Reasons. |
ContractCessationEarningModelDetailResource
The following elements are required:
| earning | (string) Earning. |
| valueMoney | (MoneyResource) Value Money.
See MoneyResource . |
| currency | (string) Currency. |
The following elements are optional:
| quantityKind | (enum QuantityKind) Quantity Kind.
See QuantityKind. |
| quantityValue | (decimal) Quantity Value. |
| quantityFormula | (string) Quantity Formula. |
| valueKind | (enum EarningValueKind) Value Kind.
See EarningValueKind. |
| valueFormula | (string) Value Formula. |
ContractCessationEarningModelResource
The following elements are required:
| contractCessationEarningModelKey | (string) Contract Cessation Earning Model. |
| name | (string) Name. |
The following elements are optional:
| contractCessationEarningModelDetails | (List of ContractCessationEarningModelDetailResource) Cessation Earning Model Details.
See ContractCessationEarningModelDetailResource. |
| leavingReasons | (LeavingReason) Leaving Reasons. |
MoneyResource
The following elements are required:
| amount | (decimal) The amount. |
The following elements are optional:
| baseAmount | (decimal) The base amount. |
| reportingAmount | (decimal) The reporting amount. |
| fractionDigits | (int) The fraction digits. |
| symbol | (string) The symbol. |
Notes: For the POST operation it is not necessary to send the fields: BaseAmount, ReportingAmount, FractionDigits and Symbol. Will be ignored.