Payroll | Absence Type

Service to manage entities of type 'AbsenceType'.

Overview

api/{tenantKey}/{orgKey}/payrollCore/absenceTypes

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

All Operations

This service includes the following operations:

GET:
POST:
- POST AbsenceTypes
- POST Absence Type
PUT:
DELETE:

All Resources

This service uses the following resources:

AbsenceTypeResource
AbsenceTypeTagResource
ApiAbsenceTypeResource
ApiAbsenceTypeTagsResource

GET Operations

GET AbsenceTypes

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollCore/absenceTypes

GET /payrollCore/absenceTypes

GET AbsenceTypes (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 AbsenceTypeResource.

Response status codes:

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

Resource URL:

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

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

GET AbsenceType 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 AbsenceTypeResource.

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

GET /payrollCore/absenceTypes/{id}

GET AbsenceType by key

Returns the entity record that matches the specified key.

The following elements are required:

absenceTypeKey

(string) Absence Type.

Response:

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

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/absenceTypes/{absenceTypeKey}

GET /payrollCore/absenceTypes/{absenceTypeKey}

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

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

GET Print AbsenceType by key

Prints the specified entity record.

The following elements are required:

absenceTypeKey

(string) Absence 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/absenceTypes/{absenceTypeKey}/print

GET /payrollCore/absenceTypes/{absenceTypeKey}/print

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

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

GET Original Print AbsenceType by key

Prints the specified entity record.

The following elements are required:

absenceTypeKey

(string) Absence 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/absenceTypes/{absenceTypeKey}/printOriginal

GET /payrollCore/absenceTypes/{absenceTypeKey}/printOriginal

POST Operations

POST AbsenceTypes

Creates a new entity record.

The following elements are required:

absenceTypeResource

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

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/payrollCore/absenceTypes

POST /payrollCore/absenceTypes

POST Absence Type

Inserts a new 'Absence Type Tag' in the 'Absence Type'.

The following elements are required:

absenceTypeKey	(string) Absence Type.
value	(ApiAbsenceTypeTagsResource) The ApiAbsenceTypeTagsResource instance. See ApiAbsenceTypeTagsResource.

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/absenceTypes/{absenceTypeKey}/tags

POST /payrollCore/absenceTypes/{absenceTypeKey}/tags

PUT Operations

PUT Set AbsenceTypeKey AbsenceType

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

The following elements are required:

absenceTypeKey	(string) Absence 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/absenceTypes/{absenceTypeKey}/absenceTypeKey

PUT /payrollCore/absenceTypes/{absenceTypeKey}/absenceTypeKey

PUT Set AnnualLimit AbsenceType

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

The following elements are required:

absenceTypeKey	(string) Absence 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/absenceTypes/{absenceTypeKey}/annualLimit

PUT /payrollCore/absenceTypes/{absenceTypeKey}/annualLimit

PUT Set ContributesAbsenteeism AbsenceType

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

The following elements are required:

absenceTypeKey	(string) Absence 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/absenceTypes/{absenceTypeKey}/contributesAbsenteeism

PUT /payrollCore/absenceTypes/{absenceTypeKey}/contributesAbsenteeism

PUT Set HasAnnualLimit AbsenceType

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

The following elements are required:

absenceTypeKey	(string) Absence 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/absenceTypes/{absenceTypeKey}/hasAnnualLimit

PUT /payrollCore/absenceTypes/{absenceTypeKey}/hasAnnualLimit

PUT Set HasSupplement AbsenceType

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

The following elements are required:

absenceTypeKey	(string) Absence 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/absenceTypes/{absenceTypeKey}/hasSupplement

PUT /payrollCore/absenceTypes/{absenceTypeKey}/hasSupplement

PUT Set InDays AbsenceType

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

The following elements are required:

absenceTypeKey	(string) Absence 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/absenceTypes/{absenceTypeKey}/inDays

PUT /payrollCore/absenceTypes/{absenceTypeKey}/inDays

PUT Set InHalfDays AbsenceType

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

The following elements are required:

absenceTypeKey	(string) Absence 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/absenceTypes/{absenceTypeKey}/inHalfDays

PUT /payrollCore/absenceTypes/{absenceTypeKey}/inHalfDays

PUT Set InHours AbsenceType

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

The following elements are required:

absenceTypeKey	(string) Absence 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/absenceTypes/{absenceTypeKey}/inHours

PUT /payrollCore/absenceTypes/{absenceTypeKey}/inHours

PUT Set IsActive AbsenceType

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

The following elements are required:

absenceTypeKey	(string) Absence 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/absenceTypes/{absenceTypeKey}/isActive

PUT /payrollCore/absenceTypes/{absenceTypeKey}/isActive

PUT Set IsEditableReduceWorkTime AbsenceType

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

The following elements are required:

absenceTypeKey	(string) Absence 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/absenceTypes/{absenceTypeKey}/isEditableReduceWorkTime

PUT /payrollCore/absenceTypes/{absenceTypeKey}/isEditableReduceWorkTime

PUT Set Name AbsenceType

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

The following elements are required:

absenceTypeKey	(string) Absence 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/absenceTypes/{absenceTypeKey}/name

PUT /payrollCore/absenceTypes/{absenceTypeKey}/name

PUT Set Percentage AbsenceType

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

The following elements are required:

absenceTypeKey	(string) Absence 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/absenceTypes/{absenceTypeKey}/percentage

PUT /payrollCore/absenceTypes/{absenceTypeKey}/percentage

PUT Set ReducePaidTime AbsenceType

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

The following elements are required:

absenceTypeKey	(string) Absence 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/absenceTypes/{absenceTypeKey}/reducePaidTime

PUT /payrollCore/absenceTypes/{absenceTypeKey}/reducePaidTime

PUT Set ReduceWorkTime AbsenceType

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

The following elements are required:

absenceTypeKey	(string) Absence 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/absenceTypes/{absenceTypeKey}/reduceWorkTime

PUT /payrollCore/absenceTypes/{absenceTypeKey}/reduceWorkTime

PUT Set Supplement AbsenceType

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

The following elements are required:

absenceTypeKey	(string) Absence 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/absenceTypes/{absenceTypeKey}/supplement

PUT /payrollCore/absenceTypes/{absenceTypeKey}/supplement

PUT Set Tag AbsenceTypeTag

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

The following elements are required:

absenceTypeKey	(string) Absence 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}/payrollCore/absenceTypes/{absenceTypeKey}/tags/{lineId}/tag

