Payroll | Contract Cessation

Service to manage entities of type 'ContractCessation'.

Overview

api/{tenantKey}/{orgKey}/payrollCore/contractCessations

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

All Operations

This service includes the following operations:

GET:
POST:
- POST ContractCessations

All Resources

This service uses the following resources:

ApiContractCessationContractCessationEarningsResource
ApiContractCessationResource
ContractCessationEarningResource
ContractCessationResource
MoneyResource

All Enumerations

This service uses the following enumerations:

ContractState

GET Operations

GET ContractCessations

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollCore/contractCessations

GET /payrollCore/contractCessations

GET ContractCessations (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 ContractCessationResource.

Response status codes:

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

Resource URL:

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

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

GET ContractCessation 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 ContractCessationResource.

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

GET /payrollCore/contractCessations/{id}

GET ContractCessation by key

Returns the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
contractCessationKey	(string) Contract Cessation.

Response:

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

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/contractCessations/{companyKey}/{contractCessationKey}

GET /payrollCore/contractCessations/{companyKey}/{contractCessationKey}

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

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

GET Print ContractCessation by key

Prints the specified entity record.

The following elements are required:

companyKey	(string) The company key.
contractCessationKey	(string) Contract Cessation.

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/contractCessations/{companyKey}/{contractCessationKey}/print

GET /payrollCore/contractCessations/{companyKey}/{contractCessationKey}/print

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

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

GET Original Print ContractCessation by key

Prints the specified entity record.

The following elements are required:

companyKey	(string) The company key.
contractCessationKey	(string) Contract Cessation.

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/contractCessations/{companyKey}/{contractCessationKey}/printOriginal

GET /payrollCore/contractCessations/{companyKey}/{contractCessationKey}/printOriginal

POST Operations

POST ContractCessations

Creates a new entity record.

The following elements are required:

contractCessationResource

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

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollCore/contractCessations

POST /payrollCore/contractCessations

Resources

ApiContractCessationContractCessationEarningsResource

The following elements are required:

earning	(string) Earning.
quantityValue	(decimal) Quantity.
unitValueMoney	(decimal) Unit Value.
valueMoney	(MoneyResource) Value. See MoneyResource .
currency	(string) Currency.

ApiContractCessationResource

The following elements are required:

contractCessationKey	(string) Contract Cessation.
contract	(string) Contract.
leavingReason	(string) Leaving Reason.
date	(DateTime) Date.
company	(string) Company.

The following elements are optional:

remarks	(string) Remarks.
employee	(string) Employee.
contractCessationEarnings	(List of ApiContractCessationContractCessationEarningsResource) Contract Cessation Earnings. See ApiContractCessationContractCessationEarningsResource.
contractState	(enum ContractState) Contract State. See ContractState.

ContractCessationEarningResource

The following elements are required:

earning	(string) Earning.
quantityValue	(decimal) Quantity.
unitValueMoney	(decimal) Unit Value.
valueMoney	(MoneyResource) Value. See MoneyResource .
currency	(string) Currency.

ContractCessationResource

The following elements are required:

contractCessationKey	(string) Contract Cessation.
contract	(string) Contract. (fk) Allowed value: the natural key of a record of type Contract. These records are accessibly through the Contracts service.
leavingReason	(string) Leaving Reason. (fk) Allowed value: the natural key of a record of type LeavingReason. These records are accessibly through the LeavingReasons service.
date	(DateTime) Date.
company	(string) Company. (fk) Allowed value: the natural key of a record of type Company.

The following elements are optional:

remarks	(string) Remarks.
employee	(string) Employee. (fk) Allowed value: the natural key of a record of type Employee. These records are accessibly through the Employees service.
contractCessationEarnings	(List of ContractCessationEarningResource) Contract Cessation Earnings. See ContractCessationEarningResource.
contractState	(enum ContractState) Contract State. See ContractState.

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

ContractState

1	NewContract
2	Active
3	Aborted
4	Outgoing
5	Finished