UKG Pro HCM (Preview)

UKG Pro HCM Connector for Pro HR, Payroll and Talent.

This connector is available in the following products and regions:

Service	Class	Regions
Logic Apps	Standard	All Logic Apps regions except the following:      -   Azure Government regions      -   Azure China regions      -   US Department of Defense (DoD)
Power Automate	Premium	All Power Automate regions except the following:      -   US Government (GCC)      -   US Government (GCC High)      -   China Cloud operated by 21Vianet      -   US Department of Defense (DoD)
Power Apps	Premium	All Power Apps regions except the following:      -   US Government (GCC)      -   US Government (GCC High)      -   China Cloud operated by 21Vianet      -   US Department of Defense (DoD)

Contact
Name	KGS
URL	https://www.ukg.com/support
Email	support@ukg.com

Connector Metadata
Publisher	Dilip Chenani
Website	https://www.ukg.com/
Privacy policy	https://www.ukg.com/privacy
Categories	Human Resources

UKG Pro HCM Connector simplifies the data transfer using UKG Pro API and enables you to leverage your UKG Pro data for solving business application and integration needs.

Prerequisites

• An existing UKG Pro users with web service account and valid resource permissions with appropriate values of Username and User API Key. UKG Pro HCM Connector uses Basic Authentication and requires a unique Username and User API key.
• UKG Pro base service URL which will be similar to "https://servicet.ultipro.com/services/", but will vary by customer datacenter and production/test environments.

How to get credentials

UKG Pro HCM Connector, using Basic Authentication, is only accessible with a web service account. For information regarding establishing and maintaining a UKG Pro Service Account, click here.

Get started with your connector

• Get a single person detail record
• Get a single person detail record for a single company
• Get employee pay statement
• Get employee last pay statement
• Get Employee Employment Details
• Get Employee Demographic Details
• Get details for a general ledger run
• Submit XML transaction to the Import Tool
• Employee ID Lookup
• Get a specific employees pto-plans
• Get Employee Supervisor Details
• Get all details for a person assigned to an employee as a contact

Known issues and limitations

None

Common errors and remedies

Contact us via https://www.ukg.com/support

FAQ

Contact us via https://www.ukg.com/support in case of errors and questions.

Creating a connection

The connector supports the following authentication types:

Default	Parameters for creating connection.	All regions	Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name	Type	Description	Required
User Name	securestring	The User Name for this api	True
User API Key	securestring	The User API Key for this api	True
UKG Pro base service URL	string	The base service URL will be similar to servicet.ultipro.com, but will vary by customer datacenter and production/test environments	True
US-Customer-Api-Key	string	Enter your US-Customer-Api-Key	True

Throttling Limits

Name	Calls	Renewal Period
API calls per connection	100	60 seconds

Actions

Employee ID Lookup	Employee ID Lookup.
Get a single person detail record	Get a single person detail record.
Get a single person detail record for a single company	Get a single person detail record for a single company.
Get a specific employees pto-plans	Get a specific employees pto-plans
Get all details for a person assigned to an employee as a contact	Get all details for a person assigned to an employee as a contact.
Get details for a general ledger run	Returns a list of details for a general ledger run.
Get Employee Demographic Details	Get employee demographic details.
Get Employee Employment Details	Get Employee employment details.
Get employee last pay statement	Get employee last pay statement based on the passed employee identifier.
Get employee pay statement	Get employee pay statement based on the passed employee identifier.
Get Employee Supervisor Details	Get employee supervisor details.
Submit XML transaction to the Import Tool	Submits an encoded XML transaction to the Import Tool.

Employee ID Lookup

Operation ID:

EmployeeIdLookup

Employee ID Lookup.

Parameters

Name	Key	Required	Type	Description
employeeIdentifierType	employeeIdentifierType	True	string	Enter employee identifier type.
employeeIdentifierValue	employeeIdentifierValue	True	string	Enter employee identifier Value
companyIdentifierType	companyIdentifierType		string	Enter company identifier type.
companyIdentiferValue	companyIdentifierValue		string	Enter company identifier value

Returns

Body

employeeIdLookup

Get a single person detail record

Operation ID:

GetASinglePersonDetailRecord

Get a single person detail record.

Parameters

Name	Key	Required	Type	Description
Employee ID	employeeID	True	string	Employee identification number.

Returns

Body

getASinglePersonDetailRecord

Get a single person detail record for a single company

Operation ID:

GetASinglePersonDetailRecordForASingleCompany

Get a single person detail record for a single company.

Parameters

