Accrual Payout Request

This extension allows employees to initiate a business process or workflow to request that an accrual balance be paid. Organizations can specify in the business process which accruals can be paid out, or can enforce mandatory remaining balances whether fixed or a percentage. This extension avoids the limitations of using time-off requests for accrual payouts.

Note: This business process is an extension model that is developed outside the normal release schedule to meet specific customer needs. To request one of these models, you must submit a Salesforce Service Request to UKG. After the model is delivered to your tenant, you can edit it to meet your needs.
  • Employees can request the accrual payout.
  • The reviewers can approve or refuse the request.
  • Employees can delete their request if it is not approved yet.

Example: Employees can request to take their accrued vacation in money rather than time off.

Organizations that track employee entitlements using two accrual types, such as hours and money, can configure the accrual payout request to simultaneously deduct equivalent accrual hour and money amounts during approval.

Multiple approvers functionality is processed by way of a reviewer list. Final accrual payout is granted after all designated reviewers manually or automatically approve the request.

User experience

Request an accrual payout

Employees can request payouts of their accruals.

  1. Select the Accrual Payout Request business process from any of the following:
    Note: For more information, see the Run a Business Process topic.
    • Business Process tile
    • GoTo control from your Timecard or schedule
    • Control Center notification: Click Tap My Actions . Select Business Processes > the Accrual Payout Request.
  2. In Accrual Payout Request:
    1. In From Accrual, select the type of accruals.
    2. Enter the Amount in hours ( H:mm format), days ( D.d format), or money.
    3. (Optional) Enter your Reason for the payout.
    4. Click Tap Next.
    5. Review the Request Summary.
    6. Click Tap Submit.

Retract an accrual payout request

Employees can retract their requests for an accrual payout only if the manager has not yet approved or refused the request.

  1. Select My Notifications > Tasks.
  2. Select the accrual-payout request that you submitted. The request cannot be approved or refused.
  3. In Accrual Payout Request, review the details and then click tap Retract Request.

Manage accrual payout requests

Managers can approve or refuse requests for accrual payouts from employees.

  1. Select My Notifications > Tasks.
  2. Select the accrual-payout request that an employee submitted.
  3. In Accrual Payout Request:
    1. Review the details.
    2. Click Tap Approve or Refuse. Notifications go to you and the employee.

      If you approve the request for an hours-based accrual, the Timecard shows a single paycode edit and the actual amount.

      If you approve the request for a days-based accrual that spans multiple days, the Timecard shows multiple paycode edits, one for each day that is paid out.

      If you approve the request for an hours-based accrual, that is configured to simultaneously deduct an equivalent hours amount, the Timecard shows money and hour paycode edits with corresponding amounts.

    3. (Optional) Enter a Comment.
    4. Click Tap Submit.

Accrual payout requests considerations

When tracking two accrual types for the same entitlement, you must ensure that:

  • The employee's base wage assignment exceeds zero.
  • Each accrual has equivalent balances and configurations with respect to grants, limits, and policies.

You can set accrual code payout boundaries using:

  • Eligibility threshold.
  • Minimum payout.
  • Maximum payout.

Before you start

Before you configure this business process, you must do the following:

Comments: Configure two comments; one is used for the payout paycode edit and the other is used to identify the paycode edits in the Timecard. The paycode category and the active option must be selected during configuration of each comment. See the Comments topic.

Paycodes: Configure paycodes to support the accrual payout process. See the Paycode definition topic. Examples include:

An hours-based paycode that is added by the process to the employee's schedule as an indicative paycode. This paycode can optionally be configured as hidden.

The payout paycode that is added as a Taking in the accrual policies. Only one taking paycode is mapped with the accrual code in the Accrual Policy decision table. The Taking paycodes for time off are different from Taking paycodes for payout.

Corresponding money and hour paycodes used for Taking.

Note: This business process does not refer directly to the paycode in the Payout Pay Code in the accrual policy. The system uses this paycode when a manager starts an accrual payout, but this action pays out all of the remaining balance. For this requirement, employees can select the payout amount, so the business process uses a standard taking paycode in the accrual policy instead of the Payout Pay Code.

Accrual codes: Create accrual codes (hour, day, and money types) for which accrual payout requests are made. If Allow Manual Edits is selected, only the corresponding accrual code is available for payout. See the Accrual codes topic.

Accrual policies: Configure accrual policies using each of the accrual codes created for this business process. See the Accrual policies topic.

If an accrual policy has paycodes in Takings, only the corresponding accrual code is paid out.

Note: The takings paycode related to time-off is different from the taking paycode related to payout.

Accrual profiles: Configure an accrual profile using each of the accrual polices created for this business process. If an accrual policy is set to Display, only the corresponding accrual code is available for payout. See the Accrual profiles topic.

Note: Assign the accrual profile to the employee on the people information page or in the employment term assigned to the employee.

Symbolic purposes: Create a symbolic (reviewer) purpose of the Reviewer Override type and Active status. See the Symbolic Purposes topic.

Note:
  • People Information uses this purpose to link to the reviewers list.

  • Assign the Purpose to the employee in People Information under Timekeeping > Approvals & Reviewers.

Reviewer lists: Create a General and Active reviewer list so that the accrual request can identify the approver. Add the appropriate reviewer at each of the required steps, and select <None> in the Also Notify section. See the Reviewer Lists topic.

Note:
  • Only one reviewer is configured at each step. Do not repeat the same reviewer on multiple steps.

  • Assign the Reviewer List to the employee in People Information under Timekeeping > Approvals & Reviewers.

Workflow notifications: Configure two workflow notifications — one for the employee and the second for the reviewer. During the configuration of each notification, select Recipient List will be supplied at runtime and Send to employee in the Recipients section; and Do not suppress duplicates in the Suppress Duplicate Alerts section. See the Configure Notifications for Business Processes topic. Examples include:

Name: Accrual Payout Request — Employee Notification

Subject, Long Message and Control Center: Select custom tags as appropriate.

Name: Accrual Payout Request — Reviewer Notification

Subject, Long Message and Control Center: Select custom tags as appropriate.

Note: The notifications are automatically generated as system messages; control center notification mapping is not required. System message must be part of the employee and manager Control Center Profile.

Custom tags

Variable definitions

Tag name

Description

<Status>

Payout requests can have the following status:

Approved, the request is approved by the payout administrator;

Refused, the request is refused by the payout administrator;

Failed, the request failed because of a paycode edit API error; or

Retracted, the request was retracted by the employee.

<StatusMessage>

Details about the status of the request.

<EmpName>

The name of the employee who submitted the request.

Format: Name (EmployeeID).

<ReviewerName>

The name of the person who reviewed the request.

Format: Name (EmployeeID).

<AccrualCodeName>

The name of the accrual code.

<PayCodeName>

The name of the taking paycode.

<Amount>

The amount of the payout that is entered by the employee.

Format: Amount type.

Example: 10:00 Hours.

<RequestDate>

The date the request was submitted or the start date of the requested accrual.

<StatusChangeDate>

The most recent date when the status of the request was changed by the employee or the reviewer.

<EmpReason>

(Optional) A note for the reason the employee submitted the request.

<ReviewerComment>

(Optional) A comment by the reviewer for the reason they approved or refused the request.

<Assigned To>

The name of the person for which the request is awaiting approval.

Format: Name (EmployeeID).

Configure the Accrual Payout Requests process model

  1. Migrate the business process model to the tenant. Migrate the Accrual Payout Request process model to the customer tenant using Setup Data Manager (SDM).
    1. Log in to the appropriate tenant.

    2. Go to Main Menu > Administration > Setup Data Manager.

    3. Select the Source tenant where the Process Model resides, and select the template to copy. It is a .zip file. A message appears in the Source column: Source: Import from <filename>.zip.

    4. Click Tap Review and Publish. The Publish Summary panel appears.

    5. Review the Publish Summary panel. It lists the items that were extracted from the migration file. If you approve, click tap Publish with Comment or just Publish.

    6. Click Tap Go to Publish History at the bottom of the panel to view the status of the data transfer. The Publish History page contains a table that lists the items you have published. If there were errors during the transfer, the button under the Errors column for that row is black.

    7. To view details, click tap the appropriate row and click tap View Selected.

    8. On the History for publish run page, click tap Show all to view the setup data that you published, and the errors that occurred, if any, listed by item type and name.

  2. Configure the decision tables. Configure the Accrual Payout Request decision tables.
    Note: The process for configuring and deploying this and other Business Process Extensions is the same as all Business Process models .
    1. Go to Main Menu > Administration > Application Setup > Business Process setup > Process Models.

    2. Select the AccrualPayoutRequest_v5.2 process model and click tap Edit. The process model enters edit mode.

    3. Select the Decision Tables tab.

    4. Click Tap Everyone's, and then select the decision table to edit.

    5. Click Tap Decision Table Editor to add or update the rows in the table.

    6. Click Tap Save and close.

    Caution:
    • Values entered in the decision tables are case-sensitive, and must match configured values in UKG Pro Workforce Management.

    • Do not remove variables, variable names, or variable types from any decision table.

  3. Edit the following decision tables:
    • AccrualPayoutRequest_v5_2_Parameters — controls process parameters.

      Accrual Payout Request Parameters decision table structure

      Accrual Payout Request Parameters decision table structure

      Variable name

      Description

      Default value

      enableDebugging

      true— Error messages display without formatting. Useful for UAT and Test environments.

      false— Error messages display with formatting. Should be used in the production environment.

      The value is case-insensitive.

      false

      SymbolicPurpose

      Associates the payout business process with a reviewers list.

      Accrual Payout Request

      EmployeeNotification

      The name of the workflow notification that goes to the employee at the end of the request process. Provide NULL if notification is not required.

      Accrual Payout Request — Employee Notification

      ReviewerNotification

      The name of the workflow notification that goes to the reviewer at the end of the request process. Provide NULL if notification is not required.

      Accrual Payout Request — Reviewer Notification

      PaycodeComment

      The name of the comment to attach to the paycode. Provide NULL if the comment is not required.

      Adjusted by Workflow

      TotalizationWaitTime

      Specifies the amount of time, in seconds, that is allowed for the callable totalizer to complete totalization.

      5

      ShowEligibleAccrualCodeOnly

      true— Only eligible accrual codes are displayed in the drop down.

      false— All accrual codes are displayed in the drop down.

      true

      SilentApprovalDuration

      (Optional) Duration of time that must elapse in order for the accrual payout request to be auto-approved. Format: HH:mm.

      When a value is not provided, auto-approval is notenabled.

      48:00

      ApprovalPendingPaycode

      (Optional) The paycode applied to the employee timecard that tracks accrual payout requests.

      When a value is not provided, a paycode is notapplied to the employee timecard.

      Payout Approval Pending

      ApprovalPendingComment

      The comment attached to the ApprovalPendingPaycode.

      Accrual Payout Status

    • AccrualPayoutRequest_v5_2_AccrualPolicy — controls which accruals can be paid out.

      Accrual Payout Request Accrual Policy decision table structure

      Accrual Payout Request Accrual Policy decision table structure

      Variable name

      Description

      Accrual Profile

      The name of the accrual profile used to associate the business process with a reviewers list.

      Accrual Code

      The name of the accrual code used by the process.

      Paycode

      The name of taking paycode from the accrual policy.

      Provide only one paycode from the taking section list.

      Disallowed Overdraft

      The overdraft limit if it is configured in the accrual policy.

      Caution:

      When the Accrual Code column contains:

      • • An hours-based code, enter the value using format HH:mm
      • • A day-based or money-based code, enter the value using format D.d.

      Mandatory Remaining Balance

      The minimum balance that is required after the requested deduction is paid out.

      Caution:

      When the Accrual Code column contains:

      • An hours-based code and the Threshold Type= Fixed, enter the value using format HH:mm

      • An hours-based code and the Threshold Type= Percentage, enter the value using format D.d

      • A day-based or money-based code, enter the value using format D.d.

      Threshold Type

      Enter one of the following as the type of mandatory remaining balance:

      • Fixed = A fixed, unchanging value.
      • Percentage = A calculated percentage.

      (Optional) Allocated Paycode - Money Payout

      The name of the hour, or money paycode corresponding to the Paycode column content.

      Caution:

      When the Accrual Code column contains:

      • An hours-based code or money-based accrual code, this column must contain a value, or NULL.

      • A day-based code, this column must be blank.

      Eligibility Threshold Amount

      The minimum balance required before the requested deduction is paid out.

      Minimum Payout Amount

      The minimum accrual payout amount that an employee can request.

      Maximum Payout Amount

      The maximum accrual payout amount that an employee can request.

      Note:

      Maintaining separate rows in the AccrualPayoutRequest_v5_2_AccrualPolicy decision table for Accrual Codes and Paycodes using various locales is NOT required.

    • AccrualPayoutRequest_v5_2_Locale — allows customization of text in the Workflow form, and error messages for different locales.

      Accrual Payout Request Locale decision table structure

      Accrual Payout Request Locale decision table structure

      Variable name

      Variable type

      Description

      Key

      String

      Internal field label; do not change.

      Locale Policy

      String

      Name of the locale policy for which the label applies. When the label applies to all locales, retain the empty value.

      Message

      String

      Label displayed in the Workflow form, or error message.

      Description

      String

      (Optional) Additional information.

      Note:
      • Values entered in the Locale decision table are case-sensitive.

      • Do not use special characters in the table.

      • The Message value must be consistent with the Locale specified in the same row.

      • Because Activiti scans decision tables from top to bottom and stops when it finds a match, define rows containing the most-used conditions at the top of the table, and rows containing wildcard conditions at the bottom of the table.

      • The !="empty" rows must always be the last rows in the Locale decision table; do not edit or remove these rows. These are the default messages and labels.

      • Names of the parameters in the "Key" column of the Locale decision table must be used as is. If any parameter value needs to be localized for a different Locale Policy, copy the "Key" with the “not empty” Locale Policy, add a new row to the table with the appropriate Locale Policy, and then add the localized values in the Value decision table column.

    Sample Locale decision table values

    Sample Locale decision table values

    Key

    Value

    Description

    ACCRUAL_NOT_FOUND

    Accrual not found.

    When Accrual is missing.

    POST_REQ_PROFILE_CHANGED

    Accrual not found.

    When Accrual is missing.

    INACTIVE_PURPOSE_FOUND

    Symbolic Purpose not found.

    When symbolic purpose is wrong.

    INVALID_COMMENT_FOUND

    Paycode comment not found.

    Pay code comment is missing.

    INVALID_CC_MAPPING_FOUND

    Control center notification mapping not found.

    Control center mapping for notification is missing.

    NO_PEOPLE_PURPOSE_FOUND

    Symbolic Purpose not found.

    When symbolic purpose is missing.

    REVIEWERLIST_INVALID_REVIEWER

    Symbolic Reviewer not supported.

    When symbolic reviewer is invalid.

    REVIEWERLIST_INVALID_CONFIG

    Invalid Reviewer List.

    When reviewer list is invalid.

    REVIEWERLIST_INACTIVE

    Inactive Reviewer List.

    When reviewer list is inactive.

    MANAGER_REVIEWER_NOT_FOUND

    Reports To not found.

    When Reports To is not defined for an employee.

    LEAVE_REVIEWER_NOT_FOUND

    Leave Administrator not found.

    When Leave Administrator is not defined for an employee.

    ATTENDANCE_REVIEWER_NOT_FOUND

    Attendance Administrator not found.

    When Attendance Administrator is not defined for an employee.

    DEFAULT_ERROR_TITLE

    Error while processing request:

    Error message title.

    INSUFFICIENT_BALANCE

    Insufficient balance.

    Insufficient accrual balance message.

    POOR_FIXED_REMAINING_BALANCE

    Maximum allowed payout is <CALCULATED_BALANCE>. Mandatory remaining Balance: <DT_BALANCE>.

    Error message for FIXED remaining balance.

    POOR_PERCENTAGE_REMAINING_BALANCE

    Maximum allowed payout is <CALCULATED_BALANCE>. Mandatory remaining Balance: <PERCENTAGE>% of <CURRENT_BALANCE>.

    Error message for PERCENTAGE remaining balance.

    DEFAULT_ERROR

    An unknown error occurred. Please contact your system administrator.

    Default error message.

    STATUS_MESSAGE_APPROVED

    Approved

    Approved Status message.

    STATUS_MESSAGE_REFUSED

    Refused

    Refused Status message.

    STATUS_MESSAGE_FAILED

    The request was unsuccessful:

    Failed Status message.

    STATUS_MESSAGE_DELETED

    Retracted

    Retracted Status message.

    UI_VALIDATION_ERROR_TITLE

    Rule Violation:

    Validation error title.

    UI_AMOUNT_INCORRECT

    Incorrect amount format.

    When the accrual amount is incorrect format.

    UI_AMOUNT_TOO_LARGE

    Amount is too high.

    When the accrual amount is high.

    UI_AMOUNT_ZERO_NOT_ALLOW

    Amount must be greater than zero.

    When accrual amount entered is 0.

    ACCRUAL_DISPLAY_KEY

    From Accrual

    Display name for Accrual title.

    AMOUNT_DISPLAY_KEY

    Amount

    Display name for Amount title.

    REASON_DISPLAY_KEY

    Reason

    Display name for Reason title.

    REVIEWER_DISPLAY_KEY

    Reviewer

    Display name for Reviewer title.

    ACCRUAL_TAG

    Accrual Name

    Display name for Accrual.

    PAYOUT_TAG

    Payout Amount

    Display name for Amount.

    REASON_TAG

    Reason

    Display name for Reason.

    EMPLOYEE_TAG

    Employee

    Display name for Employee.

    REVIEWER_OPTION_LABEL

    Please Select

    Reviewer option label in task assignment.

    REVIEWER_COMMENT_LABEL

    Comment

    Comment label visible in task assignment.

    APPROVED

    Approved

    Approved

    REFUSED

    Refused

    Refused

    RETRACTED

    Retracted

    Retracted

    FAILED

    Failed

    Failed

    EMP_REQUEST_SUMMARY

    Request Summary

    Request summary title in employee task assignment.

    REVIEWER_REQUEST_SUMMARY

    Request Summary

    Request summary title in reviewer task assignment .

    DELETED

    Retracted

    Retracted.

    EMP_COMMENT_LABEL

    Comment

    Comment label .

    APPROVE_LABEL

    Approve

    Approve label.

    REFUSE_LABEL

    Refuse

    Refuse label.

    RequestDetailPaycodeNote

    Payout for <AMOUNT> from <ACCRUAL> approved by <REVIEWER>.

    Tag for approval notification pay code note.

    EmployeeReasonPaycodeNote

    Reason: <REASON>.

    Tag for Employee Reason in pay code Note.

    ReviewerCommentPaycodeNote

    Comment: <COMMENT>.

    Tag for Reviewer Comment pay code Note.

    ELIGIBILITY_THRESHOLD

    Minimum Accrual Balance Required for Payout is <ELIGIBILITYTHRESHOLD>, Current Balance <CURRENT_BALANCE>.

    Error message when accrual balance is less than the eligibility threshold.

    MIN_MAX_THRESHOLD

    The Payout amount should be between <MINIMUM_THRESHOLD> and <MAXIMUM_THRESHOLD>, Requested amount <REQUESTED_AMOUNT>.

    Error message when the requested amount is either less than minimum payout or greater than maximum payout.

    EMPLOYEE_AUTO_APPROVAL

    Auto-Approval on <APPROVAL_DATE>.

    Label for employee task.

    MANAGER_AUTO_APPROVAL

    Auto-Approval on <APPROVAL_DATE>.

    Label for manager task.

    AUTO_COMPLETED_BY_PAYCODE_NOTE

    Completed By: <REVIEWER_NAME> (Auto Approval).

    Label for Indicative Pay Code comment note when auto-approved.

    AUTO_ASSIGNED_TO_PAYCODE_NOTE

    Assigned To: <REVIEWER_NAME> (Due Till: <DUE_DATE>).

    Label for Indicative Pay Code comment note when auto-approved.

    COMPLETED_BY_PAYCODE_NOTE

    Completed By: <REVIEWER_NAME>.

    Label for Indicative Pay Code comment note.

    ASSIGNED_TO_PAYCODE_NOTE

    Assigned To: <REVIEWER_NAME>.

    Label for Indicative Pay Code comment note.

    PREV_MANAGER_REVIEWER_NOT_FOUND

    Previous reports to not found.

    Error message label when previous reviewer’s manager is not found.

    PREV_LEAVE_REVIEWER_NOT_FOUND

    Previous leave administrator not found.

    Error message label when previous reviewer’s Leave administrator is not found.

    PREV_ATTENDANCE_REVIEWER_NOT_FOUND

    Previous attendance administrator not found.

    Error message label when previous reviewer’s Attendance administrator is not found.

    AUTO_APPROVE_LABEL

    (Auto-Approved)

    Label used to denote auto-approval on payout pay code edit note.

    NEXT_TAG

    Next

    Label used to denote Next button.

    SUBMIT_TAG

    Submit

    Label used to denote Submit button.

    CLOSE_TAG

    Close

    Label used to denote Close button.

    RETRACT_REQUEST_TAG

    Retract Request

    Label used to denote Retract Request button.

  4. Deploy the business process model. Process models must be redeployed every time changes are made to an existing model. Re-deployment is not required for decision table changes.

    Follow these steps to deploy the process model. For detailed information, see the online help topic Deploy Business Process Models .

    1. Go to Main Menu > Administration > Application Setup > Business Process Setup > Process Models.

    2. Select the AccrualPayoutRequest_v5.2 model.

    3. Click Tap Edit, and then configure the required parameters and deployment dates.

      • (Optional) In Description, enter Accrual Payout Request.
      • In Display Name, enter AccrualPayoutRequest_v5.2.
      • In Start Effective, select the effective start date.
      • In End Effective, select Forever to make the Business Process available indefinitely.
      • In Status, select Active.
      • In Action List, select Hide.
      • In Tile List, select Show.
      • In GoTo List, select Hide.
        Caution: Do not make a selection from the Template Categories list.
    4. Click Tap Save, and then select Return to deploy.

    5. Add the process model to the required process profile.

    6. Assign the process profile to employees by way of People Information.

Configure the Accrual Payout Requests dataview

Migrate the Accrual Payout Request dataview to the customer tenant using Setup Data Manager (SDM).

  1. Log in to the appropriate tenant.

  2. Go to Main Menu > Administration > Setup Data Manager.

  3. Select the Source file, SDM_Dataview_AccrualPayoutRequest.

  4. Click Tap Review and Publish. The Publish Summary panel appears.

  5. Review the Publish Summary panel. It lists the items that were extracted from the migration file. If you approve, click tap Publish with Comment or just Publish.

  6. Click Tap Go to Publish History at the bottom of the panel to view the status of the data transfer. The Publish History page contains a table that lists the items you have published. If there were errors during the transfer, the button under the Errors column for that row is black.

  7. To view details, click tap the appropriate row and click tap View Selected.

  8. On the History for publish run page, click tap Show all to view the setup data that you published, and the errors that occurred, if any, listed by item type and name.

  9. Add the dataview to the required dataview profile.

  10. After the dataview is published, go to Main Menu > Dataviews & Reports > Dataview Library > Accrual Payout Request.

  11. (Optional) You can alter the default dataview column configuration.

    See the Edit a Dataview topic.

    1. Go to Home > Application Setup > Display Preferences > Information Access > Dataview Management, and then select Accrual Payout Request.

    2. Select the column that you want to modify, click tap Edit, and then select the appropriate value.

      • Hyperfind: Default = All Home

      • Paycode Name: Default = Payout Approval Pending

      • Notes: Default = Assigned To

APIs

API details

API details

Name

Section

Type

Resource path

Location

Retrieve User Preferences for Current User

API > Common Resources II > Locale Settings > User Preferences > Retrieve User Preferences for Current User

GET

/v1/commons/user_preferences/locale_policy

EmpLocaleDetails: Retrieve the tenant locale if no locale is found for the employee.

Retrieve Locale Policy

API > Common Resources II > Locale Settings > Locale Policies > Retrieve Locale Policy

GET

/v1/commons/locale_policies

EmpLocaleDetails: Retrieve the employee locale.

Retrieve Reviewer List by ID

API > Common Resources I > Reviewer Lists > Retrieve Reviewer List by ID

GET

/v1/commons/reviewer_lists/{id}

GetReviewerList

Retrieve Attendance Admin by Person ID

API > People > Person Assignments > Attendance Administrator Assignments > Retrieve Attendance Admin by Person ID

GET

/v1/commons/persons/attendance_admin/{personId}

GetSymbolicAdmin: If the reviewer is the Attendance Administrator.

Retrieve Leave Admin by Person ID

API > People > Person Assignments > Leave Administrator Assignments > Retrieve Leave Admin by Person ID

GET

/v1/commons/persons/leave_admin/{personId}

GetSymbolicAdmin: If the reviewer is the Leave Administrator.

Retrieve All Symbolic Purposes or by Name or Type

API > Common Resources I > Symbolic Purposes > Retrieve All Symbolic Purposes or by Name or Type

GET

/v1/commons/symbolic_purposes

SymbolicPurposeDetail

Retrieve Persons

API > People > Persons > Retrieve Persons

POST

/v1/commons/persons/extensions/multi_read

EmpRecordDetails and the base wage for an employee.

Retrieve Timecard Data for Multiple Employees

API > Timekeeping > Timecard Metrics > Retrieve Timecard Data for Multiple Employees

POST

/v1/timekeeping/timecard_metrics/multi_read

GetAccrualDetail

Retrieve Employment Term by ID

API > Timekeeping Setup > Employment Terms > Retrieve Employment Term

GET

/v2/timekeeping/setup/employment_terms/{id}

EmployeeTerms Detail

Retrieve Comments as Manager

API > Common Resources I > Comments > Retrieve Comments — Manager

GET

/v1/commons/comments

CommentDetail

Retrieve Accrual Codes from Paycodes

API > Timekeeping > Accruals > Accrual from Paycodes — Retrieve Accrual Codes from Paycodes

POST

/v1/timekeeping/paycodes_ to_accrual_codes/multi_read

GetPaycodeMappings

Retrieve All Dynamic Event Notification Mappings

API > Common Resources I > Dynamic Event Notification Mappings > Retrieve All Dynamic Event Notification Mappings

GET

/v1/commons/event_notifications

CCMappingDetail

Retrieve Display Profile by ID

API > Common Resources I > Display Profiles > Get Display Profiles

GET

/v1/commons/display_profile/{profileId}

EmpDisplayProfile

Update Timecard as Manager

API > Timekeeping > Timecard > Update Timecard as Manager

POST

/v1/timekeeping/timecard

updateTimeCardReq: To add the paycode in the employee Timecard.

Retrieve Timezone by ID

APR-> Commons->Timezone

GET

v1/commons/setup/timezones/{id}

retrieveTimezone

Bulk Import Paycode Edits

API->Timekeeping Bulk Operations

POST

/v1/timekeeping/pay_code_edits/import

initialPayCodeEdit

Create Paycode Edits

APR -> Scheduling

POST

/v1/scheduling/schedule/pay_code_edits/multi_create

initialPayCodeEdit

Update Paycode Edits

APR -> Scheduling

POST

/v1/scheduling/schedule/pay_code_edits/multi_update

addPayCodeEdit

Version history

Version history

Version

Description

1

Initial release.

Provides a mechanism for employees to request an accrual payout.

2

Enhanced to:

  • support dynamic decision tables.

  • utilize the hour format configured in the display profile.

2.1

Addressed an issue to support multilingual accrual codes.

3

  • Enhanced to support hours equivalent deduction of the cashed-out amount.

  • Extended localization support by way of the decision table.

3.1

Addressed an issue to support commas that are configured as the decimal separator in the locale policy.

4

Enhanced to provide optional constraints that prevent employees from submitting requests that do not comply with policy.

5

Enhanced to support:

  • multiple approvers configured in the reviewer list.

  • silent approval.

Introduced a dataview that displays pending accrual payout requests.

5.1

The Accrual Payout Request workflow generated a script error when an hours-based accrual code configuration was combined with a percentage threshold type.

5.2

Localization of all buttons is now supported by the Accrual Payout Request workflow.