Benefit

Benefits are non-monetary compensations provided to employees, such as health insurance, sick time, vacation, personal time off, retirement package, facilities, etc. Benefit object allows you to perform the following operations:

Retrieve a specific benefit or a list of benefits
Create a benefit
Update a benefit
Delete a benefit

cURL
NODE.JS
PHP
C#
PYTHON
JAVA

Name	Description	Format	Attributes
name	Name of the benefit	string	Filterable, Sortable
accrualMethod	Describes how the accrual-type benefit is earned, whether it is based on the calendar year and the time elapsed till the current date (Calendar), or it is based on approved time entries (Time Card)	AccrualMethod Enumerated type: Click to see possible values and their descriptions.
createdById	Identifier of the user who created this object	uuid	Filterable
createdOn	Date and time when this object was created (UTC Now), in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time	Filterable, Sortable
earnedUnits	Type of units earned in the accrual-type benefit within the evaluated period, e.g., Hour or Day. This is used only when the accrual method is calendar-based	EarnedUnits Enumerated type: Click to see possible values and their descriptions.
endsOn	Date when the fixed-type benefit ends or expires for an employee in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
expiryDate	Date when the accrued units that were carried forward expire in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss. This is used when the ExpiryType property is set as 'Specific Date'. Also, the day and month from this property are used for the recurrence when the ExpiryType property is set as ‘Recurring Date’	date-time
expiryType	Describes when the MaxCarryValue for the accrual-type benefit expires, i.e., when the accrued units that were carried forward are no longer valid, e.g., on the hire date anniversary, a specific date, a recurring date, etc.	BenefitResetType Enumerated type: Click to see possible values and their descriptions.
id	Object identifier	uuid	Filterable
isCompensation	Indicates whether the fixed-type benefit is being offered as part of the compensation (salary) or not	boolean
lastUpdated	Last updated date and time value of this object in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time	Filterable, Sortable
lastUpdatedById	Identifier of the user who last updated this object	uuid	Filterable
maxAccruedValue	Maximum value of units an employee can accrue during a benefit earning period	double
maxCarryValue	Maximum value of accrued units that can be carried forward to the next benefit earning period when the current period ends	double
maxValue	Maximum amount allowed for the fixed-type benefit	double
memo	Records any extra information of the benefit for recapitulation	string
objectState	Represents the state of the object. e.g., new, unchanged, modified or deleted	ObjectState Enumerated type: Click to see possible values and their descriptions.
period	Time for which the fixed-type benefit is provided, e.g., Day, Week, Month, etc.	PeriodUnits Enumerated type: Click to see possible values and their descriptions.
realizationDate	Date when the full benefit quota becomes available for use in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss. This is used when the RealizationType property is set as 'Specific Date'	date-time
realizationType	Describes when the accrual-type benefit can be used, whether on the go as the benefits are earned, at the beginning or end of the benefit earning period, or at a specific date	RealizationType Enumerated type: Click to see possible values and their descriptions.
resetDate	Date when the accrual-type benefit balance is reset to zero in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss. This is used when the ResetType property is set as 'Specific Date'. Also, the day and month from this property are used for the recurrence when the ResetType property is set as ‘Recurring Date’	date-time
resetType	Describes when the accrual-type benefit expires, i.e., the benefit balance resets to zero, e.g., on the hire date anniversary, a specfic date, a recurring date, etc.	BenefitResetType Enumerated type: Click to see possible values and their descriptions.
rules []Array: Parent object can have multiple instances of this nested object under it.	List of benefit earning rules for accrual-type benefits	BenefitRule Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter.
startsOn	Date when the fixed-type benefit is assigned to an employee in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
status	Current status of the benefit, e.g., Active or Inactive	Status Enumerated type: Click to see possible values and their descriptions.
subType	Sub-type of the accrual-type benefit, whether Sick or Vacation	BenefitSubType Enumerated type: Click to see possible values and their descriptions.
token	Represents the token for update operations	int32
type	Type of benefit, whether accrual (which allows you to define accrual rules and manage earned versus burned benefits) or fixed (which only needs to be recorded from time to time and does not have any accrual rules)	BenefitType Enumerated type: Click to see possible values and their descriptions.
units	Time frame for which the earned units are analyzed, i.e., the period an employee must work in the company to earn a particular accrual-type benefit	PeriodUnits Enumerated type: Click to see possible values and their descriptions.
value	Amount for the fixed-type benefit, say bonus amount per year	double
version	Implements concurrency on this object	byte