Name	Key	Required	Type	Description
Employee ID	employeeID	True	string	Employee identification number.
Company ID	companyID	True	string	Company identification number.
lastName	lastName		string	Employee's last name
emailAddress	emailAddress		string	Employee's email address
addressState	addressState		string	Employee's state of residence
addressCountry	addressCountry		string	Employee's country of residence
cobraIsActive	cobraIsActive		string	Boolean field indicating if the COBRA coverage is currently active.
cobraStatus	cobraStatus		string	This is a string indicating the status of the COBRA coverage.
dateOfCobraEvent	dateOfCobraEvent		string	Used to find date of COBRA event less,greater,equal or between passed dates.
dateTimeCreated	dateTimeCreated		string	Used to find person record created less,greater,equal or between passed dates.
dateTimeChanged	dateTimeChanged		string	Used to find person record changed less,greater,equal or between passed dates.
nationalId	nationalId		string	National identification number
nationalIdCountry	nationalIdCountry		string	Country identification number
page	page		integer	Page number for pagination
per_Page	per_Page		integer	Number of items per page

Returns

response

array of getASinglePersonDetailRecord

Get a specific employees pto-plans

Operation ID:

GetASpecificEmployeesPtoplans

Get a specific employees pto-plans

Parameters

Name	Key	Required	Type	Description
Employee ID	employeeID	True	string	Employee identification number.
Company ID	companyID	True	string	Company identification number.
page	page		integer	Pagination, which page you want to see
per_page	per_page		integer	Pagination, how many records per page you want to see

Returns

response

array of getASpecificEmployeesPtoplans

Get all details for a person assigned to an employee as a contact

Operation ID:

GetAllDetailsForAPersonAssignedToAnEmployeeAsAContact

Get all details for a person assigned to an employee as a contact.

Parameters

Name	Key	Required	Type	Description
employeeId	employeeId		string	Employee Identifier
isActive	isActive		string	Active Status Indicator
relationshipCode	relationshipCode		string	Employee relation type code to the contact
contactId	contactId		string	Contact Identifier
countryCode	countryCode		string	Country Code
cobraIsActive	cobraIsActive		string	Boolean field indicating if the COBRA coverage is currently active.
cobraStatus	cobraStatus		string	This is a string indicating the status of the COBRA coverage
isBeneficiary	isBeneficiary		string	Beneficiary Indicator
isDependent	isDependent		string	Dependent Indicator
dateOfCobraEvent	dateOfCobraEvent		string	Used to find date of COBRA event less,greater,equal or between passed dates.
statusAsOfDate	statusAsOfDate		string	Used to find contact status as of date less,greater,equal or between passed dates.
page	page		integer	Pagination, which page you want to see
per_Page	per_Page		integer	Pagination, how many records per page you want to see

Returns

response

array of getAllDetailsForAPersonAssignedToAnEmployeeAsAContact

Get details for a general ledger run

Operation ID:

ReturnsAListOfDetailsForAGeneralLedgerRun

Returns a list of details for a general ledger run.

Parameters

Name	Key	Required	Type	Description
runId	runId		string	Identifier for the general ledger run
blockId	blockId		string	Identifier for the specific block within the general ledger run
per_Page	per_Page		integer	Filter to retrieve the most recent data
page	page		integer	Pagination, which page you want to see
mostRecent	mostRecent		string	Pagination, how many records per page you want to see

Returns

response

array of returnsAListOfDetailsForAGeneralLedgerRun

Get Employee Demographic Details

Operation ID:

GetEmployeeDemographicDetails

Get employee demographic details.

Parameters

Name	Key	Required	Type	Description
employeeId	employeeId		string	Employee Identifier
companyId	companyId		string	Company Identifier
lastName	lastName		string	Employee's last name
emailAddress	emailAddress		string	Employee's email address
addressState	addressState		string	Employee's state of residence
addressCountry	addressCountry		string	Employee's country of residence
page	page		integer	Pagination, which page you want to see
per_Page	per_Page		integer	Pagination, how many records per page you want to see

Returns

response

array of getEmployeeDemographicDetails

Get Employee Employment Details

Operation ID:

GetEmployeeEmploymentDetails

Get Employee employment details.

Parameters

Name	Key	Required	Type	Description
companyID	companyID		string	Company identification number
employeeID	employeeID		string	Employee identification number
primaryJobCode	primaryJobCode		string	Code representing the employee's primary job
jobTitle	jobTitle		string	Title of the employee's job
fullTimeOrPartTimeCode	fullTimeOrPartTimeCode		string	Code indicating if the employee is full-time or part-time
primaryWorkLocationCode	primaryWorkLocationCode		string	Code representing the employee's primary work location
primaryProjectCode	primaryProjectCode		string	Code representing the employee's primary project group
deductionGroupCode	deductionGroupCode		string	Code representing the deduction group for the employee
earningGroupCode	earningGroupCode		string	Code representing the earning group for the employee
employeeTypeCode	employeeTypeCode		string	Code representing the type of employee
employeeStatusCode	employeeStatusCode		string	Code representing the status of the employee
employeeNumber	employeeNumber		string	Number assigned to the employee
supervisorId	supervisorId		string	Unique identifier for the employee's supervisor
originalHireDate	originalHireDate		string	Date when the employee was originally hired
lastHireDate	lastHireDate		string	Date of the employee's last hire
dateOfTermination	dateOfTermination		string	Date of the employee's termination
dateOfRetirement	dateOfRetirement		string	Date of the employee's retirement
dateTimeCreated	dateTimeCreated		string	Timestamp indicating when the record was created
dateTimeChanged	dateTimeChanged		string	Timestamp indicating when the record was last updated
dateLastPayDatePaid	dateLastPayDatePaid		string	Date of the employee's last pay date
payGroup	payGroup		string	Group associated with the employee's pay.
isHomeCompany	isHomeCompany		boolean	Indicator if the company is the employee's home company
page	page		integer	Pagination, which page you want to see
per_Page	per_Page		integer	Pagination, how many records per page you want to see

