Contract Management | Deduction Model

Service to manage entities of type 'DeductionModel'.

Overview

api/{tenantKey}/{orgKey}/contractManagement/deductionModels

URL	api/{tenantKey}/{orgKey}/contractManagement/deductionModels
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

GET:
POST:
- POST DeductionModels
- POST Deduction Model
PUT:
DELETE:

All Resources

This service uses the following resources:

ApiDeductionModelDeductionModelDetailsResource
ApiDeductionModelResource
DeductionModelDetailResource
DeductionModelResource
MoneyResource

All Enumerations

This service uses the following enumerations:

ContractKind
DeductionValueKind

GET Operations

GET DeductionModels

Returns the list of all the entity records available.

Response:

When successful, the response body contains the list of records available. See DeductionModelResource.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/contractManagement/deductionModels

GET /contractManagement/deductionModels

GET DeductionModels (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 DeductionModelResource.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/contractManagement/deductionModels?page={page}&pageSize={pageSize}

GET /contractManagement/deductionModels?page={page}&pageSize={pageSize}

GET DeductionModel 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 DeductionModelResource.

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/deductionModels/{id}

GET /contractManagement/deductionModels/{id}

GET DeductionModel by key

Returns the entity record that matches the specified key.

The following elements are required:

deductionModelKey

(string) Deduction Model.

Response:

When successful, the response body contains the entity record. See DeductionModelResource.

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/deductionModels/{deductionModelKey}

GET /contractManagement/deductionModels/{deductionModelKey}

GET Print DeductionModel 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/deductionModels/{id}/print?template={template}

GET /contractManagement/deductionModels/{id}/print?template={template}

GET Print DeductionModel by key

Prints the specified entity record.

The following elements are required:

deductionModelKey

(string) Deduction 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/deductionModels/{deductionModelKey}/print

GET /contractManagement/deductionModels/{deductionModelKey}/print

GET Original Print DeductionModelOriginal 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/deductionModels/{id}/printOriginal?template={template}

GET /contractManagement/deductionModels/{id}/printOriginal?template={template}

GET Original Print DeductionModel by key

Prints the specified entity record.

The following elements are required:

deductionModelKey

(string) Deduction 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/deductionModels/{deductionModelKey}/printOriginal

GET /contractManagement/deductionModels/{deductionModelKey}/printOriginal

POST Operations

POST DeductionModels

Creates a new entity record.

The following elements are required:

deductionModelResource

(ApiDeductionModelResource) The request body should contain the entity record that should be created.
See ApiDeductionModelResource.

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 ApiDeductionModelResource.

Response status codes:

201	Created. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/contractManagement/deductionModels

POST /contractManagement/deductionModels

POST Deduction Model

Inserts a new 'Deduction Model Detail' in the 'Deduction Model'.

The following elements are required:

deductionModelKey	(string) Deduction Model.
value	(ApiDeductionModelDeductionModelDetailsResource) The ApiDeductionModelDeductionModelDetailsResource instance. See ApiDeductionModelDeductionModelDetailsResource.

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/deductionModels/{deductionModelKey}/deductionModelDetails

POST /contractManagement/deductionModels/{deductionModelKey}/deductionModelDetails

PUT Operations

PUT Set AppliesTo DeductionModel

Updates the value of attribute 'AppliesTo' in the specified entity record.

The following elements are required:

deductionModelKey	(string) Deduction Model.
value	(enum ContractKind) The request body should contain the new value for the attribute. See ContractKind.

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/deductionModels/{deductionModelKey}/appliesTo

PUT /contractManagement/deductionModels/{deductionModelKey}/appliesTo

PUT Set CalculationKind DeductionModelDetail

Updates the value of attribute 'CalculationKind' in the specified entity record.

The following elements are required:

deductionModelKey	(string) Deduction Model.
lineId	(string) The detail identifier.
value	(enum DeductionValueKind) The request body should contain the new value for the attribute. See DeductionValueKind.

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/deductionModels/{deductionModelKey}/deductionModelDetails/{lineId}/calculationKind

PUT /contractManagement/deductionModels/{deductionModelKey}/deductionModelDetails/{lineId}/calculationKind

PUT Set Currency DeductionModelDetail

Updates the value of attribute 'Currency' in the specified entity record.

The following elements are required:

deductionModelKey	(string) Deduction 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/deductionModels/{deductionModelKey}/deductionModelDetails/{lineId}/currency

PUT /contractManagement/deductionModels/{deductionModelKey}/deductionModelDetails/{lineId}/currency

PUT Set Deduction DeductionModelDetail

Updates the value of attribute 'Deduction' in the specified entity record.

The following elements are required:

deductionModelKey	(string) Deduction 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/deductionModels/{deductionModelKey}/deductionModelDetails/{lineId}/deduction

PUT /contractManagement/deductionModels/{deductionModelKey}/deductionModelDetails/{lineId}/deduction

PUT Set DeductionModelKey DeductionModel

Updates the value of attribute 'DeductionModelKey' in the specified entity record.

The following elements are required:

deductionModelKey	(string) Deduction 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/deductionModels/{deductionModelKey}/deductionModelKey

PUT /contractManagement/deductionModels/{deductionModelKey}/deductionModelKey

PUT Set EmployeeFormulaPercentage DeductionModelDetail

Updates the value of attribute 'EmployeeFormulaPercentage' in the specified entity record.

The following elements are required:

deductionModelKey	(string) Deduction 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/deductionModels/{deductionModelKey}/deductionModelDetails/{lineId}/employeeFormulaPercentage

PUT /contractManagement/deductionModels/{deductionModelKey}/deductionModelDetails/{lineId}/employeeFormulaPercentage

PUT Set EmployeeFormulaValue DeductionModelDetail

Updates the value of attribute 'EmployeeFormulaValue' in the specified entity record.

The following elements are required:

deductionModelKey	(string) Deduction 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/deductionModels/{deductionModelKey}/deductionModelDetails/{lineId}/employeeFormulaValue

PUT /contractManagement/deductionModels/{deductionModelKey}/deductionModelDetails/{lineId}/employeeFormulaValue

PUT Set EmployeePercentage DeductionModelDetail

Updates the value of attribute 'EmployeePercentage' in the specified entity record.

The following elements are required:

deductionModelKey	(string) Deduction 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/deductionModels/{deductionModelKey}/deductionModelDetails/{lineId}/employeePercentage

PUT /contractManagement/deductionModels/{deductionModelKey}/deductionModelDetails/{lineId}/employeePercentage

PUT Set EmployeeValue DeductionModelDetail

Updates the value of attribute 'EmployeeValue' in the specified entity record.

The following elements are required:

deductionModelKey	(string) Deduction 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/deductionModels/{deductionModelKey}/deductionModelDetails/{lineId}/employeeValue

PUT /contractManagement/deductionModels/{deductionModelKey}/deductionModelDetails/{lineId}/employeeValue

PUT Set IsActive DeductionModel

Updates the value of attribute 'IsActive' in the specified entity record.

The following elements are required:

deductionModelKey	(string) Deduction 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/deductionModels/{deductionModelKey}/isActive

PUT /contractManagement/deductionModels/{deductionModelKey}/isActive

PUT Set Name DeductionModel

Updates the value of attribute 'Name' in the specified entity record.

The following elements are required:

deductionModelKey	(string) Deduction 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/deductionModels/{deductionModelKey}/name

PUT /contractManagement/deductionModels/{deductionModelKey}/name

DELETE Operations

DELETE Deduction Model Detail by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

deductionModelKey	(string) Deduction 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/deductionModels/{deductionModelKey}/deductionModelDetails/{lineId}

DELETE /contractManagement/deductionModels/{deductionModelKey}/deductionModelDetails/{lineId}

DELETE DeductionModel 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/deductionModels/{id}

DELETE /contractManagement/deductionModels/{id}

DELETE DeductionModel by key

Deletes the entity record that matches the specified key.

The following elements are required:

deductionModelKey

(string) Deduction 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/deductionModels/{deductionModelKey}

DELETE /contractManagement/deductionModels/{deductionModelKey}

Resources

ApiDeductionModelDeductionModelDetailsResource

The following elements are required:

deduction	(string) Deduction.
employeeValue	(MoneyResource) Employee Value. See MoneyResource .
currency	(string) Currency.

The following elements are optional:

calculationKind	(enum DeductionValueKind) Calculation Kind. See DeductionValueKind.
employeePercentage	(decimal) Employee Percentage.
employeeFormulaValue	(string) Employee Formula Value.
employeeFormulaPercentage	(string) Employee Formula Percentage.

ApiDeductionModelResource

The following elements are required:

deductionModelKey	(string) Deduction Model.
name	(string) Name.
appliesTo	(enum ContractKind) Applicable to contracts of. See ContractKind.

The following elements are optional:

deductionModelDetails

(List of ApiDeductionModelDeductionModelDetailsResource) Deduction Model Details.
See ApiDeductionModelDeductionModelDetailsResource.

DeductionModelDetailResource

The following elements are required:

deduction	(string) Deduction.
employeeValue	(MoneyResource) Employee Value. See MoneyResource .
currency	(string) Currency.

The following elements are optional:

calculationKind	(enum DeductionValueKind) Calculation Kind. See DeductionValueKind.
employeePercentage	(decimal) Employee Percentage.
employeeFormulaValue	(string) Employee Formula Value.
employeeFormulaPercentage	(string) Employee Formula Percentage.

DeductionModelResource

The following elements are required:

deductionModelKey	(string) Deduction Model.
name	(string) Name.
appliesTo	(enum ContractKind) Applicable to contracts of. See ContractKind.

The following elements are optional:

deductionModelDetails

(List of DeductionModelDetailResource) Deduction Model Details.
See DeductionModelDetailResource.

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.

Enumerations

ContractKind

1	Employment
2	Service

DeductionValueKind

1	Money
2	Percentage
3	FormulaValue
4	FormulaPercentage