Benefit List

Use this method to retrieve a list of benefits. You can optionally pass where, orderBy, and page as query parameters to filter the result. Use the fields parameter to request a subset of the model. By default, a complete model is returned. The expand parameter is used to request nested properties in the model.

Request URL

base_url/hr/benefit

/hr/benefit

Method Overview

HTTP Method:

GET

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Headers:

Access Token

Module:

Benefit

Required Scopes:

read:core

Required Subscription:

View Subscription

Request Parameters asterisk denotes required

Name	Parameter Type	Description	Format
fields	Query	Specifies the model properties you want in the response body	string
where	Query	Specifies only those records that match an expression in the query	string
orderBy	Query	Specifies the order of the records	string
page	Query	Specifies the page number and number of records on each page	string
expand	Query	Specifies the nested model properties you want in the response body	string

Response Body

Name	Description	Format
name	Name of the benefit	string
accrualMethod	Describes how the accrual-type benefit is earned, whether it is based on the calendar year and the time elapsed till the current date (Calendar), or it is based on approved time entries (Time Card)	AccrualMethodEnumerated type: Click to see possible values and their descriptions.
createdById	Identifier of the user who created this object	uuid
createdOn	Date and time when this object was created (UTC Now), in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
earnedUnits	Type of units earned in the accrual-type benefit within the evaluated period, e.g., Hour or Day. This is used only when the accrual method is calendar-based	EarnedUnitsEnumerated type: Click to see possible values and their descriptions.
endsOn	Date when the fixed-type benefit ends or expires for an employee in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
expiryDate	Date when the accrued units that were carried forward expire in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss. This is used when the ExpiryType property is set as 'Specific Date'. Also, the day and month from this property are used for the recurrence when the ExpiryType property is set as ‘Recurring Date’	date-time
expiryType	Describes when the MaxCarryValue for the accrual-type benefit expires, i.e., when the accrued units that were carried forward are no longer valid, e.g., on the hire date anniversary, a specific date, a recurring date, etc.	BenefitResetTypeEnumerated type: Click to see possible values and their descriptions.
id	Object identifier	uuid
isCompensation	Indicates whether the fixed-type benefit is being offered as part of the compensation (salary) or not	boolean
lastUpdated	Last updated date and time value of this object in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
lastUpdatedById	Identifier of the user who last updated this object	uuid
maxAccruedValue	Maximum value of units an employee can accrue during a benefit earning period	double
maxCarryValue	Maximum value of accrued units that can be carried forward to the next benefit earning period when the current period ends	double
maxValue	Maximum amount allowed for the fixed-type benefit	double
memo	Records any extra information of the benefit for recapitulation	string
objectState	Represents the state of the object. e.g., new, unchanged, modified or deleted	ObjectStateEnumerated type: Click to see possible values and their descriptions.
period	Time for which the fixed-type benefit is provided, e.g., Day, Week, Month, etc.	PeriodUnitsEnumerated type: Click to see possible values and their descriptions.
realizationDate	Date when the full benefit quota becomes available for use in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss. This is used when the RealizationType property is set as 'Specific Date'	date-time
realizationType	Describes when the accrual-type benefit can be used, whether on the go as the benefits are earned, at the beginning or end of the benefit earning period, or at a specific date	RealizationTypeEnumerated type: Click to see possible values and their descriptions.
resetDate	Date when the accrual-type benefit balance is reset to zero in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss. This is used when the ResetType property is set as 'Specific Date'. Also, the day and month from this property are used for the recurrence when the ResetType property is set as ‘Recurring Date’	date-time
resetType	Describes when the accrual-type benefit expires, i.e., the benefit balance resets to zero, e.g., on the hire date anniversary, a specfic date, a recurring date, etc.	BenefitResetTypeEnumerated type: Click to see possible values and their descriptions.
rules []Array: Parent object can have multiple instances of this nested object under it.	List of benefit earning rules for accrual-type benefits	BenefitRule Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter.
startsOn	Date when the fixed-type benefit is assigned to an employee in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
status	Current status of the benefit, e.g., Active or Inactive	StatusEnumerated type: Click to see possible values and their descriptions.
subType	Sub-type of the accrual-type benefit, whether Sick or Vacation	BenefitSubTypeEnumerated type: Click to see possible values and their descriptions.
token	Represents the token for update operations	int32
type	Type of benefit, whether accrual (which allows you to define accrual rules and manage earned versus burned benefits) or fixed (which only needs to be recorded from time to time and does not have any accrual rules)	BenefitTypeEnumerated type: Click to see possible values and their descriptions.
units	Time frame for which the earned units are analyzed, i.e., the period an employee must work in the company to earn a particular accrual-type benefit	PeriodUnitsEnumerated type: Click to see possible values and their descriptions.
value	Amount for the fixed-type benefit, say bonus amount per year	double
version	Implements concurrency on this object	byte

