People | Deduction Account Type

Service to manage entities of type 'DeductionAccountType'.

Overview

api/{tenantKey}/{orgKey}/peopleCore/deductionAccountTypes

URL	api/{tenantKey}/{orgKey}/peopleCore/deductionAccountTypes
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

GET:
POST:
- POST DeductionAccountTypes
PUT:
DELETE:
- DELETE DeductionAccountType by identifier
- DELETE DeductionAccountType by key

All Resources

This service uses the following resources:

ApiDeductionAccountTypeResource
DeductionAccountTypeResource

GET Operations

GET DeductionAccountTypes

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/deductionAccountTypes

GET /peopleCore/deductionAccountTypes

GET DeductionAccountTypes (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 DeductionAccountTypeResource.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/deductionAccountTypes?page={page}&pageSize={pageSize}

GET /peopleCore/deductionAccountTypes?page={page}&pageSize={pageSize}

GET DeductionAccountType 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 DeductionAccountTypeResource.

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

GET /peopleCore/deductionAccountTypes/{id}

GET DeductionAccountType by key

Returns the entity record that matches the specified key.

The following elements are required:

deductionAccountTypeKey

(string) Deduction Account Type.

Response:

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

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}/peopleCore/deductionAccountTypes/{deductionAccountTypeKey}

GET /peopleCore/deductionAccountTypes/{deductionAccountTypeKey}

GET Print DeductionAccountType 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}/peopleCore/deductionAccountTypes/{id}/print?template={template}

GET /peopleCore/deductionAccountTypes/{id}/print?template={template}

GET Print DeductionAccountType by key

Prints the specified entity record.

The following elements are required:

deductionAccountTypeKey

(string) Deduction Account 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}/peopleCore/deductionAccountTypes/{deductionAccountTypeKey}/print

GET /peopleCore/deductionAccountTypes/{deductionAccountTypeKey}/print

GET Original Print DeductionAccountTypeOriginal 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}/peopleCore/deductionAccountTypes/{id}/printOriginal?template={template}

GET /peopleCore/deductionAccountTypes/{id}/printOriginal?template={template}

GET Original Print DeductionAccountType by key

Prints the specified entity record.

The following elements are required:

deductionAccountTypeKey

(string) Deduction Account 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}/peopleCore/deductionAccountTypes/{deductionAccountTypeKey}/printOriginal

GET /peopleCore/deductionAccountTypes/{deductionAccountTypeKey}/printOriginal

POST Operations

POST DeductionAccountTypes

Creates a new entity record.

The following elements are required:

deductionAccountTypeResource

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

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/peopleCore/deductionAccountTypes

POST /peopleCore/deductionAccountTypes

PUT Operations

PUT Set DeductionAccountTypeKey DeductionAccountType

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

The following elements are required:

deductionAccountTypeKey	(string) Deduction Account 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}/peopleCore/deductionAccountTypes/{deductionAccountTypeKey}/deductionAccountTypeKey

PUT /peopleCore/deductionAccountTypes/{deductionAccountTypeKey}/deductionAccountTypeKey

PUT Set Description DeductionAccountType

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

The following elements are required:

deductionAccountTypeKey	(string) Deduction Account 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}/peopleCore/deductionAccountTypes/{deductionAccountTypeKey}/description

PUT /peopleCore/deductionAccountTypes/{deductionAccountTypeKey}/description

PUT Set IsActive DeductionAccountType

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

The following elements are required:

deductionAccountTypeKey	(string) Deduction Account 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}/peopleCore/deductionAccountTypes/{deductionAccountTypeKey}/isActive

PUT /peopleCore/deductionAccountTypes/{deductionAccountTypeKey}/isActive

DELETE Operations

DELETE DeductionAccountType 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}/peopleCore/deductionAccountTypes/{id}

DELETE /peopleCore/deductionAccountTypes/{id}

DELETE DeductionAccountType by key

Deletes the entity record that matches the specified key.

The following elements are required:

deductionAccountTypeKey

(string) Deduction Account 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}/peopleCore/deductionAccountTypes/{deductionAccountTypeKey}

DELETE /peopleCore/deductionAccountTypes/{deductionAccountTypeKey}

Resources

ApiDeductionAccountTypeResource

The following elements are required:

deductionAccountTypeKey	(string) Deduction Account Type.
description	(string) Description.

DeductionAccountTypeResource

The following elements are required:

deductionAccountTypeKey	(string) Deduction Account Type.
description	(string) Description.