Returns

response

array of getEmployeeEmploymentDetails

Get employee last pay statement

Operation ID:

GetEmployeeLastPayStatement

Get employee last pay statement based on the passed employee identifier.

Parameters

Name	Key	Required	Type	Description
eeid	eeid	True	string	Enter your Employee ID.
coid	coid	True	string	Enter your Company ID.
startDate	startDate		string	Enter Start Date.
endDate	endDate		string	Enter End Date.
page	page		integer	Enter page number.
per_Page	per_Page		integer	Enter per page value.
pagesCount	pagesCount		integer	Enter pages count.

Returns

Body

getEmployeePayStatement

Get employee pay statement

Operation ID:

GetEmployeePayStatement

Get employee pay statement based on the passed employee identifier.

Parameters

Name	Key	Required	Type	Description
companyCode	companyCode		string	Enter your Company Code.
employeeNumber	employeeNumber		string	Enter your Employee Number.
eeid	eeid		string	Enter your Employee ID.
coid	coid		string	Enter your Company ID.
startDate	startDate		string	Enter Start Date.
endDate	endDate		string	Enter End Date.
page	page		integer	Enter page number.
per_Page	per_Page		integer	Enter per page value.
pagesCount	pagesCount		integer	Enter pages count.

Returns

response

array of getEmployeePayStatement

Get Employee Supervisor Details

Operation ID:

GetEmployeeSupervisorDetails

Get employee supervisor details.

Parameters

Name	Key	Required	Type	Description
Company Id	companyId		string	Company Identifier
Employee Id	employeeId		string	Identifier for the company of the employee
supervisorCompanyId	supervisorCompanyId		string	String that represents the supervisor's company identifier
supervisorEmployeeId	supervisorEmployeeId		string	String that represents the supervisor's employee identifier
supervisorCompanyCode	supervisorCompanyCode		string	String that represents the supervisor's company code
page	page		integer	Pagination, which page you want to see
per_Page	per_Page		integer	Pagination, how many records per page you want to see

Returns

response

array of getEmployeeSupervisorDetails

Submit XML transaction to the Import Tool

Operation ID:

TakesAnXmlTransactionAndFeedsItIntoTheImportTool

Submits an encoded XML transaction to the Import Tool.

Parameters

Name	Key	Required	Type	Description
transaction	transaction	True	string	Enter encoded XML transaction.
uniqueFileName	uniqueFileName		string	Enter Unique filename ending with xml extension.

Returns

Body

takesAnXmlTransactionAndFeedsItIntoTheImportTool

Definitions

getASinglePersonDetailRecord