Example Response

[
  {
    "name": "Benefit",
    "accrualMethod": null,
    "createdById": "8087d5da-8a0c-41a6-a0ce-e11749ef69bd",
    "createdOn": "2024-09-05T05:42:10Z",
    "earnedUnits": null,
    "endsOn": "2024-09-05T05:42:10Z",
    "expiryDate": "2024-09-05T05:42:10Z",
    "expiryType": null,
    "id": "7587c4b6-c85c-4dfb-b980-1fe6f6fe0fe1",
    "isCompensation": true,
    "lastUpdated": "2024-09-05T05:42:10Z",
    "lastUpdatedById": "da9efdad-ad4f-4874-8be8-a07154914960",
    "maxAccruedValue": 1,
    "maxCarryValue": 1,
    "maxValue": 1,
    "memo": "memo",
    "objectState": null,
    "period": null,
    "realizationDate": "2024-09-05T05:42:10Z",
    "realizationType": null,
    "resetDate": "2024-09-05T05:42:10Z",
    "resetType": null,
    "rules": [
      {
        "benefitId": "a06d17ff-feb7-46d6-9f55-a9dbd0b99292",
        "createdById": "697b66c1-d672-4dd7-bef6-36c7ae7f116e",
        "createdOn": "2024-09-05T05:42:10Z",
        "id": "8a10dd55-932e-40b4-a21e-598717adb6f8",
        "lastUpdated": "2024-09-05T05:42:10Z",
        "lastUpdatedById": "e5694603-6705-48b8-9736-3f51146fcfde",
        "objectState": null,
        "periodUnits": 1,
        "token": 0,
        "unitsEarned": 1,
        "version": "U3dhZ2dlciByb2Nrcw=="
      }
    ],
    "startsOn": "2024-09-05T05:42:10Z",
    "status": null,
    "subType": null,
    "token": 0,
    "type": null,
    "units": null,
    "value": 1,
    "version": "U3dhZ2dlciByb2Nrcw=="
  }
]

Retrieve a Benefit

Use this method to retrieve a specific benefit. Pass id as the parameter.

Request URL

base_url/hr/benefit/{id}

/hr/benefit/{id}

Method Overview

HTTP Method:

GET

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Headers:

Access Token

Module:

Benefit

Required Scopes:

read:core

Required Subscription:

View Subscription

Request Parameters asterisk denotes required

Name	Parameter Type	Description	Format
id	Path	Benefit identifier	string

Response Body

