Payroll | Debt Procedure Type

Service to manage entities of type 'DebtProcedureType'.

Overview

api/{tenantKey}/{orgKey}/payroll/debtProcedureTypes

URL	api/{tenantKey}/{orgKey}/payroll/debtProcedureTypes
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:

ApiDebtProcedureTypeDebtProcedureExcludedDeductionsResource
ApiDebtProcedureTypeDebtProcExcludedEarningNaturesResource
ApiDebtProcedureTypeResource
DebtProcedureExcludedDeductionResource
DebtProcedureTypeResource
DebtProcExcludedEarningNatureResource

All Enumerations

This service uses the following enumerations:

DebtProcedureKind

GET Operations

GET DebtProcedureTypes

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payroll/debtProcedureTypes

GET /payroll/debtProcedureTypes

GET DebtProcedureTypes (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 DebtProcedureTypeResource.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payroll/debtProcedureTypes?page={page}&pageSize={pageSize}

GET /payroll/debtProcedureTypes?page={page}&pageSize={pageSize}

GET DebtProcedureType 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 DebtProcedureTypeResource.

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

GET /payroll/debtProcedureTypes/{id}

GET DebtProcedureType by key

Returns the entity record that matches the specified key.

The following elements are required:

debtProcedureTypeKey

(string) Debt Procedure Type.

Response:

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

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}/payroll/debtProcedureTypes/{debtProcedureTypeKey}

GET /payroll/debtProcedureTypes/{debtProcedureTypeKey}

GET Print DebtProcedureType 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}/payroll/debtProcedureTypes/{id}/print?template={template}

GET /payroll/debtProcedureTypes/{id}/print?template={template}

GET Print DebtProcedureType by key

Prints the specified entity record.

The following elements are required:

debtProcedureTypeKey

(string) Debt Procedure 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}/payroll/debtProcedureTypes/{debtProcedureTypeKey}/print

GET /payroll/debtProcedureTypes/{debtProcedureTypeKey}/print

GET Original Print DebtProcedureTypeOriginal 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}/payroll/debtProcedureTypes/{id}/printOriginal?template={template}

GET /payroll/debtProcedureTypes/{id}/printOriginal?template={template}

GET Original Print DebtProcedureType by key

Prints the specified entity record.

The following elements are required:

debtProcedureTypeKey

(string) Debt Procedure 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}/payroll/debtProcedureTypes/{debtProcedureTypeKey}/printOriginal

GET /payroll/debtProcedureTypes/{debtProcedureTypeKey}/printOriginal

POST Operations

POST DebtProcedureTypes

Creates a new entity record.

The following elements are required:

debtProcedureTypeResource

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

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payroll/debtProcedureTypes

POST /payroll/debtProcedureTypes

POST Debt Procedure Type

Inserts a new 'Debt Proc Excluded Earning Nature' in the 'Debt Procedure Type'.

The following elements are required:

debtProcedureTypeKey	(string) Debt Procedure Type.
value	(ApiDebtProcedureTypeDebtProcExcludedEarningNaturesResource) The ApiDebtProcedureTypeDebtProcExcludedEarningNaturesResource instance. See ApiDebtProcedureTypeDebtProcExcludedEarningNaturesResource.

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}/payroll/debtProcedureTypes/{debtProcedureTypeKey}/debtProcExcludedEarningNatures

POST /payroll/debtProcedureTypes/{debtProcedureTypeKey}/debtProcExcludedEarningNatures

POST Debt Procedure Type

Inserts a new 'Debt Procedure Excluded Deduction' in the 'Debt Procedure Type'.

The following elements are required:

debtProcedureTypeKey	(string) Debt Procedure Type.
value	(ApiDebtProcedureTypeDebtProcedureExcludedDeductionsResource) The ApiDebtProcedureTypeDebtProcedureExcludedDeductionsResource instance. See ApiDebtProcedureTypeDebtProcedureExcludedDeductionsResource.

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}/payroll/debtProcedureTypes/{debtProcedureTypeKey}/debtProcedureExcludedDeductions

POST /payroll/debtProcedureTypes/{debtProcedureTypeKey}/debtProcedureExcludedDeductions

PUT Operations

PUT Set AttachableValueFormula DebtProcedureType

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

The following elements are required:

debtProcedureTypeKey	(string) Debt Procedure 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}/payroll/debtProcedureTypes/{debtProcedureTypeKey}/attachableValueFormula

PUT /payroll/debtProcedureTypes/{debtProcedureTypeKey}/attachableValueFormula

PUT Set CalculationByAggregation DebtProcedureType

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

The following elements are required:

debtProcedureTypeKey	(string) Debt Procedure 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.

Resource URL:

api/{tenantKey}/{orgKey}/payroll/debtProcedureTypes/{debtProcedureTypeKey}/calculationByAggregation

PUT /payroll/debtProcedureTypes/{debtProcedureTypeKey}/calculationByAggregation

PUT Set DebtProcedureAccountType DebtProcedureType

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

The following elements are required:

debtProcedureTypeKey	(string) Debt Procedure 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}/payroll/debtProcedureTypes/{debtProcedureTypeKey}/debtProcedureAccountType

PUT /payroll/debtProcedureTypes/{debtProcedureTypeKey}/debtProcedureAccountType

PUT Set DebtProcedureKind DebtProcedureType

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

The following elements are required:

debtProcedureTypeKey	(string) Debt Procedure Type.
value	(enum DebtProcedureKind) The request body should contain the new value for the attribute. See DebtProcedureKind.

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}/payroll/debtProcedureTypes/{debtProcedureTypeKey}/debtProcedureKind

PUT /payroll/debtProcedureTypes/{debtProcedureTypeKey}/debtProcedureKind