Name	Path	Type	Description
additionalName1	additionalName1	string	Additional name field 1
additionalName2	additionalName2	string	Additional name field 2
addressId	addressId	string	Identifier for the address
addressIsOnTaxBoundary	addressIsOnTaxBoundary	boolean	Indicates if the address is on a tax boundary
addressLatitude	addressLatitude	float	Latitude coordinate of the address
cobraExport	cobraExport	string	COBRA export information
cobraIsActive	cobraIsActive	boolean	Indicates if COBRA is active for the employee
cobraReason	cobraReason	string	Reason for COBRA status
cobraStatus	cobraStatus	string	COBRA status information
cobraStatusDate	cobraStatusDate	string	Date of COBRA status update
communityBroadcastSmsCode	communityBroadcastSmsCode	string	Community broadcast SMS code
consentElectronicW2	consentElectronicW2	boolean	Indicates consent for electronic W2 forms
consentElectronicw2pr	consentElectronicw2pr	boolean	Indicates consent for electronic W2 forms (PR specific)
dateDeceased	dateDeceased	string	Date of deceased
dateOfCobraEvent	dateOfCobraEvent	string	Date of COBRA event
dateOfCobraExport	dateOfCobraExport	string	Date of COBRA export
dateOfCobraLetter	dateOfCobraLetter	string	Date of COBRA letter
dateOfI9Expiration	dateOfI9Expiration	string	Date of I-9 form expiration
datetimeChanged	datetimeChanged	string	Timestamp indicating when the data was last updated
datetimeCreated	datetimeCreated	string	Timestamp indicating when the data was created
disabilityType	disabilityType	string	Type of disability
ethnicDescription	ethnicDescription	string	Ethnicity description
formerName	formerName	string	Former name
healthBloodType	healthBloodType	string	Blood type information
healthEyes	healthEyes	string	Eye color information
healthHair	healthHair	string	Hair color information
healthHeightFeet	healthHeightFeet	string	Height in feet
healthHeightInches	healthHeightInches	string	Height in inches
healthLastDonateDate	healthLastDonateDate	string	Date of last blood donation
healthWeight	healthWeight	double	Weight in pounds
i9AlienNumber	i9AlienNumber	string	Alien number for I-9 form
i9DocA	i9DocA	string	Document A for I-9 form
i9DocB	i9DocB	string	Document B for I-9 form
i9DocC	i9DocC	string	Document C for I-9 formg
i9Verified	i9Verified	boolean	Indicates if I-9 form is verified
i9VisaType	i9VisaType	string	Visa type for I-9 form
i9WorkAuth	i9WorkAuth	string	Work authorization for I-9 form
isDisabled	isDisabled	boolean	Indicates if the person is disabled
isMultiPayGroup	isMultiPayGroup	boolean	Indicates if the person is part of multiple pay groups
isSmoker	isSmoker	boolean	Indicates if the person is a smoker
militaryService	militaryService	boolean	Indicates military service status
militaryBranchServed	militaryBranchServed	string	Branch of military service served
militaryEra	militaryEra	string	Military era information
militaryIsDisabledVet	militaryIsDisabledVet	string	Indicates if the person is a disabled veteran
militaryIsOthEligVet	militaryIsOthEligVet	string	Indicates if the person is other eligible veteran
militaryIsOthEligVetBasis	militaryIsOthEligVetBasis	string	Basis for other eligible veteran status
militaryIsActiveWartimeVet	militaryIsActiveWartimeVet	string	Indicates if the person is an active wartime veteran
nameFormer	nameFormer	string	Former name
previousSSN	previousSSN	string	Previous Social Security Number
originCountry	originCountry	string	Country of origin
originLocation	originLocation	string	Location of origin
w2IsDeceased	w2IsDeceased	boolean	Indicates if the person is deceased for W2 forms
cobraNotes	cobraNotes	string	Notes related to COBRA
addressSms	addressSms	string	Address for SMS notifications
militarySeparationDate	militarySeparationDate	string	Date of military separation
homePhoneIsPrivate	homePhoneIsPrivate	boolean	Indicates if home phone number is private
smsApprovals	smsApprovals	boolean	Indicates if SMS approvals are enabled
smsPayNotification	smsPayNotification	boolean	Indicates if SMS notifications for pay are enabled
i9VisaExpirationDate	i9VisaExpirationDate	string	Expiration date for I-9 visa
militaryIsMedalVet	militaryIsMedalVet	string	Indicates if the person is a medal veteran
lastNameNotSameAsSSCard	lastNameNotSameAsSSCard	string	Indicates if last name is different from Social Security Card
chkCashingInstCode	chkCashingInstCode	string	Check cashing institution code
nationality1	nationality1	string	Nationality information 1
nationality2	nationality2	string	Nationality information 2
nationality3	nationality3	string	Nationality information 3
personId	personId	string	Identifier for the person
employeeId	employeeId	string	Identifier for the employee
companyId	companyId	string	Identifier for the company
userName	userName	string	Username
firstName	firstName	string	First name
middleName	middleName	string	Middle name
lastName	lastName	string	Last name
preferredName	preferredName	string	Preferred name
namePrefixCode	namePrefixCode	string	Prefix code for name
nameSufixCode	nameSufixCode	string	Suffix code for name
emailAddress	emailAddress	string	Email address
emailAddressAlternate	emailAddressAlternate	string	Alternate email address
homePhone	homePhone	string	Home phone number
homePhoneCountry	homePhoneCountry	string	Country code for home phone number
addressLine1	addressLine1	string	Address line 1
addressLine2	addressLine2	string	Address line 2
addressCity	addressCity	string	City
addressState	addressState	string	State
addressZipCode	addressZipCode	string	ZIP code
addressCountry	addressCountry	string	Country
addressCounty	addressCounty	string	Country
nationalId	nationalId	string	National ID
nationalIdCountry	nationalIdCountry	string	Country for national ID
dateOfBirth	dateOfBirth	string	Date of birth
gender	gender	string	Gender
ethnicIDCode	ethnicIDCode	string	Ethnic ID code
maritalStatusCode	maritalStatusCode	string	Marital status code
ssn	ssn	string	Social Security Number
ssnIsSuppressed	ssnIsSuppressed	boolean	Indicates if Social Security Number is suppressed