Name	Description	Format
name	Name of the benefit	string
accrualMethod	Describes how the accrual-type benefit is earned, whether it is based on the calendar year and the time elapsed till the current date (Calendar), or it is based on approved time entries (Time Card)	AccrualMethodEnumerated type: Click to see possible values and their descriptions.
createdById	Identifier of the user who created this object	uuid
createdOn	Date and time when this object was created (UTC Now), in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
earnedUnits	Type of units earned in the accrual-type benefit within the evaluated period, e.g., Hour or Day. This is used only when the accrual method is calendar-based	EarnedUnitsEnumerated type: Click to see possible values and their descriptions.
endsOn	Date when the fixed-type benefit ends or expires for an employee in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
expiryDate	Date when the accrued units that were carried forward expire in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss. This is used when the ExpiryType property is set as 'Specific Date'. Also, the day and month from this property are used for the recurrence when the ExpiryType property is set as ‘Recurring Date’	date-time
expiryType	Describes when the MaxCarryValue for the accrual-type benefit expires, i.e., when the accrued units that were carried forward are no longer valid, e.g., on the hire date anniversary, a specific date, a recurring date, etc.	BenefitResetTypeEnumerated type: Click to see possible values and their descriptions.
id	Object identifier	uuid
isCompensation	Indicates whether the fixed-type benefit is being offered as part of the compensation (salary) or not	boolean
lastUpdated	Last updated date and time value of this object in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
lastUpdatedById	Identifier of the user who last updated this object	uuid
maxAccruedValue	Maximum value of units an employee can accrue during a benefit earning period	double
maxCarryValue	Maximum value of accrued units that can be carried forward to the next benefit earning period when the current period ends	double
maxValue	Maximum amount allowed for the fixed-type benefit	double
memo	Records any extra information of the benefit for recapitulation	string
objectState	Represents the state of the object. e.g., new, unchanged, modified or deleted	ObjectStateEnumerated type: Click to see possible values and their descriptions.
period	Time for which the fixed-type benefit is provided, e.g., Day, Week, Month, etc.	PeriodUnitsEnumerated type: Click to see possible values and their descriptions.
realizationDate	Date when the full benefit quota becomes available for use in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss. This is used when the RealizationType property is set as 'Specific Date'	date-time
realizationType	Describes when the accrual-type benefit can be used, whether on the go as the benefits are earned, at the beginning or end of the benefit earning period, or at a specific date	RealizationTypeEnumerated type: Click to see possible values and their descriptions.
resetDate	Date when the accrual-type benefit balance is reset to zero in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss. This is used when the ResetType property is set as 'Specific Date'. Also, the day and month from this property are used for the recurrence when the ResetType property is set as ‘Recurring Date’	date-time
resetType	Describes when the accrual-type benefit expires, i.e., the benefit balance resets to zero, e.g., on the hire date anniversary, a specfic date, a recurring date, etc.	BenefitResetTypeEnumerated type: Click to see possible values and their descriptions.
rules []Array: Parent object can have multiple instances of this nested object under it.	List of benefit earning rules for accrual-type benefits	BenefitRule Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter.
startsOn	Date when the fixed-type benefit is assigned to an employee in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
status	Current status of the benefit, e.g., Active or Inactive	StatusEnumerated type: Click to see possible values and their descriptions.
subType	Sub-type of the accrual-type benefit, whether Sick or Vacation	BenefitSubTypeEnumerated type: Click to see possible values and their descriptions.
token	Represents the token for update operations	int32
type	Type of benefit, whether accrual (which allows you to define accrual rules and manage earned versus burned benefits) or fixed (which only needs to be recorded from time to time and does not have any accrual rules)	BenefitTypeEnumerated type: Click to see possible values and their descriptions.
units	Time frame for which the earned units are analyzed, i.e., the period an employee must work in the company to earn a particular accrual-type benefit	PeriodUnitsEnumerated type: Click to see possible values and their descriptions.
value	Amount for the fixed-type benefit, say bonus amount per year	double
version	Implements concurrency on this object	byte

Example Response

{
  "name": "Benefit",
  "accrualMethod": null,
  "createdById": "2df9829b-6b6a-4ba3-9bec-b7c91ab69735",
  "createdOn": "2024-09-05T05:42:10Z",
  "earnedUnits": null,
  "endsOn": "2024-09-05T05:42:10Z",
  "expiryDate": "2024-09-05T05:42:10Z",
  "expiryType": null,
  "id": "d3d77111-2236-40cd-b466-a97268d8986f",
  "isCompensation": true,
  "lastUpdated": "2024-09-05T05:42:10Z",
  "lastUpdatedById": "3bdfe80e-473d-4e9b-9363-2fc25391953e",
  "maxAccruedValue": 1,
  "maxCarryValue": 1,
  "maxValue": 1,
  "memo": "memo",
  "objectState": null,
  "period": null,
  "realizationDate": "2024-09-05T05:42:10Z",
  "realizationType": null,
  "resetDate": "2024-09-05T05:42:10Z",
  "resetType": null,
  "rules": [
    {
      "benefitId": "306c805a-2daa-4db7-8829-1d5320326270",
      "createdById": "ec1a49fa-bbed-4d86-950a-8f711e155622",
      "createdOn": "2024-09-05T05:42:10Z",
      "id": "d088b8bd-98a7-4228-b879-c574044dad78",
      "lastUpdated": "2024-09-05T05:42:10Z",
      "lastUpdatedById": "1582f730-d017-41db-8ea4-5f3617e2a375",
      "objectState": null,
      "periodUnits": 1,
      "token": 0,
      "unitsEarned": 1,
      "version": "U3dhZ2dlciByb2Nrcw=="
    }
  ],
  "startsOn": "2024-09-05T05:42:10Z",
  "status": null,
  "subType": null,
  "token": 0,
  "type": null,
  "units": null,
  "value": 1,
  "version": "U3dhZ2dlciByb2Nrcw=="
}

