Payroll | Contract Type

Service to manage entities of type 'ContractType'.

Overview

api/{tenantKey}/{orgKey}/payrollCore/contractTypes

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

All Operations

This service includes the following operations:

GET:
POST:
- POST ContractTypes
PUT:
DELETE:
- DELETE ContractType by identifier
- DELETE ContractType by key

All Resources

This service uses the following resources:

ApiContractTypeResource
ContractTypeResource

All Enumerations

This service uses the following enumerations:

ContractKind
TypeContract

GET Operations

GET ContractTypes

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollCore/contractTypes

GET /payrollCore/contractTypes

GET ContractTypes (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 ContractTypeResource.

Response status codes:

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

Resource URL:

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

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

GET ContractType 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 ContractTypeResource.

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

GET /payrollCore/contractTypes/{id}

GET ContractType by key

Returns the entity record that matches the specified key.

The following elements are required:

contractTypeKey

(string) Contract Type.

Response:

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

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/contractTypes/{contractTypeKey}

GET /payrollCore/contractTypes/{contractTypeKey}

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

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

GET Print ContractType by key

Prints the specified entity record.

The following elements are required:

contractTypeKey

(string) Contract Type.

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/contractTypes/{contractTypeKey}/print

GET /payrollCore/contractTypes/{contractTypeKey}/print

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

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

GET Original Print ContractType by key

Prints the specified entity record.

The following elements are required:

contractTypeKey

(string) Contract Type.

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/contractTypes/{contractTypeKey}/printOriginal

GET /payrollCore/contractTypes/{contractTypeKey}/printOriginal

POST Operations

POST ContractTypes

Creates a new entity record.

The following elements are required:

contractTypeResource

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

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollCore/contractTypes

POST /payrollCore/contractTypes

PUT Operations

PUT Set ContractKind ContractType

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

The following elements are required:

contractTypeKey	(string) Contract Type.
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}/payrollCore/contractTypes/{contractTypeKey}/contractKind

PUT /payrollCore/contractTypes/{contractTypeKey}/contractKind

PUT Set ContractTypeKey ContractType

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

The following elements are required:

contractTypeKey	(string) Contract Type.
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/contractTypes/{contractTypeKey}/contractTypeKey

PUT /payrollCore/contractTypes/{contractTypeKey}/contractTypeKey

PUT Set IsActive ContractType

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

The following elements are required:

contractTypeKey	(string) Contract Type.
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/contractTypes/{contractTypeKey}/isActive

PUT /payrollCore/contractTypes/{contractTypeKey}/isActive

PUT Set Name ContractType

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

The following elements are required:

contractTypeKey	(string) Contract Type.
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/contractTypes/{contractTypeKey}/name

PUT /payrollCore/contractTypes/{contractTypeKey}/name

PUT Set TypeContract ContractType

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

The following elements are required:

contractTypeKey	(string) Contract Type.
value	(enum TypeContract) The request body should contain the new value for the attribute. See TypeContract.

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/contractTypes/{contractTypeKey}/typeContract

PUT /payrollCore/contractTypes/{contractTypeKey}/typeContract

DELETE Operations

DELETE ContractType 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}/payrollCore/contractTypes/{id}

DELETE /payrollCore/contractTypes/{id}

DELETE ContractType by key

Deletes the entity record that matches the specified key.

The following elements are required:

contractTypeKey

(string) Contract Type.

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}/payrollCore/contractTypes/{contractTypeKey}

DELETE /payrollCore/contractTypes/{contractTypeKey}

Resources

ApiContractTypeResource

The following elements are required:

contractTypeKey	(string) Contract Type.
typeContract	(enum TypeContract) Type. See TypeContract.
contractKind	(enum ContractKind) Applicable to contracts of. See ContractKind.

The following elements are optional:

name	(string) Name.

ContractTypeResource

The following elements are required:

contractTypeKey	(string) Contract Type.
typeContract	(enum TypeContract) Type. See TypeContract.
contractKind	(enum ContractKind) Applicable to contracts of. See ContractKind.

The following elements are optional:

name	(string) Name.

Enumerations

ContractKind

1	Employment
2	Service

TypeContract

1	LimitedTerm
2	Permanent
3	OpenTerm