getEmployeePayStatement

Name	Path	Type	Description
accruals	accruals	array of object	List of accrual details
amountcurrent	accruals.amountcurrent	double	Current amount accrued
amounttype	accruals.amounttype	string	Type of accrual amount
balance	accruals.balance	double	Current balance of accrual
plancode	accruals.plancode	string	Code identifying the plan
plandescription	accruals.plandescription	string	Description of the plan
addressline1	addressline1	string	Address line 1
addressline2	addressline2	string	Address line 2
city	city	string	City of the address
companyaddresscity	companyaddresscity	string	Company's city address
companyaddresscountry	companyaddresscountry	string	Company's country address
companyaddresscounty	companyaddresscounty	string	Company's county address
companyaddressline1	companyaddressline1	string	Company's address line 1
companyaddressline2	companyaddressline2	string	Company's address line 2
companyaddresspostalcode	companyaddresspostalcode	string	Postal code of the company address
companyaddressstateorprovince	companyaddressstateorprovince	string	State or province of the company address
companyname	companyname	string	Name of the company
companyphone	companyphone	string	Main phone number of the company
companyphoneext	companyphoneext	string	Extension for the company phone
country	country	string	Country of the address
deductions	deductions	array of object
basisamount	deductions.basisamount	double	Basis amount for deductions
deductioncode	deductions.deductioncode	string	Code identifying the deduction
deductiondescription	deductions.deductiondescription	string	Description of the deduction
employeeamount	deductions.employeeamount	double	Deduction amount from the employee
employeeamountytd	deductions.employeeamountytd	double	Deduction amount from the employee for the year
employeramount	deductions.employeramount	double	Deduction amount contributed by the employer
employeramountytd	deductions.employeramountytd	double	Employer deduction amount for the year
pretax	deductions.pretax	boolean	Indicates if the deduction is pre-tax
deductionscurrent	deductionscurrent	double	Total current deductions
deductionsytd	deductionsytd	double	Total deductions for the year
document	document	string	Document identifier or description
earnings	earnings	array of object	List of earnings records
amount	earnings.amount	double	Earnings amount
amountytd	earnings.amountytd	double	Earnings amount for the year
hours	earnings.hours	double	Hours worked
hoursytd	earnings.hoursytd	double	Hours worked for the year
paycode	earnings.paycode	string	Code identifying the pay type
paydescription	earnings.paydescription	string	Description of the pay type
payrate	earnings.payrate	double	Rate of pay
periodend	earnings.periodend	date-time	End date of the pay period
periodstart	earnings.periodstart	date-time	Start date of the pay period
piececount	earnings.piececount	double	Count of pieces completed (for piecework)
piecepayrate	earnings.piecepayrate	double	Pay rate per piece (for piecework)
identificationtype	employeeidentifier.identificationtype	string	string
companyidentifier	employeeidentifier.companyidentifier	string	string
employeeidentifier	employeeidentifier.employeeidentifier	string	string
employeenumber	employeenumber	string	Number identifying the employee
federaladditionalamountWithheld	federaladditionalamountWithheld	double	Additional federal tax withheld
federalallowancesclaimed	federalallowancesclaimed	double	Federal tax allowances claimed
federalfilingstatus	federalfilingstatus	string	Federal tax filing status
federaltaxablewagescurrent	federaltaxablewagescurrent	double	Current federal taxable wages
federaltaxablewagesytd	federaltaxablewagesytd	double	Federal taxable wages for the year
fullname	fullname	string	Full name of the employee
grosswagescurrent	grosswagescurrent	double	Current gross wages
grosswagesytd	grosswagesytd	double	Gross wages for the year
job	job	string	Job title or description
location	location	string	Work location of the employee
netpay	netpay	array of object	List of net pay records
accountnumber	netpay.accountnumber	string	Bank account number
accounttype	netpay.accounttype	string	Type of bank account
amount	netpay.amount	double	Amount of net pay
netpaycurrent	netpaycurrent	double	Current net pay
netpayytd	netpayytd	double	Net pay for the year
orglevel1	orglevel1	string	First level of organizational hierarchy
orglevel2	orglevel2	string	Second level of organizational hierarchy
orglevel3	orglevel3	string	Third level of organizational hierarchy
orglevel4	orglevel4	string	Fourth level of organizational hierarchy
paydate	paydate	string	Date on which pay was issued
payperiodfrequency	payperiodfrequency	string	Frequency of the pay period
paygroup	paygroup	string	Group classification for payroll
payidentifier	payidentifier	string	Identifier for the pay instance
payrate	payrate	double	Pay rate
periodenddate	periodenddate	string	End date of the pay period
periodstartdate	periodstartdate	string	Start date of the pay period
postalcode	postalcode	string	Postal code for the employee's address
residentstateallowancesclaimed	residentstateallowancesclaimed	double	State tax allowances claimed by the resident
residentstatefilingstatus	residentstatefilingstatus	string	State filing status for the resident
ssn	ssn	string	Social Security Number
stateorprovince	stateorprovince	string	State or province of the employee
taxes	taxes	array of object	List of tax records
amount	taxes.amount	double	Amount of tax
amountytd	taxes.amountytd	double	Tax amount for the year
basisamount	taxes.basisamount	double	Basis amount for tax calculation
taxdescription	taxes.taxdescription	string	Description of the tax
taxcode	taxes.taxcode	string	Code identifying the tax
taxescurrent	taxescurrent	double	Total current taxes
taxesytd	taxesytd	double	Total taxes for the year
workstateallowancesclaimed	workstateallowancesclaimed	double	State tax allowances claimed by the employee
workstatefilingstatus	workstatefilingstatus	string	State tax filing status of the employee

