Payroll | Deduction

Service to manage entities of type 'Deduction'.

Overview

api/{tenantKey}/{orgKey}/payrollCore/deductions

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

All Operations

This service includes the following operations:

GET:
POST:
PUT:
DELETE:

All Resources

This service uses the following resources:

ApiDeductionPeriodDeductionsResource
ApiDeductionResource
ApiDeductionTagsResource
DeductionResource
DeductionTagResource
MoneyResource
PeriodDeductionResource

All Enumerations

This service uses the following enumerations:

ContractKind
DeductionValueKind
EarningDeductionGroup
RoundingKind

GET Operations

GET Deductions

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollCore/deductions

GET /payrollCore/deductions

GET Deductions (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 DeductionResource.

Response status codes:

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

Resource URL:

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

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

GET Deduction 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 DeductionResource.

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

GET /payrollCore/deductions/{id}

GET Deduction by key

Returns the entity record that matches the specified key.

The following elements are required:

deductionKey

(string) Deduction.

Response:

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

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/deductions/{deductionKey}

GET /payrollCore/deductions/{deductionKey}

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

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

GET Print Deduction by key

Prints the specified entity record.

The following elements are required:

deductionKey

(string) Deduction.

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/deductions/{deductionKey}/print

GET /payrollCore/deductions/{deductionKey}/print

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

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

GET Original Print Deduction by key

Prints the specified entity record.

The following elements are required:

deductionKey

(string) Deduction.

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/deductions/{deductionKey}/printOriginal

GET /payrollCore/deductions/{deductionKey}/printOriginal

GET Get Mandatory Deductions

Custom operation 'GetMandatoryDeductions'.

Response:

When successful, the response body contains a list of resources of type 'DeductionResource'. See DeductionResource.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollCore/deductions/getMandatoryDeductions

GET /payrollCore/deductions/getMandatoryDeductions

GET Get Deductions By Entity

Custom operation 'GetDeductionsByEntity'.

The following elements are required:

entityKey

(IEnumerable) EntityKey.

Response:

When successful, the response body contains a list of unique identifiers.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollCore/deductions/getDeductionsByEntity

GET /payrollCore/deductions/getDeductionsByEntity

POST Operations

POST Deductions

Creates a new entity record.

The following elements are required:

deductionResource

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

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollCore/deductions

POST /payrollCore/deductions

POST Deduction

Inserts a new 'Period Deduction' in the 'Deduction'.

The following elements are required:

deductionKey	(string) Deduction.
value	(ApiDeductionPeriodDeductionsResource) The ApiDeductionPeriodDeductionsResource instance. See ApiDeductionPeriodDeductionsResource.

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}/payrollCore/deductions/{deductionKey}/periodDeductions

POST /payrollCore/deductions/{deductionKey}/periodDeductions

POST Deduction

Inserts a new 'Deduction Tag' in the 'Deduction'.

The following elements are required:

deductionKey	(string) Deduction.
value	(ApiDeductionTagsResource) The ApiDeductionTagsResource instance. See ApiDeductionTagsResource.

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}/payrollCore/deductions/{deductionKey}/tags

POST /payrollCore/deductions/{deductionKey}/tags

PUT Operations

PUT Set AppliesCompany PeriodDeduction

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

The following elements are required:

deductionKey	(string) Deduction.
lineId	(string) The detail identifier.
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.

Resource URL:

api/{tenantKey}/{orgKey}/payrollCore/deductions/{deductionKey}/periodDeductions/{lineId}/appliesCompany

PUT /payrollCore/deductions/{deductionKey}/periodDeductions/{lineId}/appliesCompany

PUT Set AppliesEmployee PeriodDeduction

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

The following elements are required:

deductionKey	(string) Deduction.
lineId	(string) The detail identifier.
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.

Resource URL:

api/{tenantKey}/{orgKey}/payrollCore/deductions/{deductionKey}/periodDeductions/{lineId}/appliesEmployee

PUT /payrollCore/deductions/{deductionKey}/periodDeductions/{lineId}/appliesEmployee

PUT Set CompanyFormulaPercentage PeriodDeduction

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

The following elements are required:

deductionKey	(string) Deduction.
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}/payrollCore/deductions/{deductionKey}/periodDeductions/{lineId}/companyFormulaPercentage

PUT /payrollCore/deductions/{deductionKey}/periodDeductions/{lineId}/companyFormulaPercentage

PUT Set CompanyFormulaValue PeriodDeduction

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

The following elements are required:

deductionKey	(string) Deduction.
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}/payrollCore/deductions/{deductionKey}/periodDeductions/{lineId}/companyFormulaValue

