Contract Management | Earning Model

Service to manage entities of type 'EarningModel'.

Overview

api/{tenantKey}/{orgKey}/contractManagement/earningModels

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

All Operations

This service includes the following operations:

GET:
POST:
- POST EarningModels
- POST Earning Model
PUT:
DELETE:

All Resources

This service uses the following resources:

ApiEarningModelEarningModelDetailsResource
ApiEarningModelResource
EarningModelDetailResource
EarningModelResource
MoneyResource

All Enumerations

This service uses the following enumerations:

ContractKind
EarningValueKind
QuantityKind

GET Operations

GET EarningModels

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/contractManagement/earningModels

GET /contractManagement/earningModels

GET EarningModels (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 EarningModelResource.

Response status codes:

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

Resource URL:

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

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

GET EarningModel 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 EarningModelResource.

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

GET /contractManagement/earningModels/{id}

GET EarningModel by key

Returns the entity record that matches the specified key.

The following elements are required:

earningModelKey

(string) Earning Model.

Response:

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

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/earningModels/{earningModelKey}

GET /contractManagement/earningModels/{earningModelKey}

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

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

GET Print EarningModel by key

Prints the specified entity record.

The following elements are required:

earningModelKey

(string) 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/earningModels/{earningModelKey}/print

GET /contractManagement/earningModels/{earningModelKey}/print

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

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

GET Original Print EarningModel by key

Prints the specified entity record.

The following elements are required:

earningModelKey

(string) 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/earningModels/{earningModelKey}/printOriginal

GET /contractManagement/earningModels/{earningModelKey}/printOriginal

POST Operations

POST EarningModels

Creates a new entity record.

The following elements are required:

earningModelResource

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

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/contractManagement/earningModels

POST /contractManagement/earningModels

POST Earning Model

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

The following elements are required:

earningModelKey	(string) Earning Model.
value	(ApiEarningModelEarningModelDetailsResource) The ApiEarningModelEarningModelDetailsResource instance. See ApiEarningModelEarningModelDetailsResource.

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/earningModels/{earningModelKey}/earningModelDetails

POST /contractManagement/earningModels/{earningModelKey}/earningModelDetails

PUT Operations

PUT Set AppliesTo EarningModel

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

The following elements are required:

earningModelKey	(string) Earning 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/earningModels/{earningModelKey}/appliesTo

PUT /contractManagement/earningModels/{earningModelKey}/appliesTo

PUT Set Currency EarningModelDetail

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

The following elements are required:

earningModelKey	(string) 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/earningModels/{earningModelKey}/earningModelDetails/{lineId}/currency

PUT /contractManagement/earningModels/{earningModelKey}/earningModelDetails/{lineId}/currency

PUT Set Earning EarningModelDetail

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

The following elements are required:

earningModelKey	(string) 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/earningModels/{earningModelKey}/earningModelDetails/{lineId}/earning

PUT /contractManagement/earningModels/{earningModelKey}/earningModelDetails/{lineId}/earning

PUT Set EarningModelKey EarningModel

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

The following elements are required:

earningModelKey	(string) 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/earningModels/{earningModelKey}/earningModelKey

PUT /contractManagement/earningModels/{earningModelKey}/earningModelKey

PUT Set IsActive EarningModel

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

The following elements are required:

earningModelKey	(string) 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/earningModels/{earningModelKey}/isActive

PUT /contractManagement/earningModels/{earningModelKey}/isActive

PUT Set Name EarningModel

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

The following elements are required:

earningModelKey	(string) 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/earningModels/{earningModelKey}/name

PUT /contractManagement/earningModels/{earningModelKey}/name

PUT Set QuantityFormula EarningModelDetail

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

The following elements are required:

earningModelKey	(string) 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/earningModels/{earningModelKey}/earningModelDetails/{lineId}/quantityFormula

PUT /contractManagement/earningModels/{earningModelKey}/earningModelDetails/{lineId}/quantityFormula

PUT Set QuantityKind EarningModelDetail

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

The following elements are required:

earningModelKey	(string) 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/earningModels/{earningModelKey}/earningModelDetails/{lineId}/quantityKind

PUT /contractManagement/earningModels/{earningModelKey}/earningModelDetails/{lineId}/quantityKind

PUT Set QuantityValue EarningModelDetail

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

The following elements are required:

earningModelKey	(string) 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/earningModels/{earningModelKey}/earningModelDetails/{lineId}/quantityValue

PUT /contractManagement/earningModels/{earningModelKey}/earningModelDetails/{lineId}/quantityValue

PUT Set ValueFormula EarningModelDetail

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

The following elements are required:

earningModelKey	(string) 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/earningModels/{earningModelKey}/earningModelDetails/{lineId}/valueFormula

PUT /contractManagement/earningModels/{earningModelKey}/earningModelDetails/{lineId}/valueFormula

PUT Set ValueKind EarningModelDetail

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

The following elements are required:

earningModelKey	(string) 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/earningModels/{earningModelKey}/earningModelDetails/{lineId}/valueKind

PUT /contractManagement/earningModels/{earningModelKey}/earningModelDetails/{lineId}/valueKind

PUT Set ValueMoney EarningModelDetail

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

The following elements are required:

earningModelKey	(string) 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/earningModels/{earningModelKey}/earningModelDetails/{lineId}/valueMoney

PUT /contractManagement/earningModels/{earningModelKey}/earningModelDetails/{lineId}/valueMoney

DELETE Operations

DELETE Earning Model Detail by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

earningModelKey	(string) 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/earningModels/{earningModelKey}/earningModelDetails/{lineId}

DELETE /contractManagement/earningModels/{earningModelKey}/earningModelDetails/{lineId}

DELETE EarningModel 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/earningModels/{id}

DELETE /contractManagement/earningModels/{id}

DELETE EarningModel by key

Deletes the entity record that matches the specified key.

The following elements are required:

earningModelKey

(string) 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/earningModels/{earningModelKey}

DELETE /contractManagement/earningModels/{earningModelKey}

Resources

ApiEarningModelEarningModelDetailsResource

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.

ApiEarningModelResource

The following elements are required:

earningModelKey	(string) Earning Model.
name	(string) Name.
appliesTo	(enum ContractKind) Applicable to contracts of. See ContractKind.

The following elements are optional:

earningModelDetails

(List of ApiEarningModelEarningModelDetailsResource) Earning Model Details.
See ApiEarningModelEarningModelDetailsResource.

EarningModelDetailResource

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.

EarningModelResource

The following elements are required:

earningModelKey	(string) Earning Model.
name	(string) Name.
appliesTo	(enum ContractKind) Applicable to contracts of. See ContractKind.

The following elements are optional:

earningModelDetails

(List of EarningModelDetailResource) Earning Model Details.
See EarningModelDetailResource.

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

EarningValueKind

1	Money
2	Formula

QuantityKind

1	Value
2	Formula