getEmployeeEmploymentDetails

Name	Path	Type	Description
companyID	companyID	string	Identifier for the company
employeeID	employeeID	string	Identifier for the employee
primaryJobCode	primaryJobCode	string	Code identifying the primary job
jobTitle	jobTitle	string	Title of the employee's job
fullTimeOrPartTimeCode	fullTimeOrPartTimeCode	string	Code indicating if the job is full-time or part-time
primaryWorkLocationCode	primaryWorkLocationCode	string	Code for the primary work location
primaryProjectCode	primaryProjectCode	string	Code for the primary project associated with the employee
deductionGroupCode	deductionGroupCode	string	Code identifying the deduction group
earningGroupCode	earningGroupCode	string	Code identifying the earning group
employeeTypeCode	employeeTypeCode	string	Code defining the type of employment
employeeStatusCode	employeeStatusCode	string	Code representing the employee's current status
employeeNumber	employeeNumber	string	Unique number assigned to the employee
supervisorId	supervisorId	string	Identifier for the employee's supervisor
originalHireDate	originalHireDate	string	Date the employee was originally hired
lastHireDate	lastHireDate	string	Date the employee was most recently hired
dateOfTermination	dateOfTermination	string	Date the employee was terminated
dateOfRetirement	dateOfRetirement	string	Date the employee retired
dateTimeCreated	dateTimeCreated	string	Timestamp when the employee record was created
dateTimeChanged	dateTimeChanged	string	Timestamp when the employee record was last modified
dateLastPayDatePaid	dateLastPayDatePaid	string	Date when the last payment was made to the employee
payGroup	payGroup	string	Group classification for payroll
isHomeCompany	isHomeCompany	boolean	Indicates if the company is the employee's home company
page	page	integer	Page number in a paginated response
per_Page	per_Page	integer	Number of items per page in a paginated response

getEmployeeDemographicDetails

Name	Path	Type	Description
ethnicDescription	ethnicDescription	string	Ethnic background
additionalName1	additionalName1	string	Additional name field 1
additionalName2	additionalName2	string	Additional name field 2
addressId	addressId	string	Identifier for the address
addressIsOnTaxBoundary	addressIsOnTaxBoundary	string	Address on tax boundary status
addressLatitude	addressLatitude	double	Geographic latitude of address
disabilityType	disabilityType	string	Type of disability
formerName	formerName	string	Previous name
healthBloodType	healthBloodType	string	Blood type information
healthEyes	healthEyes	string	Eye color information
healthHair	healthHair	string	Hair color information
healthHeightFeet	healthHeightFeet	string	Height in feet
healthHeightInches	healthHeightInches	string	Height in inches
healthLastDonateDate	healthLastDonateDate	string	Last blood donation date
healthWeight	healthWeight	double	Weight in appropriate units
previousSSN	previousSSN	string	Previous Social Security Number
originCountry	originCountry	string	Country of origin
originLocation	originLocation	string	Location of origin
addressSms	addressSms	string	Address for SMS notifications
homePhoneIsPrivate	homePhoneIsPrivate	boolean	Home phone number is private
lastNameNotSameAsSSCard	lastNameNotSameAsSSCard	string	Last name differs from SS card
nationality1	nationality1	string	First nationality information
nationality2	nationality2	string	Second nationality information
nationality3	nationality3	string	Third nationality information
personId	personId	string	Identifier for the person
employeeId	employeeId	string	Identifier for the employee
companyId	companyId	string	Identifier for the company
firstName	firstName	string	First name
middleName	middleName	string	Middle name
lastName	lastName	string	Last name
preferredName	preferredName	string	Preferred name
namePrefixCode	namePrefixCode	string	Prefix code for the name
nameSuffixCode	nameSuffixCode	string	Suffix code for the name
emailAddress	emailAddress	string	Email address
emailAddressAlternate	emailAddressAlternate	string	Alternate email address
homePhoneID	homePhoneID	string	Identifier for the home phone
homePhone	homePhone	string	Home phone number
homePhoneCountry	homePhoneCountry	string	Country code for home phone
addressLine1	addressLine1	string	Primary address line
addressLine2	addressLine2	string	Secondary address line
addressLine3	addressLine3	string	Tertiary address line
addressLine4	addressLine4	string	Quaternary address line
addressCity	addressCity	string	City of the address
addressState	addressState	string	State of the address
addressZipCode	addressZipCode	string	ZIP code of the address
addressCountry	addressCountry	string	Country of the address
addressCounty	addressCounty	string	County of the address
dateOfBirth	dateOfBirth	string	Date of birth
gender	gender	string	Gender of the individual
ethnicIdCode	ethnicIdCode	string	Ethnic ID code
isSmoker	isSmoker	boolean	Indicates if the person is a smoker
isDisabled	isDisabled	string	Disability status
maritalStatusCode	maritalStatusCode	string	Marital status code
ssn	ssn	string	Social Security Number
ssnIsSuppressed	ssnIsSuppressed	boolean	Indicates if SSN is suppressed
userID	userID	string	User ID
integrationRecordId	integrationRecordId	string	Integration record identifier
cellPhoneNumber	cellPhoneNumber	string	Cell phone number