PUT /payrollCore/deductions/{deductionKey}/periodDeductions/{lineId}/companyFormulaValue

PUT Set CompanyMaxValue PeriodDeduction

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

The following elements are required:

deductionKey	(string) Deduction.
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}/payrollCore/deductions/{deductionKey}/periodDeductions/{lineId}/companyMaxValue

PUT /payrollCore/deductions/{deductionKey}/periodDeductions/{lineId}/companyMaxValue

PUT Set CompanyMinValue PeriodDeduction

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

The following elements are required:

deductionKey	(string) Deduction.
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}/payrollCore/deductions/{deductionKey}/periodDeductions/{lineId}/companyMinValue

PUT /payrollCore/deductions/{deductionKey}/periodDeductions/{lineId}/companyMinValue

PUT Set CompanyPercentage PeriodDeduction

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

The following elements are required:

deductionKey	(string) Deduction.
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}/payrollCore/deductions/{deductionKey}/periodDeductions/{lineId}/companyPercentage

PUT /payrollCore/deductions/{deductionKey}/periodDeductions/{lineId}/companyPercentage

PUT Set CompanyValue PeriodDeduction

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

The following elements are required:

deductionKey	(string) Deduction.
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}/payrollCore/deductions/{deductionKey}/periodDeductions/{lineId}/companyValue

PUT /payrollCore/deductions/{deductionKey}/periodDeductions/{lineId}/companyValue

PUT Set ContrTaxBracket Deduction

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

The following elements are required:

deductionKey	(string) Deduction.
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.

Resource URL:

api/{tenantKey}/{orgKey}/payrollCore/deductions/{deductionKey}/contrTaxBracket

PUT /payrollCore/deductions/{deductionKey}/contrTaxBracket

PUT Set Currency PeriodDeduction

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

The following elements are required:

deductionKey	(string) Deduction.
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}/payrollCore/deductions/{deductionKey}/periodDeductions/{lineId}/currency

PUT /payrollCore/deductions/{deductionKey}/periodDeductions/{lineId}/currency

PUT Set DeductionAccountType Deduction

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

The following elements are required:

deductionKey	(string) Deduction.
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/deductions/{deductionKey}/deductionAccountType

PUT /payrollCore/deductions/{deductionKey}/deductionAccountType

PUT Set DeductionKey Deduction

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

The following elements are required:

deductionKey	(string) Deduction.
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/deductions/{deductionKey}/deductionKey

PUT /payrollCore/deductions/{deductionKey}/deductionKey

PUT Set DeductionValueKind PeriodDeduction

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

The following elements are required:

deductionKey	(string) Deduction.
lineId	(string) The detail identifier.
value	(enum DeductionValueKind) The request body should contain the new value for the attribute. See DeductionValueKind.

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/deductions/{deductionKey}/periodDeductions/{lineId}/deductionValueKind

PUT /payrollCore/deductions/{deductionKey}/periodDeductions/{lineId}/deductionValueKind

PUT Set EmployeeFormulaPercentage PeriodDeduction

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

The following elements are required:

deductionKey	(string) Deduction.
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}/payrollCore/deductions/{deductionKey}/periodDeductions/{lineId}/employeeFormulaPercentage

PUT /payrollCore/deductions/{deductionKey}/periodDeductions/{lineId}/employeeFormulaPercentage

PUT Set EmployeeFormulaValue PeriodDeduction

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

The following elements are required:

deductionKey	(string) Deduction.
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}/payrollCore/deductions/{deductionKey}/periodDeductions/{lineId}/employeeFormulaValue

PUT /payrollCore/deductions/{deductionKey}/periodDeductions/{lineId}/employeeFormulaValue

PUT Set EmployeeMaxValue PeriodDeduction

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

The following elements are required:

deductionKey	(string) Deduction.
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}/payrollCore/deductions/{deductionKey}/periodDeductions/{lineId}/employeeMaxValue

PUT /payrollCore/deductions/{deductionKey}/periodDeductions/{lineId}/employeeMaxValue

PUT Set EmployeeMinValue PeriodDeduction

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

The following elements are required:

deductionKey	(string) Deduction.
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}/payrollCore/deductions/{deductionKey}/periodDeductions/{lineId}/employeeMinValue

PUT /payrollCore/deductions/{deductionKey}/periodDeductions/{lineId}/employeeMinValue

PUT Set EmployeePercentage PeriodDeduction

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

The following elements are required:

deductionKey	(string) Deduction.
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}/payrollCore/deductions/{deductionKey}/periodDeductions/{lineId}/employeePercentage

