NAV

ActivityGoal

Read-only view of activity goals established for sales personnel in the organization.

ActivityGoal field Type Description Not null Read-only
id Integer Unique identifier for this entity. X X
user To-one association CorporateUser for whom this activity goal was created. X X
department To-one association Department of user for whom this activity goal was created.
activityType String (100) Type of goal for record. X X
startDate Date The first day of the time period in which this activity goal is in effect, in the format: “YYYY-MM-DD”. X
endDate Date The last day of time period in which this activity goal is in effect, in the format: “YYYY-MM-DD”. X
goal Integer Target goal for activity type. X
actual Integer Current count of activity type data for goal. X
periodName String (100) Time period for activity goal. (Weekly/Monthly). X X
percentAttained Integer The whole percentage attained to date, equal to the attained value divided by the goal value multiplied by 100. X

ActivityGoalConfiguration

Lets a user configure an activity goal for use in conjunction with the activity goals feature.

ActivityGoalConfiguration field Type Description Not null Read-only
id Integer Unique Identifier for this entity. X X
codeIdentifier String (100) Field that determines if a goal is an ActivityGoal or RecordBasedGoal. X
dateLastModified Timestamp The last time record was modified. X X
Description String (2000) Goal description. X
goalPeriodId Integer Id of goal time period.
goalTypeId Integer Id of goal type. X
isDeleted Boolean Whether or not activity goal is deleted. X
name String (100) Name of goal.
pulseConfigurationValues To-many association Values against which goal is tracked.

ActivityGoalTarget

Lets a user assign an activity goal to a user.

ActivityGoalTarget field Type Description Not null Read-only
id Integer Unique Identifier for this entity. X X
activityGoalConfiguration To-one association The activity goal configuration assigned to user. X
goal Integer The amount of activity that user is trying to hit. X
periodName String (100) Time period for activity goal. (Weekly/Monthly). X
user To-one association User to which activity goal is assigned.

Appointment

Represents an appointment on a Bullhorn user’s calendar. A separate Appointment instance is created for each user who is invited to the appointment; the instance belonging to the Appointment owner (the person who created it) is the parent, and has a null value for the parentAppointment property. The Appointment instances belonging to the invitees are the child instances; these refer to the parent in their parentAppointment properties, and are associated with the parent through its childAppointments association. Each user who is invited to the appointment is represented by an AppointmentAttendee instance.

Appointment field Type Description Not null Read-only
id Integer Unique identifier for this entity.  X
attendees To-many association Ids of the AppointmentAttendees for this Appointment.
appointmentUUID String (300) A secondary unique identifier for this entity. Used to identify the record when it is synchronized to external systems. Format is 8-4-4-16 where all characters are A-Z or 0-9. X
candidateReference To-one association The Candidate with whom this Appointment is associated, if any.
clientContactReference To-one association The ClientContact with whom this Appointment is associated, if any.
childAppointments To-many association Child Appointments associated with this Appointment. The ownerID of any child Appointment represents a user who has been invited to this Appointment.
communicationMethod String (30) Indicates how the appointment will be conducted: phone, on-site, off-site, and so forth. X
dateAdded Timestamp The date on which this record was created in the Bullhorn system. X
dateBegin Timestamp The date on which the appointment began/will begin.
The default value is current time rounded up to next half hour, or 15 minutes before dateEnd if it is provided.
X
dateEnd Timestamp The date on which the appointment ended/will end.
The default value is 15 minutes after dateBegin.
X
dateLastModified Timestamp The date on which this record was last modified.
description String (2147483647) Free-text description of the appointment.
The default value is “”.
X
isAllDay Boolean Indicates whether the appointment will last all day.
isDeleted Boolean Indicates whether this record has been marked as deleted in the Bullhorn system. X
isPrivate Boolean Indicates whether the appointment is viewable by others. If set to private, only the appointment owner and attendees may view the appointment details. X
jobOrder To-one association JobOrder associated with the appointment, if any.
lead To-one association Lead, if any, associated with the appointment. Included Lead field is id.
location String (100) Indicates where the appointment will take place (conference room name, and so forth).
The default value is “”.
X
migrateGUID String (36) Unused.  X
notificationMinutes Integer Indicates when the Bullhorn application should remind the user of the appointment. May be zero for no reminder. X
opportunity To-one association Opportunity, if any, associated with the appointment. Included Opportunity field is id.
owner To-one association Bullhorn user (Person) who owns the appointment. The default value is user who creates the Appointment. X
parentAppointment To-one association Appointment that is the parent of this one, if any. Included Appointment field is id.
placement To-one association Placement associated with the appointment, if any. Included Placement field is id.
recurrenceDayBits Integer Indicates which days are part of the recurrence pattern, if the appointment is a recurring one. The value of this field is the sum of the days included in the series: Sun = 2, Mon = 4, Tue = 8, Wed = 16, Thur = 32, Fri = 64, Sat = 128. For example, a meeting that occurs on Monday and Friday would have a recurrenceDayBits value of 68 (4+64).
recurrenceFrequency Integer The frequency with which the appointment recurs: e.g., a recurrenceFrequency of 2 for a weekly meeting would imply the meeting occurs every 2 weeks. Null for a one-time appointment.
recurrenceStyle String (10) A=absolute, R=relative: e.g., an absolute would be the third week of every month, whereas a relative would be every third week.
recurrenceType String (1) The type of recurrence. D=daily, W=weekly, M=monthly, A=annually.
subject String (100) Subject header of the appointment. X
type String (30) Used to distinguish appointments by an identifiable class or kind, for example Interview, Call, Personal, and so forth. X

AppointmentAttendee

Represents a person who has been invited to an appointment.

AppointmentAttendee field Type Description Not null Read-only
id Integer Unique identifier for this entity. X X
appointment To-one association Appointment to which this AppointmentAttendee corresponds. X
attendee To-one association The ClientContact, Candidate, or CorporateUser id for this person. X
acceptanceStatus Integer Indicates whether attendee has accepted, accepted tentatively, declined, or not responded to this invitation. (-1 = declined, 0 or null = has not responded, 1 = accepted, and 2 = tentative.) X
migrateGUID String (36) Unused.  X

BusinessSector

Represents a business sector, which can be associated with Candidates, ClientCorporations, and JobOrders for classification purposes.

BusinessSector field Type Description Not null Read-only
id Integer Unique identifier for this entity. X X
dateAdded Timestamp When the entity was created.
name String (100) Name of this business sector. X X

Candidate

Represents a person seeking a job.

The Candidate entity supports the massUpdate operations.

Candidate field Type Description Not null Read-only
id Integer Unique identifier for this entity. X X
address Address Candidate address:
  • address1
  • address2
  • city
  • state
  • zip
  • countryID: options:
    • value: 1
    • value: 2
Use the following REST call to get the list of countryIDs and labels: /meta/Candidate?fields=address(countryID)
businessSectors To-many association Ids of BusinessSectors with which Candidate is associated.
candidateSource To-one association Source of the Candidate.   X
category To-one association Candidate’s primary Category. The default value is the Other Area(s) category for the user’s private label or the first 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). X
categories To-many association Categories assigned to Candidate.
certifications String (2147483647) Candidate’s certifications.
comments String (2147483647) Free-text comments on Candidate. X
companyName String (100) Name of company where the Candidate currently works.
companyURL String (100) Candidate’s personal URL.
customDate1 to 3 Timestamp Configurable date fields that can be used to store custom data depending on the needs of a particular deployment.
customFloat1 to 3 Double Configurable numeric fields that can be used to store custom data depending on the needs of a particular deployment.
customInt1 to 3 Integer Configurable numeric fields that can be used to store custom data depending on the needs of a particular deployment.
customObject1s to 10s CustomObject Fields to which custom objects can be assigned. For more information about custom objects, see the Bullhorn Resource Center and the following article on using the REST API with custom objects: http://developer.bullhorn.com/articles/customobjects
customText1 to 20 String (100) Configurable text fields that can be used to store custom data depending on the needs of a particular deployment.
customTextBlock1 to 5 String (2147483647) Configurable text fields that can be used to store custom data depending on the needs of a particular deployment.
dateAdded Timestamp Date on which this record was created in the Bullhorn system. X X
dateAvailable Timestamp Date on which Candidate will be available to begin work.
dateAvailableEnd Timestamp Date on which Candidate’s availability will end, if applicable.
dateI9Expiration Timestamp Date on which the Candidate’s I9 form will expire.
dateLastComment Timestamp Date of the most recent Note referencing Candidate.
dateLastModified Timestamp Date the Candidate was last modified.
dateNextCall Timestamp Date when the Candidate should next be called.
dateOfBirth Timestamp Candidate’s date of birth.
dayRate BigDecimal Candidate’s desired per-day pay rate.
dayRateLow BigDecimal Lowest per-day rate the Candidate will accept.
degreeList String (2147483647) List of Candidate’s educational degrees. Field on the edit screen, not the field in People Template.
description String (2147483647) Text field, usually used to contain the Candidate’s resume.
desiredLocations String (2147483647) Locations where Candidate would like to work.
disability String (1) Indicates whether Candidate has a disability. Allowable values can be configured using field maps. Default values are U (Unknown), Y (Yes), and N (No).
educationDegree String (2147483647) Candidate’s highest level of education.
email String (100) Candidate’s email address.
email2 String (100) Additional email address.
email3 String (100) Additional email address.
employeeType String (30) Candidate’s employee type: for example 1099 or W2. X
employmentPreference String (200) Indicates type of employment the Candidate would prefer: for example, permanent, part-time, and so forth.
ethnicity String (50) 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) Candidate’s fax number.
fax2 String (20) Additional fax number.
fax3 String (20) Additional fax number.
federalAdditionalWitholdingsAmount BigDecimal Number of federal withholdings the Candidate has selected on his or her W-2 tax form.
federalExemptions Integer Number of federal exemptions the Candidate has indicated on his or her W-2 tax form.
federalFilingStatus String (1) Candidate’s federal tax filing status.
firstName String (50) Candidate’s first name. X
gender String (1) Candidate’s gender. Options are U (unknown), M (male), F (female)
hourlyRate BigDecimal Candidate’s desired hourly pay rate.
hourlyRateLow BigDecimal Lowest hourly pay rate the Candidate will accept.
i9OnFile Integer Indicates whether Candidate’s I-9 form has already been filled out and is on file.
interviews To-many association Interviews for Candidate. This field is populated when you create Appointments where Appointment.candidate is this Candidate and Appointment.type is “Interview”. X
isDeleted Boolean Indicates whether this record is marked as deleted in the Bullhorn system. X
isEditable Boolean Indicates whether Candidate can edit his or her profile information; applicable to Candidate/Client login. X
lastName String (50) Candidate’s last name. X
leads To-many association Leads associated with this Candidate.
linkedPerson To-one association If person represented by Candidate is also a ClientContact, this field includes the following ClientContact fields: id, _subtype
localAddtionalWitholdingsAmount BigDecimal Number of local withholdings the Candidate has selected on his or her W-2 tax form.
localExemptions Integer Number of local exemptions Candidate has indicated on his or her W-2 tax form.
localFilingStatus String (1) Candidate’s local tax filing status.
localTaxCode String (40) Candidate’s local tax code (if local taxes apply); not required.
massMailOptOut Boolean Indicates whether Candidate has chosen not to be included in mass emails through the Bullhorn system.
middleName String (50) Candidate’s middle name.
mobile String (20) Candidate’s mobile (cell) telephone number.
name String Candidate’s full name. If setting firstname or lastname, you must also set this field; it does not populate automatically. X
namePrefix String (5) Candidate’s name prefix, for example Dr., Ms., Mr., and so forth.
nameSuffix String (5) Candidate’s name suffix, for example Jr.
nickName String (50) Candidate’s nickname.
numCategories Integer Number of Category objects associated with Candidate.
numOwners Integer Number of CorporateUsers that are listed as owner of Candidate.
occupation String (50) Candidate’s current occupation or job title.
owner To-one association CorporateUser who is the primary owner of Candidate. The default value is user who creates the Candidate. X
pager String (20) Candidate’s pager number.
paperWorkOnFile String Configurable field that tracks whether the Candidate’s tax paperwork has been received.
password String Candidate’s password. The default value is a randomly generated string. X
phone String (20) Candidate’s home telephone number.
phone2 String (20) Candidate’s telephone number at work.
phone3 String (20) Alternate telephone number.
placements To-many association Placements for Candidate. This field is populated when you create Placements where Placement.candidate is this Candidate. X
preferredContact String (15) Candidate’s preferred method of contact (for example, phone, email, and so forth.) X
primarySkills To-many association Skills that are listed as primary Skills for Candidate.
recentClientList String (2147483647) List of ClientCorporations for which Candidate has worked.
referredBy String (50) Name of person who referred Candidate.
referredByPerson To-one association Person who referred Candidate, if applicable.
salary BigDecimal Candidate’s desired yearly salary.
salaryLow BigDecimal Lowest yearly salary the Candidate will accept.
secondaryAddress Address Candidate’s work address:
  • address1
  • address2
  • city
  • state
  • zip
  • countryID: options:
    • value: 1
    • value: 2