returnsAListOfDetailsForAGeneralLedgerRun

Name	Path	Type	Description
runId	runId	string	Unique identifier for the run
payPeriodEndDate	payPeriodEndDate	string	End date of the pay period
accountType	accountType	string	Type of account
baseSegment	baseSegment	string	Base segment identifier
companyCode	companyCode	string	Code identifying the company
creditAmt	creditAmt	double	Credit amount recorded
debitAmt	debitAmt	double	Debit amount recorded
description	description	string	Description of the transaction
generalLedgerAccount	generalLedgerAccount	string	General ledger account number
jobCode	jobCode	string	Code for the job
jobDesc	jobDesc	string	Description of the job
location	location	string	Location of the transaction
orgLevel1	orgLevel1	string	First level of organizational hierarchy
orgLevel2	orgLevel2	string	Second level of organizational hierarchy
orgLevel3	orgLevel3	string	Third level of organizational hierarchy
orgLevel4	orgLevel4	string	Fourth level of organizational hierarchy
payGroup	payGroup	string	Payroll group identifier
periodEndDate	periodEndDate	string	End date of the accounting period
periodStartDate	periodStartDate	string	Start date of the accounting period
positionCode	positionCode	string	Code for the position
positionDesc	positionDesc	string	Description of the position
project	project	string	Project identifier
systemId	systemId	double	System identification number
blockId	blockId	double	Block identifier within the system
coId	coId	string	Company identifier
glRunDateTime	glRunDateTime	string	Date and time of GL run
totalNrOfBlocks	totalNrOfBlocks	double	Total number of blocks in the run
userWhoRanThisGl	userWhoRanThisGl	string	User who executed the GL run
glJson	glJson	string	JSON data of the general ledger run

takesAnXmlTransactionAndFeedsItIntoTheImportTool

Name	Path	Type	Description
stagingId	stagingId	string	Identifier for the staging record
dateTimeCreated	dateTimeCreated	string	Timestamp when the record was created
fileName	fileName	string	Name of the file

employeeIdLookup

Name	Path	Type	Description
type	type	string	Type of error or status
title	title	string	Title summarizing the error or status
detail	detail	string	Detailed description of the error or status
errorCount	errorCount	double	Number of errors reported
multistatus	multistatus	array of object
sequenceId	multistatus.sequenceId	double	Identifier for the sequence in multistatus
status	multistatus.status	string	Status of the operation in multistatus
property-name	multistatus.modelstate.property-name	array of object	List of error messages keyed by property name
message	multistatus.modelstate.property-name.message	string	Error message for the specific property
type	multistatus.modelstate.property-name.type	string	Type of error for the specific property
eeid	multistatus.body.eeid	string	Employee identifier
coid	multistatus.body.coid	array of string	List of company identifiers; home company is first

getASpecificEmployeesPtoplans

Name	Path	Type	Description
employeeId	employeeId	string	Unique identifier for the employee
companyId	companyId	string	Identifier for the company associated with the employee
ptoPlan	ptoPlan	string	Identifier for the PTO plan applicable to the employee
earned	earned	double	Total PTO hours earned by the employee
taken	taken	double	Total PTO hours taken by the employee
pendingBalance	pendingBalance	double	Current balance of pending PTO hours
earnedThroughDate	earnedThroughDate	string	Last date through which PTO has been accrued
reset	reset	string	Date when the PTO balance resets
pendingMoveDate	pendingMoveDate	string	Date relevant for pending PTO rules

getEmployeeSupervisorDetails