PUT Set DebtProcedureTypeKey DebtProcedureType

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

The following elements are required:

debtProcedureTypeKey	(string) Debt Procedure 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}/payroll/debtProcedureTypes/{debtProcedureTypeKey}/debtProcedureTypeKey

PUT /payroll/debtProcedureTypes/{debtProcedureTypeKey}/debtProcedureTypeKey

PUT Set Deduction DebtProcedureExcludedDeduction

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

The following elements are required:

debtProcedureTypeKey	(string) Debt Procedure Type.
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}/payroll/debtProcedureTypes/{debtProcedureTypeKey}/debtProcedureExcludedDeductions/{lineId}/deduction

PUT /payroll/debtProcedureTypes/{debtProcedureTypeKey}/debtProcedureExcludedDeductions/{lineId}/deduction

PUT Set Description DebtProcedureType

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

The following elements are required:

debtProcedureTypeKey	(string) Debt Procedure 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}/payroll/debtProcedureTypes/{debtProcedureTypeKey}/description

PUT /payroll/debtProcedureTypes/{debtProcedureTypeKey}/description

PUT Set EarningNature DebtProcExcludedEarningNature

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

The following elements are required:

debtProcedureTypeKey	(string) Debt Procedure Type.
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}/payroll/debtProcedureTypes/{debtProcedureTypeKey}/debtProcExcludedEarningNatures/{lineId}/earningNature

PUT /payroll/debtProcedureTypes/{debtProcedureTypeKey}/debtProcExcludedEarningNatures/{lineId}/earningNature

PUT Set IsActive DebtProcedureType

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

The following elements are required:

debtProcedureTypeKey	(string) Debt Procedure 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}/payroll/debtProcedureTypes/{debtProcedureTypeKey}/isActive

PUT /payroll/debtProcedureTypes/{debtProcedureTypeKey}/isActive

DELETE Operations

DELETE Debt Proc Excluded Earning Nature by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

debtProcedureTypeKey	(string) Debt Procedure Type.
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}/payroll/debtProcedureTypes/{debtProcedureTypeKey}/debtProcExcludedEarningNatures/{lineId}

DELETE /payroll/debtProcedureTypes/{debtProcedureTypeKey}/debtProcExcludedEarningNatures/{lineId}

DELETE Debt Procedure Excluded Deduction by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

debtProcedureTypeKey	(string) Debt Procedure Type.
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}/payroll/debtProcedureTypes/{debtProcedureTypeKey}/debtProcedureExcludedDeductions/{lineId}

DELETE /payroll/debtProcedureTypes/{debtProcedureTypeKey}/debtProcedureExcludedDeductions/{lineId}

DELETE DebtProcedureType 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}/payroll/debtProcedureTypes/{id}

DELETE /payroll/debtProcedureTypes/{id}

DELETE DebtProcedureType by key

Deletes the entity record that matches the specified key.

The following elements are required:

debtProcedureTypeKey

(string) Debt Procedure 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}/payroll/debtProcedureTypes/{debtProcedureTypeKey}

DELETE /payroll/debtProcedureTypes/{debtProcedureTypeKey}

Resources

ApiDebtProcedureTypeDebtProcedureExcludedDeductionsResource

The following elements are required:

deduction

(string) Deduction.

ApiDebtProcedureTypeDebtProcExcludedEarningNaturesResource

The following elements are required:

earningNature

(string) Earning Nature.

ApiDebtProcedureTypeResource

The following elements are required:

debtProcedureTypeKey	(string) Debt Procedure Type.
debtProcedureKind	(enum DebtProcedureKind) Debt Procedure Kind. See DebtProcedureKind.
attachableValueFormula	(string) Attachable Value Formula.
debtProcedureAccountType	(string) Debt Procedure Account Type.
calculationByAggregation	(bool) Autonomous Calc. By Aggregation.

The following elements are optional:

description	(string) Description.
debtProcExcludedEarningNatures	(List of ApiDebtProcedureTypeDebtProcExcludedEarningNaturesResource) Debt Proc Excluded Earning Natures. See ApiDebtProcedureTypeDebtProcExcludedEarningNaturesResource.
debtProcedureExcludedDeductions	(List of ApiDebtProcedureTypeDebtProcedureExcludedDeductionsResource) Debt Procedure Excluded Deductions. See ApiDebtProcedureTypeDebtProcedureExcludedDeductionsResource.

DebtProcedureExcludedDeductionResource

The following elements are required:

deduction

(string) Deduction.

DebtProcedureTypeResource

The following elements are required:

debtProcedureTypeKey	(string) Debt Procedure Type.
debtProcedureKind	(enum DebtProcedureKind) Debt Procedure Kind. See DebtProcedureKind.
attachableValueFormula	(string) Attachable Value Formula. (fk) Allowed value: the natural key of a record of type Formula. These records are accessibly through the Formulas service.
debtProcedureAccountType	(string) Debt Procedure Account Type. (fk) Allowed value: the natural key of a record of type DebtProcedureAccountType. These records are accessibly through the DebtProcedureAccountTypes service.
calculationByAggregation	(bool) Autonomous Calc. By Aggregation.

The following elements are optional:

description	(string) Description.
debtProcExcludedEarningNatures	(List of DebtProcExcludedEarningNatureResource) Debt Proc Excluded Earning Natures. See DebtProcExcludedEarningNatureResource.
debtProcedureExcludedDeductions	(List of DebtProcedureExcludedDeductionResource) Debt Procedure Excluded Deductions. See DebtProcedureExcludedDeductionResource.

DebtProcExcludedEarningNatureResource

The following elements are required:

earningNature

(string) Earning Nature.

Enumerations

DebtProcedureKind

1	Garnishment
2	Advance
3	Refund