Use the following REST call to get the list of countryIDs and labels: /meta/Candidate?fields=address(countryID)
secondaryOwners To-many association CorporateUsers who are additional owners of Candidate.
secondarySkills Skill Skills that are listed as secondary skills for Candidate.
sendouts To-many association Sendouts for Candidate. This field is populated when you create Sendouts where the Sendout.candidate is this Candidate.
skillSet String (2147483647) Text description of Candidate’s skills.
smsOptIn Boolean Indicates whether Candidate has granted permission to be sent messages via SMS.
source String (200) Candidate source: for example, Advertisement, Client Referral, LinkedIn, Monster.com, and so forth. Allowable values can be configured using field maps.
specialties To-many association Candidate’s specialty skills. This field is populated when you associate a Specialty with this Candidate in a to-many association operation.
ssn String (18) Candidate’s Social Security Number. Check field map for proper format.
stateAddtionalWitholdingsAmount BigDecimal Number of state withholdings Candidate has selected on his or her W-2 tax form.
stateExemptions Integer Number of state exemptions Candidate has indicated on W-2 tax form.
stateFilingStatus String (1) Candidate’s state tax filing status.
status String (100) Candidate status with company: for example, New Lead, Active, Offer Pending, Placed, and so forth. Allowable values can be configured using field maps. X
submissions To-many association JobSubmissions for Candidate. This field is populated when you create JobSubmissions where JobSubmission.candidate is this Candidate. X
tasks To-many association Tasks associated with Candidate. This field is populated when you create Tasks where Task.candidate is this Candidate.
taxID String (18) Id that Candidate uses for tax purposes if not SSN.
taxState String (30) State in which 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 Maximum distance Candidate is willing to travel.
travelMethod String (100) Method of travel to job.
type String (100) Candidate type: for example, Active, Passive, and so forth.
userDateAdded Timestamp Date the record was added to the system. X
username String (100) Candidate’s username for logging in to Bullhorn. The default value is _[random number] X
veteran String (1) Indicates whether Candidate is a veteran: Y for yes, N for no, or U for unknown.
webResponse To-many association Web responses for Candidate. This field is populated when you create JobSubmissions where JobSubmission.candidate is this Candidate and JobSubmission.status is “New Lead”.
willRelocate Boolean Indicates whether Candidate is willing to relocate for a position.
workAuthorized Boolean Indicates whether Candidate is authorized to work in the U.S.
workPhone String (20) Candidate’s telephone number at work.

Candidate confidential fields

By default, candidate fields listed in the ‘Confidential Fields’ private label attribute are returned with the value “**CONFIDENTIAL**”. However, confidential fields can also be included in the ‘Candidate Viewable Confidential Fields’ private label attribute. Only users with the ‘View Candidate Viewable Confidential Fields’ user action entitlement can view candidate viewable confidential fields.

User who have both the ‘View Candidate Viewable Confidential Fields’ and ‘Edit Confidential Fields’ user action entitlements can edit candidate viewable confidential fields.

CandidateCertification

This entity represents a certification that a Candidate may have.

CandidateCertification field Type Description Not null Read-only
id Integer Unique identifier for this entity. X X
boardCertification String (100) Set by certificationBoardCertificationList private label attribute
candidate To-one association Candidate linked to CandidateCertification. X
certification To-one association Certification linked to CandidateCertification. X
comments String (2147483647) Free-text comments on this record.
compact Integer yes/no (1/0) Whether compact or not.
copyOnFile Integer yes/no (1/0) Whether on file.
dateCertified Timestamp Date candidate obtained certification.
dateExpiration Timestamp Date certification expires.
dateLastModified Timestamp Date the CandidateCertification was last updated. X
fileAttachments Many-to-many association CandidateFileAttachements associated to entity. Association created by adding the ID(s) of the fileAttachment(s) to this field in an association PUT call of the form: {corpToken}/entity/CandidateCertification/{entity-id}/fileAttachments/{entity-id},*}.
issuedBy String (100) Entity that issued certification to candidate.
licenseNumber String (100) License number of the certification.
licenseType String (30) License Type of the certification.
location String (100) Location where certification is valid.
modifyingUser To-one association Creator of CandidateCertification.
name String (100) Name of CandidateCertification. X
results String (255) Free text of certification results.
status String (30) Status of CandidateCertification.

CandidateReference

Represents a person who serves as a reference for a Candidate.

CandidateReference field Type Description Not null Read-only
id Integer Unique identifier for this entity. X X
candidate To-one association Candidate for whom this person is a reference. X
candidateTitle String (50) Candidate’s title when he or she worked with or for the reference.
clientCorporation To-one association ClientCorporation where the CandidateReference works.
companyName String (50) Name of the company where reference works, if it does not have a ClientCorporation record in Bullhorn.
customDate1 to 5 Timestamp Configurable date fields that can be used to store custom data depending on the needs of a particular deployment.
customFloat1 to 5 Double Configurable numeric fields that can be used to store custom data depending on the needs of a particular deployment.
customInt1 to 5 Integer Configurable numeric fields that can be used to store custom data depending on the needs of a particular deployment.
customText1 to 5 String (500) Configurable text fields that can be used to store custom data depending on the needs of a particular deployment.
customTextBlock1 to 3 String (2147483647) Configurable text fields that can be used to store custom data depending on the needs of a particular deployment.
dateAdded Timestamp Date on which this record was created in the Bullhorn system. X
employmentEnd Timestamp End date of Candidate’s employment with the reference.
employmentStart Timestamp Start of the period during which the Candidate worked with the reference.
isDeleted Boolean Indicates whether this record has been marked as deleted in the Bullhorn system. X
jobOrder Integer JobOrder for which Candidate is being considered.
referenceClientContact To-one association Bullhorn ClientContact for this reference, if applicable.
referenceEmail String (50) Email address for reference; not used if the CandidateReference is a client contact.
referenceFirstName String (50) Reference’s first name; not used if reference is a ClientContact.
referenceLastName String (50) Reference’s last name; not used if the CandidateReference is a ClientContact.
referencePhone String (20) Phone number for the CandidateReference; not used if the reference is a ClientContact.
referenceTitle String (50) Reference’s job title; not used if the reference is a ClientContact.
status String (20) Status of this reference request.
yearsKnown Integer Indicates how long reference has known the Candidate.

CandidateWorkHistory

Represents a single entry in the “Work History” section of a Candidate’s resume: that is, a job the Candidate has had. For each current or former position the Candidate has held, there is a unique CandidateWorkHistory instance associated with that Candidate. Each CandidateWorkHistory instance corresponds to a line item on the “Work History” tab of a Candidate record in the Bullhorn application.

CandidateWorkHistory field Type Description Not null Read-only
id Integer Unique identifier for this entity. X X
bonus Double Amount of the bonus paid to Candidate.
candidate To-one association Candidate with whom CandidateWorkHistory is associated. X
clientCorporation To-one association ClientCorporation associated with Candidate.
comments String (2147483647) Free-text comments on CandidateWorkHistory.
commission Double Amount of commission earned by Candidate at this position.
companyName String (100) Name of the company where the Candidate worked.
customDate1 to 5 Timestamp Configurable date fields that can be used to store custom data depending on the needs of a particular deployment.
customFloat1 to 5 Double Configurable numeric fields that can be used to store custom data depending on the needs of a particular deployment.
customInt1 to 5 Integer Configurable numeric fields that can be used to store custom data depending on the needs of a particular deployment.
customText1 to 5 String Configurable text fields that can be used to store custom data depending on the needs of a particular deployment.
customTextBlock1 to 3 String Configurable text fields that can be used to store custom data depending on the needs of a particular deployment.
dateAdded Timestamp Date on which this record was created in the Bullhorn system. X X
endDate Timestamp Date on which job ended, if applicable.
isDeleted Boolean Indicates whether this record has been marked as deleted in the Bullhorn system. X
isLastJob Boolean Indicates whether this was the Candidate’s most recent job. X
jobOrder To-one association JobOrder associated with the CandidateWorkHistory, if applicable.
placement To-one association Placement representing the Candidate’s placement in a job, if applicable. 
salary1 BigDecimal Candidate’s starting salary at this position.
salary2 BigDecimal Candidate’s final salary at this position.
salaryType String (20) Indicates how the Candidate was paid: Hourly, Yearly, and so forth.
startDate Timestamp Date on which Candidate began working at this position.
terminationReason String (100) Reason for the Candidate’s termination from this position, if applicable.
title String (50) Candidate’s job title in this position.

Category

This entity represents a category in which a Candidate or JobOrder can be placed. A category that has a value for parentCategoryId greater than zero is anty.

Category field Type Description Not null Read-only
id Integer Unique identifier for this entity. X X
dateAdded Timestamp Date on which record was created in the Bullhorn system. X X
description String (255) Free-text description of this category. X
enabled Boolean Indicates whether category is available for use in the Bullhorn system. X X
name String (100) Name of the category + PLId (for categories) X X
occupation String (50) Occupation. X
skills To-many association Ids of the Skills associated with this Category.
specialties To-many association Ids of the Specialties that are children of this Category.
type String (20) Bill Rate Category, Skills Checklist Category, and so forth. X

Certification

This entity represents a certification that a Candidate has.

Certification field Type Description Not null Read-only
id Integer Unique identifier for this entity. X X
description String (2147483647) Free-text description of this certification.
name String (100) Name of this certification. X

ClientContact

Represents a contact person who works at a ClientCorporation. A ClientContact can be any person at the ClientCorporation whom you wish to track in the Bullhorn system: a hiring manager, HR staffer, executive, or other employee. Note that a Candidate may become a Client Contact after being placed in a job; or a ClientContact may become a Candidate after deciding to look for another position.

The ClientContact entity supports the massUpdate operations.

ClientContact field Type Description Not null Read-only
id Integer Unique identifier for this entity. X X
address Address Contact’s address:
  • address1
  • address2
  • city
  • state
  • zip
  • countryID: options:
    • value: 1
    • value: 2