PUT /payrollCore/absenceTypes/{absenceTypeKey}/tags/{lineId}/tag

PUT Set TagView AbsenceType

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

The following elements are required:

absenceTypeKey	(string) Absence 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/absenceTypes/{absenceTypeKey}/tagView

PUT /payrollCore/absenceTypes/{absenceTypeKey}/tagView

PUT Set UnjustifiedTime AbsenceType

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

The following elements are required:

absenceTypeKey	(string) Absence 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/absenceTypes/{absenceTypeKey}/unjustifiedTime

PUT /payrollCore/absenceTypes/{absenceTypeKey}/unjustifiedTime

DELETE Operations

DELETE Absence Type Tag by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

absenceTypeKey	(string) Absence 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}/payrollCore/absenceTypes/{absenceTypeKey}/tags/{lineId}

DELETE /payrollCore/absenceTypes/{absenceTypeKey}/tags/{lineId}

DELETE AbsenceType 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/absenceTypes/{id}

DELETE /payrollCore/absenceTypes/{id}

DELETE AbsenceType by key

Deletes the entity record that matches the specified key.

The following elements are required:

absenceTypeKey

(string) Absence 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/absenceTypes/{absenceTypeKey}

DELETE /payrollCore/absenceTypes/{absenceTypeKey}

Resources

AbsenceTypeResource

The following elements are required:

absenceTypeKey	(string) Absence Type.
name	(string) Name.
reduceWorkTime	(bool) Reduce Work Time.
isEditableReduceWorkTime	(bool) Is Editable.
percentage	(decimal) Percentage.
inHours	(bool) In Hours.
inDays	(bool) In Days.
inHalfDays	(bool) In Half Days.
reducePaidTime	(bool) Indicates if absences of this type reduces paid time.
unjustifiedTime	(bool) Indicates if absences of this type should be considered as unjustified time.
contributesAbsenteeism	(bool) Indicates if absences of this type should be considered on absenteeism analysis.
hasSupplement	(bool) Indicates where a suplement is to be inserted when an absence of this type exists.
hasAnnualLimit	(bool) Indicates if absence type has annual limit of days.

The following elements are optional:

tags	(List of AbsenceTypeTagResource) Tags. See AbsenceTypeTagResource.
tagView	(string) Tag View.
supplement	(string) A earning to be inserted when a absence of this type exists on processing. (fk) Allowed value: the natural key of a record of type Earning. These records are accessibly through the Earnings service.
annualLimit	(decimal) Indicates annual limit days of absence type.

AbsenceTypeTagResource

The following elements are required:

tag	(string) Tag.

ApiAbsenceTypeResource

The following elements are required:

absenceTypeKey	(string) Absence Type.
name	(string) Name.
reduceWorkTime	(bool) Reduce Work Time.
isEditableReduceWorkTime	(bool) Is Editable.
percentage	(decimal) Percentage.
inHours	(bool) In Hours.
inDays	(bool) In Days.
inHalfDays	(bool) In Half Days.
reducePaidTime	(bool) Indicates if absences of this type reduces paid time.
unjustifiedTime	(bool) Indicates if absences of this type should be considered as unjustified time.
contributesAbsenteeism	(bool) Indicates if absences of this type should be considered on absenteeism analysis.
hasSupplement	(bool) Indicates where a suplement is to be inserted when an absence of this type exists.
hasAnnualLimit	(bool) Indicates if absence type has annual limit of days.

The following elements are optional:

tags	(List of ApiAbsenceTypeTagsResource) Tags. See ApiAbsenceTypeTagsResource.
tagView	(string) Tag View.
supplement	(string) A earning to be inserted when a absence of this type exists on processing.
annualLimit	(decimal) Indicates annual limit days of absence type.

ApiAbsenceTypeTagsResource

The following elements are required:

tag	(string) Tag.