Payroll | Benefit Account Type

Service to manage entities of type 'BenefitAccountType'.

Overview

api/{tenantKey}/{orgKey}/payrollCore/benefitAccountTypes

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

All Operations

This service includes the following operations:

GET:
POST:
- POST BenefitAccountTypes
PUT:
DELETE:
- DELETE BenefitAccountType by identifier
- DELETE BenefitAccountType by key

All Resources

This service uses the following resources:

ApiBenefitAccountTypeResource
BenefitAccountTypeResource

All Enumerations

This service uses the following enumerations:

BalanceTimeLimit
BenefitAccountKind
CreditValueCriteriaKind
DebitKind
Timing

GET Operations

GET BenefitAccountTypes

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollCore/benefitAccountTypes

GET /payrollCore/benefitAccountTypes

GET BenefitAccountTypes (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 BenefitAccountTypeResource.

Response status codes:

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

Resource URL:

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

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

GET BenefitAccountType 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 BenefitAccountTypeResource.

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

GET /payrollCore/benefitAccountTypes/{id}

GET BenefitAccountType by key

Returns the entity record that matches the specified key.

The following elements are required:

benefitAccountTypeKey

(string) Benefit Account Type.

Response:

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

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/benefitAccountTypes/{benefitAccountTypeKey}

GET /payrollCore/benefitAccountTypes/{benefitAccountTypeKey}

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

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

GET Print BenefitAccountType by key

Prints the specified entity record.

The following elements are required:

benefitAccountTypeKey

(string) Benefit 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}/payrollCore/benefitAccountTypes/{benefitAccountTypeKey}/print

GET /payrollCore/benefitAccountTypes/{benefitAccountTypeKey}/print

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

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

GET Original Print BenefitAccountType by key

Prints the specified entity record.

The following elements are required:

benefitAccountTypeKey

(string) Benefit 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}/payrollCore/benefitAccountTypes/{benefitAccountTypeKey}/printOriginal

GET /payrollCore/benefitAccountTypes/{benefitAccountTypeKey}/printOriginal

POST Operations

POST BenefitAccountTypes

Creates a new entity record.

The following elements are required:

benefitAccountTypeResource

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

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollCore/benefitAccountTypes

POST /payrollCore/benefitAccountTypes

PUT Operations

PUT Set AbsenceValidationFormula BenefitAccountType

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

The following elements are required:

benefitAccountTypeKey	(string) Benefit 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}/payrollCore/benefitAccountTypes/{benefitAccountTypeKey}/absenceValidationFormula

PUT /payrollCore/benefitAccountTypes/{benefitAccountTypeKey}/absenceValidationFormula

PUT Set AnualAdjustmentFormula BenefitAccountType

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

The following elements are required:

benefitAccountTypeKey	(string) Benefit 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}/payrollCore/benefitAccountTypes/{benefitAccountTypeKey}/anualAdjustmentFormula

PUT /payrollCore/benefitAccountTypes/{benefitAccountTypeKey}/anualAdjustmentFormula

PUT Set BalanceMinLimit BenefitAccountType

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

The following elements are required:

benefitAccountTypeKey	(string) Benefit Account Type.
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/benefitAccountTypes/{benefitAccountTypeKey}/balanceMinLimit

PUT /payrollCore/benefitAccountTypes/{benefitAccountTypeKey}/balanceMinLimit

PUT Set BalanceMinValidate BenefitAccountType

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

The following elements are required:

benefitAccountTypeKey	(string) Benefit 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.

Resource URL:

api/{tenantKey}/{orgKey}/payrollCore/benefitAccountTypes/{benefitAccountTypeKey}/balanceMinValidate

PUT /payrollCore/benefitAccountTypes/{benefitAccountTypeKey}/balanceMinValidate

PUT Set BalanceTimeLimit BenefitAccountType

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

The following elements are required:

benefitAccountTypeKey	(string) Benefit Account Type.
value	(enum BalanceTimeLimit) The request body should contain the new value for the attribute. See BalanceTimeLimit.

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/benefitAccountTypes/{benefitAccountTypeKey}/balanceTimeLimit

PUT /payrollCore/benefitAccountTypes/{benefitAccountTypeKey}/balanceTimeLimit

PUT Set BenefitAccountKind BenefitAccountType

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

The following elements are required:

benefitAccountTypeKey	(string) Benefit Account Type.
value	(enum BenefitAccountKind) The request body should contain the new value for the attribute. See BenefitAccountKind.

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/benefitAccountTypes/{benefitAccountTypeKey}/benefitAccountKind

PUT /payrollCore/benefitAccountTypes/{benefitAccountTypeKey}/benefitAccountKind

PUT Set BenefitAccountTypeKey BenefitAccountType

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

The following elements are required:

benefitAccountTypeKey	(string) Benefit 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}/payrollCore/benefitAccountTypes/{benefitAccountTypeKey}/benefitAccountTypeKey

PUT /payrollCore/benefitAccountTypes/{benefitAccountTypeKey}/benefitAccountTypeKey

PUT Set CreditFormula BenefitAccountType

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

The following elements are required:

benefitAccountTypeKey	(string) Benefit 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}/payrollCore/benefitAccountTypes/{benefitAccountTypeKey}/creditFormula

PUT /payrollCore/benefitAccountTypes/{benefitAccountTypeKey}/creditFormula

PUT Set CreditValueCriteria BenefitAccountType

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

The following elements are required:

benefitAccountTypeKey	(string) Benefit Account Type.
value	(enum CreditValueCriteriaKind) The request body should contain the new value for the attribute. See CreditValueCriteriaKind.

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/benefitAccountTypes/{benefitAccountTypeKey}/creditValueCriteria

PUT /payrollCore/benefitAccountTypes/{benefitAccountTypeKey}/creditValueCriteria

PUT Set DebitAbsence BenefitAccountType

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

The following elements are required:

benefitAccountTypeKey	(string) Benefit 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}/payrollCore/benefitAccountTypes/{benefitAccountTypeKey}/debitAbsence

PUT /payrollCore/benefitAccountTypes/{benefitAccountTypeKey}/debitAbsence

PUT Set DebitFormula BenefitAccountType

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

The following elements are required:

benefitAccountTypeKey	(string) Benefit 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}/payrollCore/benefitAccountTypes/{benefitAccountTypeKey}/debitFormula

PUT /payrollCore/benefitAccountTypes/{benefitAccountTypeKey}/debitFormula

PUT Set DebitKind BenefitAccountType

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

The following elements are required:

benefitAccountTypeKey	(string) Benefit Account Type.
value	(enum DebitKind) The request body should contain the new value for the attribute. See DebitKind.

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/benefitAccountTypes/{benefitAccountTypeKey}/debitKind

PUT /payrollCore/benefitAccountTypes/{benefitAccountTypeKey}/debitKind

PUT Set Earning BenefitAccountType

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

The following elements are required:

benefitAccountTypeKey	(string) Benefit 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}/payrollCore/benefitAccountTypes/{benefitAccountTypeKey}/earning

PUT /payrollCore/benefitAccountTypes/{benefitAccountTypeKey}/earning

PUT Set IsActive BenefitAccountType

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

The following elements are required:

benefitAccountTypeKey	(string) Benefit 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}/payrollCore/benefitAccountTypes/{benefitAccountTypeKey}/isActive

PUT /payrollCore/benefitAccountTypes/{benefitAccountTypeKey}/isActive

PUT Set IsEditable BenefitAccountType

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

The following elements are required:

benefitAccountTypeKey	(string) Benefit 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.

Resource URL:

api/{tenantKey}/{orgKey}/payrollCore/benefitAccountTypes/{benefitAccountTypeKey}/isEditable

PUT /payrollCore/benefitAccountTypes/{benefitAccountTypeKey}/isEditable

PUT Set LiquidationEarning BenefitAccountType

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

The following elements are required:

benefitAccountTypeKey	(string) Benefit 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}/payrollCore/benefitAccountTypes/{benefitAccountTypeKey}/liquidationEarning

PUT /payrollCore/benefitAccountTypes/{benefitAccountTypeKey}/liquidationEarning

PUT Set Name BenefitAccountType

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

The following elements are required:

benefitAccountTypeKey	(string) Benefit 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}/payrollCore/benefitAccountTypes/{benefitAccountTypeKey}/name