Name	Path	Type	Description
employeeID	employeeID	string	Identifier for the employee
companyID	companyID	string	Identifier for the company of the employee
employeeNumber	employeeNumber	string	Unique number assigned to the employee
supervisorEmployeeID	supervisorEmployeeID	string	Identifier for the supervisor
supervisorFirstName	supervisorFirstName	string	First name of the supervisor
supervisorLastName	supervisorLastName	string	Last name of the supervisor
supervisorEmployeeNumber	supervisorEmployeeNumber	string	Employee number of the supervisor
supervisorCompanyID	supervisorCompanyID	string	Company identifier for the supervisor
supervisorCompanyCode	supervisorCompanyCode	string	Company code associated with the supervisor
supervisorStatusCode	supervisorStatusCode	string	Status code representing supervisor's employment status
supervisorJobCode	supervisorJobCode	string	Job code assigned to the supervisor
supervisorPositionCode	supervisorPositionCode	string	Position code assigned to the supervisor
supervisorEmail	supervisorEmail	string	Email address of the supervisor
supervisorWorkPhone	supervisorWorkPhone	string	Work phone number of the supervisor
supervisorPersonId	supervisorPersonId	string	Unique identifier for the supervisor as a person

getAllDetailsForAPersonAssignedToAnEmployeeAsAContact

Name	Path	Type	Description
city	city	string	City of the address
countryCode	countryCode	string	Country code of the address
county	county	string	County of the address
addressIsDifferentFromEmployee	addressIsDifferentFromEmployee	boolean	Indicates if address differs from employee's address
addressLine1	addressLine1	string	Primary address line
addressLine2	addressLine2	string	Secondary address line
state	state	string	State of the address
zipCode	zipCode	string	ZIP code of the address
cobraExport	cobraExport	boolean	Indicates if COBRA data is exported
cobraIsActive	cobraIsActive	boolean	Indicates if COBRA is active
cobraReason	cobraReason	string	Reason for COBRA status
cobraStatus	cobraStatus	string	Current COBRA status
cobraStatusDate	cobraStatusDate	string	Date of the current COBRA status
dateOfBirth	dateOfBirth	string	Date of birth
dateOfCOBRAEvent	dateOfCOBRAEvent	string	Date of the COBRA event
dateOfCOBRALetter	dateOfCOBRALetter	string	Date when the COBRA letter was issued
employeeId	employeeId	string	Identifier for the employee
gender	gender	string	Gender of the individual
importId	importId	string	Import identifier
isBeneficiary	isBeneficiary	boolean	Indicates if the individual is a beneficiary
isDependent	isDependent	boolean	Indicates if the individual is a dependent
isDisabled	isDisabled	boolean	Indicates if the individual is disabled
isEmergencyContact	isEmergencyContact	boolean	Indicates if the individual is an emergency contact
isSmoker	isSmoker	boolean	Indicates if the individual is a smoker
isStudent	isStudent	boolean	Indicates if the individual is a student
marriageDate	marriageDate	string	Date of marriage
firstName	firstName	string	First name of the individual
formerName	formerName	string	Former name of the individual
lastName	lastName	string	Last name of the individual
middleName	middleName	string	Middle name of the individual
nameSuffix	nameSuffix	string	Suffix of the individual's name
occupation	occupation	string	Occupation of the individual
otherInsurance	otherInsurance	string	Details of other insurance
homePhoneCountry	homePhoneCountry	string	Country code for home phone
homePhoneNumber	homePhoneNumber	string	Home phone number
otherPhoneNumber	otherPhoneNumber	string	Other phone number
otherPhoneType	otherPhoneType	string	Type of other phone
preferredPhoneNumber	preferredPhoneNumber	string	Preferred phone number
relationshipCode	relationshipCode	string	Code describing the relationship
relationshipDescription	relationshipDescription	string	Description of the relationship
ssn	ssn	string	Social Security Number
contactId	contactId	string	Identifier for the contact
userDefinedField01	userDefinedField01	string	Custom field for additional info
workPhoneExtension	workPhoneExtension	string	Extension for the work phone number
workPhoneNumber	workPhoneNumber	string	Work phone number
cobraNotes	cobraNotes	string	Notes related to COBRA
notes	notes	string	General notes about the individual
isActive	isActive	boolean	Indicates if the record is active
statusAsOfDate	statusAsOfDate	string	Date of the current status
deathDate	deathDate	string	Date of death
divorceDate	divorceDate	string	Date of divorce
emailAddress	emailAddress	string	Email address
otherPhoneCountryCode	otherPhoneCountryCode	string	Country code for other phone
healthCareId	healthCareId	string	Health care identifier
nationalId	nationalId	string	National identifier
nationalIdExpirationDate	nationalIdExpirationDate	string	Expiration date of national ID
personID	personID	string	Unique identifier for the person
addressID	addressID	string	Identifier for address
workPhoneId	workPhoneId	string	Identifier for work phone
homePhoneId	homePhoneId	string	Identifier for home phone
otherPhoneId	otherPhoneId	string	Identifier for another phone