Use the following REST call to get the list of countryIDs and labels:/meta/ClientContact?fields=address(countryID)
businessSectors To-many association Ids of BusinessSectors in which the Contact operates.
category To-one association Contact’s primary Category. The default value is the Other Area(s) category for the user’s private label or the first Category. X
categories To-many association Ids of the Categories associated with the Contact. Note that the categoryId property is used to store the contact’s primary Category, while this association hold that Category and any other Categories to which the Contact belongs.
certifications String (2147483647) Contact’s certifications.
clientCorporation To-one association ClientCorporation for which the Contact works. X
comments String (2147483647) Free-text comments on this Contact.
customDate1-3 Timestamp 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.
customObject1s to 10s CustomObject Fields to which custom objects can be assigned. For more information about custom objects, see the Bullhorn Resource Center and the following article on using the REST API with custom objects: http://developer.bullhorn.com/articles/customobjects
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 (2147483647) Configurable text fields that can be used to store custom data depending on the needs of a particular deployment.
dateAdded Timestamp Date on which this record was created in the Bullhorn system. X
dateLastModified Timestamp Date on which the ClientContact was last modified.
dateLastVisit Timestamp Date of ClientContact’s last visit.
description String (2147483647) Large text field for additional information about the contact.
desiredCategories String (255) Categories that the ClientContact wants Candidates to belong to.
desiredSkills String (255) Skills that the ClientContact wants his or her Candidates to have.
desiredSpecialties String (255) Specialties that the ClientContact wants his or her Candidates to have.
division String (40) Department that the Contact is associated with.
email String (60) ClientContact’s primary (work) email address. X
email2 String (100) Additional email address. Typically used for the ClientContact’s home or personal email.
email3 String (100) Additional email address.
externalID String (30) External identifier for the record, used for migrations and back-office Integration.
fax String (20) ClientContact’s primary (work) fax number.
fax2 String (20) Additional fax number. Typically used for the contact’s home or personal fax.
fax3 String (20) Additional fax number.
firstName String (50) ClientContact’s first name.
isDayLightSavings Boolean Indicates whether the ClientContact’s location is using Daylight Saving Time.
isDeleted Boolean Indicates whether this record has been marked as deleted in the Bullhorn system. X
lastName String (50) ClientContact’s last name.
leads To-many association Leads associated with this ClientContact.
linkedPerson Person (superclass of Candidate and ClientContact) If the person represented by this ClientContact is also a Candidate, this field includes the following Candidate fields: id, _subtype
massMailOptOut Boolean Indicates whether the Contact has chosen not to be included in mass emails through the Bullhorn system. X
middleName String (50) ClientContact’s middle name.
mobile String (20) ClientContact’s mobile (cellular) telephone number.
name String (100) ClientContact’s full name. Should be a combination of the firstName and lastName fields separated by a space. Notes: If you create a ClientContact with no value in the name field, users will have no way to select that ClientContact in the Bullhorn staffing application. If you create or modify a ClientContact name that is not a combination of the firstName and lastName fields, the name will be overwritten when a user saves the ClientContact in the Bullhorn staffing application. The name will change to a combination of the firstName and lastName fields.
namePrefix String (5) ClientContact’s name prefix, for example Dr., Ms, Mr., and so forth.
nameSuffix String (5) ClientContact’s name suffix, for example Jr.
nickName String ClientContact’s nickname.
numEmployees Integer Number of employees who report to this Contact. X
occupation String (50) ClientContact’s job title.
office String (40) For companies with multiple locations, this field can be used to indicate which office this contact works out of.
owner To-one association CorporateUser who is the owner of this Contact record. The default value is user who creates the ClientContact. X
pager String (20) ClientContact’s pager number.
password String ClientContact’s password for logging in to Bullhorn. The default value is a randomly generated string. X
phone String (20) ClientContact’s primary (work) telephone number.
phone2 String (20) Alternate phone number. Typically used for the contact’s home phone number.
phone3 String (20) Alternate phone number.
preferredContact String (15) Contact’s preferred method of contact (For example, phone, email, and so forth.) X
referredByPerson Person Person who referred this ClientContact.
reportToPerson Person Person to whom this ClientContact reports.
secondaryAddress Address ClientContact’s secondary (home) address:
  • address1
  • address2
  • city
  • state
  • zip
  • countryID: options:
    • value: 1
    • value: 2
Use the following REST call to get the list of countryIDs and labels: /meta/ClientContact?fields=address(countryID).
secondaryOwners To-many association Ids of internal users who are secondary owners of this Contact. Note that the owner property is used to store the ClientContact’s primary owner, while this association hold that person and any other owners of the Contact.
skills To-many association Ids of Skills that the ClientContact wants Candidates to have.
smsOptIn Boolean Indicates whether the ClientContact has granted permission to be sent messages via SMS.
source String (200) Source from which this ClientContact was found.
status String (30) Status of the contact; for example, New Lead, Active, Prospect, and so forth. Possible values can be configured using field maps. X
timeZoneOffsetEST Integer Indicates the number of hours by which the ClientContact’s time zone differs from Eastern Standard Time. For example, Pacific Standard Time is -3, three hours earlier than Eastern.
type String (30) Describes the type of ClientContact (for example, Primary, Secondary, Target, Gatekeeper). Possible values can be configured using field maps. X
username String (100) ClientContact’s username for logging in to Bullhorn. The default value is _[random number]

ClientCorporation

Represents a company that is a client of a company; for example, a company with jobs to fill.

The ClientCorporation entity supports the massUpdate operations.

ClientCorporation field Type Description Not null Read-only
id Integer Unique identifier for this entity. X X
address Address ClientCorporation’s main address:
  • address1
  • address2
  • city
  • state
  • zip
  • countryID: options:
    • value: 1
    • value: 2
Use the following REST call to get the list of countryIDs and labels:/meta/ClientContact?fields=address(countryID)
X
annualRevenue BigDecimal ClientCorporation’s annual revenue in millions of U.S. dollars. X
billingAddress AddressWithout-Country Address that contains the address to which bills should be sent for this ClientCorporation. address1, address2, city, state, zip
billingContact String (100) Name of the person to whom bills should be sent.
billingFrequency String (20) Frequency with which bills should be sent to the ClientCorporation: for example, Weekly, Bi-Weekly, Semi-Monthly, Monthly.
billingPhone String (20) Phone number of the billing contact person.
businessSectorList String (2147483647) Comma-separated list of BusinessSectors in which the ClientCorporation operates. See field map data for a list of possible values.
childClientCorporations To-many association ClientCorporations that are children of this one.
clientCorporationCertifications To-many association Not supported in this release. ClientCorporationCertifications associated with this corporation.
clientContacts To-many association ClientContacts who work at this ClientCorporation.
companyDescription String (2147483647) Text description of the company.
companyURL String (100) Company’s website URL. May use http:// but not required.
competitors String (2147483647) Company’s major competitors.
culture String (2147483647) Text description of the corporate culture.
customDate1-3 Timestamp 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.
customObject1s to 10s CustomObject Fields to which custom objects can be assigned. For more information about custom objects, see the Bullhorn Resource Center and the following article on using the REST API with custom objects: http://developer.bullhorn.com/articles/customobjects
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 (2147483647) Configurable text fields that can be used to store custom data depending on the needs of a particular deployment.
dateAdded Timestamp Date on which this record was created in the Bullhorn system. X X
dateFounded Timestamp Date on which the ClientCorporation was founded.
dateLastModified Timestamp Date on which the ClientCorporation was last modified.
department To-one association Department in the ClientCorporation that has primary responsibility for this client (for example, a regional office). Default value is primary department of user who adds the ClientCorporation.
externalID String (30) External identifier for the record, used for migrations and back-office Integration.
feeArrangement Double Fee, expressed as a percentage, that this ClientCorporation will pay for each Placement. X
funding String (2147483647) Current funding status of the ClientCorporation.
industryList String (2147483647) Comma-separated list of industries in which the company operates. See field map data for the list used by a particular company.
invoiceFormat String (50) Configurable field to be passed to a back-office system to indicate how to group invoices for this company (Per Placement, Per Billing Contact, and so forth.)
invoiceGroups To-many association Not supported in this release. Invoice groups associated with this ClientCorporation.
invoices To-many association Not supported in this release. Invoices associated with this corporation.
leads To-many association Leads associated with this ClientCorporation.
name String (100) Name of the company. X
notes String (2147483647) Free text field for entering any comments or notes about the company.
numEmployees Integer Total number of people employed by the company. X
numOffices Integer Total number of offices for the ClientCorporation. X
owners To-many association Owners of the ClientContacts for this ClientCorporation.
ownerShip String (30) Status of the ClientCorporation’s current ownership (for example, Public, Private).
parentClientCorporation To-one association ClientCorporation that is a parent of this one.
phone String (20) Main phone number for the ClientCorporation.
rateCards To-many association Not supported in this release. Rate cards associated with this ClientCorporation.
revenue String (2147483647) Estimated annual revenue in millions for the company.
status String (30) Status of the business relationship with this company; for example, Prospect, Active, and so forth. X
taxRate Double Tax rate for the company expressed in percentage: for example, 28%. Passed to a back-office system if applicable.
tickerSymbol String (20) Stock market ticker symbol for the company.
workWeekStart Integer Day of the week on which the work week starts for this company. 1=Sunday, 2=Monday, and so forth.

ClientCorporationAppointment

Association entity between ClientCorporation, ClientContact, and Appointment entities. This entity is read-only and is only created when the companyStampOnActivitiesEnabled corporation setting is enabled.

ClientCorporationAppointment field Type Description Not null Read-Only
id Integer Unique identifier for this entity. X X
clientCorporation To-one association Associated ClientCorporation. X
clientContact To-one association Associated ClientContact.  X
appointment To-one association Associated Appointment. X

ClientCorporationNote

Association entity between ClientCorporation, ClientContact, and Note entities. This entity is read-only and is only created when the companyStampOnActivitiesEnabled corporation setting is enabled.

ClientCorporationNote field Type Description Not null Read-Only
id Integer Unique identifier for this entity. X X
clientCorporation To-one association Associated ClientCorporation. X
clientContact To-one association Associated ClientContact.  X
note To-one association Associated Note. X

ClientCorporationTask

Association entity between ClientCorporation, ClientContact, and Task entities. This entity is read-only and is only created when the companyStampOnActivitiesEnabled corporation setting is enabled.

ClientCorporationAppointment field Type Description Not null Read-Only
id Integer Unique identifier for this entity. X X
clientCorporation To-one association Associated ClientCorporation. X
clientContact To-one association Associated ClientContact.  X
task To-one association Associated Task. X

CorporateUser

Represents an Internal user at your organization. CorporateUser is read-only. 

CorporateUser field Type Description Not null Read-only
id Integer Unique identifier for this entity. X X
customDate1 to 3 Timestamp Configurable date fields that can be used to store custom data depending on the needs of a particular deployment.
customFloat1 to 3 Double Configurable numeric fields that can be used to store custom data depending on the needs of a particular deployment.
customInt1 to 3 Integer Configurable numeric fields that can be used to store custom data depending on the needs of a particular deployment
customText1 to 20 String (100) Configurable text fields that can be used to store custom data depending on the needs of a particular deployment.
dateLastComment Timestamp Date on which CorporateUser’s last comment was made.
departments To-many association Ids of departments to which the CorporateUser belongs.
address Address CorporateUser’s main address:
  • address1
  • address2
  • city
  • state
  • zip
  • countryID: options:
    • value: 1
    • value: 2