Create a Benefit

Use this method to save a benefit. Pass benefit as the parameter.

Request URL

base_url/hr/benefit

/hr/benefit

Method Overview

HTTP Method:

POST

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Headers:

Access Token

Module:

Benefit

Required Scopes:

readwrite:core

Required Subscription:

View Subscription

Request Parameters asterisk denotes required

Name	Parameter Type	Description	Format
body	Body	Benefit object	Benefit

Response Body

Name	Description	Format
name	Name of the benefit	string
accrualMethod	Describes how the accrual-type benefit is earned, whether it is based on the calendar year and the time elapsed till the current date (Calendar), or it is based on approved time entries (Time Card)	AccrualMethodEnumerated type: Click to see possible values and their descriptions.
createdById	Identifier of the user who created this object	uuid
createdOn	Date and time when this object was created (UTC Now), in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
earnedUnits	Type of units earned in the accrual-type benefit within the evaluated period, e.g., Hour or Day. This is used only when the accrual method is calendar-based	EarnedUnitsEnumerated type: Click to see possible values and their descriptions.
endsOn	Date when the fixed-type benefit ends or expires for an employee in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
expiryDate	Date when the accrued units that were carried forward expire in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss. This is used when the ExpiryType property is set as 'Specific Date'. Also, the day and month from this property are used for the recurrence when the ExpiryType property is set as ‘Recurring Date’	date-time
expiryType	Describes when the MaxCarryValue for the accrual-type benefit expires, i.e., when the accrued units that were carried forward are no longer valid, e.g., on the hire date anniversary, a specific date, a recurring date, etc.	BenefitResetTypeEnumerated type: Click to see possible values and their descriptions.
id	Object identifier	uuid
isCompensation	Indicates whether the fixed-type benefit is being offered as part of the compensation (salary) or not	boolean
lastUpdated	Last updated date and time value of this object in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
lastUpdatedById	Identifier of the user who last updated this object	uuid
maxAccruedValue	Maximum value of units an employee can accrue during a benefit earning period	double
maxCarryValue	Maximum value of accrued units that can be carried forward to the next benefit earning period when the current period ends	double
maxValue	Maximum amount allowed for the fixed-type benefit	double
memo	Records any extra information of the benefit for recapitulation	string
objectState	Represents the state of the object. e.g., new, unchanged, modified or deleted	ObjectStateEnumerated type: Click to see possible values and their descriptions.
period	Time for which the fixed-type benefit is provided, e.g., Day, Week, Month, etc.	PeriodUnitsEnumerated type: Click to see possible values and their descriptions.
realizationDate	Date when the full benefit quota becomes available for use in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss. This is used when the RealizationType property is set as 'Specific Date'	date-time
realizationType	Describes when the accrual-type benefit can be used, whether on the go as the benefits are earned, at the beginning or end of the benefit earning period, or at a specific date	RealizationTypeEnumerated type: Click to see possible values and their descriptions.
resetDate	Date when the accrual-type benefit balance is reset to zero in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss. This is used when the ResetType property is set as 'Specific Date'. Also, the day and month from this property are used for the recurrence when the ResetType property is set as ‘Recurring Date’	date-time
resetType	Describes when the accrual-type benefit expires, i.e., the benefit balance resets to zero, e.g., on the hire date anniversary, a specfic date, a recurring date, etc.	BenefitResetTypeEnumerated type: Click to see possible values and their descriptions.
rules []Array: Parent object can have multiple instances of this nested object under it.	List of benefit earning rules for accrual-type benefits	BenefitRule Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter.
startsOn	Date when the fixed-type benefit is assigned to an employee in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
status	Current status of the benefit, e.g., Active or Inactive	StatusEnumerated type: Click to see possible values and their descriptions.
subType	Sub-type of the accrual-type benefit, whether Sick or Vacation	BenefitSubTypeEnumerated type: Click to see possible values and their descriptions.
token	Represents the token for update operations	int32
type	Type of benefit, whether accrual (which allows you to define accrual rules and manage earned versus burned benefits) or fixed (which only needs to be recorded from time to time and does not have any accrual rules)	BenefitTypeEnumerated type: Click to see possible values and their descriptions.
units	Time frame for which the earned units are analyzed, i.e., the period an employee must work in the company to earn a particular accrual-type benefit	PeriodUnitsEnumerated type: Click to see possible values and their descriptions.
value	Amount for the fixed-type benefit, say bonus amount per year	double
version	Implements concurrency on this object	byte

