Payroll | Contract Execution History

Service to manage entities of type 'ContractExecutionHistory'.

Overview

api/{tenantKey}/{orgKey}/payrollCore/contractExecutionHistories

URL	api/{tenantKey}/{orgKey}/payrollCore/contractExecutionHistories
Methods Supported	GET, POST, PUT

All Operations

This service includes the following operations:

GET:
POST:
- POST ContractExecutionHistories
PUT:

All Resources

This service uses the following resources:

ApiContractExecutionHistoryResource
ContractExecutionHistoryResource

All Enumerations

This service uses the following enumerations:

ContractLineState
ContractState
ContractualDecision

GET Operations

GET ContractExecutionHistories

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollCore/contractExecutionHistories

GET /payrollCore/contractExecutionHistories

GET ContractExecutionHistories (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 ContractExecutionHistoryResource.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollCore/contractExecutionHistories?page={page}&pageSize={pageSize}

GET /payrollCore/contractExecutionHistories?page={page}&pageSize={pageSize}

GET ContractExecutionHistory 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 ContractExecutionHistoryResource.

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

GET /payrollCore/contractExecutionHistories/{id}

GET ContractExecutionHistory by key

Returns the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
contractExecutionHistoryKey	(string) Sequence.

Response:

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

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}/payrollCore/contractExecutionHistories/{companyKey}/{contractExecutionHistoryKey}

GET /payrollCore/contractExecutionHistories/{companyKey}/{contractExecutionHistoryKey}

GET Print ContractExecutionHistory 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}/payrollCore/contractExecutionHistories/{id}/print?template={template}

GET /payrollCore/contractExecutionHistories/{id}/print?template={template}

GET Print ContractExecutionHistory by key

Prints the specified entity record.

The following elements are required:

companyKey	(string) The company key.
contractExecutionHistoryKey	(string) Sequence.

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}/payrollCore/contractExecutionHistories/{companyKey}/{contractExecutionHistoryKey}/print

GET /payrollCore/contractExecutionHistories/{companyKey}/{contractExecutionHistoryKey}/print

GET Original Print ContractExecutionHistoryOriginal 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}/payrollCore/contractExecutionHistories/{id}/printOriginal?template={template}

GET /payrollCore/contractExecutionHistories/{id}/printOriginal?template={template}

GET Original Print ContractExecutionHistory by key

Prints the specified entity record.

The following elements are required:

companyKey	(string) The company key.
contractExecutionHistoryKey	(string) Sequence.

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}/payrollCore/contractExecutionHistories/{companyKey}/{contractExecutionHistoryKey}/printOriginal

GET /payrollCore/contractExecutionHistories/{companyKey}/{contractExecutionHistoryKey}/printOriginal

POST Operations

POST ContractExecutionHistories

Creates a new entity record.

The following elements are required:

contractExecutionHistoryResource

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

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollCore/contractExecutionHistories

POST /payrollCore/contractExecutionHistories

PUT Operations

PUT Set Company ContractExecutionHistory

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

The following elements are required:

contractExecutionHistoryKey	(string) Sequence.
companyKey	(string) The company key.
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}/payrollCore/contractExecutionHistories/{companyKey}/{contractExecutionHistoryKey}/company

PUT /payrollCore/contractExecutionHistories/{companyKey}/{contractExecutionHistoryKey}/company

PUT Set Contract ContractExecutionHistory

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

The following elements are required:

contractExecutionHistoryKey	(string) Sequence.
companyKey	(string) The company key.
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}/payrollCore/contractExecutionHistories/{companyKey}/{contractExecutionHistoryKey}/contract

PUT /payrollCore/contractExecutionHistories/{companyKey}/{contractExecutionHistoryKey}/contract

PUT Set ContractExecutionHistoryKey ContractExecutionHistory

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

The following elements are required:

contractExecutionHistoryKey	(string) Sequence.
companyKey	(string) The company key.
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}/payrollCore/contractExecutionHistories/{companyKey}/{contractExecutionHistoryKey}/contractExecutionHistoryKey

PUT /payrollCore/contractExecutionHistories/{companyKey}/{contractExecutionHistoryKey}/contractExecutionHistoryKey

PUT Set ContractualDecision ContractExecutionHistory

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

The following elements are required:

contractExecutionHistoryKey	(string) Sequence.
companyKey	(string) The company key.
value	(enum ContractualDecision) The request body should contain the new value for the attribute. See ContractualDecision.

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}/payrollCore/contractExecutionHistories/{companyKey}/{contractExecutionHistoryKey}/contractualDecision

PUT /payrollCore/contractExecutionHistories/{companyKey}/{contractExecutionHistoryKey}/contractualDecision

PUT Set IsActive ContractExecutionHistory

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

The following elements are required:

contractExecutionHistoryKey	(string) Sequence.
companyKey	(string) The company key.
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}/payrollCore/contractExecutionHistories/{companyKey}/{contractExecutionHistoryKey}/isActive

PUT /payrollCore/contractExecutionHistories/{companyKey}/{contractExecutionHistoryKey}/isActive

PUT Set NextStageDescription ContractExecutionHistory

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

The following elements are required:

contractExecutionHistoryKey	(string) Sequence.
companyKey	(string) The company key.
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}/payrollCore/contractExecutionHistories/{companyKey}/{contractExecutionHistoryKey}/nextStageDescription

PUT /payrollCore/contractExecutionHistories/{companyKey}/{contractExecutionHistoryKey}/nextStageDescription

PUT Set NextStageEstimatedEndDate ContractExecutionHistory

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

The following elements are required:

contractExecutionHistoryKey	(string) Sequence.
companyKey	(string) The company key.
value	(DateTime) 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}/payrollCore/contractExecutionHistories/{companyKey}/{contractExecutionHistoryKey}/nextStageEstimatedEndDate

PUT /payrollCore/contractExecutionHistories/{companyKey}/{contractExecutionHistoryKey}/nextStageEstimatedEndDate

PUT Set NextStageId ContractExecutionHistory

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

The following elements are required:

contractExecutionHistoryKey	(string) Sequence.
companyKey	(string) The company key.
value	(Guid) 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}/payrollCore/contractExecutionHistories/{companyKey}/{contractExecutionHistoryKey}/nextStageId

PUT /payrollCore/contractExecutionHistories/{companyKey}/{contractExecutionHistoryKey}/nextStageId

PUT Set NextStageLineNumber ContractExecutionHistory

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

The following elements are required:

contractExecutionHistoryKey	(string) Sequence.
companyKey	(string) The company key.
value	(int) 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}/payrollCore/contractExecutionHistories/{companyKey}/{contractExecutionHistoryKey}/nextStageLineNumber

PUT /payrollCore/contractExecutionHistories/{companyKey}/{contractExecutionHistoryKey}/nextStageLineNumber

PUT Set NextState ContractExecutionHistory

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

The following elements are required:

contractExecutionHistoryKey	(string) Sequence.
companyKey	(string) The company key.
value	(enum ContractLineState) The request body should contain the new value for the attribute. See ContractLineState.

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}/payrollCore/contractExecutionHistories/{companyKey}/{contractExecutionHistoryKey}/nextState

PUT /payrollCore/contractExecutionHistories/{companyKey}/{contractExecutionHistoryKey}/nextState

PUT Set Notes ContractExecutionHistory

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

The following elements are required:

contractExecutionHistoryKey	(string) Sequence.
companyKey	(string) The company key.
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}/payrollCore/contractExecutionHistories/{companyKey}/{contractExecutionHistoryKey}/notes

PUT /payrollCore/contractExecutionHistories/{companyKey}/{contractExecutionHistoryKey}/notes

PUT Set PrevContractState ContractExecutionHistory

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

The following elements are required:

contractExecutionHistoryKey	(string) Sequence.
companyKey	(string) The company key.
value	(enum ContractState) The request body should contain the new value for the attribute. See ContractState.

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}/payrollCore/contractExecutionHistories/{companyKey}/{contractExecutionHistoryKey}/prevContractState

PUT /payrollCore/contractExecutionHistories/{companyKey}/{contractExecutionHistoryKey}/prevContractState

PUT Set PrevStageDescription ContractExecutionHistory

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

The following elements are required:

contractExecutionHistoryKey	(string) Sequence.
companyKey	(string) The company key.
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}/payrollCore/contractExecutionHistories/{companyKey}/{contractExecutionHistoryKey}/prevStageDescription

PUT /payrollCore/contractExecutionHistories/{companyKey}/{contractExecutionHistoryKey}/prevStageDescription

PUT Set PrevStageEndDate ContractExecutionHistory

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

The following elements are required:

contractExecutionHistoryKey	(string) Sequence.
companyKey	(string) The company key.
value	(DateTime) 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}/payrollCore/contractExecutionHistories/{companyKey}/{contractExecutionHistoryKey}/prevStageEndDate

PUT /payrollCore/contractExecutionHistories/{companyKey}/{contractExecutionHistoryKey}/prevStageEndDate

PUT Set PrevStageEndDateEfective ContractExecutionHistory

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

The following elements are required:

contractExecutionHistoryKey	(string) Sequence.
companyKey	(string) The company key.
value	(DateTime) 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}/payrollCore/contractExecutionHistories/{companyKey}/{contractExecutionHistoryKey}/prevStageEndDateEfective

PUT /payrollCore/contractExecutionHistories/{companyKey}/{contractExecutionHistoryKey}/prevStageEndDateEfective

PUT Set PrevStageId ContractExecutionHistory

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

The following elements are required:

contractExecutionHistoryKey	(string) Sequence.
companyKey	(string) The company key.
value	(Guid) 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}/payrollCore/contractExecutionHistories/{companyKey}/{contractExecutionHistoryKey}/prevStageId

PUT /payrollCore/contractExecutionHistories/{companyKey}/{contractExecutionHistoryKey}/prevStageId

PUT Set PrevStageLineNumber ContractExecutionHistory

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

The following elements are required:

contractExecutionHistoryKey	(string) Sequence.
companyKey	(string) The company key.
value	(int) 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}/payrollCore/contractExecutionHistories/{companyKey}/{contractExecutionHistoryKey}/prevStageLineNumber

PUT /payrollCore/contractExecutionHistories/{companyKey}/{contractExecutionHistoryKey}/prevStageLineNumber

PUT Set PrevState ContractExecutionHistory

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

The following elements are required:

contractExecutionHistoryKey	(string) Sequence.
companyKey	(string) The company key.
value	(enum ContractLineState) The request body should contain the new value for the attribute. See ContractLineState.

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}/payrollCore/contractExecutionHistories/{companyKey}/{contractExecutionHistoryKey}/prevState

PUT /payrollCore/contractExecutionHistories/{companyKey}/{contractExecutionHistoryKey}/prevState

PUT Set PrevStateEffective ContractExecutionHistory

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

The following elements are required:

contractExecutionHistoryKey	(string) Sequence.
companyKey	(string) The company key.
value	(enum ContractLineState) The request body should contain the new value for the attribute. See ContractLineState.

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}/payrollCore/contractExecutionHistories/{companyKey}/{contractExecutionHistoryKey}/prevStateEffective

PUT /payrollCore/contractExecutionHistories/{companyKey}/{contractExecutionHistoryKey}/prevStateEffective

Resources

ApiContractExecutionHistoryResource

The following elements are required:

contractExecutionHistoryKey	(string) Sequence.
contract	(string) Contract.

The following elements are optional:

company	(string) Company.
contractualDecision	(enum ContractualDecision) Contractual Decision. See ContractualDecision.
prevContractState	(enum ContractState) Prev. Contract State. See ContractState.
prevStageLineNumber	(int) Prev. Stage Line Number.
prevStageId	(Guid) Prev Stage.
prevStageDescription	(string) Prev. Stage Description.
prevStageEndDate	(DateTime) Prev. Stage End Date.
prevStageEndDateEfective	(DateTime) Prev. Effec. Stage End Date.
prevState	(enum ContractLineState) Prev. Stage State. See ContractLineState.
prevStateEffective	(enum ContractLineState) Prev. Effec. Stage State. See ContractLineState.
nextStageLineNumber	(int) Next Stage Line Number.
nextStageId	(Guid) Next Stage.
nextStageDescription	(string) Next Stage Description.
nextStageEstimatedEndDate	(DateTime) Next Stage Estimated End Date.
nextState	(enum ContractLineState) Next Stage State. See ContractLineState.
notes	(string) Notes.

ContractExecutionHistoryResource

The following elements are required:

contractExecutionHistoryKey	(string) Sequence.
contract	(string) Contract. (fk) Allowed value: the natural key of a record of type Contract. These records are accessibly through the Contracts service.

The following elements are optional:

company	(string) Company. (fk) Allowed value: the natural key of a record of type Company.
contractualDecision	(enum ContractualDecision) Contractual Decision. See ContractualDecision.
prevContractState	(enum ContractState) Prev. Contract State. See ContractState.
prevStageLineNumber	(int) Prev. Stage Line Number.
prevStageId	(Guid) Prev Stage.
prevStageDescription	(string) Prev. Stage Description.
prevStageEndDate	(DateTime) Prev. Stage End Date.
prevStageEndDateEfective	(DateTime) Prev. Effec. Stage End Date.
prevState	(enum ContractLineState) Prev. Stage State. See ContractLineState.
prevStateEffective	(enum ContractLineState) Prev. Effec. Stage State. See ContractLineState.
nextStageLineNumber	(int) Next Stage Line Number.
nextStageId	(Guid) Next Stage.
nextStageDescription	(string) Next Stage Description.
nextStageEstimatedEndDate	(DateTime) Next Stage Estimated End Date.
nextState	(enum ContractLineState) Next Stage State. See ContractLineState.
notes	(string) Notes.
employee	(string) Employee. (fk) Allowed value: the natural key of a record of type Employee. These records are accessibly through the Employees service.

Enumerations

ContractLineState

1	Scheduled
2	Active
3	Executed
4	Aborted
5	Skipped

ContractState

1	NewContract
2	Active
3	Aborted
4	Outgoing
5	Finished

ContractualDecision

1	Activate
2	Renew
3	MakePermanent
4	Cessation
5	Abort
6	Finished