NameDescriptionTypeAdditional information
FirstName

string

Max length: 100

MiddleName

string

Max length: 100

LastName

string

Max length: 100

MaidenName

string

Max length: 100

PreferredName

string

Max length: 100

NameSuffix

string

Max length: 50

DateofBirth

MM/DD/YYYY

date

None.

SocialSecurityNumber

string

Max length: 20

EmployeeEmailAddress

string

Max length: 100

Username

Unique Identifier

string

Max length: 100

EmployeeID

Custom employee ID

string

Max length: 50

SystemID

integer

None.

EmploymentType

Full Time, Part Time, Seasonal

string

Max length: 25

JobTitle

string

Max length: 50

JobCode

string

Max length: 50

LaborDistributionCode

string

Max length: 50

AddressLine1

string

Max length: 500

AddressLine2

string

Max length: 500

EmployeeCity

string

Max length: 500

State

string

Max length: 2

County

string

Max length: 100

ZipCode

string

Max length: 50

CountryofResidence

string

Max length: 100

HomePhoneNumber

string

Max length: 50

MobilePhoneNumber

string

Max length: 50

Gender

Male, Female

string

Max length: 50

BusinessUnit

string

Max length: 50

LocationNumber

string

Max length: 50

LocationName

string

Max length: 100

HiringManager

Email Address

string

Max length: 200

ConfirmationofStateResidency

boolean

None.

RaceEthnicity

White, Black Or African-American, Hispanic, Asian, American Indian Or Alaska Native, Native Hawaiian Or Pacific Islander, Two Or More Races

string

Max length: 50

MaritalStatus

Single, Married, Undefined

string

Max length: 50

DisabilityStatus

boolean

None.

VeteranStatus

boolean

None.

EmergencyContact

string

Max length: 200

EmergencyContactRelationship

string

Max length: 50

EmergencyContactHomePhoneNumber

string

Max length: 50

EmergencyContactMobilePhoneNumber

string

Max length: 50

EmergencyContactWorkPhoneNumber

string

Max length: 50

HireDate

MM/DD/YYYY

date

None.

Rehire

boolean

None.

CompletedDate

Date/time that the employee is completed in the system.

date

None.

I9Assistance

boolean

None.

CitizenshipName

Citizen, NonCitizenNational, Permanent Resident, Alien

string

None.

AlienRegUSCISNumber

Populated if Permanent Resident or Alien

string

Max length: 50

ExpirationDate

Populated if Permanent Resident or Alien

date

None.

I94Number

Populated only if Alien and AlienReg/USCISNumber not provided

string

Max length: 50

PassportNumber

Populated only if Alien and AlienReg/USCISNumber or I94Number not provideds

string

Max length: 50

Country

Required if PassportNumber is provided

string

Max length: 100

FederalPerjuryConfirmation

boolean

None.

AllowancesandDeductionConfirmation

boolean

None.

DirectDeposit

TRUE/FALSE, whether Direct Deposit is turned on or not

boolean

None.

DepositType1

Bank, PayCard

string

Max length: 50

Route1

string

Max length: 50

Institution1

string

Max length: 100

Account1

string

Max length: 50

AccountType1

Checking, Savings

string

Max length: 50

Amount1

decimal number

None.

AmountType1

%, $, Net Remainder of Pay

string

Max length: 50

DepositType2

Bank, PayCard

string

Max length: 50

Route2

string

Max length: 50

Institution2

string

Max length: 100

Account2

string

Max length: 50

AccountType2

Checking, Savings

string

Max length: 50

Amount2

decimal number

None.

AmountType2

%, $, Net Remainder of Pay

string

Max length: 50

DepositType3

Bank, PayCard

string

Max length: 50

Route3

string

Max length: 50

Institution3

string

Max length: 100

Account3

string

Max length: 50

AccountType3

Checking, Savings

string

Max length: 50

Amount3

decimal number

None.

AmountType3

%, $, Net Remainder of Pay

string

None.

DepositType4

Bank, PayCard

string

Max length: 50

Route4

string

Max length: 50

Institution4

string

Max length: 100

Account4

string

Max length: 50

AccountType4

Checking, Savings

string

Max length: 50

Amount4

decimal number

None.

AmountType4

%, $, Net Remainder of Pay

string

Max length: 50

DepositType5

Bank, PayCard

string

Max length: 50

Route5

string

Max length: 50

Institution5

string

Max length: 100

Account5

string

Max length: 50

AccountType5

Checking, Savings

string

Max length: 50

Amount5

decimal number

None.

AmountType5

%, $, Net Remainder of Pay

string

Max length: 50

DepositType6

Bank, PayCard

string

Max length: 50

Route6

string

Max length: 50

Institution6

string

Max length: 100

Account6

string

Max length: 50

AccountType6

Checking, Savings

string

Max length: 50

Amount6

decimal number

None.

AmountType6

%, $, Net Remainder of Pay

string

Max length: 50

PayRateType

Hourly, Salary

string

Max length: 50

PayRate1

Pay Rate Amount

decimal number

None.

FederalFilingStatus

Single, Married, Married Filing Single

string

Max length: 50

FederalAllowances

integer

None.

FederalAddlAllowances

decimal number

None.

FederalExemption

boolean

None.

FederalDependentsAmtTotal

decimal number

None.

FederalOtherIncome

decimal number

None.

FederalDeductions

decimal number

None.

FederalTwoJobsTotal

boolean

None.

PrimaryState

State for which new hire will complete a state form W-4

string

Max length: 2

StateWithholdingPercentage

decimal number

None.

StateExemption

boolean

None.

StateAllowances

integer

None.

StateWithholding

decimal number

None.

CountyWithholding

decimal number

None.

StateFilingStatus

string

Max length: 50

DateExported

This will be a date stamp indicating when the exported file was created.

date

None.

Disposition

string

None.

PayrollCode

string

None.

StartDate

date

None.

CustomFields

Onboarding Custom Fields are available in the API by default. The data is not flattened and contains a List of "CustomFieldModel". Each of these have a "Name", "FieldType" "Value", and “FieldLabel”. The "FieldLabel” corresponds to the custom field label on the UI. These fields always show even if not filled

Collection of CustomFieldModel

None.

CustomForms

Custom Form Fields are also available, but not by default due to the potential for a large quantity of data. There is a filter “IncludeGroups” in the API and if “CustomForms” is passed as a filter, custom form fields will be passed.

Collection of CustomFormModel

None.