Use th. e following REST call to get the list of countryIDs and labels: /meta/CorporateUser?fields=address(countryID)
X
email String (100) Primary email address.
email2 String (100) Additional email address 2.
email3 String (100) Additional email address 3.
emailNotify Boolean Indicates whether the user has chosen to be notified via pop-up in the Bullhorn application when a new email message arrives. X
emailSignature String (2147483647) Contents of the user’s email signature. X
enabled Boolean Indicates whether the user may log in to the Bullhorn application. X X
externalEmail String (60) User’s external (non-Bullhorn) email address. Used for forwarding X
firstName String (50) First name of the CorporateUser.
inboundEmailEnabled Boolean Indicates whether the user can receive email through the Bullhorn application. X
isDayLightSavingsTime Boolean Indicates whether it is daylight savings time.
isDeleted Boolean Indicates whether CorporateUser is deleted.
isLockedOut Boolean Indicates whether the CorporateUser is locked out.
isOutboundFaxEnabled Boolean Indicates whether the user has permission to send faxes. X
jobAssignments To-many association JobOrders that have been assigned to this CorporateUser.
loginRestrictions LoginRestrictions A group of available login restrictions, including time, date, and IP address.
massMailOptOut Boolean Indicates whether the CorporateUser opted out of mass mailings.
middleName String (50) Middle name of the CorporateUser.
mobile String (20) Mobile phone number of the CorporateUser.
name String (100) Name of the CorporateUser.
namePrefix String (5) Name prefix of the CorporateUser.
nameSuffix String (5) Name suffix of the CorporateUser.
nickName String (50) Nickname of the CorporateUser.
occupation String (50) Occupation of the CorporateUser.
pager String (20) Pager number of the CorporateUser.
phone to phone3 String (20) Phone number of the CorporateUser.
smsOptIn Boolean Indicates whether the CorporateUser has granted permission to be sent messages via SMS.
taskAssignments Task Tasks that have been assigned to this CorporateUser, including those owned by the user.
timeZoneOffsetEST Integer Indicates the number of hours by which the CorporateUser’s time zone differs from Eastern Standard Time. For example, Pacific Standard Time is -3, three hours earlier than Eastern.
username String (100) CorporateUser’s username for logging in to Bullhorn. X

CorporationDepartment

Represents a department in a corporation.

CorporationDepartment field Type Description Not null Read-Only
id Integer Unique identifier for this entity. X X
dateAdded Timestamp Date when this record was created in the Bullhorn system. X X
description String (255) Text description of the CorporationDepartment.
enabled Boolean Indicates whether this CorporationDepartment is enabled for use in the system. X X
name String (100) Name of the CorporationDepartment. X X

Country

Represents a country.

Country field Type Description Not null Read-only
id Integer Unique identifier for this entity. X X
code String (4) Code associated with this Country.
name String (64) Name of the Country. X
states To-many association Ids of States that are associated with this Country.

CustomAction

Represents a Bullhorn custom action. For more information about custom actions, see: http://developer.bullhorn.com/doc/version_2-0/understanding_custom_components.htm

CustomAction field Type Description Not null Read-only
id Integer Unique identifier for this entity. X X
actionOrder Integer Order of custom action.
apiKeyID Integer Bullhorn API key id.
componentURL String (4000) URL of CustomAction.
enabled Boolean Indicates whether CustomAction is enabled.
entity String (50) Entity to which CustomAction applies. X
name String (50) Name of CustomAction.

Department

Represents a department for a user’s corporation. Users can create, read, and update departments. Only users with the  Account Administration entitlement can create and update departments.

Department field Type Description Not null Read-only
id Integer Unique Identifier for this entity. X X
description String (255) Department description. X
enabled Boolean Indicates whether department is enabled.
name String (100) Department name. X

{Entity}EditHistory

Read-only entity that represents the transaction history of an {Entity}. The GET /query{Entity}EditHistory call returns a list of {Entity}EditHistory entities for one or more {Entity} entities. The GET /entity{Entity}EditHistory/{comma-separated entityIds} call returns one or more {Entity}EditHistory entities, each of which represents a set of {Entity} field changes. {Entity} can be any one of the following: Appointment, CandidateCertification, ClientCorporation, JobOrder, JobSubmission, Opportunity, Placement, PlacementCertification, PlacementChangeRequest, PlacementCommission, Task, User.

{Entity}EditHistory field Type Description Not null Read-only
id Integer id of this entity. X X
auditTrail String (2147483647) An HTML snippet representing the field changes for the given ID. Not always generated. X
dateAdded Timestamp Date on which this {Entity}EditHistory record was created in the Bullhorn system. X X
fieldChanges To-many association The {Entity}EditHistoryFieldChange entities associated with this {Entity}EditHistory. X
migrateGUID String (36) Unused.  X
modifyingPerson To-one association User credited with making the [Entity] change(s).  X
targetEntity To-one association The [Entity] to which this {Entity}EditHistory applies. X X
transactionID String (36) Unique transaction id for this {Entity}EditHistory. X

{Entity}EditHistoryFieldChange

Read-only entity that represents a field change associated with an [Entity]EditHistory entity. The GET /query{Entity}EditHistoryFieldChange call returns a list of [Entity]EditHistoryFieldChange entities for one or more {Entity}EditHistory entities. The GET /entity{Entity}EditHistoryFieldChange/{comma-separated entityIds} call returns one or more {Entity}EditHistoryFieldChange entities. {Entity} can be any one of the following: Appointment, CandidateCertification, ClientCorporation, JobOrder, JobSubmission, Opportunity, Placement, PlacementCertification, PlacementChangeRequest, PlacementCommission, Task, User.

{Entity}EditHistoryFieldChange field Type Description Not null Read-only
id Integer id of this entity. X X
columnName String (100) Database column name for the value that was changed. X X
display String (100) FieldMap label for the columnName. Value is deduced at the time of [Entity]EditHistoryFieldChange entity creation and does not update if the columnName FieldMap is subsequently renamed/relabeled. X X
editHistory To-one association {Entity}EditHistory entity that owns this [Entity]EditHistoryFieldChange entity. X X
newValue String (2147483647) The value of columnName before update.  X
oldValue String (2147483647) The value of columnName after update.  X

{Entity}FileAttachment

Read-only entity that represents a file associated with an entity. The GET /entity/{EntityType}]/{entityID}/fileAttachments call returns a list of files associated with that entity. Entity can be ClientCorporation, JobOrder, Candidate, ClientContact, Opportunity, or Placement.

{Entity}FileAttachement field Type Description Not null Read-only
id Integer Unique identifier for the entity. X X
contentSubType String (64) Content subtype for the file. X
contentType String (64) Content type for the file. X
dateAdded Timestamp When the file was added. X X
description String (2147483647) Description for the file. X
directory String (150) Location of the file on server. X
distribution String (8) Distribution type for the file. X
externalID String (100) Third-party id of the file. X
fileExtension String (10) Extension type of the file. X X
fileSize Integer Size on disk of the file. X X
fileType String (15) Type of the file; for example, SAMPLE. X
isCopied Boolean Whether the file was copied from another entity. X
isDeleted Boolean Whether file is deleted X X
isOpen Boolean Whether file is open. X X
isPrivate Boolean Whether the file is private. X X
isSendOut Boolean Whether the file is from a sendout. X X
{entity} To-one association Entity associated with the file. X X
name String (100) Name of the file. X X
type String (50) Type of the file; for example, Resume. X
usersSharedWith To-many association Users with whom the file is shared. X
uuid String (36) Globally unique random ID. X X

HousingComplex

Represents a housing complex that a ClientCorporation uses when providing housing for certain types of employees. 

HousingComplex field Type Description Not null Read-only
id Integer Unique identifier for this entity. X X
address Address HousingComplex address:
  • address1
  • address2
  • city
  • state
  • zip
  • countryID: options:
    • value: 1
    • value: 2
Use the following REST call to get the list of countryIDs and labels: /meta/HousingComplex?fields=address(countryID)
billingContactID Integer The Bullhorn ClientContact id of the billing contact person for this housing complex.
comments String (2147483647) Free-text comments about this housing complex.
complexManagerID Integer The Bullhorn ClientContact id of the housing complex manager.
complexOwnerID Integer The Bullhorn ClientContact id of the housing complex owner. 
contactName String (100) Name of the contact person for the housing complex, generally a facilities manager or superintendent.
customContactID1 to 3 Integer Configurable fields for identifying additional ClientContacts who have roles related to this housing complex.
customDate1 to 3 Timestamp Configurable date fields that can be used to store custom data depending on the needs of a particular deployment.
customFloat1 to 3 Double Configurable text fields that can be used to store custom data depending on the needs of a particular deployment. X
customInt1 to 3 Integer Configurable numeric fields that can be used to store custom data depending on the needs of a particular deployment.
customText1 to 5 String (100) Configurable text fields that can be used to store custom data depending on the needs of a particular deployment.
customTextBlock1 to 5 String (2147483647) Configurable text fields that can be used to store custom data depending on the needs of a particular deployment.
dateAdded Timestamp The date on which this record was created in the Bullhorn system. X
fax String (20) Fax number for the housing complex.
isDeleted Boolean Indicates whether this record has been marked as deleted in the Bullhorn system. X
name String (100) Name of the housing complex. X
owner Integer CorporateUser who is the owner of this housing complex. X
phone String (20) Primary phone number of the housing complex.
whitelistClientCorporations To-many association Set of ClientCorporations to use this housing complex.

JobBoardPost

Represents a view into a JobOrder entity with information typically used in public job boards. JobBoardPost is a read-only entity.

JobBoardPost field Type Description Not null Read-only
id Integer Unique identifier for this entity. X X
address Address Address of the hiring company; when the record is created in the Bullhorn application, this data is pulled from the client contact record.  X
benefits String (2147483647) Text description of benefits offered with this job.  X
bonusPackage String (2147483647) Text description of the bonus package offered with this job.  X
categories To-many association IDs of Categories associated with this job.  X
dateAdded Timestamp Date when this record was created in the Bullhorn system. X
dateEnd Timestamp Date when the job will end (if applicable).  X
dateLastPublished Timestamp Date when this record was last published to the ‘Corporate’ Job Board. X
employmentType String (200) Type of employment offered: for example, contract, permanent, and so forth. Determines which of the five job types are used. X  X
isPublic Boolean Controls whether a job appears on the Bullhorn job board (if in use). Only 3 values allows, -1, 0, 1.  X
isOpen Boolean Indicates whether the job is open.
payRate BigDecimal Pay rate offered with this job.  X
publicDescription String (200000) Description of this job for use on public job boards. X
publishedCategory To-one association The category that was last selected when publishing the job.  X
publishedZip String (18) Published Zip Code of the job location.
responseUser To-one association id of CorporateUser to whom submissions should be sent.  X
salary BigDecimal Salary offered for this job.  X
salaryUnit String (12) Salary unit represented by the range (e.g. per hour, yearly).  X
startDate Timestamp Desired start date for the position. X X
title String (100) Job title.  X
travelRequirements String (50) Text description of the amount of travel required for this job.  X
willRelocate Boolean Indicates whether the hiring company will provide relocation assistance.  X
willSponsor Boolean Indicates whether the hiring company is willing to sponsor an employee on a work visa.  X
yearsRequired Integer Number of years of experience required for the job.  X

JobOrder

Represents an open job to be filled.

The JobOrder entity supports the massUpdate operations.

JobOrder field Type Description Not null Read-only
id Integer Unique identifier for this entity. X X
address Address1 Address of the hiring company; when the record is created in the Bullhorn application, this data is pulled from the client contact record.
  • address1
  • address2
  • city
  • state
  • zip
  • countryID: options:
    • value: 1
    • value: 2