Example Response

{
  "name": "Benefit",
  "accrualMethod": null,
  "createdById": "15206158-3d78-4601-9b3c-335e8f86aeca",
  "createdOn": "2024-09-05T05:42:10Z",
  "earnedUnits": null,
  "endsOn": "2024-09-05T05:42:10Z",
  "expiryDate": "2024-09-05T05:42:10Z",
  "expiryType": null,
  "id": "d585eff2-2cb3-451e-8e4c-6ac13984dbce",
  "isCompensation": true,
  "lastUpdated": "2024-09-05T05:42:10Z",
  "lastUpdatedById": "999e2830-6912-4a49-b545-14b9b283848f",
  "maxAccruedValue": 1,
  "maxCarryValue": 1,
  "maxValue": 1,
  "memo": "memo",
  "objectState": null,
  "period": null,
  "realizationDate": "2024-09-05T05:42:10Z",
  "realizationType": null,
  "resetDate": "2024-09-05T05:42:10Z",
  "resetType": null,
  "rules": [
    {
      "benefitId": "eede1ded-8152-4257-9a6e-0abcc9a7df4a",
      "createdById": "c271cd65-ab24-4145-ac44-04864f41f61d",
      "createdOn": "2024-09-05T05:42:10Z",
      "id": "6d2cbbbe-e88c-4658-a5eb-12717042d708",
      "lastUpdated": "2024-09-05T05:42:10Z",
      "lastUpdatedById": "b02967fb-32dd-4e8f-abd5-574a8c96e56f",
      "objectState": null,
      "periodUnits": 1,
      "token": 0,
      "unitsEarned": 1,
      "version": "U3dhZ2dlciByb2Nrcw=="
    }
  ],
  "startsOn": "2024-09-05T05:42:10Z",
  "status": null,
  "subType": null,
  "token": 0,
  "type": null,
  "units": null,
  "value": 1,
  "version": "U3dhZ2dlciByb2Nrcw=="
}

Create a Benefit List

Use this method to save multiple benefits. Pass model as the parameter.

Request URL

base_url/hr/benefit/batch

/hr/benefit/batch

Method Overview

HTTP Method:

POST

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Headers:

Access Token

Module:

Benefit

Required Scopes:

readwrite:core

Required Subscription:

View Subscription

Request Parameters asterisk denotes required

Name	Parameter Type	Description	Format
body	Body	Benefit object	BenefitBatchRequest

Response Body

Name	Description	Format
batchSize	Represents the number of entities in a batch	int64
createdById	Identifier of the user who created this object	uuid
createdOn	Date and time when this object was created (UTC Now), in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
id	Object identifier	uuid
lastUpdated	Last updated date and time value of this object in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
lastUpdatedById	Identifier of the user who last updated this object	uuid
objectState	Represents the state of the object. e.g., new, unchanged, modified or deleted	ObjectStateEnumerated type: Click to see possible values and their descriptions.
progress	Represents the total number of entities processed	int64
status	Represents the status of a job e.g., ready, running, completed, or terminated	string
token	Represents the token for update operations	int32
type	Represents the type of a job e.g., create, update, or delete	string
version	Implements concurrency on this object	byte

Example Response