PUT /payrollCore/deductions/{deductionKey}/periodDeductions/{lineId}/employeePercentage

PUT Set EmployeeValue PeriodDeduction

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

The following elements are required:

deductionKey	(string) Deduction.
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}/payrollCore/deductions/{deductionKey}/periodDeductions/{lineId}/employeeValue

PUT /payrollCore/deductions/{deductionKey}/periodDeductions/{lineId}/employeeValue

PUT Set EndPeriod PeriodDeduction

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

The following elements are required:

deductionKey	(string) Deduction.
lineId	(string) The detail identifier.
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/deductions/{deductionKey}/periodDeductions/{lineId}/endPeriod

PUT /payrollCore/deductions/{deductionKey}/periodDeductions/{lineId}/endPeriod

PUT Set Entity Deduction

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

The following elements are required:

deductionKey	(string) Deduction.
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/deductions/{deductionKey}/entity

PUT /payrollCore/deductions/{deductionKey}/entity

PUT Set IsActive Deduction

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

The following elements are required:

deductionKey	(string) Deduction.
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/deductions/{deductionKey}/isActive

PUT /payrollCore/deductions/{deductionKey}/isActive

PUT Set IsEditableContrTaxBracket Deduction

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

The following elements are required:

deductionKey	(string) Deduction.
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.

Resource URL:

api/{tenantKey}/{orgKey}/payrollCore/deductions/{deductionKey}/isEditableContrTaxBracket

PUT /payrollCore/deductions/{deductionKey}/isEditableContrTaxBracket

PUT Set IsMandatory Deduction

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

The following elements are required:

deductionKey	(string) Deduction.
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.

Resource URL:

api/{tenantKey}/{orgKey}/payrollCore/deductions/{deductionKey}/isMandatory

PUT /payrollCore/deductions/{deductionKey}/isMandatory

PUT Set Name Deduction

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

The following elements are required:

deductionKey	(string) Deduction.
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/deductions/{deductionKey}/name

PUT /payrollCore/deductions/{deductionKey}/name

PUT Set PaymentMethod Deduction

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

The following elements are required:

deductionKey	(string) Deduction.
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/deductions/{deductionKey}/paymentMethod

PUT /payrollCore/deductions/{deductionKey}/paymentMethod

PUT Set PaymentTerm Deduction

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

The following elements are required:

deductionKey	(string) Deduction.
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/deductions/{deductionKey}/paymentTerm

PUT /payrollCore/deductions/{deductionKey}/paymentTerm

PUT Set Policy Deduction

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

The following elements are required:

deductionKey	(string) Deduction.
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/deductions/{deductionKey}/policy

PUT /payrollCore/deductions/{deductionKey}/policy

PUT Set StartPeriod PeriodDeduction

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

The following elements are required:

deductionKey	(string) Deduction.
lineId	(string) The detail identifier.
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/deductions/{deductionKey}/periodDeductions/{lineId}/startPeriod

PUT /payrollCore/deductions/{deductionKey}/periodDeductions/{lineId}/startPeriod

PUT Set Tag DeductionTag

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

The following elements are required:

deductionKey	(string) Deduction.
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}/payrollCore/deductions/{deductionKey}/tags/{lineId}/tag

PUT /payrollCore/deductions/{deductionKey}/tags/{lineId}/tag

PUT Set TagView Deduction

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

The following elements are required:

deductionKey	(string) Deduction.
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/deductions/{deductionKey}/tagView

PUT /payrollCore/deductions/{deductionKey}/tagView

DELETE Operations

DELETE Period Deduction by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

deductionKey	(string) Deduction.
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}/payrollCore/deductions/{deductionKey}/periodDeductions/{lineId}

DELETE /payrollCore/deductions/{deductionKey}/periodDeductions/{lineId}

DELETE Deduction Tag by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

deductionKey	(string) Deduction.
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}/payrollCore/deductions/{deductionKey}/tags/{lineId}

DELETE /payrollCore/deductions/{deductionKey}/tags/{lineId}

DELETE Deduction 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/deductions/{id}

DELETE /payrollCore/deductions/{id}

DELETE Deduction by key

Deletes the entity record that matches the specified key.

The following elements are required:

deductionKey

(string) Deduction.

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/deductions/{deductionKey}

DELETE /payrollCore/deductions/{deductionKey}

Resources

ApiDeductionPeriodDeductionsResource

The following elements are required:

startPeriod	(DateTime) Start Period.
deductionValueKind	(enum DeductionValueKind) Value Kind. See DeductionValueKind.
appliesEmployee	(bool) Applies.
employeeValue	(MoneyResource) Employee Value. See MoneyResource .
employeePercentage	(decimal) Employee Percentage.
employeeMinValue	(MoneyResource) Minimum Value. See MoneyResource .
employeeMaxValue	(MoneyResource) Maximum Value. See MoneyResource .
appliesCompany	(bool) Applies.
companyValue	(MoneyResource) Company Value. See MoneyResource .
companyPercentage	(decimal) Company Percentage.
companyMinValue	(MoneyResource) Minimum Value. See MoneyResource .
companyMaxValue	(MoneyResource) Maximum Value. See MoneyResource .
currency	(string) Currency.

The following elements are optional:

endPeriod	(DateTime) End Period.
employeeFormulaValue	(string) Employee Formula Value.
companyFormulaValue	(string) Company Formula Value.
employeeFormulaPercentage	(string) Employee Formula Percentage.
companyFormulaPercentage	(string) Company Formula Percentage.

ApiDeductionResource

The following elements are required:

deductionKey	(string) Deduction.
name	(string) Name.
isMandatory	(bool) Is Mandatory.
contrTaxBracket	(bool) Calculation by Bracket.
isEditableContrTaxBracket	(bool) Is Editable.
deductionAccountType	(string) Deduction Account Type.
paymentMethod	(string) Payment Method.
paymentTerm	(string) Payment Term.
contractKind	(enum ContractKind) Applicable to contracts of. See ContractKind.

The following elements are optional:

periodDeductions	(List of ApiDeductionPeriodDeductionsResource) Period Deductions. See ApiDeductionPeriodDeductionsResource.
earningDeductionGroup	(enum EarningDeductionGroup) Earning Deduction Group. See EarningDeductionGroup.
rounding	(enum RoundingKind) Rounding. See RoundingKind.
entity	(string) Entity.
policy	(string) Policy.
tags	(List of ApiDeductionTagsResource) Tags. See ApiDeductionTagsResource.
tagView	(string) Tag View.

ApiDeductionTagsResource

The following elements are required:

tag	(string) Tag.

DeductionResource

The following elements are required:

deductionKey	(string) Deduction.
name	(string) Name.
isMandatory	(bool) Is Mandatory.
contrTaxBracket	(bool) Calculation by Bracket.
isEditableContrTaxBracket	(bool) Is Editable.
deductionAccountType	(string) Deduction Account Type.
paymentMethod	(string) Payment Method.
paymentTerm	(string) Payment Term.
contractKind	(enum ContractKind) Applicable to contracts of. See ContractKind.

The following elements are optional:

periodDeductions	(List of PeriodDeductionResource) Period Deductions. See PeriodDeductionResource.
earningDeductionGroup	(enum EarningDeductionGroup) Earning Deduction Group. See EarningDeductionGroup.
rounding	(enum RoundingKind) Rounding. See RoundingKind.
entity	(string) Entity.
policy	(string) Policy.
tags	(List of DeductionTagResource) Tags. See DeductionTagResource.
tagView	(string) Tag View.

DeductionTagResource

The following elements are required:

tag	(string) Tag.

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.

PeriodDeductionResource

The following elements are required:

startPeriod	(DateTime) Start Period.
deductionValueKind	(enum DeductionValueKind) Value Kind. See DeductionValueKind.
appliesEmployee	(bool) Applies.
employeeValue	(MoneyResource) Employee Value. See MoneyResource .
employeePercentage	(decimal) Employee Percentage.
employeeMinValue	(MoneyResource) Minimum Value. See MoneyResource .
employeeMaxValue	(MoneyResource) Maximum Value. See MoneyResource .
appliesCompany	(bool) Applies.
companyValue	(MoneyResource) Company Value. See MoneyResource .
companyPercentage	(decimal) Company Percentage.
companyMinValue	(MoneyResource) Minimum Value. See MoneyResource .
companyMaxValue	(MoneyResource) Maximum Value. See MoneyResource .
currency	(string) Currency.

The following elements are optional:

endPeriod	(DateTime) End Period.
employeeFormulaValue	(string) Employee Formula Value.
companyFormulaValue	(string) Company Formula Value.
employeeValuesInfo	(string) Employee.
companyValuesInfo	(string) Company.
employeeFormulaPercentage	(string) Employee Formula Percentage.
companyFormulaPercentage	(string) Company Formula Percentage.

Enumerations

ContractKind

1	Employment
2	Service

DeductionValueKind

1	Money
2	Percentage
3	FormulaValue
4	FormulaPercentage

EarningDeductionGroup

1	Tax
2	ProtectionScheme
3	Quota
4	WorkInsurance
5	VAT

RoundingKind

1	SuperiorUnit
2	InferiorUnit