Use the following REST call to get the list of countryIDs and labels: /meta/JobOrder?felds=address(countryID)
appointments To-many association Ids of Appointments associated with this job.
approvedPlacements To-many association Ids of the approved Placements associated with this job.
assignedUsers To-many association Internal users assigned to this job.
benefits String (2147483647) Text description of benefits offered with this job.
billRateCategoryID Integer Id of the client bill rate category.
bonusPackage String (2147483647) Text description of the bonus package offered with this job.
branchCode String (100) Code representing the corporate branch where the job is located.
businessSectors To-many association Ids of BusinessSectors associated with this job.
categories To-many association Ids of Categories associated with this job.
certificationList String (255) List of Certifications that an applicant should have.
certifications To-many association Certifications that applicants should have.
clientBillRate BigDecimal Amount to be billed to the client for this job when it is filled.
clientContact To-one association ClientContact associated with this job. X
clientCorporation To-one association Hiring company. X
correlatedCustom-Date1-3 Timestamp Configurable date fields that can be used to store custom data depending on the needs of a particular deployment.
correlatedCustom-Float1-3 Double Configurable numeric fields that can be used to store custom data depending on the needs of a particular deployment.
correlatedCustomInt1-3 Integer Configurable numeric fields that can be used to store custom data depending on the needs of a particular deployment.
correlatedCustomText1-10 String (100) Configurable text fields that can be used to store custom data depending on the needs of a particular deployment.
correlatedCustom-TextBlock1-3 String (2147483647) Configurable text fields that can be used to store custom data depending on the needs of a particular deployment.
costCenter String (30) Name of the cost center associated with this job. This cost center flows to the placement record and drives invoice grouping (placements with the same cost center for the same client will be grouped together)
customDate1-3 BigDecimal 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.
customObject1s to 10s CustomObject Fields to which custom objects can be assigned. For more information about custom objects, see the Bullhorn Resource Center and the following article on using the REST API with custom objects: http://developer.bullhorn.com/articles/customobjects
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 (2147483647) Configurable text fields that can be used to store custom data depending on the needs of a particular deployment.
dateAdded Timestamp Date when this record was created in the Bullhorn system. X
dateClosed Timestamp Date when the job was marked as closed.
dateEnd Timestamp Date when the job will end (if applicable).
dateLastExported Timestamp Date when the job was last exported.
dateLastModified Timestamp Date on which the job was last modified.
degreeList String (2147483647) List of educational degrees required for this job.
description String (200000) Text description of the job.
durationWeeks Double Expected duration the job. For a permanent position, this is null.
educationDegree String (50) Required degree for the job.
employmentType String (200) Type of employment offered: for example, contract, permanent, and so forth. Determines which of the five job types are used. X
externalCategoryID Integer Category exposed on public job postings to the web.
externalID String (30) Used for migrations or for the job’s external/back-office identification number.
feeArrangement Double Fee, expressed as a percentage, that will be paid by the ClientCorporation when the job is filled.
hoursOfOperation String (30) Hiring company’s hours of operation.
hoursPerWeek Double Number of hours per week that the employee will work.
Interviews To-many association Ids of interview Appointments associated with this job.
isClientEditable Boolean Indicates whether a ClientContact can modify the job via the Bullhorn system.
isDeleted Boolean Indicates whether this record is marked as deleted in the Bullhorn system.
isInterviewRequired Boolean Indicates whether applicants are required to Interview for the job.
isJobcastPublished Boolean Indicates whether the job was published through Jobcast.
isOpen Boolean Indicates whether the job is open.
isPublic Boolean Controls whether a job appears on the Bullhorn job board (if in use). Only 3 values allows, -1, 0, 1.
jobBoardList String (2147483647) List of job boards on which this job has been posted.
markupPercentage Double Represents the relationship between clientBillRate and PayRate MP = (CBR - PR) / PR X X
notes To-many association Ids of Notes associated with this job.
numOpenings Integer Number of openings to be filled for this job.
onSite String (20) Location requirements; for example, on-site, off-site, no preference.
Opportunity To-one association Opportunity with which this JobOrder is associated.
optionsPackage String (2147483647) Text description of the stock options package offered with this job.
owner To-one association CorporateUser who owns this job. The default value is user who creates the JobOrder. X
payRate BigDecimal Pay rate offered with this job.
placements To-many association Ids of Placements associated with this job.
publicDescription String (200000) Description of this job for use on public job boards.
publishedZip String (18) Published Zip Code of the job location.
reasonClosed String (2147483647) Text description of the reason this job was closed, if applicable.
reportTo String (100) Name and/or title of the person this job will report to.
reportToClientContact To-one association ClientContact this job reports to.
responseUser To-one association CorporateUser to whom submissions should be sent.
salary BigDecimal Salary offered for this job.
salaryUnit String (12) Salary unit represented by the range (for example, per hour, yearly).
sendouts To-many association Ids of Sendouts associated with this job.
skillList String (2147483647) Comma-separated list of skills the applicants should have.
skills To-many association Ids of Skills associated with this job.
source String (100) Source of the job.
startDate Timestamp Desired start date for the position. The default value is 12 AM on day record is added. X
status String (200) Current status of the Job Order. Examples: Accepting Candidates, Currently Interviewing, Covered, Offer Out, Placed
submissions To-many association Ids of JobSubmissions associated with this job.
tasks Task Tasks associated with this job.
taxRate Double Rate (percentage) at which the person hired for this job will be taxed.
taxStatus String (20) Tax Status, for example, 1099, W-2, and so forth.
tearsheets To-many association Ids of Tearsheets with which this JobOrder is associated.
title String (100) Job title.
travelRequirements String (50) Text description of the amount of travel required for this job.
type Integer Job type, for example, Cold, Cool, Medium, Warm, Hot. Stored in DB as Integer with display values configured in field maps.
willRelocate Boolean Indicates whether the hiring company will provide relocation assistance.
willSponsor Boolean Indicates whether the hiring company is willing to sponsor an employee on a work visa.
yearsRequired Integer Number of years of experience required for the job.

JobSubmission

Represents a formal submission of a Candidate for a particular job. A job submission occurs after the Candidate has been evaluated, interviewed, and otherwise assessed, and the parties involved have agreed that the Candidate may be suitable. The JobSubmission entity is then created with references to the Candidate and the JobOrder representing the position. If the JobSubmission is approved, a Placement entity is created.

The JobSubmission entity supports the massUpdate operations.

Note: When you set the status field of a JobSubmission to “New Lead”, it becomes a web response, which is an informal job submission. When you update another status, it becomes a formal job submission. When you create a web response, set the dateWebResponse field to the current date. When you update a web response to make it a formal job submission, set the dateAdded field to the current date.

JobSubmission field Type Description Not null Read-only
id Integer Unique identifier for this entity. X X
appointments To-many association Ids of Appointments associated with this JobSubmission.
billRate BigDecimal Bill rate for this JobSubmission.
candidate To-one association Candidate submitted for this job. X
comments String (2147483647) Free-text comments on this JobSubmission.
dateAdded Timestamp Date on which this JobSubmission record was created in the Bullhorn system. X X
dateLastModified Timestamp Date on which the JobSubmission was last modified.
dateWebResponse Timestamp When a new web response is added, set the dateWebResponse field to the current timestamp. When a web response is promoted to a submission, update the dateAdded property to the current timestamp. X
isDeleted Boolean Indicates whether this record is marked as deleted in the Bullhorn system. X
isHidden Boolean Indicates whether web responses are hidden. If you do not plan to promote a web response to a submission, set the isHidden field to true.
jobOrder Integer JobOrder to which this JobSubmission corresponds. X
owners To-many association Primary (first) and secondary (all but first) corporateUsers considered owners of this JobSubmission.
payRate BigDecimal Pay rate for this JobSubmission.
salary BigDecimal Salary for this JobSubmission.
sendingUser To-one association CorporateUser credited with making the submission. The default value is user who created the JobSubmission. X
source String (100) Source of the JobSubmission (for example, web, Integer, and so forth.)
status String (30) Status of the JobSubmission (for example, reviewed, accepted, and so forth.). Allowable values are available in the response of the settings/jobResponseStatusList operation. X

JobSubmissionHistory

Read-only entity that represents the transaction history of a JobSubmission. The GET /query/JobSubmissionHistory call returns a list of JobSubmissionHistory entities for one or more JobSubmission entities. The GET /entity/JobSubmissionHistory/{entityId} call returns a single JobSubmissionHistory entity that represents one JobSubmission change. Supports create and delete operations.

JobSubmissionHistory field Type Description Not null Read-only
id Integer Unique identifier for this entity. X X
comments String (2147483647) Value of the JobSubmission comments fields for this transaction.
dateAdded Timestamp Date on which the JobSubmission record was created in the Bullhorn system. X X
jobSubmission To-one association JobSubmission associated with this JobSubmissionHistory. X X
sendingUser To-one association CorporateUser credited with making the JobSubmission. The default value is user who created the JobSubmission. X  X
status String (30) Status of the JobSubmission (for example, reviewed, accepted, and so forth.). Allowable values are configured in field maps. X  X
transactionID String (36) Unique transaction id for this JobSubmissionHistory.

Lead

Represents a Lead on a potential Candidate, ClientContact, or ClientCorporation. A Lead can be converted into a Candidate, ClientContact, or ClientCorporation.

