Payroll | Calculate Debt Procedure

Overview

api/{tenantKey}/{orgKey}/payroll/calculateDebtProcedures

URL	api/{tenantKey}/{orgKey}/payroll/calculateDebtProcedures
Methods Supported	GET, POST

This service includes the following operations:

This service uses the following resources:

Returns the list of entity records that can be processed by the 'EmployeeReceipts' service.

The following elements are required:

pageIndex	(int) The index of the page of the list that should be returned.
pageSize	(int) The number of page elements that should be returned (max. is 1000).
period	(DateTime) Period.

The following elements are optional:

contract	(string) Contract This is a query string parameter.
company	(string) Company This is a query string parameter.

Response:

When successful, the response body contains the list of entity records available for processing. See CalculateDebtProcedurePickingLine.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payroll/calculateDebtProcedures/{pageIndex}/{pageSize}?contract={contract}&company={company}

GET /payroll/calculateDebtProcedures/{pageIndex}/{pageSize}?contract={contract}&company={company}

Instructs the 'EmployeeReceipts' service to process the specified entity records.

The following elements are required:

list	(CalculateDebtProcedurePickingLine) List of the entity records that should be processed. See CalculateDebtProcedurePickingLine.
companyKey	(string) The company key.

Response:

When successful, the response body is empty. The URL of the processed items is returned in the response location header.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payroll/calculateDebtProcedures/{companyKey}

POST /payroll/calculateDebtProcedures/{companyKey}

The following elements are required:

selectedCount	(int) Selected Count.
period	(DateTime) Period.

The following elements are optional:

contract	(string) Contract.
company	(string) Company.

The following elements are required:

selected	(bool) Selected.
debtProcedure	(string) Debt Procedure.
aggregation	(string) Debt Procedure Agrregation Group with drill dow to Debt Procedure Type.
accumulatedWithheld	(decimal) Accumulated Withheld.
previousValue	(decimal) Value calculated Previous Value.
subjectValue	(decimal) Subject Value.
previousProcedures	(decimal) Previous Procedure Values.
attachableValue	(decimal) Attachable Value.
unattachable	(decimal) Unattachable Value.
calculatedWithholding	(decimal) Calculated Withholding.
valueToWithhold	(decimal) Value To Withhold.

The following elements are optional:

company	(string) Company.
payment	(string) Payment where debt procedure will bbe associated.
includedPayments	(string) Payments included on calculation.
contract	(string) Contract.
balance	(decimal) Balance.