{
  "batchSize": 0,
  "createdById": "01b966d6-6595-4c3e-85d4-cf699a438bea",
  "createdOn": "2024-09-05T05:42:10Z",
  "id": "3efe3a05-5be9-4c1f-93df-552ed9bcefee",
  "lastUpdated": "2024-09-05T05:42:10Z",
  "lastUpdatedById": "151392c9-9973-4d2c-bec5-4460bfcdb079",
  "objectState": null,
  "progress": 0,
  "status": "status",
  "token": 0,
  "type": "type",
  "version": "U3dhZ2dlciByb2Nrcw=="
}

Update a Benefit

Use this method to update a benefit. Pass id and benefit as the parameters.

Request URL

base_url/hr/benefit/{id}

/hr/benefit/{id}

Method Overview

HTTP Method:

PUT

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Headers:

Access Token

Module:

Benefit

Required Scopes:

readwrite:core

Required Subscription:

View Subscription

Request Parameters asterisk denotes required

Name	Parameter Type	Description	Format
id	Path	Benefit identifier	string
body	Body	Benefit object	Benefit

Response Body

Name	Description	Format
name	Name of the benefit	string
accrualMethod	Describes how the accrual-type benefit is earned, whether it is based on the calendar year and the time elapsed till the current date (Calendar), or it is based on approved time entries (Time Card)	AccrualMethodEnumerated type: Click to see possible values and their descriptions.
createdById	Identifier of the user who created this object	uuid
createdOn	Date and time when this object was created (UTC Now), in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
earnedUnits	Type of units earned in the accrual-type benefit within the evaluated period, e.g., Hour or Day. This is used only when the accrual method is calendar-based	EarnedUnitsEnumerated type: Click to see possible values and their descriptions.
endsOn	Date when the fixed-type benefit ends or expires for an employee in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
expiryDate	Date when the accrued units that were carried forward expire in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss. This is used when the ExpiryType property is set as 'Specific Date'. Also, the day and month from this property are used for the recurrence when the ExpiryType property is set as ‘Recurring Date’	date-time
expiryType	Describes when the MaxCarryValue for the accrual-type benefit expires, i.e., when the accrued units that were carried forward are no longer valid, e.g., on the hire date anniversary, a specific date, a recurring date, etc.	BenefitResetTypeEnumerated type: Click to see possible values and their descriptions.
id	Object identifier	uuid
isCompensation	Indicates whether the fixed-type benefit is being offered as part of the compensation (salary) or not	boolean
lastUpdated	Last updated date and time value of this object in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
lastUpdatedById	Identifier of the user who last updated this object	uuid
maxAccruedValue	Maximum value of units an employee can accrue during a benefit earning period	double
maxCarryValue	Maximum value of accrued units that can be carried forward to the next benefit earning period when the current period ends	double
maxValue	Maximum amount allowed for the fixed-type benefit	double
memo	Records any extra information of the benefit for recapitulation	string
objectState	Represents the state of the object. e.g., new, unchanged, modified or deleted	ObjectStateEnumerated type: Click to see possible values and their descriptions.
period	Time for which the fixed-type benefit is provided, e.g., Day, Week, Month, etc.	PeriodUnitsEnumerated type: Click to see possible values and their descriptions.
realizationDate	Date when the full benefit quota becomes available for use in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss. This is used when the RealizationType property is set as 'Specific Date'	date-time
realizationType	Describes when the accrual-type benefit can be used, whether on the go as the benefits are earned, at the beginning or end of the benefit earning period, or at a specific date	RealizationTypeEnumerated type: Click to see possible values and their descriptions.
resetDate	Date when the accrual-type benefit balance is reset to zero in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss. This is used when the ResetType property is set as 'Specific Date'. Also, the day and month from this property are used for the recurrence when the ResetType property is set as ‘Recurring Date’	date-time
resetType	Describes when the accrual-type benefit expires, i.e., the benefit balance resets to zero, e.g., on the hire date anniversary, a specfic date, a recurring date, etc.	BenefitResetTypeEnumerated type: Click to see possible values and their descriptions.
rules []Array: Parent object can have multiple instances of this nested object under it.	List of benefit earning rules for accrual-type benefits	BenefitRule Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter.
startsOn	Date when the fixed-type benefit is assigned to an employee in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
status	Current status of the benefit, e.g., Active or Inactive	StatusEnumerated type: Click to see possible values and their descriptions.
subType	Sub-type of the accrual-type benefit, whether Sick or Vacation	BenefitSubTypeEnumerated type: Click to see possible values and their descriptions.
token	Represents the token for update operations	int32
type	Type of benefit, whether accrual (which allows you to define accrual rules and manage earned versus burned benefits) or fixed (which only needs to be recorded from time to time and does not have any accrual rules)	BenefitTypeEnumerated type: Click to see possible values and their descriptions.
units	Time frame for which the earned units are analyzed, i.e., the period an employee must work in the company to earn a particular accrual-type benefit	PeriodUnitsEnumerated type: Click to see possible values and their descriptions.
value	Amount for the fixed-type benefit, say bonus amount per year	double
version	Implements concurrency on this object	byte