Lead field Type Description Not null Read-only
id Integer Unique identifier for this entity. X X
address Address Lead’s address. This is an address object containing Street Address, City, State, Zip, and CountryID.
assignedTo To-many association CorporateUser(s) this Lead is assigned to.
businessSectors To-many association IDs of BusinessSectors in which the Lead operates.
campaignSource String (15) Campaign source of the Lead.
candidates To-many association Candidates associated with this Lead.
category To-one association Lead’s primary Category. X
categories To-many association IDs of the Categories associated with the Lead. Note that the categoryId property is used to store the Lead’s primary Category, while this association hold that Category and any other Categories to which the Lead belongs.
clientContacts To-many association ClientContacts associated with this Lead.
clientCorporation To-one association ClientCorporation associated with this Lead.
comments String (2147483647) Free-text comments on this Lead.
companyName String(100) Name of the Lead’s company (can be used if there is no ClientCorporation entity for this Lead’s company).
companyURL String(100)
conversionSource String(200) Source of the Lead’s conversion. For example, Cold Call, Monster, and so forth.
customDate1-3 Timestamp 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 (2147483647) Configurable text fields that can be used to store custom data depending on the needs of a particular deployment.
dateAdded Timestamp Date on which this record was created in the Bullhorn system. X
dateLastComment Timestamp Date on which the last comment referencing this Lead was made.
dateLastModified Timestamp Date on which the Lead was last modified.
dateLastVisited Timestamp Date on which the Lead was last visited.
description String (2147483647) Description of the Lead.
distributionLists To-many association IDs of DistributionLists associated with this Lead.
division String (40) Department that the Lead is associated with.
email String (100) Lead’s primary email address. X
email2 String (100) Additional email address. Typically used for the Lead’s home or personal email.
email3 String(100) Additional email address. Typically used for the Lead’s home or personal email.
fax String(20) The primary fax number for the Lead.
fax2 String(20) An additional fax number for the Lead.
fax3 String(20) An additional fax number for the Lead.
firstName String (50) Lead’s first name.
history To-many association IDs of LeadHistory entities associated with this Lead.
isDayLightSavingsTime Boolean Indicates whether the Lead’s location is using Daylight Saving Time.
isDeleted Boolean Indicates whether this record has been marked as Deleted in the Bullhorn system. X
lastName String (50) Lead’s last name
leadSource String (15) Source of the Lead. For example, LinkedIn, Facebook, Marketing, and so forth.
massMailOptOut Boolean Indicates whether the Lead has chosen not to be included in mass emails through the Bullhorn system X
middleName String (50) Lead’s middle name.
mobile String (20) Lead’s mobile (cellular) telephone number.
name String (100) Lead’s full name. Should be a combination of the firstName and lastName fields separated by a space.
Notes: If you create a Lead with no value in the name field, users have no way to select that Lead in the Bullhorn staffing application. If you create or modify a Lead name that is not a combination of the firstName and lastName fields, the name will be overwritten when a user saves the Lead in the Bullhorn staffing application. The name will change to a combination of the firstName and lastName fields.
namePrefix String (5) Lead’s name prefix. For example Dr., Ms, Mr., and so forth.
nameSuffix String (5) Lead’s name suffix. For example Jr.
nickName String(50) Lead’s nickname.
notes To-many association IDs of Note entities associated with this Lead.
numEmployees Integer The number of employees associated with the Lead.
occupation String(50) Occupation of the Lead.
owner To-one association id of the CorporateUser who is the owner of this Lead record. X
ownerCorporation To-one association Corporation id of the Lead’s owner.
pager String(20) Lead’s pager number.
phone String (20) Lead’s primary telephone number.
phone2 String(20) Additional phone number for the Lead.
phone3 String(20) Additional phone number for the Lead.
preferredContact String(15) Preferred contact method of the Lead. X
primarySkills To-many association Skills that are listed as the primary skills for this Lead.
priority String(15) Priority of the Lead.
referredByPerson To-one association Person who referred this Lead.
reportToPerson To-one association Person to whom this Lead reports.
role String (255) Role of the Lead.
salary BigDecimal The desired salary of the Lead.
salaryLow BigDecimal The lowest yearly salary the Lead would accept.
secondarySkills To-many association Skills that are listed as secondary skills for this Lead
skillSet String (2147483647) Text description of the Lead’s skills.
smsOptIn Boolean Indicates whether the Lead has granted permission to be sent messages via SMS.
specialties To-many association IDs of the Specialties are associated with this Lead.
status String (100) Status of the lead; for example, New Lead, Active, Prospect, and so forth. Possible values can be configured using field maps. X
tearsheets To-many association IDs of Tearsheets associated with this Lead.
timeZoneOffsetEST Integer Indicates the number of hours by which the Lead’s time zone differs from Eastern Standard Time. For example, Pacific Standard Time is -3, three hours earlier than Eastern Standard Time.
type String(30) Describes the type of Lead. For example, Staffing, RFP/VOR, etc. Possible values can be configured using the field maps. X
willRelocate Boolean Indicates whether or not a Lead is willing to relocate.

LeadHistory

Read-only entity that represents the status and ClientCorporation history of a Lead.

LeadHistory field Type Description Not null Read-only
id Integer Unique Identifier for this entity. X X
clientCorporation To-one association ClientCorporation of the associated Lead at the time this LeadHistory was created. X
dateAdded Timestamp Date this LeadHistory was added. X X
lead To-one association Lead associated with this LeadHistory. X X
modifyingUser To-one association CorporateUser who modified the Lead associated with this LeadHistory. X X
status String (30) Status of the associated Lead at the time this LeadHistory was created. X X

Note

Represents a note (comment) associated with a Candidate, ClientContact, CorporateUser, JobOrder, Lead, or Opportunity. Notes can be accessed via the “Notes” tab on the person’s record in the Bullhorn application.

If you include a commentingPerson value and a personReference value when you create a Note, the association to an entity is made automatically and you do not need to make a separate call to create a NoteEntity.

Note field Type Description Not null Read-only
id Integer Id of this Note. X
action String (30) Action type associated with Note. The list of values is configured in the private label attribute called commentActionList.
bHTimestamp byte[] Timestamp for this Note.
commentingPerson To-one association Person who created the Note. The default value is user who creates the Note. X
candidates To-many association Candidates associated with this Note.
clientContacts To-many association ClientContacts associated with this Note.
comments String (2147483647) Text of this Note. X
corporateUsers To-many association Ids of CorporateUsers associated with this Note.
dateAdded Timestamp Date on which this record was created in the Bullhorn system. X
dateLastModified Timestamp Date on which the Note was last modified.
externalID String (50) External identifier for the record, used for integrations with external datasources or custom imports.
entities To-many association Ids of NoteEntities associated with this Note.
isDeleted Boolean Indicates whether this record has been marked as Deleted in the Bullhorn system. X
jobOrder To-one association Primary JobOrder associated with this Note.
jobOrders To-many association JobOrders associated with this Note.
leads To-many association Leads associated with this Note.
minutesSpent Integer Number of minutes spent on actions associated with this note, if applicable.
personReference To-one association Person with whom this Note is associated. X
placements To-many association Ids of Placements associated with this Note.

Opportunity

Represents a possible Opportunity which can be converted to a JobOrder.

Opportunity field Type Description Not null Read-Only
id Integer Unique identifier for this entity. X X
actualCloseDate Timestamp Actual close date of the Opportunity.
address Address Address of the hiring company; when the Opportunity is created in the Bullhorn application, this data is pulled from the ClientContact record that is associated with this Opportunity.
appointments To-many association IDs of Appointments associated with this Opportunity.
assignedDate Timestamp Date the Opportunity was assigned to a CorporateUser.
assignedUsers To-many association CorporateUsers assigned to this Opportunity.
benefits String (2147483647) Text description of benefits offered with this Opportunity.
billRateCategoryID Integer ID of the client bill rate category.
bonusPackage String (2147483647) Text description of the bonus package offered with this Opportunity.
branchCode String (100) Code representing the corporate branch where this Opportunity is located.
businessSector Integer ID of the primary BusinessSector associated with this Opportunity.
businessSectors To-many association IDs of BusinessSectors associated with this Opportunity.
campaignSource String (100) Campaign source of this Opportunity.
category Integer ID of the primary Category associated with this Opportunity.
categories To-many association IDs of Categories associated with this Opportunity.
certifications To-many association Certifications needed for this Opportunity.
clientContact To-one association ClientContact associated with this Opportunity. X
clientCorporation To-one association ClientCorporation the ClientContact associated with this Opportunity is employed by. X
committed Boolean Indicates whether the Opportunity has been committed to.
customDate1-3 BigDecimal 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 (2147483647) Configurable text fields that can be used to store custom data depending on the needs of a particular deployment.
customObject1s to 10s CustomObject Fields to which custom objects can be assigned. For more information about custom objects, see the Bullhorn Resource Center and the following article on using the REST API with custom objects: http://developer.bullhorn.com/articles/customobjects
dateAdded Timestamp Date when this record was created in the Bullhorn system. X
dateLastModified Timestamp Date this record was last modified.
dealValue BigDecimal Deal value for this Opportunity.
degreeList String (2147483647) Degree requirements for this Opportunity.
description String (2147483647) Text description of this Opportunity.
educationDegree String (50) Education requirements for this Opportunity.
effectiveDate Timestamp Effective date of this Opportunity.
estimatedDuration Double Estimated duration of this Opportunity.
estimatedEndDate Timestamp Estimated date when this Opportunity will end (if applicable).
estimatedHoursPerWeek Double The estimated hours per week of this Opportunity.
estimatedStartDate Timestamp The estimated start date for this Opportunity. X
estimatedBillRate BigDecimal Estimated bill rate of this Opportunity.
expectedCloseDate Timestamp Expected close date of this Opportunity.
expectedFee Double Fee, expressed as a percentage, that will be paid by the ClientCorporation when the potential JobOrder is filled.
expectedParRate BigDecimal The expected pay rate of this Opportunity.
externalCategoryID Integer ID of the external category of this Opportunity.
externalID String (30) External identifier for the record, used for migrations and back-office integration.
history To-many association IDs of OpportunityHistory entities associated with this Opportunity.
ignoreUntilDate Timestamp The date, if any, until which to ignore this Opportunity. Allows you to ignore an Opportunity until a certain day/time.
isDeleted Boolean Indicates whether this record has been marked as Deleted in the Bullhorn system. X
isOpen Boolean Indicates whether this Opportunity is Open or Closed. X
jobOrders To-many association JobOrders that have been converted from this Opportunity.
lead To-one association Lead, if any, that is associated to this Opportunity.
markUpPercentage Double Percent of mark up for this Opportunity.
notes To-many association Notes associated with this Opportunity.
numOpenings Integer Number of openings of this Opportunity.
onSite String (20) Location requirements of this Opportunity.
optionsPackage String (2147483647) Options package of this Opportunity.
owner To-one association ID of CorporateUser who owns this Opportunity. X
priority Integer Priority of this Opportunity, for example, Cold, Cool, Medium, Warm, Hot. Stored in DB as Integer with display values configured in field maps.
publicDescription String (2147483647) Public description of this Opportunity.
publishedZip String (18) Published zip code of this Opportunity.
reasonClosed String (255) Text description of the reason this Opportunity was closed.
salary BigDecimal Salary offered for this Opportunity.
salaryUnit String (12) Salary unit represented by the range. For example, per hour, yearly, and so forth.
skillList String (2147483647) Comma-separated list of skills the applicants should have.
skills To-many association IDs of Skills associated with this Opportunity.
source String (100) Source of this Opportunity. For example, Existing Client, Internet Search, and so forth.
specialties To-many association IDs of Specialties associated with this Opportunity.
status String (200) Current status of this Opportunity. i.e. Prospective, Active, Lost to Competition, and so forth.
tasks To-many association Tasks associated with this Opportunity.
tearsheets To-many association Tearsheets associated with this Opportunity
title String (100) Opportunity title.
type String (200) Type of employment offered: for example, contract, permanent, and so forth. Determines which of the five Opportunity tracks are used. X
weightedDealValue BigDecimal Weighted deal value of this Opportunity.
willRelocate Boolean Indicates whether or not the company will provide relocation assistance for this Opportunity.
winProbabilityPercent Double Probability of winning this Opportunity.
yearsRequired Integer Minimum experience required for this Opportunity.

OpportunityHistory

Read-only entity that represents the history of certain fields of an Opportunity.

OpportunityHistory field Type Description Not null Read-only
id Integer Unique identifier for this entity. X X
dateAdded Timestamp Date this OpportunityHistory was added. X X
dealValue BigDecimal Deal value of the associated Opportunity at the time this OpportunityHistory was created. X
effectiveDate Timestamp Date the status change comes into effect for the associated Opportunity. X
modifyingUser To-one association CorporateUser who modified the Opportunity associated with this OpportunityHistory. X X
opportunity To-one association Opportunity associated with this OpportunityHistory. X X
status String (200) Status of the associated Opportunity at the time this OpportunityHistory was created. X X
weightedDealValue BigDecimal Weighted deal value of the associated Opportunity at the time this OpportunityHistory was created. X
winProbabilityPercent Double Probability of winning the associated Opportunity at the time this OpportunityHistory was created. X

Placement

Represents a successfully filled job; for example, a placement of a candidate in a job. Each Placement record corresponds to a single JobOrder and a single Candidate, although a JobOrder may have multiple Placements associated with it. For example, a company could hire several people for the same position. The Placement entity supports the massupdate operations.

