Overview
The UKG Ready integration provides a set of ready-made functions you can call when building mappings. They handle common conversions and lookups for UKG Ready, such as formatting date and time values the way UKG Ready expects and resolving an employee account ID from an external ID, so you do not have to write that logic yourself in a formula.
Where you can use these functions
These functions are available anywhere you write a formula for the UKG Ready integration:
Dynamic Formula mappings: where a destination field's value is produced by a formula rather than mapped directly from a source field.
Mapping collection filters: where a formula decides whether a record should be processed.
Error filters: a mapping collection's error filter, which sits alongside its collection filter. When the error filter's formula resolves to true, the transfer raises an error that is held in the Error Logs for review and is not retried automatically.
Translation collections: where a translation entry uses a formula as its source value.
How to use them
Call a function by name and pass the values it needs in parentheses, for example:
ConvertToUKGDateFormat(SourceDate).Each function's signature shows its name, the parameters it accepts (with their types), and the type of value it returns. Use it as the reference for exactly how to call the function.
Function names and formula syntax are case-sensitive, so type each name exactly as shown. Whether the values a function matches are treated as case-sensitive varies by function, and is called out in the relevant parameter's description.
Some of these functions are asynchronous (their signature returns a
Task) and must be called withawait; the rest are synchronous and are called directly. Each function's How to call it example shows the correct form.Each function runs at sync time, against the data in your connected UKG Ready account and your iPaaS.com subscription.
The functions are grouped below by the area of the integration they support.
Date and Time Formatting
ConvertToUKGDateTimeOffsetFormat
What it does: Converts a date-time value into the UKG Ready date-time-offset string format yyyy-MM-ddTHH:mm:ss.fffzzz. A DateTime is treated as UTC (zero offset); any other value is parsed into a date-time-offset first.
Signature: string ConvertToUKGDateTimeOffsetFormat(object input)
How to call it: ConvertToUKGDateTimeOffsetFormat(input)
Parameter | Type | Required | Default | Description |
|
| Yes | N/A | The value to convert. Can be a |
Returns: string. The value formatted as a UKG Ready date-time-offset string, or null if the input is null.
Example: A date-time of 2026-01-12 14:30:00 returns "2026-01-12T14:30:00.000+00:00".
When to use it: Use this when a UKG Ready field or API needs a date-time-offset value in UKG Ready's exact string format.
ConvertToUKGDateTimeFormat
What it does: Converts a date-time value into the UKG Ready date-time string format yyyy-MM-ddTHH:mm:ss.
Signature: string ConvertToUKGDateTimeFormat(object input)
How to call it: ConvertToUKGDateTimeFormat(input)
Parameter | Type | Required | Default | Description |
|
| Yes | N/A | The value to convert. Can be a |
Returns: string. The value formatted as a UKG Ready date-time string, or null if the input is null.
Example: A date-time of 2026-01-12 14:30:00 returns "2026-01-12T14:30:00".
When to use it: Use this when a UKG Ready field or API needs a date-time value (without an offset) in UKG Ready's exact string format.
ConvertToUKGDateFormat
What it does: Converts a DateTime into the UKG Ready date string format yyyy-MM-dd, keeping only the date portion.
Signature: string ConvertToUKGDateFormat(DateTime input)
How to call it: ConvertToUKGDateFormat(input)
Parameter | Type | Required | Default | Description |
|
| Yes | N/A | The date-time value to convert. Only its date portion is used. |
Returns: string. The date formatted as yyyy-MM-dd.
Example: A date of 2026-01-12 returns "2026-01-12".
When to use it: Use this when only the date portion is needed for a UKG Ready field, without any time information.
ConverToUKGTimeFormat
What it does: Converts a DateTime into the UKG Ready time string format HH:mm:ss, keeping only the time portion.
Signature: string ConverToUKGTimeFormat(DateTime input)
How to call it: ConverToUKGTimeFormat(input)
Parameter | Type | Required | Default | Description |
|
| Yes | N/A | The date-time value from which the time portion is taken and formatted. |
Returns: string. The time formatted as HH:mm:ss.
Example: A time of 14:30:45 returns "14:30:45".
When to use it: Use this when only the time portion is needed for a UKG Ready field, without any date information.
Employees
EmployeeAccountIdFromExternalIdStart
What it does: Finds a UKG Ready employee whose external ID starts with the given prefix and returns that employee's UKG Ready account ID.
Signature: Task<long?> EmployeeAccountIdFromExternalIdStart(string externalIdStart)
How to call it: await EmployeeAccountIdFromExternalIdStart(externalIdStart)
Parameter | Type | Required | Default | Description |
|
| Yes | N/A | The beginning of the employee's external ID to search for in UKG Ready. |
Returns: long?. The UKG Ready employee account ID, or null if no employee matches. If more than one employee matches the prefix, the function raises an error.
Example: "EXT123" returns the account ID of the single UKG Ready employee whose external ID starts with EXT123.
When to use it: Use this to resolve a UKG Ready employee account ID from a known external ID prefix, for example when mapping records that reference an employee by an external identifier.