The Candidate Entity

This entity represents a person seeking a job.

 

The Candidate entity has the following properties.

Property Name

Type (limit)

Description

Not Nullable

Read-Only

userID

Integer

A unique identifier for this record.

X

X

address

address

The Candidate's address. This is an address object containing Street Address, City, State, and Zip.

 

 

candidateSourceID

Integer

The ID of the CandidateSource associated with this Candidate. Used for 3rd party referral.

 

Note: When using this field in a query, you must refer to this property as candidateSource.id (see query operation for more details).

 

 

categoryID

Integer

The Candidate's primary Category.

 

Note: This property refers to the original category assigned to the Candidate. To retrieve or update categories for the Candidate, you should use the categories associations (see below) and the associate and unassociate operations.

X

 

certifications

string

The Candidate's certifications.

 

 

comments

String

Free-text comments on this Candidate.

X

 

companyName

String (100)

The name of the company where the Candidate currently works.

 

 

companyURL

String (100)

Candidate's personal URL.

 

 

customDate1-3

datetime

Configurable date fields that can be used to store custom data depending on the needs of a particular deployment.

 

 

customFloat1-3

Double

Configurable numeric fields that can be used to store custom data depending on the needs of a particular deployment.

 

 

customInt1-3

Integer

Configurable numeric fields that can be used to store custom data depending on the needs of a particular deployment.

 

 

customText1-20

String (100)

Configurable text fields that can be used to store custom data depending on the needs of a particular deployment.

 

 

customTextBlock1-5

String

Configurable text fields that can be used to store custom data depending on the needs of a particular deployment.

 

 

dateAdded

datetime

The date on which this record was created in the Bullhorn system.

X

X

dateAvailable

datetime

The date on which the Candidate will be available to begin work.

 

 

dateAvailableEnd

datetime

The date on which the Candidate's availability will end, if applicable.

 

 

dateI9Expiration

datetime

The date on which the Candidate's I9 form will expire.

 

 

dateLastComment

datetime

The date of the most recent Note referencing this Candidate.

 

 

dateNextCall

datetime

The date when the Candidate should next be called.

 

 

dateOfBirth

datetime

The Candidate's date of birth.

 

 

dayRate

decimal

The Candidate's desired per-day pay rate.

 

 

dayRateLow

decimal

The lowest per-day rate the Candidate will accept.

 

 

degreeList

String

List of the Candidate's educational degrees. Field on the edit screen, not the field in People Template.

 

 

description

String

Text field, usually used to contain the Candidate's resume.

 

 

desiredLocations

String

Locations where the Candidate would like to work.

 

 

disability

String (1)

Indicates whether the Candidate has a disability. Allowable values can be configured using field maps. Default values are U (Unknown), Y (Yes), and N (No).

 

 

educationDegree

String

The Candidate's highest level of education.

 

 

email

String (60)

The Candidate's email address.

 

 

email2

String (100)

Additional email address.

 

 

email3

String (100)

Additional email address.

 

 

employeeType

String (30)

The Candidate's employee type: for example 1099 or W2.

X

 

employmentPreference

String (200)

Indicates the type of employment the candidate would prefer: for example, permanent, part-time, etc.

 

 

ethnicity

String (50)

The Candidate's ethnicity.

 

 

experience

Integer

Number of years of experience that the Candidate has.

 

 

externalID

String (50)

Used for records migrated in from other systems; often used for the Candidate's external/backoffice ID.

 

 

fax

String (20)

The Candidate's fax number.

 

 

fax2

String (20)

Additional fax number.

 

 

fax3

String (20)

Additional fax number.

 

 

federalAddtional

WitholdingsAmount

decimal

The number of federal withholdings the candidate has selected on his or her W-2 tax form.

 

 

federalExemptions

Integer

The number of federal exemptions the candidate has indicated on his or her W-2 tax form.

 

 

federalFilingStatus

String

The Candidate's federal tax filing status.

 

 

firstName

String (50)

The Candidate's first name.

X

 

gender

String (6)

The Candidate's gender.

 

 

hourlyRate

decimal

The Candidate's desired hourly pay rate.

 

 

hourlyRateLow

decimal

The lowest hourly pay rate the Candidate will accept.

 

 

i9OnFile

Integer

Indicates whether the Candidate's I-9 form has already been filled out and is on file.

 

 

isDeleted

Boolean

Indicates whether this record has been marked as Deleted in the Bullhorn system.

X

 

isEditable

Boolean

Indicates whether the Candidate can edit his or her profile information; applicable to candidate/client login.

X

 

lastName

String (50)

The Candidate's last name.

X

 

linkedPersonID

Integer

If the person represented by this Candidate record is also represented by a ClientContact record, this field indicates the ID of that ClientContact record.

 

Note: When using this field in a query, you must refer to this property as linkedPerson.id (see query operation for more details).

 

 

localAddtional

WitholdingsAmount

decimal

The number of local withholdings the candidate has selected on his or her W-2 tax form.

 

 

localExemptions

Integer

