invantive documentation
Invantive Support ForumsLog In / Sign Up

LeaveDefaultsByEmploymentId: Loket.nl REST itgen_loketnl_leavedefaultsbyemploymentid_plural

read only REST

  • Catalog: LoketNlRest
  • Schema: Leave
  • Label: itgen_loketnl_leavedefaultsbyemploymentid_plural

Get the default values to be used when POSTing a new record Activity name : GetLeaveDefaultsByEmploymentId

Returns the default values for all the fields. In case no default is present null will be returned.

Can only retrieve data.

API Source

  • Endpoint: /providers/employers/employees/employments/{employmentId}/leave/defaults
  • Operation: get /providers/employers/employees/employments/{employmentId}/leave/defaults

Parameters

Name Data Type Required Default Documentation
employmentId `` The unique identifier of the employment

Table Columns

The columns of the table LeaveDefaultsByEmploymentId are shown below. Each column has an SQL data type. A new non-null value must be provided for every required column at all times during insert and update.

Name Data Type Label Required Marks Documentation
comment varchar2(4000) Comment
endDate datetime End Date The end date of the leave requested (last day of the leave)
id guid ID The unique identifier of an object (GUID/UUID)
isAccrual char itgen_loketnl_isaccrual Indicates whether the request is for accrual of leave. - false will result in a reduction of the employee's leave entitlement - true will result in an increase of the employee's leave entitlement
leaveType_balanceExceedsYear char itgen_loketnl_leavetype_balanceexceedsyear Indicates whether the balance at the end of the year for this leave type carries over to the next year.
leaveType_key int32 Leave Type Key The key for the leave type.
leaveType_value varchar2 Leave Type Value The description for the leave type. Note that leave types can be overridden at the employer level. In these cases the description at the employer level takes precedence over the default description of the leave type.
numberOfUnits double Number of Units The number of leave units requested
origin_leavePolicy_id guid itgen_loketnl_origin_leavepolicy_id The unique identifier (a GUID/UUID)
origin_leavePolicy_leaveUnitType_key int32 itgen_loketnl_origin_leavepolicy_leaveunittype_key The key for the leave unit Type.
origin_leavePolicy_leaveUnitType_value varchar2 itgen_loketnl_origin_leavepolicy_leaveunittype_value The description for the leave unit type
origin_leavePolicy_value varchar2 itgen_loketnl_origin_leavepolicy_value The description of the leave regulation.
origin_meansOfCreation_key int32 itgen_loketnl_origin_meansofcreation_key The key for the means of creation
origin_meansOfCreation_value varchar2 itgen_loketnl_origin_meansofcreation_value The description for the leave unit type
relatedLeave_id guid Related Leave ID The unique identifier (a GUID/UUID)
relatedLeaveRequest_id guid Related Leave Request ID The unique identifier (a GUID/UUID)
startDate datetime Start Date The start date of the leave requested
unitType_key int32 Unit Type Key The key for the unit type
unitType_value varchar2 Unit Type Value The description for the unit type

Release Notes

What changed per release in the tables, columns, attributes and capabilities of the driver: