Chile Timecard Report

Note: This extension, a combined integration and BIRT report, is developed outside the normal release schedule to meet specific customer needs. To request one of these extensions, you must submit a Salesforce Service Request to UKG. After the extension is delivered to your tenant, you can edit it accordingly.

In compliance with legislation in Chile, the Chile Timecard Report extension generates a report that employers provide to employees.

This extension relies on two components to produce the report:

When the Boomi™ integration completes, the Chile Timecard Report is available in the completed section of the Report Library.

The report is designed with a fixed layout, but labels can be edited in the report properties file. Organizational details are reflected in the report header and footer through customized fields, such as: Company name; Address lines 1,2, and 3. Default branding capabilities in UKG Pro Workforce Management™ provide the mechanism for adding the company logo in the report header.

The Boomi™ integration uses combined paycode A category of time or money that employees earn, for example, Regular Hours, Bonus, or Sick. totals from the timecard in the report. Mapping between the timecard and report data appears as follows:

Combined paycodes and report column mapping
Combined paycode Report column name Combined paycode description
Approved Hours Permisos Horas All hours that are considered approved and worked, such as Regular.
Approved Days Permisos Dias All days that are considered approved absences, such as Sickness.
Vacation Days Vacaciones Dias All absence days that are considered vacation, such as Vacation.
Unauthorized Hours Tiempos No Authorizado All overtime hours that were refused during overtime approval, such as Overtime Denied.
Overtime Horas Extra Horas All hours that are considered approved overtime, such as OT50 or OT100.
Rest Days Horario Planificado Tipo All hours that are considered as the employee's rest days. This is a day-based paycode added on days when the employee has rest. When this paycode is found in the timecard, the Tipo column displays the Descanso label.

The selected report format limits the maximum combination of employees and days that a report generates.

Report limitations
Report format Maximum number of employees selected in the location Maximum number of days
PDF <=10,000 365
PDF >10,000 <=25,000 15
Excel (XLSX) <=10,000 365

Run the Chile Timecard Report integration

After navigating to the integration, the user selects the Hyperfind and time period for which the report is generated.

Go to the Report Library

The user navigates to the Report Library and retrieves the report from the Completed section.

Version history — Report
Version Description
v1 Initial release.
This configurable BIRT report receives timecard data from a Boomi™ integration based on a specified Hyperfind and time period.

UKG Pro Workforce Management™ report configuration

Customize the report labels.

  1. Unzip the shared file ChileTimecardReport_v1.zip.

  2. Navigate to ChileTimecardReport_v1 > Properties , and then open file report_com.kronos.report.data.design.ChileTimecardReport_v1_strings.properties.

  3. Provide values for the following report strings:

    Company Name
    Address Line1
    Address Line2
    Address Line3
    Report Title
    Report Footer

  4. Save the changes, and then add the updated file to the zip file.

Localize the report strings.

  1. Unzip the shared file ChileTImecardReport_v1.zip.

  2. Create a new properties file that adheres to the following naming convention: report_com.kronos.report.data.design.ChileTimecardReport_v1_strings_<languageCode>_<countryCode>.properties

    Example: report_com.kronos.report.data.design.ChileTimecardReport_v1_strings_fr_FR.properties

  3. Copy each key and value data pair from report_com.kronos.report.data.design. ChileTimecardReport_v1_strings.properties, and then paste the content into the new file.

  4. Replace all values after the "=" with required locale data, and then save the properties file.

  5. Zip the file after completing and saving all localization.

Note:

Refer to the table for appropriate character sequences to use in the properties file.

Character sequence
Character Character Sequence
Space \
Colon \:
Semicolon \;
Blank \t

Note: If you plan to test the report in your non-production (NPR) environment before implementation in your production (PRD) environment, you must complete each of the following UKG Pro Workforce Management™ report configuration steps in both NPR and PRD environments.

Migrate the report data objects (RDO) configuration to the tenant

Migrate the SDM Set-up Data Manager moves and manages configuration data across software and hardware environments._ChileTimecardReport_RDO.zip 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 RDO configuration 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.

Deploy the Chile Timecard Report

The BIRT report must be redeployed every time changes are made to existing report objects. Re-deployment is not required for integration process changes.

  1. Go to Main Menu > Administration > Application Setup > Common Setup > Manage Read-Only Report.

  2. Click Tap Create, and then select Choose File.

  3. Select the ChileTimecardReport_v1.zip file, and then click tap Upload.

  4. Click Tap Save after the upload completes.

  5. Go to Main Menu > Administration > Application Setup > Common Setup > Unpublished Reports.

  6. Select ChileTimecardReport, and then click tap Publish.

  7. Configure the report-specific fields:

    Report Name
    Default Output Type: pdf
    Output formats: PDF, XLXS
    Category: Custom Reports

    Note: The value entered in Report Name must match the integration control parameter Report — Name.

  8. Click Tap Save to publish the report. See the Unpublished Reports topic.

Configure the logo

Configure the branding logo that appears in the report header. After choosing the file, select Use this logo for all reports regardless of the active theme. Report logos are displayed on a white background. See the Themes topic.

Note: By default, the system uses the logo specified in the active theme for reports. If you wish, you can designate that the logo specified in a different theme be used for all reports, even if that theme is not active.

Approve the report

  1. Login to UKG Pro Workforce Management™ as a Support User.

  2. Go to Main Menu > Administration > Application Setup > Common Setup > Manage Read-Only Report.

  3. Select the ChileTimecardReport file, and then click tap Review.

  4. Select Approve, and then click tap Apply. This action changes the Approval Status from Pending to Approved.

Configure access to the Chile Timecard Report

Add the Chile Timecard Report to the Report Data Access Profile assigned to individuals who run the report. See the Report Data Access Profiles Report Data Access Profiles topic.

Version history — Integration
Version Description
v1 Initial release.
This integration retrieves timecard data for a specified Hyperfind and time period, and then provides the data for report generation.

UKG Pro Workforce Management™ prerequisites

UKG Pro Workforce Management™ configurations

  1. Integration List Parameters: Configure a ChileTimecardReport_ReportOutputFormat list parameter containing PDF (default) and XLSX parameter values. See the Configure Integration List Parameters topic.

  2. Extensions Table: Configure a Chile Timecard Report extensions table. See the Extension Tables topic. Enter the following in Commands for execution:

CREATE TABLE chiletimecardreport
(
ApplyDate VARCHAR(255),
TypeOfEntry VARCHAR(255),
EmployeeNumber VARCHAR(255),
EmployeeName VARCHAR(255),
ScheduleStartTime VARCHAR(255),
ScheduleEndTime VARCHAR(255),
Exceptions VARCHAR(255),
InPunch VARCHAR(255),
AmountOfTimeLateIn VARCHAR(255),
OutPunch VARCHAR(255),
AmountOfTimeEarlyOut VARCHAR(255),
ApprovedHours VARCHAR(255),
ApprovedDays VARCHAR(255),
Vacation VARCHAR(255),
DailyTotals VARCHAR(255),
UnauthorizedHours VARCHAR(255),
OvertimePayCode VARCHAR(max),
OvertimeHours VARCHAR(255),
UniqueCode VARCHAR(255),
ExecutionDate VARCHAR(255),
SumDailyTotals VARCHAR(255),
SumApprovedHours VARCHAR(255),
SumApprovedDays VARCHAR(255),
SumVacation VARCHAR(255),
SumUnAuth VARCHAR(255),
SumOvertime VARCHAR(255),
SumLateIn VARCHAR(255),
SumLateOut VARCHAR(255)
);

  1. Configure Access to Integrations.
  2. Deploy the ChileTimecardReport_v1 integration; see the Deploy Integrations topic.
  3. Get the URL for the APIGatewayServer for the tenant.

Select the environment

  1. Open the Integration Template Designer: Select Main Menu  > Administration > Application Setup > Integrations Setup > Design Integration Templates.

    Note: If prompted, enter your Username and Password. Click Tap Log in.

  2. Select the Manage tab > Atom Management.
  3. Select your environment.

Select environment extensions

  1. In Administration, click tap Environment Extensions.
  2. In Process Filter, click tap the magnifying glass Search button. It can take several seconds before the button becomes active.
  3. Scroll to and select the integration pack: ChileTimecardReport > ChileTimecardReport_v1.

Caution: If you select Use Default for the connection settings and process properties, ensure that Value is blank. If Value is not blank, that value overrides the default value whether or not Use Default is selected or cleared. Example: If the default value is abc, but Value shows xyz, the integration uses xyz regardless of the setting of Use Default.

Configure connection settings

  1. Select Connection Settings.

  2. From the Connection dropdown list, select and configure the following:

    Connection Settings
    Setting Required Actions
    APIGatewayServer Required

    (Optional) To change the default API gateway server:

    1. Clear Use Default.
    2. Enter the URL to the server.

      Example: <tenantURL>/api
    ChileTimecardReport_DataBaseServer Required

    The database server setting defines the connection to the file that contains the records.

    To change the default server parameters:

    1. For each field, clear Use Default.
    2. Enter the following values:

      In User, enter the username for the server.

      In Password, select <Encrypted>. Enter the password for the server. Click Tap Apply.

      Enter the Class Name.

      Enter the Connection URL for the database server.

Configure process properties

  1. Select Process Properties.

    Caution: Do not edit the default values of the AuthenticationProperties. By default, cookies are enabled and set the values for authentication properties.

  2. Select ChileTimecardReport_v1_CRTConfig.

  3. For the process property, disable the Use Default option, and then provide the cross-reference table (CRT) column header value.

    Process Property
    Process property name Column header value
    ChileTimecardReport_v1_Locale_CRT Name,Locale Policy,Value,Description

  4. In the Cross Reference section, enable the override option for the CRT.

Configure cross-reference tables

Cross-reference tables (CRT) are the look-up tables that the integrations use to translate parameter values. One or more data values from the source system can be used to assign one or more parameters in the destination system.

  • If more than one row matches a reference value, the first match is the output value.

  • If no match is found, the output value can be null, or the integration can produce errors.

  1. Select Cross Reference.
  2. From the Cross Reference dropdown list, select a ChileTimecardReport table.
  3. Select Override, which allows you to:
  • Download the table when you run the integration.
  • Edit the table cells in Extensions.
  1. When you finish, click tap OK.

ChileTimecardReport_Locale_CRT: Allows translation of messages and labels into different languages.

Chile Timecard Report — Locale CRT
Column header Description
Parameter Name Parameters defined in ChileTimecardReport_v1_Locale_CRT process property.
Locale Policy Locale Policy.

You can use an asterisk (*) as a wildcard, but put the less-restrictive locale policy names at the bottom of the table because the integration scans cross-reference tables from the top.
Value Message shown in Additional Details, or value of the label defined in the Run Summary section.

Example: Hyperfind or Location not provided.
Description The description that is shown in Additional Details.
Note:

  • Localization of integration extensions remains optional, but is supported.

  • The cross-reference table (CRT) holds all messages represented with standard English labels; these apply to all locales when the Locale is set to a wildcard (*).

  • Some or all messages can be translated by adding lines to the table in their preferred translation for specific locales. Messages for the most commonly used Locale Policy should be defined at the top of the CRT.

  • Names of the parameters in the CRT column "Parameter Name" must be used as is. If any parameter value needs to be localized for a different Locale Policy, copy the "Parameter Name" with the * Locale Policy, add a new row to the CRT with the appropriate Locale Policy, and then add the localized values in the Message (or Value) and Description CRT columns.

  • Do not enter values in the CRT column "Description" if it is blank.

  • Do not modify tags (<>) or the variable values that are included in the CRT column "Message" (or "Value").

Parameter key names

Parameter key name

Use

Error_HyperfindAndLocationSelector

The Hyperfind or Location cannot be found or is not valid error shows in the Run Summary when neither Hyperfind nor Location is selected during the integration run.

Error_TimePeriod

Time period not provided error shows in the Run Summary when a time period is not selected during the integration run.

Error_ApprovedHoursPayCode

Approved Hours paycode not provided error shows in the Run Summary when the approved hours paycode integration parameter is not defined.

Error_ApprovedDaysPayCode

Approved Days paycode not provided error shows in the Run Summary when the approved days paycode integration parameter is not defined.

Error_VacationDaysPayCode

Vacation Days paycode not provided error shows in the Run Summary when the vacation days paycode integration parameter is not defined.

Error_UnauthorizedHoursPayCode

Unauthorized paycode not provided error shows in the Run Summary when the unauthorized hours paycode integration parameter is not defined.

Error_RestPayCode

Rest paycode not provided error shows in the Run Summary when the rest paycode integration parameter is not defined.

Error_OvertimePayCode

Overtime paycode not provided error shows in the Run Summary when the overtime paycode integration parameter is not defined.

Error_ReportName

Report name not provided error shows in the Run Summary when the report name integration parameter is not defined.

Error_ReportOutputFormatMissing

Report output format not provided error shows in the Run Summary when the report output format integration parameter is not defined.

Error_NoEmployee

Selected hyperfind is blank. No employee returned. error shows in the Run Summary when the Hyperfind or Location returns no employees.

Crt_Blank_Code

Omitido shows in the Entrada and Salida report columns when no punches exist for the shift.

Regular_Entry

Prog. Trab shows in the Tipo report column when a scheduled shift exists.

Rest_Entry

Descanso shows in the Tipo report column when a rest day entry exists.

Error_ReportOutputFormatIncorrect

Incorrect report output format. Accepted values: pdf, xlsx shows in the Run Summary

Error_InvalidPayCode

Invalid Paycode(s) shows when paycodes are not found in the application.

Exception_early_in

EI represents early in exception in the Falta report column.

Exception_long_break

LB represents long break exception in the Falta report column.

Exception_long_total_break

LTB represents long total break exception in the Falta report column.

Exception_late_out

LO represents late out exception in the Falta report column.

Exception_unexcused_absence

UA represents unexcused absence exception in the Falta report column.

Exception_very_Late_out

VLO represents very late out exception in the Falta report column.

Exception_late_in

LI represents late in exception in the Falta report column.

Exception_short_total_break

STB represents short total break exception in the Falta report column.

Exception_short_break

SB represents short break exception in the Falta report column.

Exception_core_hours_violation

CHV represents core hours violation exception in the Falta report column.

Exception_cancelled_Deduction

CD represents canceled deduction exception in the Falta report column.

Exception_very_early_in

VEI represents very early in exception in the Falta report column.

Exception_early_out

EO represents early out exception in the Falta report column.

Exception_short_shift

SS represents short shift exception in the Falta report column.

Exception_long_shift

LS represents long shift exception in the Falta column of the report.

Exception_missed_in_punch

MIP represents missed in-punch exception in the Falta report column.

Exception_missed_out_punch

MOP represents miss out-punch exception in the Falta report column.

Exception_unscheduled

USCH represents unscheduled exception in the Falta report column.

Exception_bonus_applied

BA represents bonus applied exception in the Falta column of the report.
Exception_excused_absence EA represents excused absence exception in the Falta report column.

Message_SuccessReportStatus

Please navigate to the Report Library page to fetch the report shows in the Run Summary when the integration completes successfully.

Error_ReportStatus

Failed to execute the report shows in the Run Summary when the integration fails to run the report.

Message_BlankReport

No data found to generate the report shows in the Run Summary when no data generates for the report.

After the integrations are deployed and the connection settings and process properties are configured, install the integrations to make them available for running or scheduling.

Note:
  • An integration template is the configured integration that you deploy to an Atom and then install to make available for running or scheduling.
  • An installed integration is a single instance of an integration that is based on an integration template. When you install an integration, you can define parameters or set parameters to be defined when the integration is run.
  1. Select Main Menu  > Administration > Application Setup > Integrations Setup > Install Integrations.
  2. Click Tap Create .
  3. In Integration Name, enter ChileTimecardReport_ReportOutputFormat. The Name must be unique.
  4. (Optional) Enter a Description, such as Output formats applicable to report Chile Timecard Report.
  5. Do not select API Integration.
  6. In File Access, select None to not select a connection.
  7. If the person who runs the integration does not have full access to integrations, select Execute Integration with System Account. This allows the integration access to all APIs in the FAP, and the relevant permissions and data, regardless of the FAP and GDAP of the person who runs the integration.

  8. (Optional) Select Re-Run to allow repeated runs of the integration with the same parameter values as the previous run.

  9. Email Notifications

    (Optional)

    1. Select Yes to send email and control center notifications for integration runs.
    2. Enter the email addresses of the recipients for the following types of run status. For multiple recipients, separate the addresses by a comma, but no spaces:

      In Progress — The integration run started and has not finished.

      Completed — The integration ran successfully without errors.

      Failed — The integration ran successfully, but one or more records have errors. The integration run is treated as failed. If Abort on Failure is configured in an integration set A sequence of integrations that can be run on-demand or be scheduled., the integration set stops.

      Completed with Errors — The integration run has errors or could not run.

  10. In Skip Configuration, select None (default) to allow multiple integrations to run at the same time or with the same data without restrictions.
  11. Do not select Allow Minute Interval.
  12. Integration template and parameters
    1. In Integration Template, select ChileTimecardReport_v1.
    2. Click Tap Assign .
    3. In Integration Parameters, you can override default settings. Click Tap Create .

    4. Complete the configuration for each integration control parameter value.

    5. Click Tap Save.

      Repeat this step for each integration control parameter that supports the Chile Timecard Report process.

      Integration control parameter
      Parameter name Description / User prompt / Mandatory Template parameter Parameter type
      Locations&Hyperfind

      The default Hyperfind or Location query that contains the employees for whom the integration is run.

      Default = 1 (All Home A query that returns a list of employees associated with a manager's employee group. All Home finds people who are active employees or active users as of today.)

      Note: Ad-hoc Hyperfinds are not supported.
      All Home does not include terminated and inactive employees even if they have hours during the period. To include these employees, configure a Hyperfind that includes terminated and inactive employees, and select that Hyperfind in this process property.
      The maximum number of employees in a Hyperfind is 3500. To process more employees, divide the population into smaller Hyperfinds to run sequentially.

      User prompt = Yes

      Mandatory = Yes

      		 HyperfindAndLocationSelector Hyperfind
      TimePeriod

      The date range or symbolic time period for which the report is run.
      Supported values include:

      0 = Previous pay period

      1 = Current pay period

      2 = Next pay period

      3 = Previous schedule period A repeating span of days in the schedule that is defined for administrative purposes, such as pay periods.

      4 = Current schedule period

      5 = Next schedule period

      6 = Week to date

      7 = Last week

      8 = Yesterday

      10 = Range of relative dates

      11 = Specific date

      12 = Relative specific date

      13 = Today

      User prompt = Yes

      Mandatory = Yes

      		 TimePeriod Time period
      Report - Output Format

      Determines the report output.

      Default = PDF

      User prompt = Yes

      Mandatory = Yes

      		 ReportOutputFormat Dropdown
      Report - Name

      Determines the name of the report created by the integration.

      User prompt = No

      Mandatory = Yes

      Note: This value must match the name of the BIRT report configured in UKG Pro Workforce Management™.

      		 ReportName Text
      Locale

      Determines the locale of the output file.

      User prompt = No

      Mandatory = No

      		 Locale Text
      Pay Code - Approved Days Pay Code

      The combined paycode that holds approved days.

      User prompt = No

      Mandatory = Yes

      		 ApprovedDaysPaycode Text
      Pay Code - Approved Hours Pay Code

      The combined paycode that holds approved hours.

      User prompt = No

      Mandatory = Yes

      		 ApprovedHoursPaycode Text
      Pay Code - Overtime Pay Code

      The combined paycode that holds overtime hours.

      User prompt = No

      Mandatory = Yes

      		 OvertimePayCode Text
      Pay Code - Punch Receipt Pay Code

      Identifies the paycode to which an attached comment stores the punch time in hh:mm:ss format.

      User prompt = No

      Mandatory = No

      Note: If the organization also uses the Chile Punch Receipt extension, this value must match the PayCode parameter value in the Chile Punch Receipt Parameters decision table.

      		 PunchPayCode Text
      Pay Code - Rest Pay Code

      The combined paycode that holds rest days.

      User prompt = No

      Mandatory = Yes

      		 RestPayCode Text
      Pay Code - Unauthorized Pay Code

      The combined paycode that holds unauthorized hours.

      User prompt = No

      Mandatory = Yes

      		 UnauthorizedPayCode Text
      Pay Code - Vacation Pay Code

      The schedule tag A graphic on the schedule that identifies a specific characteristic that applies to a specific employee on a specific day. Not a shift or a pay code. Example: On call. that is assigned in the schedule to an employee who is disqualified from receiving the premium amount.

      User prompt = No

      Mandatory = Yes

      		 VacationPayCode Text

Note: The integration supports a maximum of 30 overtime paycodes and 15 exceptions.

  1. Ensure that the generic data access profiles (GDAP) allow access to the Chile Timecard Report integration for the people who need to run the installed integrations. See Configure Access to Integrations.

Run integrations to test that the configuration is set up correctly.

Run the integration

  1. Select the integration:
    1. Select Main Menu  > Maintenance > Integrations. 
    2. Click Tap Run an Integration . 
    3. Select the ChileTimecardReport_v1 integration from the list. Click Tap Select. 
    4. (Optional) Enter a unique Integration Run Name to make it easier to identify the run of the integration. Otherwise, the default name ends with a date and time stamp.
  2. Set parameters as follows:
    • Hyperfind: Select a Hyperfind query of employees.
    • Person Numbers: To process data for only a limited group of employees, enter the person numbers, as defined in the source system, each separated by a comma (,) but no spaces.

      For 3 employees: 13997,15556,20012

    • Time Period: Select a time period.

  3. Select the following:

    • Run Integration: If this is the first time this integration is being run.
    • Re-Run: If this integration has been run before, and the status is not In-Progress, you can run the integration again without entering the parameter values again. Click Tap Yes to continue, or No to not run the integration and to return to the parameter settings.

  4. Wait for the confirmation that the integration completed or failed. Close the panel.
  5. Click Tap Refresh . 
  6. To see details, select the integration run. Select Run Summary.

Check the results

Status indicators

  •  In-Progress: The run of this integration has not yet completed.
  •  Completed: The integration ran successfully without errors.
  •  Scheduled: This integration is scheduled to run later or repeatedly.
  • (Grayed out) Scheduled but Deleted: This integration is scheduled to run, but the integration template has been deleted. When it runs, it will generate an error. To prevent this error, delete the scheduled integration run.
  •  Completed with Errors: The integration ran successfully, but one or more records have errors. The integration run is treated as failed. If Abort on Failure is configured in an integration set, the integration set stops.
  •  Failed: The integration run has errors or could not run.
  • To troubleshoot and resolve errors, do the following:

    Check the Run Summary for details.

To check the results in more detail, do the following:

  1. To see detailed results, click tap the tile A container that provides navigation or action from its summary view. for the integration run.
  2. Click Tap Run Summary to see the results of the integration run.

    Example Run Summary details

    Note: The available details vary by integration and configuration.

    • Integration Run Name: Name of this run of the integration.
    • Process Name: Name of any integration set that includes this integration.
    • Integration Name: Name of the installed integration.
    • Integration Reference ID: Unique identifier for this integration run (to help in troubleshooting errors).
    • User: The person or user account that ran the integration.
    • Integration Type: Import, Export, or None
    • Start Date: Date and time when the integration run started.
    • End Date: Date and time when the integration run finished.
    • Status: In-Progress, Completed, Completed with Errors, or Failed.
    • Records Processed: Number of records that were processed.
    • Records Created: Number of records that were created.
    • Errors: Number of records that failed.
    • Source Files, Output File, and Error Files: For file-based import integrations, use Manage SFTP to access the source and output files on the inbound (source) and outbound (destination) SFTP folders. See the Manage SFTP topic.
  3. Log in to the destination system and make sure that the data has been correctly updated.

Note: You can schedule integrations and integration sets to run once later or at a recurring frequency. See the Schedule Integrations topic.

API details
API name Type Resource path Description
Retrieve Persons POST /v1/commons/persons/extensions/multi_read Returns multiple person records based on search criteria.
Execute Hyperfind POST /v1/commons/hyperfind/execute Executes a Hyperfind query by ID or qualifier, and returns the result.
Retrieve user preferences for current user GET /v1/commons/user_preferences/locale_policy?userCurrent=true Returns locale details of the current user or the tenant default locale details.

Retrieve data

POST v1/commons/data/multi_read Returns records based on the keys and filter criteria provided in the request.
Retrieve timecard as manager POST /v1/timekeeping/timecard/multi_read Returns a list of timecards based on employee or Hyperfind details. Required parameters include employee ID or person number and a date range or symbolic period ID.
Retrieve paycodes POST /v1/timekeeping/setup/pay_codes/multi_read Returns one or more paycodes available to the logged-in manager by object references.
Run Report by Name POST /v1/platform/reports/{name}/execute Runs a report by name.
Retrieve Executed Report Output by ID GET /v1/platform/report_executions/{id}/file Returns an executed report by ID as an attachment.
Retrieve All Exception Types GET v1/timekeeping/exception_types Returns all exception types.