Example Response

{
  "name": "Benefit",
  "accrualMethod": null,
  "createdById": "bfa9ebc0-715f-4a8c-b91c-453dcfe6975c",
  "createdOn": "2024-09-05T05:42:10Z",
  "earnedUnits": null,
  "endsOn": "2024-09-05T05:42:10Z",
  "expiryDate": "2024-09-05T05:42:10Z",
  "expiryType": null,
  "id": "123d4f2a-ab7d-4ff0-b409-d2430d89475c",
  "isCompensation": true,
  "lastUpdated": "2024-09-05T05:42:10Z",
  "lastUpdatedById": "688577eb-adaa-41ec-a121-5689f52c609f",
  "maxAccruedValue": 1,
  "maxCarryValue": 1,
  "maxValue": 1,
  "memo": "memo",
  "objectState": null,
  "period": null,
  "realizationDate": "2024-09-05T05:42:10Z",
  "realizationType": null,
  "resetDate": "2024-09-05T05:42:10Z",
  "resetType": null,
  "rules": [
    {
      "benefitId": "2f094413-c649-45d4-ae80-819e0e9a8022",
      "createdById": "c0b7b804-f8b5-401c-83af-346db7aade4d",
      "createdOn": "2024-09-05T05:42:10Z",
      "id": "ff364b64-a2ea-405a-87ed-576d6f8bf548",
      "lastUpdated": "2024-09-05T05:42:10Z",
      "lastUpdatedById": "9fa21f00-ad7b-4370-97b4-1f620b538c95",
      "objectState": null,
      "periodUnits": 1,
      "token": 0,
      "unitsEarned": 1,
      "version": "U3dhZ2dlciByb2Nrcw=="
    }
  ],
  "startsOn": "2024-09-05T05:42:10Z",
  "status": null,
  "subType": null,
  "token": 0,
  "type": null,
  "units": null,
  "value": 1,
  "version": "U3dhZ2dlciByb2Nrcw=="
}

Delete a Benefit

Use this method to delete a specific benefit. Pass id as the parameter.

Request URL

base_url/hr/benefit/{id}

/hr/benefit/{id}

Method Overview

HTTP Method:

DELETE

Content Type:

application/json

Response Format:

N/A

Requires Authentication?

Yes

Headers:

Access Token

Required Scopes:

readwrite:core

Required Subscription:

View Subscription

Request Parameters asterisk denotes required

Name	Parameter Type	Description	Format
id	Path	Benefit identifier	string

Patch a Benefit

Use this method to perform partial modifications to a benefit. Pass id and patch document as parameters.

Request URL

base_url/hr/benefit/{id}

/hr/benefit/{id}

Method Overview

HTTP Method:

PATCH

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Headers:

Access Token

Module:

Benefit

Required Scopes:

readwrite:core

Required Subscription:

View Subscription

Request Parameters asterisk denotes required

Name	Parameter Type	Description	Format
id	Path	Benefit identifier	string
body	Body	A document containing an array of objects with each object representing a single operation to be performed	BenefitPatchDocument

Response Body

Name	Description	Format

Benefit

The Benefit Object

Request URL

Method Overview

Request Parameters asterisk denotes required

Response Body

Request URL

Method Overview

Request Parameters asterisk denotes required

Response Body

Request URL

Method Overview

Request Parameters asterisk denotes required

Response Body

Request URL

Method Overview

Request Parameters asterisk denotes required

Response Body

Request URL

Method Overview

Request Parameters asterisk denotes required

Response Body

Request URL

Method Overview

Request Parameters asterisk denotes required

Request URL

Method Overview

Request Parameters asterisk denotes required

Response Body