The number of local exemptions the candidate has indicated on his or her W-2 tax form.

 

 

localFilingStatus

String

The Candidate's local tax filing status.

 

 

localTaxCode

String

The Candidate's local tax code (if local taxes apply); not required.

 

 

massMailOptOut

Boolean

Indicates whether the Candidate has chosen not to be included in mass emails through the Bullhorn system.

 

 

middleName

String (50)

The Candidate's middle name.

 

 

mobile

String (20)

The Candidate's mobile (cellular) telephone number.

 

 

name

String

The Candidate's full name. If setting firstname or lastname, you must also set this field; it does not populate automatically.

X

 

namePrefix

String (5)

The Candidate's name prefix, for example Dr., Ms, Mr., etc.

 

 

nameSuffix

String (5)

The Candidate's name suffix, for example Jr.

 

 

nickName

String

The Candidate's nickname.

 

 

numCategories

Integer

The number of Category objects associated with this Candidate.

 

 

numOwners

Integer

The number of Corporate Users that are listed as owner of this Candidate.

 

 

occupation

String (50)

The Candidate's current occupation or job title.

 

 

ownerCorporationID

Integer

Corporation ID of the candidate owner.

 

Note: When using this field in a query, you must refer to this property as ownerCorporation.id (see query operation for more details).

 

X

ownerID

Integer

The ID of the Corporate User who is the primary owner of this Candidate.

 

Note: When using this field in a query, you must refer to this property as owner.id (see query operation for more details).

X

 

pager

String (20)

The Candidate's pager number.

 

 

paperWorkOnFile

String

Configurable field that tracks whether the Candidate's tax paperwork has been received.

 

 

phone

String (20)

The Candidate's home telephone number.

 

 

phone2

String (20)

The Candidate's telephone number at work.

 

 

phone3

String (20)

Alternate telephone number.

 

 

preferredContact

String (15)

The Candidate's preferred method of contact (e.g. phone, email, etc.)

X

 

recentClientList

String

List of Client Corporations for which the Candidate has worked.

 

 

referredBy

String (50)

Name of the person who referred this Candidate.

 

 

referredByPersonID

Integer

The Bullhorn ID of the person who referred this Candidate, if applicable.

 

Note: When using this field in a query, you must refer to this property as referredByPerson.id (see query operation for more details).

 

 

salary

decimal

The Candidate's desired yearly salary.

 

 

salaryLow

decimal

The lowest yearly salary the Candidate will accept.

 

 

secondaryAddress

address

The Candidate's work address.

 

 

skillSet

String

Text description of the Candidate's skills.

 

 

source

String (200)

Candidate source: for example, Advertisement, Client Referral, LinkedIn, Monster.com, etc. Allowable values can be configured using field maps.

 

 

ssn

String (18)

The Candidate's Social Security Number. Check field map for proper format.

 

 

stateAddtional

WitholdingsAmount

decimal

The number of state withholdings the candidate has selected on his or her W-2 tax form.

 

 

stateExemptions

Integer

The number of state exemptions the candidate has indicated on his or her W-2 tax form.

 

 

stateFilingStatus

String

The Candidate's state tax filing status.

 

 

status

String (100)

Candidate status with the company: for example, New Lead, Active, Offer Pending, Placed, etc. Allowable values can be configured using field maps.

X

 

taxID

String (18)

The ID that Candidate uses for tax purposes if not SSN.

 

 

taxState

String

The state in which the Candidate pays taxes.

 

 

timeZoneOffsetEST

Integer

Indicates the number of hours by which the Candidate's time zone differs from Eastern Standard Time. For example, Pacific Standard Time is -3, three hours earlier than Eastern.

 

 

travelLimit

Integer

The maximum distance the Candidate is willing to travel.

 

 

type

String (100)

Candidate type: for example, Active, Passive, etc.

 

 

userDateAdded

datetime

The date the record was added to the system.

 

X

username

String

The Candidate's username for the Bullhorn application.

X

 

userTypeID

Integer

The userType for this candidate. The majority of candidates use the standard "BH Staffing Candidate" type (UserTypeID = 35).

X

 

veteran

String (1)

Indicates whether the Candidate is a veteran: Y for yes, N for no, or U for unknown.

 

 

willRelocate

Boolean

Indicates whether the Candidate is willing to relocate for a position.

 

 

workAuthorized

Boolean

Indicates whether the Candidate is authorized to work in the U.S.

 

 

workPhone

String (20)

The Candidate's telephone number at work.

 

 

 

The Candidate entity has the following associations.

Association Name

Association DTO

Description

businessSectors

BusinessSector

The set of BusinessSectors associated with this Candidate.

categories

Category

The set of categories associated with this Candidate.

secondaryOwners

CorporateUser

The set of CorporateUsers who are additional Owners of this Candidate.

skills

Skill

(Read Only) The set of Skills that the Candidate has. This includes skills listed as either primary or secondary.

primarySkills

Skill

The set of Skills that are listed as primary skills for this candidate.

secondarySkills

Skill

The set of Skills that are listed as secondary skills for this candidate.