PUT /payrollCore/benefitAccountTypes/{benefitAccountTypeKey}/name

PUT Set Timing BenefitAccountType

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

The following elements are required:

benefitAccountTypeKey	(string) Benefit Account Type.
value	(enum Timing) The request body should contain the new value for the attribute. See Timing.

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/benefitAccountTypes/{benefitAccountTypeKey}/timing

PUT /payrollCore/benefitAccountTypes/{benefitAccountTypeKey}/timing

DELETE Operations

DELETE BenefitAccountType 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/benefitAccountTypes/{id}

DELETE /payrollCore/benefitAccountTypes/{id}

DELETE BenefitAccountType by key

Deletes the entity record that matches the specified key.

The following elements are required:

benefitAccountTypeKey

(string) Benefit 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}/payrollCore/benefitAccountTypes/{benefitAccountTypeKey}

DELETE /payrollCore/benefitAccountTypes/{benefitAccountTypeKey}

Resources

ApiBenefitAccountTypeResource

The following elements are required:

benefitAccountTypeKey	(string) Benefit Account Type.
name	(string) Name.
benefitAccountKind	(enum BenefitAccountKind) Kind. See BenefitAccountKind.
creditFormula	(string) Formula.
creditValueCriteria	(enum CreditValueCriteriaKind) Value Criteria. See CreditValueCriteriaKind.
debitKind	(enum DebitKind) Kind. See DebitKind.
balanceTimeLimit	(enum BalanceTimeLimit) Balance Time Limit. See BalanceTimeLimit.
balanceMinLimit	(decimal) Min. Value.
balanceMinValidate	(bool) Validate Min. Balance?.
isEditable	(bool) Is Editable.

The following elements are optional:

debitFormula	(string) Formula.
debitAbsence	(string) Absence.
absenceValidationFormula	(string) Absence Validation Formula.
earning	(string) Earning.
timing	(enum Timing) Timing. See Timing.
liquidationEarning	(string) Liquidation Earning.
anualAdjustmentFormula	(string) Anual Adjustment Formula.

BenefitAccountTypeResource

The following elements are required:

benefitAccountTypeKey	(string) Benefit Account Type.
name	(string) Name.
benefitAccountKind	(enum BenefitAccountKind) Kind. See BenefitAccountKind.
creditFormula	(string) Formula. (fk) Allowed value: the natural key of a record of type Formula. These records are accessibly through the Formulas service.
creditValueCriteria	(enum CreditValueCriteriaKind) Value Criteria. See CreditValueCriteriaKind.
debitKind	(enum DebitKind) Kind. See DebitKind.
balanceTimeLimit	(enum BalanceTimeLimit) Balance Time Limit. See BalanceTimeLimit.
balanceMinLimit	(decimal) Min. Value.
balanceMinValidate	(bool) Validate Min. Balance?.
isEditable	(bool) Is Editable.

The following elements are optional:

debitFormula	(string) Formula. (fk) Allowed value: the natural key of a record of type Formula. These records are accessibly through the Formulas service.
debitAbsence	(string) Absence. (fk) Allowed value: the natural key of a record of type AbsenceType. These records are accessibly through the AbsenceTypes service.
absenceValidationFormula	(string) Absence Validation Formula. (fk) Allowed value: the natural key of a record of type Formula. These records are accessibly through the Formulas service.
earning	(string) Earning. (fk) Allowed value: the natural key of a record of type Earning. These records are accessibly through the Earnings service.
timing	(enum Timing) Timing. See Timing.
liquidationEarning	(string) Liquidation Earning. (fk) Allowed value: the natural key of a record of type Earning. These records are accessibly through the Earnings service.
anualAdjustmentFormula	(string) Anual Adjustment Formula. (fk) Allowed value: the natural key of a record of type Formula. These records are accessibly through the Formulas service.

Enumerations

BalanceTimeLimit

1	ByContract
2	Yearly

BenefitAccountKind

1	Quantity
2	Value

CreditValueCriteriaKind

1	Accumulated
2	Monthly

DebitKind

1	Formula
2	Absence
3	VocationalTraining

Timing

1	Advance
2	Regular
3	Posterior