Placement field Type Description Not null Read-only
id Integer Unique identifier for this entity. X X
appointments To-many association Appointments associated with this Placement.
approvedChangeRequests Integer Number of change requests with a status of approved.
approvingClientContact To-one association ClientContact who can approve the timecard, if used. Included fields are id, firstName, lastName.
backupApprovingClientContact To-one association Another ClientContact who can approve the timecard, if used. Included fields are: id, firstName, lastName
billingClientContact To-one association ClientContact in charge of processing bills for this Placement. 
billingFrequency String (20) Frequency with which the client company will be billed for this position, initially copied from the associated ClientCorporation record but can be modified on the Placement record.
bonusPackage String (2147483647) Text description of the bonus package for this placement.
candidate To-one association Candidate who was placed. Cannot be changed after this record is created. Included fields are id, firstName, lastName. X
changeRequests To-many association PlacementChangeRequests for this Placement.
clientBillRate Double Hourly rate at which the client company will be billed for work done during regular business hours.
clientOvertimeRate Double Hourly rate at which the client company will be billed for overtime.
comments String (2147483647) Text field for entering any comments about the Placement.
commissions To-many association Ids of PlacementCommissions associated with this Placement.
correlatedCustomDate1-3 Timestamp Configurable date fields that can be used to store custom data depending on the needs of a particular deployment.
correlatedCustomFloat1-3 Double Configurable numeric fields that can be used to store custom data depending on the needs of a particular deployment.
correlatedCustomInt1-3 Integer Configurable numeric fields that can be used to store custom data depending on the needs of a particular deployment.
correlatedCustomText1-10 String (100) Configurable text fields that can be used to store custom data depending on the needs of a particular deployment.
correlatedCustomTextBlock1-3 String (2147483647) Configurable text fields that can be used to store custom data depending on the needs of a particular deployment.
costCenter String (100) Text field for Client Cost Center. Drives invoice grouping (placements with the same cost center for the same client will be grouped together).
customBillRate1-10 BigDecimal Configurable numeric fields that can be used to store custom data depending on the needs of a particular deployment.
customDate1-3 Timestamp 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.
customObject1s to 10s CustomObject Fields to which custom objects can be assigned.
customPayRate1-10 BigDecimal Configurable numeric fields that can be used to store custom data depending on the needs of a particular deployment.
customText1-40 String (100) Configurable text fields that can be used to store custom data depending on the needs of a particular deployment.
customTextBlock1-5 String (2147483647) Configurable text fields that can be used to store custom data depending on the needs of a particular deployment.
dateAdded Timestamp (5) Indicates when this Placement was created in the Bullhorn system. X
dateBegin Timestamp Date when the Candidate will begin work. X
dateClientEffective Timestamp Date when a pending change to the client bill rate will take effect.
dateEffective Timestamp Date when a pending change to the Candidate’s pay rate will take effect.
dateEnd Timestamp Date when the job will end. For a permanent placement, this is null.
daysGuaranteed Integer Number of days the Candidate is guaranteed for this job. If the Candidate leaves the job before working this many days, the ClientCompany may not have to pay its fee; see daysProRated. Used for Permanent placements. X
dateLastModified Timestamp Date on which the Placement was last modified.
daysProRated Integer Indicates how many days the Candidate must work before the Client Corporation will be expected to pay a pro-rated portion of the fee. Used for Permanent placements. For example, if daysGuaranteed = 90 and daysProRated = 30, then if the Candidate works 29 days no fee is due, but if the Candidate works 30-89 days the Client Corporation must pay a percentage of the fee, and if the Candidate works 90 days or more, the full fee is due. X
durationWeeks Double Duration of the job in weeks. You can use this property in addition to dateEnd. X
employeeType String (30) Type of employee. For example, W2, 1099, Employee, Contractor, and so forth.
expiringCredentials Integer Number of credentials on requirements of this placement that are expiring within the next 30 days or already expired.
employmentType String (30) Employment type. X X
fee Double Fee (expressed as a decimal) that the company will receive for this placement. X
hoursOfOperation String (100) Hours during which the employee will work.
hoursPerDay Double Number of hours per day that the employee will work. X
housingAmenities To-many association Not supported in this release. Amenities available as part of the housing arrangement for this Placement, if applicable.
housingManagerID Integer Id of the corporate user serving as manager of the housing arrangements, if applicable.
housingStatus String (30) Status of the Placement Housing, if applicable.
incompleteRequirements Integer Number of requirements on this placements that are incomplete.
invoiceGroupID Integer Not supported in this release. Id of the InvoiceGroup object associated with this Placement.
invoiceGroupName String (100) Name of the invoice group associated with this Placement.
invoiceID Integer Not supported in this release. Id of the Invoice object associated with this Placement. This field is used for Permanent placements since only a single invoice is needed.
invoiceItems To-many association Not supported in this release. Invoice Items associated with this Placement.
jobOrder To-one association JobOrder associated with this Placement. Cannot be changed after this record is created. X
jobSubmission To-one association JobSubmission associated with this Placement.
markupPercentage Double markupPercentage = (clientBillRate - payRate) / payRate. Multiply by 100 to get actual percentage.
notes To-many association Notes associated with this Placement.
optionsPackage String (2147483647) Text description of the stock options package associated with this Placement.
otExemption Boolean Indicates whether the employee is eligible for hours over 40 to automatically be classified as Overtime. Boolean: 0 = Eligible, 1 = Exempt.
otherHourlyFee Double Additional hourly fees, if any.
otherHourlyFeeComments String (2147483647) Free text field for comments on additional hourly fees.
overtimeMarkupPercentage Double overtimeMarkupPercentage = (clientOvertimeRate - overtimeRate) / overtimeRate. Multiply by 100 to get actual percentage.
overtimeRate Double Hourly rate at which the employee will be paid for overtime work.
payRate BigDecimal Rate at which the employee will be paid during regular business hours. This may or may not be used depending on the job type. X
pendingChangeRequests Integer Number of change requests with a status of submitted.
placementCertifications To-many association PlacementCertifications associated with this Placement.
recruitingManagerPercentGrossMargin Double Percentage of the total gross margin that the recruiting manager will receive. X
referralFee BigDecimal Referral fee associated with this Placement, if any. Only used with external Candidate source. X
referralFeeType String (20) Configurable list of fee types associated with the referralFee. Only used with external Candidate source. X
reportedMargin Double Hourly margin in dollars, calculated using burden and other costs.
reportTo String (100) Name/title of the person to whom this position will report.
salary BigDecimal Salary that the employee will receive. This may be either a yearly or hourly salary. See salaryUnit. The default value is 0. X
salaryUnit String (20) Indicates whether the salary is per year or per hour. X
salesManagerPercentGrossMargin Double Percentage of the total gross margin that the sales manager will receive. X
shift To-one association Shift associated with this Placement, if applicable.
statementClientContact To-one association ClientContact who should receive statements associated with this Placement.
status String (30) Status of the Placement. For example, Approved, Completed, Terminated, and so forth. The default value is “Placed”. X
surveys Survey Not supported in this release. Surveys associated with this Placement.
tasks To-many association Tasks associated with this Placement.
taxRate Double Percentage at which this Placement will be taxed.
taxState String (50) Name of the US State that is the tax state for this Placement.
terminationReason String (100) If the Placement has a status of “Terminated,” this field indicates the reason for termination.
timeUnits TimeUnit TimeUnit associated with this Placement.
timeCard TimeCard Not supported in this release. Timecards associated with this Placement.
timecardExpenses TimecardExpense Not supported in this release. Expenses incurred in relation to this Placement, for which the employee wishes to be reimbursed.
timecardTimes TimecardTime Not supported in this release. Timecard entries associated with this Placement.
workersCompensationRateID Integer (100) Not supported in this release. Id of the WorkersCompensationRate associated with this Placement.
workWeekStart Integer Day of the week on which the work week begins for this Placement. 1 = Sunday, 2 = Monday, and so forth.
venderClientCorporation To-one association Umbrella company associated with this Placement.

PlacementCertification

This entity represents the required certification for a Placement.

PlacementCertification field Type Description Not null Read-only
id Integer Unique identifier for this entity. X X
CandidateCertification To-one association CandidateCertification that fulfills this PlacementCertification.
certification To-one association The certification that is required. X
dateAdded Timestamp The date on which this record was created in the Bullhorn system. X
placement To-one association Placement that this PlacementCertification is for. X

PlacementChangeRequest

Represents a change request that is submitted for a particular Placement. Placements cannot be directly modified; a user must submit a PlacementChangeRequest for approval. Supports create, update, and delete operations.

PlacementChangeRequest field Type Description Not null Read-only
id Integer Unique identifier for this entity. X X
approvingUser To-one association Id of user who approved the change.
billingClientContact To-one association ClientContact in charge of processing bills for this Placement.
billingFrequency String (20) Frequency with which the client company will be billed for this position, initially copied from the associated ClientCorporation but can be modified on the Placement.
bonusPackage String (2147483647) Text description of the bonus package for this Placement.
clientBillRate Double Hourly rate at which the client company will be billed for work done during regular business hours.
clientOvertimeRate Double Hourly rate at which the client company will be billed for overtime.
comments String (2147483647) Free text field for any comments on this record.
correlatedCustomDate1-3 Timestamp Configurable date fields that can be used to store custom data depending on the needs of a particular deployment.
correlatedCustomFloat1-3 Double Configurable numeric fields that can be used to store custom data depending on the needs of a particular deployment.
correlatedCustomInt1-3 Integer Configurable numeric fields that can be used to store custom data depending on the needs of a particular deployment.
correlatedCustomText1-10 String (100) Configurable text fields that can be used to store custom data depending on the needs of a particular deployment.
correlatedCustomTextBlock1-3 String (2147483647) Configurable text fields that can be used to store custom data depending on the needs of a particular deployment.
costCenter String (100) Text field for Client Cost Center. Drives invoice grouping (placements with the same cost center for the same client will be grouped together).
customBillRate1-10 BigDecimal Configurable numeric fields that can be used to store custom data depending on the needs of a particular deployment.
customDate1-3 Timestamp 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
customPayRate1-10 BigDecimal Configurable numeric fields that can be used to store custom data depending on the needs of a particular deployment.
customText1-40 String (100) Configurable text fields that can be used to store custom data depending on the needs of a particular deployment.
customTextBlock1-5 String (2147483647) Configurable text fields that can be used to store custom data depending on the needs of a particular deployment.
dateAdded Timestamp Date on which this entity was created. X X
dateApproved Timestamp Date on which this change was approved.
dateBegin Timestamp Date on which Candidate will begin work. X
dateClientEffective Timestamp Date on which a pending change to the ClientCorporation bill rate will take effect.
dateEffective Timestamp Date on which a pending change to the Candidate’s pay rate will take effect.
dateEnd Timestamp Date on which the job will end. For a permanent placement, this will be null.
dateLastModified Timestamp Date on which the PlacementChangeRequest was last modified.
daysGuaranteed Integer Number of days Candidate is guaranteed for this job. If Candidate leaves the job before working this many days, the ClientCorporation may not have to pay its fee; see daysProRated. Used for Permanent placements. X
daysProRated Integer Indicates how many days the Candidate must work before the ClientCorporation will be expected to pay a pro-rated portion of the fee. Used for Permanent placements. For example, if daysGuaranteed = 90 and daysProRated = 30, then if the Candidate works 29 days no fee is due, but if the Candidate works 30-89 days the ClientCorporation must pay a percentage of the fee, and if the Candidate works 90 days or more, the full fee is due. X
durationWeeks Double Duration of the job in weeks. This field can be used in addition to dateEnd. X
employeeType String (30) Type of employee: for example W2, 1099, Employee, Contractor, and so forth.
employmentType String (30) Employment type, initially copied from the associated JobOrder but can be modified on the Placement. X
fee Double Fee (expressed as a decimal) that the company will receive for this placement. X
hoursOfOperation String (100) Hours during which the employee will work.
hoursPerDay Double Number of hours per day that the employee will work. X
housingManagerID Integer Id of CorporateUser serving as manager of the housing arrangements, if applicable.
housingStatus String (30) Status of the Placement Housing, if applicable.
optionsPackage String (2147483647) Text description of the stock options package associated with this Placement.
otExemption Integer Indicates whether the employee is eligible for hours over 40 to automatically be classified as Overtime. Boolean 0 = Eligible, 1 = Exempt.
otherHourlyFee Double Additional hourly fees, if any.
otherHourlyFeeComments String (2147483647) Free text field for comments on additional hourly fees.
overtimeRate Double Hourly rate at which the employee will be paid for overtime work.
payRate BigDecimal Rate at which the employee will be paid during regular business hours. This may or may not be used depending on the job type. X
placement To-one association Placement to which this change request applies. X
recruitingManagerPercentGrossMargin Double Percentage of total gross margin that the recruiting manager will receive. X
referralFee BigDecimal Referral fee associated with this Placement, if any. Only used with external Candidate source.
referralFeeType String (20) Configurable list of fee types associated with referralFee. Only used with external Candidate source.
reportTo String (100) Name/title of the person to whom this position will report.
requestCustomDate1-3 Timestamp Configurable date fields.
requestCustomFloat1-3 Double Configurable numeric fields.
requestCustomInt1-3 Integer Configurable numeric fields.
requestCustomText1-20 String (30) Configurable text fields.
requestCustomTextBlock1-5 String (2147483647) Configurable text fields.
requestingUser To-one association CorporateUser who initiated this change request. X
requestStatus String (40) Status of change request. X
requestType String (50) Configurable. Type of request. X
salary BigDecimal Salary that employee will receive. This may be either a yearly or hourly salary. See salaryUnit. X
salaryUnit String (20) Indicates whether the salary is per year or per hour. X
salesManager-PercentGrossMargin Double Percentage of the total gross margin that the sales manager will receive. X
statementClientContact To-one association ClientContact who should receive statements associated with this Placement.
status String (100) Status of Placement: for example, Approved, Completed, Terminated, and so forth. X
terminationReason String (100) Status of Placement: for example, Approved, Completed, Terminated, and so forth.
vendorClientCorporation To-one association Vendor ClientCorporation associated with change request.
workersCompRateID Integer Not supported in this release. Id of the WorkersCompensationRate object associated with this Placement.
workWeekStart Integer Day of the week on which the work week begins for this Placement. 1 = Sunday, 2 = Monday, and so forth.

PlacementCommission

Represents a commission payment that is paid upon successful placement of a Candidate in a job. Each PlacementCommission instance is associated with exactly one Placement instance; a Placement may have multiple PlacementCommissions associated with it.

PlacementCommission field Type Description Not null Read-only
id Integer Unique identifier for this entity. X
comments String (2147483647) Free-text comments on this commission.
commissionPercentage Double The commission amount, expressed as a percentage: for example, 0.05 = 5%. Saved as decimal. X
dateAdded Timestamp Date on which this record was created in the Bullhorn system. X
dateLastModified Timestamp Date on which the PlacementCommission was last modified.
externalRecipient String (100) If the person who should receive the commission does not have a Bullhorn id, this field indicates that person’s name.
flatPayout Double The commission expressed as a flat sum. X
grossMarginPercentage Double The percentage of the total gross margin for the Placement that the commission recipient will receive. X
hourlyPayout Double The commission expressed as an hourly rate (e.g., $1.00 for each hour worked by the employee). X
placement To-one association Placement to which this commission pertains. X
role String (50) The commission recipient’s role for the Placement (Sales, Recruiting, and so forth).
status String (30) Status of this commission.
user To-one association User who will receive the commission, if applicable.

Sendout

Represents a sendout, which occurs when a Candidate’s information is sent to a ClientCorporation to be evaluated for a particular job.

Sendout field Type Description Not null Read-only
id Integer Unique identifier for this entity. X
candidate To-one association Candidate being sent out. X
clientContact To-one association ClientContact receiving the Sendout.
clientCorporation To-one association Hiring company.
dateAdded Timestamp The date on which this entity was created in the Bullhorn system. X
email String (100) Email address to which the Sendout is sent.
isRead Boolean Indicates whether the email has been opened. X
jobOrder To-one association JobOrder for which the Candidate is being considered.
user To-one association CorporateUser who initiated this Sendout. The default value is user who creates the Sendout. X

Skill

Represents a skill that a candidate may have. You can use the Skill entity in a Candidate entity to indicate that the candidate has that skill, or in a JobOrder entity to indicate that applicants for that job should have that skill.

Skill field Type Description Not null Read-Only
id Integer Unique identifier for this entity. X X
enabled Boolean Indicates whether Skill is enabled.
categories To-many association Categories with which this Skill is associated.
name String (100) Name of this Skill. X X

Specialty

Represents anty that can be associated with a job or held by a candidate. Specialties are associated with a parent Category entity.

Specialty field Type Description Not null Read-only
id Integer Unique identifier for this entity. X X
dateAdded Timestamp Date on which this record was created in the Bullhorn system. X X
enabled Boolean Indicates whether category is available for use in the Bullhorn application. X X
name String (100) Name of Specialty. X X
parentCategory Integer Category that is parent of this Specialty. X

State

Represents a state or province within a nation. 

State field Type Description Not null Read-only
id Integer Unique identifier for this entity. X
code String (50) Postal abbreviation of the state.
country To-one association Nation that contains this state. X
name String Name of the state. X

Task

Represents a task that a user has created in the Bullhorn system using the Tasks feature.

The Task entity supports the massUpdate operations.

Task field Type Description Not null Read-only
id Integer Unique identifier for this entity. X X
assignees To-many association Associates CorporateUsers with a Task. Can only be accessed from the user interface when the multipleAssigneesAndContactsOnTasks corporation setting is enabled, in which case childTasks are neither shown nor created.
candidate To-one association Candidate associated with this task, if any.
childTaskOwners To-many association Users assigned to childTasks.
childTasks To-many association Assignments. You populate this field by creating Tasks where Task.parentTask is this Task.
clientContact To-one association ClientContact associated with this task, if any.
clientContactReferences To-many association Associates Tasks to multiple ClientContacts. Can only be accessed from the user interface when the multipleAssigneesAndContactsOnTasks corporation setting is enabled, in which case this field is populated instead of the clientContact field.
dateAdded Timestamp The date on which this record was created. X
dateBegin Timestamp The date when the task is due to begin. The default value is current time rounded up to next 15 minutes, or dateEnd if it is provided. X
dateCompleted Timestamp The date when the task was completed, if applicable. The default value is current time rounded up to next 15 minutes, or dateBegin if it is provided.
dateEnd Timestamp The date when the task was scheduled to end. Used for recurring tasks. X
dateLastModified Timestamp Date when the Task was last modified.
description String (2147483647) Free-text description of the task. The default value is “”. X
isCompleted Boolean Indicates whether the task has been completed. X
isDeleted Boolean Indicates whether this record has been marked as deleted. X
isPrivate Boolean Indicates whether this is a private task. A private task is not visible to users other than the user who created the task. X
jobOrder To-one association JobOrder associated with this task, if any.
lead To-one association Lead, if any, associated with this task.
notificationMinutes Integer Indicates how many minutes in advance the user has chosen to be reminded of this task. X
opportunity To-one association Opportunity, if any, associated with this task.
owner To-one association User who created the task. The default value is user who creates the Task. X
parentTask To-one association Task that is parent of this one, if any. Used when the task is assigned to someone other than the owner. The childTask is a copy of the parentTask managed by the assignee.
placement To-one association Placement associated with this Task.
priority Integer Priority level of a task.Value is 1, 2, or 3, where 1 is Low, 2 is Normal, and 3 is High.
recurrenceDayBits Integer Indicates which days are part of the recurrence pattern, if the task is a recurring one. The value of this field is the sum of the days included in the series: Sun = 2, Mon = 4, Tue = 8, Wed = 16, Thur = 32, Fri = 64, Sat = 128. For example, a meeting that occurs on Monday and Friday would have a recurrenceDayBits value of 68 (4+64).
recurrenceFrequency Integer Frequency with which the task recurs: for example, a recurrenceFrequency of 2 for a weekly meeting would imply the meeting occurs every 2 weeks. Null for a one-time task.
recurrenceStyle String (10) A=absolute, R=relative: e.g., an absolute would be the third week of every month, whereas a relative would be every third week.
recurrenceType String (1) Type of recurrence. D=daily, W=weekly, M=monthly, A=annually.
subject String (100) Subject header for the task. X
taskUUID String (35) Secondary unique identifier for this entity. Used to identify the record when it is synchronized to external systems. Format is 8-4-4-16 where all characters are A-Z or 0-9.
timeZoneID String (50) Id of time zone.
type String (30) Type of task. For example, Follow-Up, Email, Personal, and so forth. X

Tearsheet

Represents a tearsheet. The Tearsheet entity supports the massUpdate operations.

Tearsheet field Type Description Not null Read-only
id Integer Unique identifier for this entity. X
candidates To-many association Candidates with which this Tearsheet is associated. The default fields
clientContacts To-many association ClientContacts with which this Tearsheet is associated.
dateAdded Timestamp Date on which the Tearsheet was created in the Bullhorn system. X
dateLastModified Timestamp Date on which the Tearsheet was last modified.
description String (2147483647) Free-text description.
isDeleted Boolean Indicates whether this record is marked as deleted in the Bullhorn system. X
isPrivate Boolean Indicates whether this is a private Tearsheet. A private Tearsheet is not visible to users other than the user who created the tearsheet.
jobOrders To-many association JobOrders with which this Tearsheet is associated.
name String (100) Name of this Tearsheet. X
owner To-one association CorporateUser who is the primary owner of this Tearsheet. The default value is user who created the tearsheet.
recipients To-many association Ids of TearsheetRecipients with which this Tearsheet is associated.

TearsheetMember

Represents a tearsheet member. 

TearsheetMember field Type Description Not null Read-only
id Integer Unique identifier for this entity. X
candidateRestrictionBits Integer Candidate restriction bits. X
dateAdded Timestamp The date on which this record was created in the Bullhorn system. X
person To-one association Person with whom this TearsheetMember is associated.
tearsheet To-one association Tearsheet with which this TearsheetMember is associated.

TearsheetRecipient

Represents a tearsheet recipient. 

TearsheetRecipient field Type Description Not null Read-only
id Integer Unique identifier for this entity. X
candidateRestrictionBits Integer Candidate restriction bits. X
dateAdded Timestamp The date on which this record was created in the Bullhorn system. X
description String (2147483647) Free-text description.
isDeleted Boolean Indicates whether this record is marked as deleted in the Bullhorn system. X
isSent Boolean Indicates whether
jobOrder To-one association JobOrder with which this TearsheetRecipient is associated.
person To-one association Person with whom this TearsheetRecipient is associated.
tearsheet To-one association Tearsheet with which this TearsheetRecipient is associated.

TimeUnit

Represents a time unit. 

TimeUnit field Type Description Not null Read-only
id Integer Unique identifier for this entity. X
name String (100) Name of this TimeUnit. X
timeMarker Integer Time marker, such as AM or PM. X
weekDay Integer Day of the week. X