├── .gitignore ├── .travis.yml ├── CHANGELOG.md ├── CONTRIBUTING.md ├── Code Generation.postman_collection.json ├── Dockerfile ├── Gemfile ├── Gemfile.lock ├── LICENSE ├── README.md ├── Rakefile ├── Vagrantfile ├── config.rb ├── deploy.sh ├── docker-compose.yml ├── font-selection.json └── source ├── changelog.html.md ├── datahubref.html.md ├── entityref.html.md ├── fonts ├── slate.eot ├── slate.svg ├── slate.ttf ├── slate.woff └── slate.woff2 ├── images ├── logo.png └── navbar.png ├── includes ├── _allcorpnotes.md ├── _association.md ├── _authorization.md ├── _datahub.md ├── _departmententities.md ├── _entitlements.md ├── _entity.md ├── _errors.md ├── _file.md ├── _find.md ├── _intro.md ├── _login.md ├── _massupdate.md ├── _meta.md ├── _myentities.md ├── _options.md ├── _ping.md ├── _query.md ├── _resume.md ├── _savedsearch.md ├── _search.md ├── _services.md ├── _settings.md ├── _subscription.md ├── _userheadshot.md ├── changelog │ └── changelog.md ├── entityref │ ├── _activitygoal.md │ ├── _activitygoalconfiguration.md │ ├── _activitygoaltarget.md │ ├── _appointment.md │ ├── _appointmentattendee.md │ ├── _businesssector.md │ ├── _candidate.md │ ├── _candidateavailability.md │ ├── _candidatecertification.md │ ├── _candidatecertificationrequirement.md │ ├── _candidateeducation.md │ ├── _candidatereference.md │ ├── _candidatereferencequestion.md │ ├── _candidatereferenceresponse.md │ ├── _candidateshiftpreference.md │ ├── _candidatetaxinfo.md │ ├── _candidateworkhistory.md │ ├── _category.md │ ├── _certification.md │ ├── _certificationfileattachment.md │ ├── _certificationgroup.md │ ├── _certificationrequirement.md │ ├── _clientcontact.md │ ├── _clientcorporation.md │ ├── _clientcorporationappointment.md │ ├── _clientcorporationnote.md │ ├── _clientcorporationtask.md │ ├── _corporateuser.md │ ├── _corporationdepartment.md │ ├── _country.md │ ├── _customaction.md │ ├── _deduction.md │ ├── _deductioncategorylookup.md │ ├── _department.md │ ├── _employeepay.md │ ├── _employercontribution.md │ ├── _entityedithistory.md │ ├── _entityedithistoryfieldchange.md │ ├── _entityfileattachment.md │ ├── _estaffmappableflowback.md │ ├── _federaltaxform.md │ ├── _housingcomplex.md │ ├── _housingcomplexfurnituredelivery.md │ ├── _housingcomplexunit.md │ ├── _housingcomplexutilityaccount.md │ ├── _issue.md │ ├── _issueitems.md │ ├── _jobboardpost.md │ ├── _joborder.md │ ├── _jobshift.md │ ├── _jobshiftassignment.md │ ├── _jobshiftsubmission.md │ ├── _jobsubmission.md │ ├── _jobsubmissioncertificationrequirement.md │ ├── _jobsubmissionhistory.md │ ├── _lead.md │ ├── _leadhistory.md │ ├── _localtaxform.md │ ├── _location.md │ ├── _locationversion.md │ ├── _note.md │ ├── _noteentity.md │ ├── _opportunity.md │ ├── _opportunityhistory.md │ ├── _paycheck.md │ ├── _placement.md │ ├── _placementcertification.md │ ├── _placementchangerequest.md │ ├── _placementcommission.md │ ├── _placementshiftset.md │ ├── _placementtimeandexpense.md │ ├── _placementtimeandexpensechangerequest.md │ ├── _screenerquestion.md │ ├── _sendout.md │ ├── _shift.md │ ├── _shiftposition.md │ ├── _shifttype.md │ ├── _skill.md │ ├── _specialty.md │ ├── _state.md │ ├── _statetaxform.md │ ├── _task.md │ ├── _tearsheet.md │ ├── _tearsheetmember.md │ ├── _tearsheetrecipient.md │ ├── _timeunit.md │ ├── _userhousingcomplexunit.md │ ├── _workerscompensation.md │ ├── _workerscompensationrate.md │ └── paybill │ │ ├── _accountingperiod.md │ │ ├── _batchgroup.md │ │ ├── _billablecharge.md │ │ ├── _billingsyncbatch.md │ │ ├── _billingsyncbatchfileattachment.md │ │ ├── _billingsyncerror.md │ │ ├── _billmaster.md │ │ ├── _billmastercustomerrequiredfield.md │ │ ├── _billmasterdiscountrate.md │ │ ├── _billmastersurchargerate.md │ │ ├── _billmastertransaction.md │ │ ├── _billmastertransactiondiscountdetail.md │ │ ├── _billmastertransactiondiscountrate.md │ │ ├── _billmastertransactiondistributionbatch.md │ │ ├── _billmastertransactionsalestaxdetail.md │ │ ├── _billmastertransactionsalestaxrate.md │ │ ├── _billmastertransactionsurchargedetail.md │ │ ├── _billmastertransactionsurchargerate.md │ │ ├── _calendar.md │ │ ├── _calendarfrequencylookup.md │ │ ├── _calendarinstance.md │ │ ├── _citysalestaxrate.md │ │ ├── _clientcorporationbillruleset.md │ │ ├── _clientcorporationbillrulesetversion.md │ │ ├── _clientcorporationpayruleset.md │ │ ├── _clientcorporationpayrulesetversion.md │ │ ├── _clientcorporationrateagreementcard.md │ │ ├── _clientcorporationrateagreementcardline.md │ │ ├── _clientcorporationrateagreementcardlinegroup.md │ │ ├── _clientcorporationrateagreementcardversion.md │ │ ├── _countysalestaxrate.md │ │ ├── _customerrequiredfieldconfiguration.md │ │ ├── _customerrequiredfieldconfigurationversion.md │ │ ├── _customerrequiredfieldconfigurationversionoption.md │ │ ├── _customerrequiredfieldjobconfiguration.md │ │ ├── _customerrequiredfieldmeta.md │ │ ├── _customerrequiredfieldoption.md │ │ ├── _customerrequiredfieldplacementconfiguration.md │ │ ├── _customerrequiredfieldvaluetypelookup.md │ │ ├── _directdepositaccount.md │ │ ├── _directdepositaccounttypelookup.md │ │ ├── _discountrate.md │ │ ├── _discountrateversion.md │ │ ├── _districtsalestaxrate.md │ │ ├── _earncode.md │ │ ├── _earncodegroup.md │ │ ├── _expensesheet.md │ │ ├── _expensesheetentry.md │ │ ├── _generalledgeraccount.md │ │ ├── _generalledgersegment.md │ │ ├── _generalledgersegmenttype.md │ │ ├── _generalledgerservicecode.md │ │ ├── _holiday.md │ │ ├── _holidaycategorylookup.md │ │ ├── _holidayinstance.md │ │ ├── _invoicestatementdiscountrate.md │ │ ├── _invoicestatementlineitem.md │ │ ├── _invoicestatementlineitemdiscountrate.md │ │ ├── _invoicestatementlineitemsalestaxrate.md │ │ ├── _invoicestatementlineitemsurchargerate.md │ │ ├── _invoicestatementsalestaxrate.md │ │ ├── _invoicestatementsurchargerate.md │ │ ├── _invoicestatementtemplate.md │ │ ├── _invoiceterm.md │ │ ├── _invoicetermtemplate.md │ │ ├── _invoicetermversion.md │ │ ├── _jobcode.md │ │ ├── _joborderbillruleset.md │ │ ├── _joborderbillrulesetversion.md │ │ ├── _joborderpayruleset.md │ │ ├── _joborderpayrulesetversion.md │ │ ├── _joborderratecard.md │ │ ├── _joborderratecardline.md │ │ ├── _joborderratecardlinegroup.md │ │ ├── _joborderratecardversion.md │ │ ├── _legalBusinessEntity.md │ │ ├── _othersalestaxrate.md │ │ ├── _payablecharge.md │ │ ├── _paybillcycle.md │ │ ├── _paymaster.md │ │ ├── _paymastertransaction.md │ │ ├── _placementbillruleset.md │ │ ├── _placementbillrulesetversion.md │ │ ├── _placementpayruleset.md │ │ ├── _placementpayrulesetversion.md │ │ ├── _placementratecard.md │ │ ├── _placementratecardline.md │ │ ├── _placementratecardlinegroup.md │ │ ├── _placementratecardversion.md │ │ ├── _salestaxgroup.md │ │ ├── _salestaxrate.md │ │ ├── _salestaxrateversion.md │ │ ├── _statesalestaxrate.md │ │ ├── _surchargerate.md │ │ ├── _surchargerateversion.md │ │ ├── _surchargerateversionearncode.md │ │ ├── _timelaborevalrule.md │ │ ├── _timelaborevalruletemplate.md │ │ ├── _timesheet.md │ │ ├── _timesheetentry.md │ │ ├── _transactionorigin.md │ │ ├── _transactionstatus.md │ │ ├── _transactiontype.md │ │ └── _unbilledrevenuedistributionbatch.md └── get.md ├── index.html.md ├── javascripts ├── all.js ├── all_nosearch.js ├── app │ ├── _lang.js │ ├── _search.js │ └── _toc.js └── lib │ ├── _energize.js │ ├── _imagesloaded.min.js │ ├── _jquery.highlight.js │ ├── _jquery.js │ ├── _jquery.tocify.js │ ├── _jquery_ui.js │ └── _lunr.js ├── layouts └── layout.erb └── stylesheets ├── _icon-font.scss ├── _normalize.scss ├── _variables.scss ├── print.scss └── screen.scss /.gitignore: -------------------------------------------------------------------------------- 1 | build/ 2 | _site 3 | /source/includes/npm-debug.log 4 | .vagrant 5 | .idea -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: ruby 2 | rvm: 3 | - 2.7 4 | - 3.0 5 | 6 | cache: 7 | bundler: true 8 | 9 | install: 10 | - bundle install 11 | 12 | script: 13 | - bundle exec middleman build --verbose 14 | 15 | deploy: 16 | provider: script 17 | script: bash deploy.sh 18 | skip_cleanup: true 19 | on: 20 | branch: master 21 | 22 | # Add environment variables if needed 23 | env: 24 | global: 25 | - NOKOGIRI_USE_SYSTEM_LIBRARIES=true 26 | 27 | # Specify which branches to build 28 | branches: 29 | only: 30 | - master 31 | - f/update-slate 32 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # Changelog 2 | 3 | ## Version 2.0.0 4 | 5 | *May 22, 2025* 6 | 7 | Major update to modernize the documentation system and improve compatibility with current technologies. 8 | 9 | **Features:** 10 | - Updated to Middleman 4.4+ for improved performance and features 11 | - Added Docker support for easier development environment setup 12 | - Added support for Ruby 2.7+ and 3.0+ 13 | - Improved GitHub Pages deployment process with middleman-gh-pages gem 14 | - Enhanced Markdown rendering with newer Redcarpet version 15 | - Modernized Jenkins pipeline for improved CI/CD 16 | 17 | **Fixes:** 18 | - Resolved Ruby version compatibility issues 19 | - Updated dependencies to address security vulnerabilities 20 | - Fixed deployment script for modern GitHub Pages 21 | - Improved CSS minification and asset handling 22 | - Enhanced syntax highlighting with Rouge 3.28+ 23 | 24 | **Changes:** 25 | - Replaced custom deploy script with Rake-based deployment (optional) 26 | - Updated documentation generation with better error handling 27 | - Improved configuration for mobile responsiveness 28 | - Enhanced code syntax highlighting 29 | 30 | ## Version 1.3.2 31 | 32 | *February 3, 2016* 33 | 34 | A small bugfix for slightly incorrect background colors on code samples in some cases. 35 | 36 | ## Version 1.3.1 37 | 38 | *January 31, 2016* 39 | 40 | A small bugfix for incorrect whitespace in code blocks. 41 | 42 | ## Version 1.3 43 | 44 | *January 27, 2016* 45 | 46 | We've upgraded Middleman and a number of other dependencies, which should fix quite a few bugs. 47 | 48 | Instead of `rake build` and `rake deploy`, you should now run `bundle exec middleman build --clean` to build your server, and `./deploy.sh` to deploy it to Github Pages. 49 | 50 | ## Version 1.2 51 | 52 | *June 20, 2015* 53 | 54 | **Fixes:** 55 | 56 | - Remove crash on invalid languages 57 | - Update Tocify to scroll to the highlighted header in the Table of Contents 58 | - Fix variable leak and update search algorithms 59 | - Update Python examples to be valid Python 60 | - Update gems 61 | - More misc. bugfixes of Javascript errors 62 | - Add Dockerfile 63 | - Remove unused gems 64 | - Optimize images, fonts, and generated asset files 65 | - Add chinese font support 66 | - Remove RedCarpet header ID patch 67 | - Update language tabs to not disturb existing query strings 68 | 69 | ## Version 1.1 70 | 71 | *July 27, 2014* 72 | 73 | **Fixes:** 74 | 75 | - Finally, a fix for the redcarpet upgrade bug 76 | 77 | ## Version 1.0 78 | 79 | *July 2, 2014* 80 | 81 | [View Issues](https://github.com/tripit/slate/issues?milestone=1&state=closed) 82 | 83 | **Features:** 84 | 85 | - Responsive designs for phones and tablets 86 | - Started tagging versions 87 | 88 | **Fixes:** 89 | 90 | - Fixed 'unrecognized expression' error 91 | - Fixed #undefined hash bug 92 | - Fixed bug where the current language tab would be unselected 93 | - Fixed bug where tocify wouldn't highlight the current section while searching 94 | - Fixed bug where ids of header tags would have special characters that caused problems 95 | - Updated layout so that pages with disabled search wouldn't load search.js 96 | - Cleaned up Javascript 97 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Before You Submit an Issue 2 | 3 | - Are you using Windows? We unfortunately don't support Windows. You could try using Docker, as outlined in the `README`. 4 | - Is your version of Slate out of date? We have [upgrade instructions](https://github.com/tripit/slate/wiki/Updating-Slate) in the wiki. You could also try seeing if your problem is reproducible on the latest version of Slate. 5 | 6 | If you answered "no" to each of the questions above, feel free to submit an issue! It's also helpful if you include a code example of your problem (if applicable), we can't help you if you just say "Slate stopped loading for me once I added my documentation" without telling us the problematic documentation. 7 | 8 | # Before You Submit a Pull Request 9 | 10 | Thanks for contributing to Slate! A couple of quick guidelines for submitting pull requests: 11 | 12 | - **Please point your pull requests at the `dev` branch.** We don't accept pull requests to `master`. 13 | - Please make sure your contributions work in the most recent version of Chrome, Firefox, and IE. 14 | - If you're implementing a new feature, even if it's relatively small, it's nice to open an issue before you start so that others know what you're working on and can help make sure you're on the right track. 15 | 16 | Thanks again! Happy coding. -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM ruby:3.0-alpine 2 | 3 | RUN apk --no-cache add build-base nodejs npm git 4 | 5 | WORKDIR /srv/slate 6 | 7 | COPY Gemfile Gemfile.lock ./ 8 | RUN bundle install 9 | 10 | COPY . . 11 | 12 | EXPOSE 4567 13 | 14 | CMD ["bundle", "exec", "middleman", "server", "--watcher-force-polling"] -------------------------------------------------------------------------------- /Gemfile: -------------------------------------------------------------------------------- 1 | source 'https://rubygems.org' 2 | 3 | # Middleman 4 | gem 'middleman', '~>4.4' 5 | gem 'middleman-syntax', '~> 3.2' 6 | gem 'middleman-autoprefixer', '~> 3.0' 7 | gem 'middleman-sprockets', '~> 4.1' 8 | gem 'rouge', '~> 3.28' 9 | gem 'redcarpet', '~> 3.6' 10 | gem 'nokogiri', '~> 1.13.9' 11 | gem 'sass', '~> 3.7' 12 | gem 'webrick' 13 | 14 | # For GitHub Pages deployment 15 | gem 'middleman-gh-pages', '~> 0.4.1' 16 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Copyright 2008-2013 Concur Technologies, Inc. 2 | 3 | Licensed under the Apache License, Version 2.0 (the "License"); you may 4 | not use this file except in compliance with the License. You may obtain 5 | a copy of the License at 6 | 7 | http://www.apache.org/licenses/LICENSE-2.0 8 | 9 | Unless required by applicable law or agreed to in writing, software 10 | distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 11 | WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the 12 | License for the specific language governing permissions and limitations 13 | under the License. -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Bullhorn Rest API Docs 2 | 3 | These docs use [Slate](https://github.com/slatedocs/slate) to convert markdown files into the [Bullhorn Rest API Docs Site](http://bullhorn.github.io/rest-api-docs). 4 | 5 | ## Prerequisites 6 | 7 | You're going to need: 8 | 9 | - **Ruby 2.7+** (we recommend using rbenv or RVM) 10 | - **Bundler** - `gem install bundler` 11 | 12 | ## Getting Started 13 | 14 | ### Setup & Installation 15 | 16 | ```bash 17 | # Install dependencies 18 | bundle install 19 | 20 | # Start the local development server 21 | bundle exec middleman server 22 | ``` 23 | 24 | You can now see the docs at http://localhost:4567 25 | 26 | ### Using Docker (Alternative) 27 | 28 | ```bash 29 | # Build the Docker image 30 | docker-compose build 31 | 32 | # Run the development server 33 | docker-compose up 34 | ``` 35 | 36 | ## Generating Documentation 37 | 38 | - Import `Code Generation.postman_collection.json` to Postman 39 | - Fill out the script parameters under the 'Pre-request scripts' tab as follows: 40 | - If documentation has already been generated for your entity, copy and paste the full file contents as the `currentDocumentation` parameter 41 | - If generating documentation for a new entity, fill out the `originalEntity` parameter with the name of the entity (no spaces) 42 | - For either of the above cases, if the entity belongs to a specific mission, fill out the `originalEntityMission` parameter with the mission name 43 | 44 | - Send the request 45 | - View your Postman console (`View -> Show Postman Console`, or `Ctrl+Alt+C` on Windows) and copy the new documentation 46 | - Paste the new documentation in the corresponding file in this repository 47 | 48 | ## Deployment 49 | 50 | To deploy to GitHub Pages: 51 | 52 | ```bash 53 | # Build and deploy the site 54 | bundle exec rake publish 55 | ``` 56 | 57 | This will build the static site and push it to the `gh-pages` branch. 58 | 59 | ## Architecture 60 | 61 | This documentation site is built with: 62 | 63 | - **Middleman 4.6** - Static site generator 64 | - **Sass/SCSS** - For styling with variables and mixins 65 | - **Ruby 3.0** - Runtime environment 66 | - **Sprockets** - Asset pipeline for CSS/JS compilation 67 | 68 | ## Development Notes 69 | 70 | - SCSS files are compiled automatically by Sprockets 71 | - The site uses a responsive design that works on desktop and mobile 72 | - Syntax highlighting is provided by Rouge 73 | - Search functionality is built-in for easy navigation 74 | 75 | ## Troubleshooting 76 | 77 | ### Common Issues 78 | 79 | - **Bundle install fails**: Make sure you have Ruby 2.7+ installed 80 | - **Middleman server won't start**: Check that all dependencies are installed with `bundle install` 81 | - **CSS not loading**: Ensure SCSS files are properly named and located in `source/stylesheets/` 82 | 83 | ### Getting Help 84 | 85 | For more information about Slate, see the [official Slate documentation](https://github.com/slatedocs/slate). 86 | -------------------------------------------------------------------------------- /Rakefile: -------------------------------------------------------------------------------- 1 | require 'middleman-gh-pages' -------------------------------------------------------------------------------- /Vagrantfile: -------------------------------------------------------------------------------- 1 | Vagrant.configure(2) do |config| 2 | config.vm.box = "ubuntu/trusty64" 3 | config.vm.network :forwarded_port, guest: 4567, host: 4567 4 | 5 | config.vm.provision "bootstrap", 6 | type: "shell", 7 | inline: <<-SHELL 8 | sudo apt-get update 9 | sudo apt-get install -yq ruby2.0 ruby2.0-dev pkg-config build-essential nodejs git libxml2-dev libxslt-dev 10 | sudo apt-get autoremove -yq 11 | gem2.0 install --no-ri --no-rdoc bundler 12 | SHELL 13 | 14 | # add the local user git config to the vm 15 | config.vm.provision "file", source: "~/.gitconfig", destination: ".gitconfig" 16 | 17 | config.vm.provision "install", 18 | type: "shell", 19 | privileged: false, 20 | inline: <<-SHELL 21 | echo "==============================================" 22 | echo "Installing app dependencies" 23 | cd /vagrant 24 | bundle config build.nokogiri --use-system-libraries 25 | bundle install 26 | SHELL 27 | 28 | config.vm.provision "run", 29 | type: "shell", 30 | privileged: false, 31 | run: "always", 32 | inline: <<-SHELL 33 | echo "==============================================" 34 | echo "Starting up middleman at http://localhost:4567" 35 | echo "If it does not come up, check the ~/middleman.log file for any error messages" 36 | cd /vagrant 37 | bundle exec middleman server --force-polling -l 1 &> ~/middleman.log & 38 | SHELL 39 | end 40 | -------------------------------------------------------------------------------- /config.rb: -------------------------------------------------------------------------------- 1 | # Markdown 2 | set :markdown_engine, :redcarpet 3 | set :markdown, 4 | fenced_code_blocks: true, 5 | smartypants: true, 6 | disable_indented_code_blocks: true, 7 | prettify: true, 8 | tables: true, 9 | with_toc_data: true, 10 | no_intra_emphasis: true, 11 | strikethrough: true, 12 | superscript: true 13 | 14 | # Assets 15 | set :css_dir, 'stylesheets' 16 | set :js_dir, 'javascripts' 17 | set :images_dir, 'images' 18 | set :fonts_dir, 'fonts' 19 | 20 | # Activate Sprockets 21 | activate :sprockets 22 | 23 | # Create proxy pages for CSS files to ensure they have .css extensions 24 | proxy '/stylesheets/screen.css', '/stylesheets/screen' 25 | proxy '/stylesheets/print.css', '/stylesheets/print' 26 | 27 | # Activate the syntax highlighter 28 | activate :syntax 29 | activate :relative_assets 30 | set :relative_links, true 31 | 32 | activate :autoprefixer do |config| 33 | config.browsers = ['last 2 versions', 'Firefox ESR', 'not IE < 11'] 34 | config.cascade = false 35 | config.inline = true 36 | end 37 | 38 | # Build Configuration 39 | configure :build do 40 | activate :minify_css 41 | activate :minify_javascript 42 | # activate :asset_hash 43 | # activate :gzip 44 | end 45 | -------------------------------------------------------------------------------- /docker-compose.yml: -------------------------------------------------------------------------------- 1 | services: 2 | slate: 3 | build: . 4 | ports: 5 | - "4567:4567" 6 | volumes: 7 | - .:/srv/slate 8 | restart: unless-stopped 9 | -------------------------------------------------------------------------------- /source/changelog.html.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: REST API Change Log 3 | 4 | language_tabs: false 5 | page_classes: no-langs 6 | mystyle: no-langs 7 | 8 | toc_footers: 9 | 10 | includes: 11 | - changelog/changelog 12 | 13 | search: true 14 | --- 15 | -------------------------------------------------------------------------------- /source/datahubref.html.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Data Hub Reference 3 | 4 | language_tabs: 5 | - shell 6 | 7 | toc_footers: 8 | 9 | includes: 10 | - datahub 11 | 12 | search: true 13 | --- 14 | -------------------------------------------------------------------------------- /source/fonts/slate.eot: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bullhorn/rest-api-docs/f15738ccfe1f1033a01ebb15af5ed5406a7ff54f/source/fonts/slate.eot -------------------------------------------------------------------------------- /source/fonts/slate.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | Generated by IcoMoon 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /source/fonts/slate.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bullhorn/rest-api-docs/f15738ccfe1f1033a01ebb15af5ed5406a7ff54f/source/fonts/slate.ttf -------------------------------------------------------------------------------- /source/fonts/slate.woff: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bullhorn/rest-api-docs/f15738ccfe1f1033a01ebb15af5ed5406a7ff54f/source/fonts/slate.woff -------------------------------------------------------------------------------- /source/fonts/slate.woff2: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bullhorn/rest-api-docs/f15738ccfe1f1033a01ebb15af5ed5406a7ff54f/source/fonts/slate.woff2 -------------------------------------------------------------------------------- /source/images/logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bullhorn/rest-api-docs/f15738ccfe1f1033a01ebb15af5ed5406a7ff54f/source/images/logo.png -------------------------------------------------------------------------------- /source/images/navbar.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bullhorn/rest-api-docs/f15738ccfe1f1033a01ebb15af5ed5406a7ff54f/source/images/navbar.png -------------------------------------------------------------------------------- /source/includes/_allcorpnotes.md: -------------------------------------------------------------------------------- 1 | # allCorpNotes 2 | ##GET /allCorpNotes 3 | ``` shell 4 | curl https://rest{swimlane#}.bullhornstaffing.com/rest-services/e999/allCorpNotes?clientCorpId=4&fields=start=0&count=5 5 | 6 | # Example Response 7 | { 8 | "total": 9, 9 | "start": 3, 10 | "count": 4, 11 | "data": [ 12 | { 13 | "_score": 0.3471885, 14 | "id": 515, 15 | "action": "Outbound Call" 16 | }, 17 | { 18 | "_score": 0.3091938, 19 | "id": 25, 20 | "action": "Outbound Call" 21 | }, 22 | { 23 | "_score": 0.3091938, 24 | "id": 48, 25 | "action": "Outbound Call" 26 | }, 27 | ... 28 | ] 29 | } 30 | 31 | ``` 32 | Returns all Notes in the specified ClientCorporation. Specify the fields to be included in the response in the fields request parameter. 33 | 34 | ### HTTP Request 35 | 36 | `{corpToken}/allCorpNotes/?fields={fieldList}` 37 | 38 | Parameter | Required | Description 39 | ------ | -------- | ----- 40 | fields | yes | Comma-separated list of field names. fields or layout is required. 41 | layout | yes | Name of a configured layout. fields or layout is required. 42 | BhRestToken | no | Token that represents a session established by the login process. Must be sent with all subsequent requests to the API. The session key can be provided in the BhRestToken query string, a cookie, or an HTTP header. 43 | clientCorpId | yes | id of a ClientCorporation entity. 44 | 45 | -------------------------------------------------------------------------------- /source/includes/_association.md: -------------------------------------------------------------------------------- 1 | # association 2 | 3 | ## POST /association 4 | ``` shell 5 | curl -X POST \ 6 | -H "Content-Type: application/json" \ 7 | -d '{ "ids": [7681,2625,1464], "showTotalMatched": true, "start": 0, "count": 3}' \ 8 | https://rest{swimlane#}.bullhornstaffing.com/rest-services/e999/association/Candidate/primarySkills 9 | 10 | # Example Response 11 | { 12 | "total": 24, 13 | "data": [ 14 | [ 15 | 7681, 16 | 10115 17 | ], 18 | [ 19 | 2625, 20 | 19739 21 | ], 22 | [ 23 | 1464, 24 | 241506 25 | ] 26 | ] 27 | } 28 | ``` 29 | 30 | Retrieves a list of associated entity ids for a given entity. The association field can be a to-many or to-one association. 31 | 32 | ### HTTP Request 33 | 34 | `{corpToken}/association/{entity}/{association field}` 35 | 36 | **Note:** The ids parameter is the only required parameter and must be set in the request body as JSON. All other parameters can be set in the request body or as query parameters on the URL. 37 | 38 | Parameter | Required | Description 39 | ------ | -------- | ----- 40 | ids | yes | List of entity ids. Must be set in the body of the request rather than in a URL query parameter. 41 | count | no | Limit on the number of records to return. If the set of matched results is larger than count, cap the returned results at size count. The Max allowed count is 10000. 42 | start | no | From the set of matched results, return record numbers start through (start + count). 43 | showTotalMatched | no | (true/false) When set to true, the total count of matching items is returned. 44 | BhRestToken | no | Token that represents a session established by the login process. Must be sent with all subsequent requests to the API. The session key can be provided in the BhRestToken query string, a cookie, or an HTTP header. -------------------------------------------------------------------------------- /source/includes/_authorization.md: -------------------------------------------------------------------------------- 1 | # Authorization 2 | 3 | User authorization and session management use the following flow: 4 | 5 | 1. An OAuth 2.0 access token is returned though the OAuth 2.0 authorization flow. For more information about the OAuth flow, see [Getting Started with REST](/Getting-Started-with-REST) 6 | 2. A REST API login call that contains the access token as a query parameter is made. If this call is sucessful, a token named BHRestToken is returned. This token represents a session established by the login process; it must be sent along with all subsequent requests to the REST API. The BhRestToken can be provided in a URL query string, a cookie, or an HTTP header. 7 | 3. The login call also returns a base URL with which all subsequent API requests must be prefixed. 8 | 9 | ## Unauthorized requests 10 | 11 | If a client makes a request and does not include a BhRestToken, the server sends a response with HTTP status `412` (precondition failed). If a client request contains an invalid session key, the server returns response status `401` (unauthorized). For more information on HTTP status codes see [Errors](#errors). 12 | 13 | ## Session key 14 | 15 | The REST API has the concept of a client "session". This is essentially a method for allowing clients to authenticate themselves once and then be free of the need to authenticate for subsequent calls to the API. Since REST is a stateless protocol, there must be a mechanism for clients to identify themselves upon each request, so the requests can be tied to an established session. This is what the session key provides. Login calls return, as part of their responses, a session key that represents a successful authorization and can be used to make further calls without having to authenticate. 16 | 17 | This key must be provided in HTTP requests in at least one of the following places: 18 | 19 | 1. A query parameter named `BhRestToken` on the request URL. 20 | 2. An HTTP header named `BhRestToken` or `BHRestToken`. 21 | 3. A cookie named `BhRestToken`. This cookie is set by the API at login time as a convenience for browser-based clients. 22 | -------------------------------------------------------------------------------- /source/includes/_entitlements.md: -------------------------------------------------------------------------------- 1 | # entitlements 2 | 3 | ## GET /entitlements 4 | 5 | ``` shell 6 | curl https://rest{swimlane#}.bullhornstaffing.com/rest-services/e999/entitlements/Candidate 7 | 8 | # Example Response 9 | [ 10 | "CREATE", 11 | "READ", 12 | "READ_DEPARTMENT" 13 | "UPDATE", 14 | "DELETE" 15 | ] 16 | ``` 17 | 18 | Gets the entity entitlements of an entity for the current user. For GET, PUT, POST, and DELETE requests on entities, the user must have the appropriate entitlements for the action to succeed. PUT requests (adding records) require create entitlements. Read, update, and delete entitlements are divided into owned, department, and corporate entitlements. If a user tries to perform an action without the required entitlements, the call fails and an error is thrown. 19 | A user’s ability to perform file attachment GET, PUT, POST, and DELETE operations is based on the user’s entitlements for the entity to which the file attachment operation applies 20 | 21 | ### List of Entitlements 22 | 23 | | **Entitlement** | **Description** | 24 | | --- | --- | 25 | | CREATE | User can create entities. | 26 | | READ_CORPORATE | Generally, user can read all entities. If the entity can be categorized into private and non-private, the user cannot read private entities owned by other users unless the user has the READ_PRIVATE entitlement. | 27 | | READ_DEPARTMENT | User can read entities owned by the current user AND owned by users from the same department(s). | 28 | | READ | User can read entities owned by the user only. | 29 | | UPDATE_CORPORATE | Generally, user can edit all entities. User must also have READ CORPORATE access level. | 30 | | UPDATE_DEPARTMENT | User can edit entities owned by the user AND owned by users from the same department(s). User must also have READ DEPARTMENT or READ CORPORATE access level. | 31 | | UPDATE | User can edit entities owned by the user only. | 32 | | UPDATE_OWNER | Applies to the following entities: Candidate, ClientContact, JobOrder, JobSubmission, Lead,and Opportunity. Without the UPDATE_OWNER entitlement, the user is not allowed to change the owner of an entity even if the user has update entitlements to the entity. If a user has the UPDATE_OWNER entitlement, but only has department-level edit access, the user is able to edit the owners of entities belonging to users in his or her department, but not those belonging to users in other departments. | 33 | | DELETE_CORPORATE | Generally, user can delete any entity. User must also have READ_CORPORATE access level. | 34 | | DELETE_DEPARTMENT | User can delete entities owned by the user AND owned by users from the same department(s). User must also have READ DEPARTMENT or READ CORPORATE access level. | 35 | | DELETE | User can delete entities owned by the user only. | 36 | 37 | ### File privacy entitlements 38 | 39 | File privacy settings are enforced by a field isPrivate on the file entity. If a file is marked private, the user can only access that file if one of the following is true: 40 | 41 | * User has the View All Private Attachments entitlement 42 | * File is shared with the user 43 | * User is the owner or secondary owner of the entity to which the file is associated 44 | * File is shared with a department of which the user is a member 45 | * If file ownership is enabled, the user is the owner (uploader) of the file; otherwise, the user is the owner or secondary owner of the entity to which the file is associated 46 | 47 | -------------------------------------------------------------------------------- /source/includes/_errors.md: -------------------------------------------------------------------------------- 1 | # Errors 2 | 3 | The REST API uses the following error codes: 4 | 5 | Error Code | Meaning 6 | ---------- | ------- 7 | 400 | Bad Request -- Your request is no good 8 | 401 | Unauthorized -- Your API key is wrong or expired 9 | 403 | Forbidden -- The entity requested is hidden for administrators only 10 | 404 | Not Found -- The specified entity could not be found 11 | 405 | Method Not Allowed -- You tried to access an entity with an invalid method 12 | 406 | Not Acceptable -- You requested a format that isn't json 13 | 410 | Gone -- The entity requested has been removed from our servers 14 | 429 | Rate Limited -- Wait 1 second then retry request. Repeat until successful. 15 | 500 | Internal Server Error -- We had a problem with our server. Try again later. 16 | 503 | Service Unavailable -- We're temporarily offline for maintenance. Please try again later. 17 | -------------------------------------------------------------------------------- /source/includes/_login.md: -------------------------------------------------------------------------------- 1 | # login 2 | 3 | ## Partner login using OAuth 4 | 5 | ``` shell 6 | curl https://rest.bullhornstaffing.com/login?access_token=xxx&version=* 7 | 8 | # Example Response 9 | { 10 | "BhRestToken" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", 11 | "restUrl" : "https://rest{swimlane#}.bullhornstaffing.com/rest-services/{corpToken}/" 12 | } 13 | ``` 14 | 15 | Log in and get a REST session. This is the only supported login process in a production environment. 16 | 17 | - Never assume that a REST session will not expire. 18 | - Perform a [ping](#ping) request to return the timestamp of the REST session expiration. 19 | - Perform a refresh token request when a REST API request returns a 401 status code that indicates the session is expired. See *Use a refresh token to get a new access token* in [Getting Started with REST](/Getting-Started-with-REST). 20 | 21 | Parameter | Required | Description 22 | ------ | -------- | ----- 23 | access_token | yes | Access token obtained from OAuth authorization | 24 | version | yes | Version of the API to use (\* is a wildcard for latest version). | 25 | ttl | no | Session time-to-live in minutes. | 26 | 27 | 28 | 29 | ## Logout 30 | 31 | ``` shell 32 | curl https://rest{{swimlane#}.bullhornstaffing.com/rest-services/e999/logout 33 | 34 | # Example Response 35 | { 36 | logout: "OK" 37 | } 38 | ``` 39 | 40 | Log out and invalidate your REST session. 41 | -------------------------------------------------------------------------------- /source/includes/_ping.md: -------------------------------------------------------------------------------- 1 | # ping 2 | 3 | ## GET /ping 4 | 5 | ``` shell 6 | curl https://rest{swimlane#}.bullhornstaffing.com/rest-services/e999/ping 7 | 8 | # Example Response 9 | { 10 | "sessionExpires" : 1323449994922 11 | } 12 | ``` 13 | 14 | Returns the date of the calling client's session expiration. You can use this call to test whether the client's session is valid. If the session is not valid, the response is the standard response for unauthenticated clients. 15 | 16 | Parameter | Required | Description 17 | ------ | -------- | ----- 18 | BhRestToken | true | Token that represents a session established by the login process. Must be sent with all subsequent requests to the API. The session key can be provided in the BhRestToken query string, a cookie, or an HTTP header. 19 | -------------------------------------------------------------------------------- /source/includes/_settings.md: -------------------------------------------------------------------------------- 1 | # settings 2 | 3 | ## GET /settings/setting1[,setting2...] 4 | 5 | ``` shell 6 | curl https://rest{swimlane#}.bullhornstaffing.com/rest-services/e999/settings/allPrivateLabelIds,currencyFormat 7 | 8 | # Example Response 9 | { 10 | "allPrivateLabelIds": [ 1, 2, 3], 11 | "currencyFormat": "USD" 12 | } 13 | ``` 14 | 15 | Returns the value(s) of the specified system setting(s). The value type (Integer, String, Boolean, and so forth) depends on the specified setting name. 16 | 17 | 18 | ## GET /settings 19 | 20 | ``` shell 21 | curl -X GET "http://rest{swimlane#}.bullhornstaffing.com/rest-services/e999/settings" 22 | 23 | # Example Response 24 | { 25 | "data": [ 26 | { 27 | "name": "accountLockoutDuration", 28 | "valueUrl": "http://rest{swimlane#}.bullhornstaffing.com/rest-services/e999/settings/accountLockoutDuration", 29 | "valueType": "INTEGER", 30 | "isArray": false 31 | }, { 32 | "name": "allDeptIds", 33 | "valueUrl": "http://rest{swimlane#}.bullhornstaffing.com/rest-services/e999/settings/allDeptIds", 34 | "valueType": "INTEGER", 35 | "isArray": true 36 | }, { 37 | "name": "allPrivateLabelIds", 38 | "valueUrl": "http://rest{swimlane#}.bullhornstaffing.com/rest-services/e999/settings/allPrivateLabelIds", 39 | "valueType": "INTEGER", 40 | "isArray": true 41 | }, { 42 | "name": "commentActionList", 43 | "valueUrl": "http://rest{swimlane#}.bullhornstaffing.com/rest-services/e999/settings/commentActionList", 44 | "valueType": "STRING", 45 | "isArray": true 46 | } 47 | ... 48 | ] 49 | } 50 | ``` 51 | 52 | Returns a list of predefined setting names and their metadata. -------------------------------------------------------------------------------- /source/includes/entityref/_activitygoal.md: -------------------------------------------------------------------------------- 1 | # ActivityGoal 2 | 3 | Read-only view of activity goals established for sales personnel in the organization. 4 | 5 | | **ActivityGoal field** | **Type** | **Description** | **Not null** | **Read-only** | 6 | | --- | --- | --- | --- | --- | 7 | | id | Integer | Unique identifier for this entity. | X | X | 8 | | user | To-one association | CorporateUser for whom this activity goal was created. | X | X | 9 | | department | To-one association | Department of user for whom this activity goal was created. | | | 10 | | activityType | String (100) | Type of goal for record. | X | X | 11 | | startDate | Date | The first day of the time period in which this activity goal is in effect, in the format: "YYYY-MM-DD". | X | | 12 | | endDate | Date | The last day of time period in which this activity goal is in effect, in the format: "YYYY-MM-DD". | X | | 13 | | goal | Integer | Target goal for activity type. | X | | 14 | | actual | Integer | Current count of activity type data for goal. | X | | 15 | | periodName | String (100) | Time period for activity goal. (Weekly/Monthly). | X | X | 16 | | percentAttained | Integer | The whole percentage attained to date, equal to the attained value divided by the goal value multiplied by 100. | X | | -------------------------------------------------------------------------------- /source/includes/entityref/_activitygoalconfiguration.md: -------------------------------------------------------------------------------- 1 | 2 | # ActivityGoalConfiguration 3 | 4 | Lets a user configure an activity goal for use in conjunction with the activity goals feature. 5 | 6 | | **ActivityGoalConfiguration field** | **Type** | **Description** | **Not null** | **Read-only** | 7 | | --- | --- | --- | --- | --- | 8 | | id | Integer | Unique identifier for this entity. | X | X | 9 | | codeIdentifier | String (100) | Field that determines if a goal is an ActivityGoal or RecordBasedGoal. | X | | 10 | | dateLastModified | Timestamp | Last time record was modified. | X | X | 11 | | Description | String (2000) | Goal description. | X | | 12 | | goalPeriodId | Integer | Id of goal time period. | X | | 13 | | goalTypeId | Integer | Id of goal type. | X  | X | 14 | | isDeleted | Boolean | Whether or not activity goal is deleted. | X | | 15 | | name | String (100) | Name of goal. | X  | | 16 | | pulseConfigurationValues | To-many association | Values against which goal is tracked. | | | -------------------------------------------------------------------------------- /source/includes/entityref/_activitygoaltarget.md: -------------------------------------------------------------------------------- 1 | # ActivityGoalTarget 2 | 3 | Lets a user assign an activity goal to a user. 4 | 5 | | **ActivityGoalTarget field** | **Type** | **Description** | **Not null** | **Read-only** | 6 | | --- | --- | --- | --- | --- | 7 | | id | Integer | Unique identifier for this entity. | X | X | 8 | | activityGoalConfiguration | To-one association | The activity goal configuration assigned to user. | X | | 9 | | goal | Integer | The amount of activity that user is trying to hit. | X | | 10 | | periodName | String (100)| Time period for activity goal. (Weekly/Monthly). | X | | 11 | | user | To-one association | User to which activity goal is assigned. | X  | | | 12 | -------------------------------------------------------------------------------- /source/includes/entityref/_appointmentattendee.md: -------------------------------------------------------------------------------- 1 | # AppointmentAttendee 2 | 3 | Represents a person who has been invited to an appointment. 4 | 5 | | **AppointmentAttendee field** | **Type** | **Description** | **Not null** | **Read-only** | 6 | | --- | --- | --- | --- | --- | 7 | | id | Integer | Unique identifier for this entity. | X | X | 8 | | appointment | To-one association | Appointment to which this AppointmentAttendee corresponds. | X | | 9 | | attendee | To-one association | The ClientContact, Candidate, or CorporateUser id for this person. | X | | 10 | | 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 | | 11 | | migrateGUID | String (36) | Unused. |  X | | -------------------------------------------------------------------------------- /source/includes/entityref/_businesssector.md: -------------------------------------------------------------------------------- 1 | # BusinessSector 2 | 3 | Represents a business sector, which can be associated with Candidates, ClientCorporations, and JobOrders for classification purposes. 4 | 5 | | **BusinessSector field** | **Type** | **Description** | **Not null** | **Read-only** | 6 | | --- | --- | --- | --- | --- | 7 | | id | Integer | Unique identifier for this entity. | X | X | 8 | | dateAdded | Timestamp | Date on which this record was created in the Bullhorn system.| | | 9 | | name | String (100) | Name of this business sector. | X | X | -------------------------------------------------------------------------------- /source/includes/entityref/_candidateavailability.md: -------------------------------------------------------------------------------- 1 | # CandidateAvailability 2 | 3 | Allows for viewing and updating specific availability for a Candidate on an explicit date/time. 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 |
CandidateAvailability fieldsTypeDescriptionNot nullRead-only
idIntegerUnique identifier for this entity.XX
candidateTo-one associationCandidate associated to this CandidateAvailability.X
dateAddedTimestampDate when this record was created in the Bullhorn system.X
endTimeOffsetDateTimeTime the associated CandidateAvailability ends.X
isAvailableBooleanIndicates whether the associated Candidate is available or not.X
startTimeOffsetDateTimeTime the associated CandidateAvailability starts.X
typeString (50)Type of CandidateAvailability.
74 | -------------------------------------------------------------------------------- /source/includes/entityref/_candidateeducation.md: -------------------------------------------------------------------------------- 1 | 2 | # CandidateEducation 3 | 4 | Represents an educational degree or course of study that a Candidate lists on his or her resume. Each CandidateEducation instance corresponds to a line item on the Education tab of a Candidate in the Bullhorn application. 5 | 6 | | **CandidateEducation field** | **Type** | **Description** | **Not null** | **Read-only** | 7 | | --- | --- | --- | --- | --- | 8 | | id | Integer | Unique identifier for this entity. | X | | 9 | | candidate | To-one association | Candidate with whom this entity is associated. | | | 10 | | certification | String (100) | Certification received with this education, if applicable. | | | 11 | | city | String (40) | Name of the city where the education took place. | | | 12 | | comments | String (2147483647) | Free-text comments on this record. | | | 13 | | customDate1 to 5 | Timestamp | Configurable date fields that can be used to store custom data depending on the needs of a particular deployment. | | | 14 | | customFloat1 to 5 | Double | Configurable numeric fields that can be used to store custom data depending on the needs of a particular deployment. | | | 15 | | customInt1 to 5 | Integer | Configurable numeric fields that can be used to store custom data depending on the needs of a particular deployment. | | | 16 | | customText1 to 5 | String (500)| Configurable text fields that can be used to store custom data depending on the needs of a particular deployment. | | | 17 | | customTextBlock1 to 3 | String (255) | Configurable text fields that can be used to store custom data depending on the needs of a particular deployment. | | | 18 | | dateAdded | Timestamp | Date on which this record was created in the Bullhorn system. | X | | 19 | | dateLastModified | Timestamp | Date on which this record was last updated in the Bullhorn system.| X | | 20 | | degree | String (100) | Indicates what educational degree the Candidate received; for example, B.A., M.A., Ph.D., and so forth. | | | 21 | | endDate | Timestamp | Date when Candidate finished this education. | | | 22 | | expirationDate | Timestamp | Expiration date for a certificate or other credential that needs to be periodically renewed. | | | 23 | | gpa | Double | Indicates Candidate's grade point average. | | | 24 | | graduationDate | Timestamp | Date when Candidate graduated. | | | 25 | | isDeleted | Boolean | Indicates whether this record has been marked as deleted in the Bullhorn system. | | | 26 | | major | String (100) | Indicates the field in which Candidate majored. | | | 27 | | school | String (100) | Name of the educational institute where this education took place. | | | 28 | | startDate | Timestamp | Date when Candidate began study. | | | 29 | | state | String (50) | Name of the U.S. state in which the education took place. | | | 30 | -------------------------------------------------------------------------------- /source/includes/entityref/_candidatereferencequestion.md: -------------------------------------------------------------------------------- 1 | # CandidateReferenceQuestion 2 | Represents a question that can be asked of a CandidateReference. Answers to these questions are stored as CandidateReferenceResponses. 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 74 | 75 | 76 | 77 | 78 | 79 | 80 | 81 | 82 | 83 | 84 | 85 | 86 | 87 | 88 | 89 | 90 | 91 | 92 | 93 |
CandidateReferenceQuestion fieldsTypeDescriptionNot nullRead-only
idIntegerUnique identifier for this entity.XX
categoryTo-one associationCategory associated with this CandidateReferenceQuestion.
corporationTo-one associationCorporation associated with this CandidateReferenceQuestion.X
enabledIntegerWhether this CandidateReferenceQuestion is enabled for new references. 46 | X
migrateGUIDString (36)Unused.
questionTextString (2000)Text of this CandidateReferenceQuestion.
responsesTo-many associationCandidateReferenceResponses that have been provided for this CandidateReferenceQuestion.X
sortOrderIntegerThe relative order in which this CandidateReferenceQuestion will appear (lower numbers precede higher).X
dateAddedTimestampDate the entity was added.XX
dateLastModifiedTimestampDate last modified.XX
94 | -------------------------------------------------------------------------------- /source/includes/entityref/_candidatereferenceresponse.md: -------------------------------------------------------------------------------- 1 | # CandidateReferenceResponse 2 | Represents a CandidateReference's answer to a CandidateReferenceQuestion. 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 |
CandidateReferenceResponse fieldsTypeDescriptionNot nullRead-only
idIntegerUnique identifier for this entity.XX
migrateGUIDString (36)Unused.
questionTo-one associationCandidateReferenceQuestion that this CandidateReferenceResponse answers.X
referenceTo-one associationCandidateReference who provided this CandidateReferenceResponse.X
responseTextString (2147483647)Text of this CandidateReferenceResponse.
dateAddedTimestampDate the entity was added.XX
dateLastModifiedTimestampDate last modified.XX
72 | -------------------------------------------------------------------------------- /source/includes/entityref/_candidateshiftpreference.md: -------------------------------------------------------------------------------- 1 | # CandidateShiftPreference 2 | 3 | Stores a Candidate's preferences for times and days when they want to work in association with the ShiftTypes that are configured. 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 |
CandidateShiftPreference fieldsTypeDescriptionNot nullRead-only
idIntegerUnique identifier for this entity.XX
candidateTo-one associationCandidate associated to CandidateShiftPreference.X
dateAddedTimestampDate when this record was created in the Bullhorn system.X
dayNumberIntegerIndicates the day number in the week.X
dayOfWeekString (255)Indicates the day of the week. For example, Monday.X
isAvailableBooleanIndicates whether the associated Candidate is available to be assigned to a JobShift.X
shiftTypeTo-one associationShiftType associated to CandidateShiftPreference. X
74 | -------------------------------------------------------------------------------- /source/includes/entityref/_candidateworkhistory.md: -------------------------------------------------------------------------------- 1 | # CandidateWorkHistory 2 | 3 | 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. 4 | 5 | | **CandidateWorkHistory field** | **Type** | **Description** | **Not null** | **Read-only** | 6 | | --- | --- | --- | --- | --- | 7 | | id | Integer | Unique identifier for this entity. | X | X | 8 | | bonus | Double | Amount of the bonus paid to Candidate. | | | 9 | | candidate | To-one association | Candidate with whom CandidateWorkHistory is associated. | X | | 10 | | clientCorporation | To-one association | ClientCorporation associated with Candidate. | | | 11 | | comments | String (2147483647) | Free-text comments on CandidateWorkHistory. | | | 12 | | commission | Double | Amount of commission earned by Candidate at this position. | | | 13 | | companyName | String (100) | Name of the company where the Candidate worked. | | | 14 | | customDate1 to 5 | Timestamp | Configurable date fields that can be used to store custom data depending on the needs of a particular deployment. | | | 15 | | customFloat1 to 5 | Double | Configurable numeric fields that can be used to store custom data depending on the needs of a particular deployment. | | | 16 | | customInt1 to 5 | Integer | Configurable numeric fields that can be used to store custom data depending on the needs of a particular deployment. | | | 17 | | customText1 to 5 | String | Configurable text fields that can be used to store custom data depending on the needs of a particular deployment. | | | 18 | | customTextBlock1 to 3 | String | Configurable text fields that can be used to store custom data depending on the needs of a particular deployment. | | | 19 | | dateAdded | Timestamp | Date on which this record was created in the Bullhorn system. | X | X | 20 | | dateLastModified | Timestamp | Date on which this record was last updated in the Bullhorn system.| X | | 21 | 22 | | endDate | Timestamp | Date on which job ended, if applicable. | | | 23 | | isDeleted | Boolean | Indicates whether this record has been marked as deleted in the Bullhorn system. | X | | 24 | | isLastJob | Boolean | Indicates whether this was the Candidate's most recent job. | X | | 25 | | jobOrder | To-one association | JobOrder associated with the CandidateWorkHistory, if applicable. | | | 26 | | placement | To-one association | Placement representing the Candidate's placement in a job, if applicable.  | | | 27 | | salary1 | BigDecimal | Candidate's starting salary at this position. | | | 28 | | salary2 | BigDecimal | Candidate's final salary at this position. | | | 29 | | salaryType | String (20) | Indicates how the Candidate was paid: Hourly, Yearly, and so forth. | | | 30 | | startDate | Timestamp | Date on which Candidate began working at this position. | | | 31 | | terminationReason | String (100) | Reason for the Candidate's termination from this position, if applicable. | | | 32 | | title | String (50) | Candidate's job title in this position. | | | 33 | -------------------------------------------------------------------------------- /source/includes/entityref/_category.md: -------------------------------------------------------------------------------- 1 | # Category 2 | 3 | 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 is a specialty. 4 | 5 | | **Category field** | **Type** | **Description** | **Not null** | **Read-only** | 6 | | --- | --- | --- | --- | --- | 7 | | id | Integer | Unique identifier for this entity. | X | X | 8 | | dateAdded | Timestamp | Date on which record was created in the Bullhorn system. | X | X | 9 | | description | String (255) | Free-text description of this category. | | | 10 | | enabled | Boolean | Indicates whether category is available for use in the Bullhorn system. | X | X | 11 | | name | String (100) | Name of the category. | X | X | 12 | | occupation | String (50) | Occupation. | X | | 13 | | skills | To-many association | Ids of the Skills associated with this Category. | | | 14 | | specialties | To-many association | Ids of the Specialties that are children of this Category. | | | 15 | | type | String (20) | Bill Rate Category, Skills Checklist Category, and so forth. | X | | 16 | -------------------------------------------------------------------------------- /source/includes/entityref/_certificationgroup.md: -------------------------------------------------------------------------------- 1 | # CertificationGroup 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 |
CertificationGroup fieldsTypeDescriptionNot nullRead-only
idIntegerUnique identifier for this entity.XX
certificationsTo-many AssociationCertification
dateAddedTimestampX
dateLastModifiedTimestampX
migrateGUIDString (36)
nameString (100)X
privateLabelIDIntegerX
74 | -------------------------------------------------------------------------------- /source/includes/entityref/_clientcorporationappointment.md: -------------------------------------------------------------------------------- 1 | # ClientCorporationAppointment 2 | 3 | Association entity between ClientCorporation, ClientContact, and Appointment entities. This entity is read-only and is only created when the companyStampOnActivitiesEnabled corporation setting is enabled. 4 | 5 | | **ClientCorporationAppointment field** | **Type** | **Description** | **Not null** | **Read-Only** | 6 | | --- | --- | --- | --- | --- | 7 | | id | Integer | Unique identifier for this entity. | X | X | 8 | | clientCorporation | To-one association | Associated ClientCorporation. | X | | 9 | | clientContact | To-one association | Associated ClientContact. |  X | | 10 | | appointment | To-one association | Associated Appointment. | X | | -------------------------------------------------------------------------------- /source/includes/entityref/_clientcorporationnote.md: -------------------------------------------------------------------------------- 1 | # ClientCorporationNote 2 | 3 | Association entity between ClientCorporation, ClientContact, and Note entities. This entity is read-only and is only created when the companyStampOnActivitiesEnabled corporation setting is enabled. 4 | 5 | | **ClientCorporationNote field** | **Type** | **Description** | **Not null** | **Read-Only** | 6 | | --- | --- | --- | --- | --- | 7 | | id | Integer | Unique identifier for this entity. | X | X | 8 | | clientCorporation | To-one association | Associated ClientCorporation. | X | | 9 | | clientContact | To-one association | Associated ClientContact. |  X | | 10 | | note | To-one association | Associated Note. | X | | -------------------------------------------------------------------------------- /source/includes/entityref/_clientcorporationtask.md: -------------------------------------------------------------------------------- 1 | # ClientCorporationTask 2 | 3 | Association entity between ClientCorporation, ClientContact, and Task entities. This entity is read-only and is only created when the companyStampOnActivitiesEnabled corporation setting is enabled. 4 | 5 | | **ClientCorporationAppointment field** | **Type** | **Description** | **Not null** | **Read-Only** | 6 | | --- | --- | --- | --- | --- | 7 | | id | Integer | Unique identifier for this entity. | X | X | 8 | | clientCorporation | To-one association | Associated ClientCorporation. | X | | 9 | | clientContact | To-one association | Associated ClientContact. |  X | | 10 | | task | To-one association | Associated Task. | X | | -------------------------------------------------------------------------------- /source/includes/entityref/_corporationdepartment.md: -------------------------------------------------------------------------------- 1 | # CorporationDepartment 2 | 3 | Represents a department in a corporation. 4 | 5 | | **CorporationDepartment field** | **Type** | **Description** | **Not null** | **Read-Only** | 6 | | --- | --- | --- | --- | --- | 7 | | id | Integer | Unique identifier for this entity. | X | X | 8 | | dateAdded | Timestamp | Date when this record was created in the Bullhorn system. | X | X | 9 | | description | String (255) | Text description of the CorporationDepartment. | | | 10 | | enabled | Boolean | Indicates whether this CorporationDepartment is enabled for use in the system. | X | X | 11 | | name | String (100) | Name of the CorporationDepartment. | X | X | -------------------------------------------------------------------------------- /source/includes/entityref/_country.md: -------------------------------------------------------------------------------- 1 | # Country 2 | 3 | Represents a country. 4 | 5 | | **Country field** | **Type** | **Description** | **Not null** | **Read-only** | 6 | | --- | --- | --- | --- | --- | 7 | | id | Integer | Unique identifier for this entity. | X | X | 8 | | code | String (4) | Code associated with this Country. | | | 9 | | name | String (64) | Name of the Country. | X | | 10 | | states | To-many association | Ids of States that are associated with this Country. | | | -------------------------------------------------------------------------------- /source/includes/entityref/_customaction.md: -------------------------------------------------------------------------------- 1 | # CustomAction 2 | 3 | Represents a Bullhorn custom action. Custom Actions are read only and must be configured through the Bullhorn application. For more information about custom actions, see: 4 | 5 | 6 | | **CustomAction field** | **Type** | **Description** | **Not null** | **Read-only** | 7 | | --- | --- | --- | --- | --- | 8 | | id | Integer | Unique identifier for this entity. | X | X | 9 | | actionOrder | Integer | Order of custom action. | | | 10 | | apiKeyID | Integer | Bullhorn API key id. | | | 11 | | componentURL | String (4000) | URL of CustomAction. | | | 12 | | enabled | Boolean | Indicates whether CustomAction is enabled. | | | 13 | | entity | String (50) | Entity to which CustomAction applies. | X | | 14 | | location | Integer | Location of the action within Bullhorn. | X | | 15 | | name | String (50) | Name of CustomAction. | | | 16 | | privateLabel | To-one association | PrivateLabel the custom action is associated with. | X | | 17 | -------------------------------------------------------------------------------- /source/includes/entityref/_deductioncategorylookup.md: -------------------------------------------------------------------------------- 1 | # DeductionCategoryLookup 2 | 3 | Entity that represents the deduction categories available. 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 |
DeductionCategoryLookup fieldsTypeDescriptionNot nullRead-only
isDeletedBooleanWhether or not deduction label is deleted.X
labelString (100)This field is used in the UI to display the deducation category type indicated by the payroll provider. Payroll provider can choose a default value of Tax, Deduction, Other, or simply add new deduction types and labels.
39 | 40 | 41 | 42 | 43 | -------------------------------------------------------------------------------- /source/includes/entityref/_department.md: -------------------------------------------------------------------------------- 1 | # Department 2 | 3 | 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. 4 | 5 | | **Department field** | **Type** | **Description** | **Not null** | **Read-only** | 6 | | --- | --- | --- | --- | --- | 7 | | id | Integer | Unique identifier for this entity. | X | X | 8 | | description | String (255) | Department description. | X | | 9 | | enabled | Boolean | Indicates whether department is enabled. | | | 10 | | name | String (100) | Department name. | X | | -------------------------------------------------------------------------------- /source/includes/entityref/_employercontribution.md: -------------------------------------------------------------------------------- 1 | # EmployerContribution 2 | 3 | Entity that represents the payroll provider's employer contributions. 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 |
EmployerContribution fieldsTypeDescriptionNot nullRead-only
idIntegerPayroll provider’s identifier for the contributions made by the employer.X
amountBigDecimalTotal employer contribution dollar amount.X
codeString (100)Payroll provider’s employer contribution code.X
descriptionString (2147483647)Description of the employer contribution.X
payCheckTo-one associationPayroll provider’s paycheck IDs for the employee paycheck. This is required to update the paycheck user interface for your client.X
60 | 61 | 62 | 63 | 64 | -------------------------------------------------------------------------------- /source/includes/entityref/_entityedithistory.md: -------------------------------------------------------------------------------- 1 | # {Entity}EditHistory 2 | 3 | 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. 4 | {Entity} can be any one of the following: Appointment, CandidateCertification, ClientCorporation, JobOrder, JobSubmission, Opportunity, Placement, PlacementCertification, PlacementChangeRequest, PlacementCommission, Task, User. 5 | 6 | | **{Entity}EditHistory field** | **Type** | **Description** | **Not null** | **Read-only** | 7 | | --- | --- | --- | --- | --- | 8 | | id | Integer | id of this entity. | X | X | 9 | | auditTrail | String (2147483647) | An HTML snippet representing the field changes for the given ID. Not always generated. | X | | 10 | | dateAdded | Timestamp | Date on which this {Entity}EditHistory record was created in the Bullhorn system. | X | X | 11 | | fieldChanges | To-many association | The {Entity}EditHistoryFieldChange entities associated with this {Entity}EditHistory. | X | | 12 | | migrateGUID | String (36) | Unused. |  X | | 13 | | modifyingPerson | To-one association | User credited with making the [Entity] change(s). |  X | | 14 | | targetEntity | To-one association | The [Entity] to which this {Entity}EditHistory applies. | X | X | 15 | | transactionID | String (36) | Unique transaction id for this {Entity}EditHistory. | X | | -------------------------------------------------------------------------------- /source/includes/entityref/_entityedithistoryfieldchange.md: -------------------------------------------------------------------------------- 1 | # {Entity}EditHistoryFieldChange 2 | 3 | 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. 4 | {Entity} can be any one of the following: Appointment, CandidateCertification, ClientCorporation, JobOrder, JobSubmission, Opportunity, Placement, PlacementCertification, PlacementChangeRequest, PlacementCommission, Task, User. 5 | 6 | | **{Entity}EditHistoryFieldChange field** | **Type** | **Description** | **Not null** | **Read-only** | 7 | | --- | --- | --- | --- | --- | 8 | | id | Integer | id of this entity. | X | X | 9 | | columnName | String (100) | Database column name for the value that was changed. | X | X | 10 | | 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 | 11 | | editHistory | To-one association | {Entity}EditHistory entity that owns this [Entity]EditHistoryFieldChange entity. | X | X | 12 | | newValue | String (2147483647) | The value of columnName after update. |  X | | 13 | | oldValue | String (2147483647) | The value of columnName before update. |  X | | -------------------------------------------------------------------------------- /source/includes/entityref/_entityfileattachment.md: -------------------------------------------------------------------------------- 1 | # {Entity}FileAttachment 2 | 3 | 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. 4 | 5 | | **{Entity}FileAttachment field** | **Type** | **Description** | **Not null** | **Read-only** | 6 | | --- | --- | --- | --- | --- | 7 | | id | Integer | Unique identifier for the entity. | X | X | 8 | | contentSubType | String (64) | Content subtype for the file. | X | | 9 | | contentType | String (64) | Content type for the file. | X | | 10 | | dateAdded | Timestamp | When the file was added. | X | X | 11 | | departmentsSharedWith | To-many association | Departments with which the file is shared. | X | | 12 | | description | String (2147483647) | Description for the file. | X | | 13 | | directory | String (150) | Location of the file on server. | X | | 14 | | distribution | String (8) | Distribution type for the file. | X | | 15 | | externalID | String (100) | Third-party id of the file. | X | | 16 | | fileExtension | String (10) | Extension type of the file. | X | X | 17 | | fileSize | Integer | Size on disk of the file. | X | X | 18 | | fileType | String (15) | Type of the file; for example, SAMPLE. | X | | 19 | | isCopied | Boolean | Whether the file was copied from another entity. | X | | 20 | | isDeleted | Boolean | Whether file is deleted | X | X | 21 | | isOpen | Boolean | Whether file is open. | X | X | 22 | | isPrivate | Boolean | Whether the file is private. | X | X | 23 | | isSendOut | Boolean | Whether the file is from a sendout. | X | X | 24 | | {entity} | To-one association | Entity associated with the file. | X | X | 25 | | name | String (100) | Name of the file. | X | X | 26 | | type | String (50) | Type of the file; for example, Resume. | X | | 27 | | usersSharedWith | To-many association | Users with whom the file is shared. | X | | 28 | | uuid | String (36) | Globally unique random ID. | X | X | 29 | -------------------------------------------------------------------------------- /source/includes/entityref/_estaffmappableflowback.md: -------------------------------------------------------------------------------- 1 | # EstaffMappableFlowback 2 | 3 | Represents data sent to Bullhorn ATS when Candidate onboarding information is updated in eStaff. 4 | 5 | | **EstaffMappableFlowback field** | **Type** | **Description** | **Not null** | **Read-only** | 6 | | --- | --- | --- | --- | --- | 7 | | id | Integer | Unique identifier for this entity. | X | X | 8 | | estaffFieldType | String (255) | Field type in eStaff ATS. | X | | 9 | | estaffRecordType | String (255) | Record type in eStaff ATS. | X | | 10 | | atsField | String (255) | Field type in Bullhorn ATS. | X | | 11 | | atsEntity | String (255) | Entity type in Bullhorn ATS. | X | | 12 | | alwaysOverwrite | Boolean | Determines if values in Bullhorn ATS should always be overwritten by eStaff values or only if the Bullhorn value is blank. | X | | -------------------------------------------------------------------------------- /source/includes/entityref/_housingcomplex.md: -------------------------------------------------------------------------------- 1 | # HousingComplex 2 | 3 | Represents a housing complex that a ClientCorporation uses when providing housing for certain types of employees.  4 | 5 | | **HousingComplex field** | **Type** | **Description** | **Not null** | **Read-only** | 6 | | --- | --- | --- | --- | --- | 7 | | id | Integer | Unique identifier for this entity. | X | X | 8 | | address | Address | HousingComplex address:Use the following REST call to get the list of countryIDs and labels:
/meta/HousingComplex?fields=address(countryID) | | | 9 | | billingContactID | Integer | The Bullhorn ClientContact id of the billing contact person for this housing complex. | | | 10 | | comments | String (2147483647) | Free-text comments about this housing complex. | | | 11 | | complexManagerID | Integer | The Bullhorn ClientContact id of the housing complex manager. | | | 12 | | complexOwnerID | Integer | The Bullhorn ClientContact id of the housing complex owner.  | | | 13 | | contactName | String (100) | Name of the contact person for the housing complex, generally a facilities manager or superintendent. | | | 14 | | customContactID1 to 3 | Integer | Configurable fields for identifying additional ClientContacts who have roles related to this housing complex. | | | 15 | | customDate1 to 3 | Timestamp | Configurable date fields that can be used to store custom data depending on the needs of a particular deployment. | | | 16 | | customFloat1 to 3 | Double | Configurable text fields that can be used to store custom data depending on the needs of a particular deployment. | | | 17 | | customInt1 to 3 | Integer | Configurable numeric fields that can be used to store custom data depending on the needs of a particular deployment. | | | 18 | | customText1 to 5 | String (100) | Configurable text fields that can be used to store custom data depending on the needs of a particular deployment. | | | 19 | | customTextBlock1 to 5 | String (2147483647) | Configurable text fields that can be used to store custom data depending on the needs of a particular deployment. | | | 20 | | dateAdded | Timestamp | Date on which this record was created in the Bullhorn system. | X | | 21 | | fax | String (20) | Fax number for the housing complex. | | | 22 | | isDeleted | Boolean | Indicates whether this record has been marked as deleted in the Bullhorn system. | X | | 23 | | name | String (100) | Name of the housing complex. | X | | 24 | | owner | Integer | CorporateUser who is the owner of this housing complex. | X | | 25 | | phone | String (20) | Primary phone number of the housing complex. | | | 26 | | whitelistClientCorporations | To-many association | Set of ClientCorporations to use this housing complex. | | | -------------------------------------------------------------------------------- /source/includes/entityref/_housingcomplexfurnituredelivery.md: -------------------------------------------------------------------------------- 1 | # HousingComplexFurnitureDelivery 2 | 3 | Read-only enntity that represents a housing complex furniture delivery that a ClientCorporation uses when providing housing for certain types of employees.  4 | 5 | | **HousingComplexFurnitureDelivery field** | **Type** | **Description** | **Not null** | **Read-only** | 6 | | --- | --- | --- | --- | --- | 7 | | id | Integer | Unique identifier for this entity. | X | X | 8 | | address | Address | HousingComplex address:Use the following REST call to get the list of countryIDs and labels:
/meta/HousingComplex?fields=address(countryID) | | | 9 | | billingContactID | Integer | The Bullhorn ClientContact id of the billing contact person for this housing complex. | | | 10 | | comments | String (2147483647) | Free-text comments about this housing complex. | | | 11 | | contactName | String (100) | Name of the contact person for the housing complex, generally a facilities manager or superintendent. | | | 12 | | customContactID1 and 2 | Integer | Configurable fields for identifying additional ClientContacts who have roles related to this housing complex. | | | 13 | | customDate1 to 3 | Timestamp | Configurable date fields that can be used to store custom data depending on the needs of a particular deployment. | | | 14 | | customFloat1 to 3 | Double | Configurable text fields that can be used to store custom data depending on the needs of a particular deployment. | | | 15 | | customInt1 to 3 | Integer | Configurable numeric fields that can be used to store custom data depending on the needs of a particular deployment. | | | 16 | | customText1 to 5 | String (100) | Configurable text fields that can be used to store custom data depending on the needs of a particular deployment. | | | 17 | | customTextBlock1 to 5 | String (2147483647) | Configurable text fields that can be used to store custom data depending on the needs of a particular deployment. | | | 18 | | dateAdded | Timestamp | Date on which this record was created in the Bullhorn system. | X | | 19 | | dateOfDelivery | Timestamp | The delivery date of furniture. | | | 20 | | dateOfOrder | Timestamp | The order date of furniture. | | | 21 | | dateOfPickup | Timestamp | The pickup date of furniture. | | | 22 | | fax | String (20) | Fax number for the housing complex. | | | 23 | | isDeleted | Boolean | Indicates whether this record has been marked as deleted in the Bullhorn system. | X | | 24 | | name | String (100) | Name of the housing complex. | | | 25 | | phone | String (20) | Primary phone number of the housing complex. | | | 26 | | unit | To-one association | Associated HousingComplexUnit. | X | | -------------------------------------------------------------------------------- /source/includes/entityref/_housingcomplexunit.md: -------------------------------------------------------------------------------- 1 | # HousingComplexUnit 2 | 3 | Read-only entity that represents a housing complex unit that a ClientCorporation uses when providing housing for certain types of employees.  4 | 5 | | **HousingComplexUnit field** | **Type** | **Description** | **Not null** | **Read-only** | 6 | | --- | --- | --- | --- | --- | 7 | | id | Integer | Unique identifier for this entity. | X | X | 8 | | billingContactID | Integer | The Bullhorn ClientContact id of the billing contact person for this housing complex. | | | 9 | | comments | String (2147483647) | Free-text comments about this housing complex. | | | 10 | | contactName | String (100) | Name of the contact person for the housing complex, generally a facilities manager or superintendent. | | | 11 | | customContactID1 and 2 | Integer | Configurable fields for identifying additional ClientContacts who have roles related to this housing complex. | | | 12 | | customDate1 to 3 | Timestamp | Configurable date fields that can be used to store custom data depending on the needs of a particular deployment. | | | 13 | | customFloat1 to 3 | Double | Configurable text fields that can be used to store custom data depending on the needs of a particular deployment. | | | 14 | | customInt1 to 3 | Integer | Configurable numeric fields that can be used to store custom data depending on the needs of a particular deployment. | | | 15 | | customText1 to 5 | String (100) | Configurable text fields that can be used to store custom data depending on the needs of a particular deployment. | | | 16 | | customTextBlock1 to 5 | String (2147483647) | Configurable text fields that can be used to store custom data depending on the needs of a particular deployment. | | | 17 | | dateAdded | Timestamp | Date on which this record was created in the Bullhorn system. | X | | 18 | | dateLeaseBegin | Timestamp | The lease begin date. | | | 19 | | dateLeaseEnd | Timestamp | The lease end date. | | | 20 | | dateOfDeposit | Timestamp | The deposit date. | | | 21 | | dateORefund | Timestamp | The refund date. | | | 22 | | firstMonthProRate | Double | Prorate value for the first month of the lease. | | | 23 | | isDeleted | Boolean | Indicates whether this record has been marked as deleted in the Bullhorn system. | X | | 24 | | isDepositRefundable | Boolean | Indicates whether lease is on file. | X | | 25 | | isLeaseOnFile | Boolean | Indicates whether deposit is refundable. | X | | 26 | | maxOccupants | Integer | Maximum number of occupants. | | | 27 | | monthlyRent | Double | Monthly rent. | | | 28 | | name | String (100) | Name of the housing complex. | | | 29 | | occupants | Integer | Number of occupants. | | | 30 | | penalties | String | CorporateUser who is the owner of this housing complex. | X | | 31 | | securityDeposit | Double | Amount of security deposit. | | | 32 | | unitManagerID | Integer | ID of unit manager. | | | 33 | | furnitureDeliveries | To-many association | Set of FurnitureDeliveries attached to this HousingComplexUnit. | | | 34 | | userHousingComplexUnits | To-many association | Set of userHousingComplexUnits attached to this HousingComplexUnit. | | | 35 | | utilityAccounts | To-many association | Set of utilityAccounts attached to this HousingComplexUnit. | | | -------------------------------------------------------------------------------- /source/includes/entityref/_housingcomplexutilityaccount.md: -------------------------------------------------------------------------------- 1 | # HousingComplexUtilityAccount 2 | 3 | Read-only entity that represents a housing complex unit utility account that a ClientCorporation uses when providing housing for certain types of employees.  4 | 5 | | **HousingComplexUtilityAccount field** | **Type** | **Description** | **Not null** | **Read-only** | 6 | | --- | --- | --- | --- | --- | 7 | | id | Integer | Unique identifier for this entity. | X | X | 8 | | address | Address | HousingComplex address:Use the following REST call to get the list of countryIDs and labels:
/meta/HousingComplex?fields=address(countryID) | | | 9 | | accountNumber | String (100) | Utility account number. | | | 10 | | billingContactID | Integer | The Bullhorn ClientContact id of the billing contact person for this housing complex. | | | 11 | | comments | String (2147483647) | Free-text comments about this housing complex. | | | 12 | | contactName | String (100) | Name of the contact person for the housing complex, generally a facilities manager or superintendent. | | | 13 | | customContactID1 and 2 | Integer | Configurable fields for identifying additional ClientContacts who have roles related to this housing complex. | | | 14 | | customDate1 to 3 | Timestamp | Configurable date fields that can be used to store custom data depending on the needs of a particular deployment. | | | 15 | | customFloat1 to 3 | Double | Configurable text fields that can be used to store custom data depending on the needs of a particular deployment. | | | 16 | | customInt1 to 3 | Integer | Configurable numeric fields that can be used to store custom data depending on the needs of a particular deployment. | | | 17 | | customText1 to 5 | String (100) | Configurable text fields that can be used to store custom data depending on the needs of a particular deployment. | | | 18 | | customTextBlock1 to 5 | String (2147483647) | Configurable text fields that can be used to store custom data depending on the needs of a particular deployment. | | | 19 | | dateAdded | Timestamp | Date on which this record was created in the Bullhorn system. | X | | 20 | | dateConnected | Timestamp | Utility connection date. | | | 21 | | dateDisconnected | Timestamp | Utility disconnection date. | | | 22 | | deposit | Double | Deposit amount. | | | 23 | | fax | String (20) | Fax number for the housing complex. | | | 24 | | isDeleted | Boolean | Indicates whether this record has been marked as deleted in the Bullhorn system. | X | | 25 | | name | String (100) | Name of the housing complex. | | | 26 | | phone | String (20) | Primary phone number. | | | 27 | | type | String (100) | Type of utility account. | | | 28 | | unit | To-one association | Associated HousingComplexUnit. | X | | 29 | 30 | -------------------------------------------------------------------------------- /source/includes/entityref/_issue.md: -------------------------------------------------------------------------------- 1 | # Issue 2 | 3 | Entity representing an Issue which contains metadata and a collection of IssueItems which represent individual reported issues. 4 | 5 | | **Issue field** | **Type** | **Description** | **Not null** | **Read-only** | 6 | | --- | --- | --- | --- | --- | 7 | | id | Integer | Unique identifier for this entity. | X | X | 8 | | action | String | The action being performed that initiated this Issue. This field is free-form. For Payroll Export issues, typical values are "Payroll Export", "New Hire Export", "Accounts Payable Export", or "Unknown". | | | 9 | | actionEntityID | Integer | The ID of the entity on which this Issue is based. This can be left blank if no specific entity is relevant. | | | 10 | | actionEntityName | String | The name of the entity on which this Issue is based. This can be left blank if no specific entity is relevant. | | | 11 | | dateAdded | Timestamp | Date on which the entity was created. | X | | 12 | | externalSystemName | String | Name of an integrating external system to be used to specify the source of the issue being reported. | | | 13 | | issueItems | To-many association | The list of associated IssueItems related to this Issue. | | | 14 | | payMasterTransactionPayExportBatchIssues | To-many association | Association to any related PayMasterTransactionPayExportBatchIssues which can tie the issue to a pay export batch.| | X | 15 | | severity | String | The severity of the Issue. Valid values are Error, Warning, Exception, and Unknown. | X | | 16 | -------------------------------------------------------------------------------- /source/includes/entityref/_issueitems.md: -------------------------------------------------------------------------------- 1 | # IssueItems 2 | 3 | Entity representing individual reported issues. 4 | 5 | | **IssueItems field** | **Type** | **Description** | **Not null** | **Read-only** | 6 | | --- | --- | --- | --- | --- | 7 | | id | Integer | Unique identifier for this entity. | X | X | 8 | | comments | String | Comments about the IssueItems to be used for reference. | | | 9 | | description | String | A text description of the IssueItems. | | | 10 | | dateAdded | Timestamp | Date on which the entity was created. | X | | 11 | | dateLateModified | Timestamp | Date on which the entity was last modified. | | | 12 | | errorType | String | The type of error type being reported. Valid values are INVALID-DATA, MISSING-DATA, DATA-MISMATCH, SYSTEM-ERROR, or UNKNOWN. | | | 13 | | externalEntityID | String | A reference to any external entity ID that is related to this issue. | | | 14 | | externalEntityName | String | A reference to any external entity name that is related to this issue. | | | 15 | | fieldReference | String | The field on the entity that is known to be related to the issue being reported. | | | 16 | | fixableByUser | Boolean | Whether or not this issue should be fixable by a user. | | | 17 | | fixInBullhorn | Boolean | Whether or not this issue should be fixable within the Bullhorn system. | | | 18 | | issue | To-one associaton | The Issue entity to which this IssueItems entity is associated. | X | | 19 | | issueResolutionStatusLookup | To-one associaton | The code of the issue resolution status. A value of 1 means Open. A value of 2 means Resolved. A value of 3 means Dismissed. | X | | 20 | | modifiedByUser | To-one association | The user who last modified the entity. | | | 21 | | rawIssueItemPayload | String | Text field containing raw payload information such as JSON containing additional context of the reported issue. | | | 22 | | referenceUrl | String | The Bullhorn API URL that is being reported on by this issue. | | | 23 | | referenceUrlMethod | String | The Bullhorn API HTTP method that is being reported on by this issue. | | | 24 | | referenceUrlResponse | String | The Bullhorn API response message that is being reported on by this issue. | | | 25 | | referenceUrlStatusCode | Integer | The Bullhorn API HTTP status code that is being reported on by this issue. | | | 26 | | severity | String | The severity of the IssueItems. Valid values are Error, Warning, Exception, and Unknown. | X | | 27 | | sourceEntity | String | The entity type that is being reported on in this issue. | | | 28 | | sourceEntityID | Integer | The ID of the entity that is being reported on in this issue. | | | 29 | -------------------------------------------------------------------------------- /source/includes/entityref/_jobboardpost.md: -------------------------------------------------------------------------------- 1 | # JobBoardPost 2 | 3 | Represents a view into a JobOrder entity with information typically used in public job boards. JobBoardPost is a read-only entity. 4 | 5 | | **JobBoardPost field** | **Type** | **Description** | **Not null** | **Read-only** | 6 | | --- | --- | --- | --- | --- | 7 | | id | Integer | Unique identifier for this entity. | X | X | 8 | | 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 | | 9 | | benefits | String (2147483647) | Text description of benefits offered with this job. |  X | | 10 | | bonusPackage | String (2147483647) | Text description of the bonus package offered with this job. |  X | | 11 | | categories | To-many association | IDs of Categories associated with this job. |  X | | 12 | | dateAdded | Timestamp | Date when this record was created in the Bullhorn system. | X | | 13 | | dateEnd | Timestamp | Date when the job will end (if applicable). |  X | | 14 | | dateLastPublished | Timestamp | Date when this record was last published to the 'Corporate' Job Board. | X | | 15 | | 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 | 16 | | isPublic | Boolean | Controls whether a job appears on the Bullhorn job board (if in use). Only 3 values allows, -1, 0, 1. |  X | | 17 | | isOpen | Boolean | Indicates whether the job is open. | X  | | 18 | | payRate | BigDecimal | Pay rate offered with this job. |  X | | 19 | | publicDescription | String (200000) | Description of this job for use on public job boards. | X | | 20 | | publishedCategory | To-one association | The category that was last selected when publishing the job. |  X | | 21 | | publishedZip | String (18) | Published Zip Code of the job location. | X  | | 22 | | responseUser | To-one association | id of CorporateUser to whom submissions should be sent. |  X | | 23 | | salary | BigDecimal | Salary offered for this job. |  X | | 24 | | salaryUnit | String (12) | Salary unit represented by the range (e.g. per hour, yearly). |  X | | 25 | | startDate | Timestamp | Desired start date for the position. | X | X | 26 | | title | String (100) | Job title. |  X | | 27 | | travelRequirements | String (50) | Text description of the amount of travel required for this job. |  X | | 28 | | willRelocate | Boolean | Indicates whether the hiring company will provide relocation assistance. |  X | | 29 | | willSponsor | Boolean | Indicates whether the hiring company is willing to sponsor an employee on a work visa. |  X | | 30 | | yearsRequired | Integer | Number of years of experience required for the job. |  X | | -------------------------------------------------------------------------------- /source/includes/entityref/_jobshiftsubmission.md: -------------------------------------------------------------------------------- 1 | # JobShiftSubmission 2 | 3 | Similar to a JobSubmission, JobShiftSubmissions contain status and allow for a workflow of assigning a Candidate to a JobShift without a JobShiftAssignment. 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 74 | 75 | 76 | 77 | 78 | 79 | 80 |
JobShiftSubmission fieldsTypeDescriptionNot nullRead-only
idIntegerUnique identifier for this entity.XX
candidateTo-one associationCandidate associated to JobShiftSubmission.X
dateAddedTimestampDate when this record was created in the Bullhorn system.X
dateLastModifiedTimestampDate when this record was last modified in the Bullhorn system.X
isPublishedBooleanIndicates when JobShiftSubmission is promoted to JobShiftAssignment.X
jobShiftTo-one associationJobShift associated with JobShiftSubmission.X
jobShiftOfferContextTo-one associationContext within the JobShift offer.
statusString (50)Status of JobShiftSubmission.
81 | -------------------------------------------------------------------------------- /source/includes/entityref/_jobsubmissionhistory.md: -------------------------------------------------------------------------------- 1 | # JobSubmissionHistory 2 | 3 | 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. 4 | 5 | | **JobSubmissionHistory field** | **Type** | **Description** | **Not null** | **Read-only** | 6 | | --- | --- | --- | --- | --- | 7 | | id | Integer | Unique identifier for this entity. | X | X | 8 | | comments | String (2147483647) | Value of the JobSubmission comments fields for this transaction. | | | 9 | | dateAdded | Timestamp | Date on which the JobSubmission record was created in the Bullhorn system. | X | X | 10 | | jobSubmission | To-one association | JobSubmission associated with this JobSubmissionHistory. | X | X | 11 | | modifyingUser | To-one association | CorporateUser credited with modifying the JobSubmission. | X |  X | 12 | | status | String (30) | Status of the JobSubmission (for example, reviewed, accepted, and so forth.). Allowable values are configured in field maps. | X |  X | 13 | | transactionID | String (36) | Unique transaction id for this JobSubmissionHistory. | | | 14 | -------------------------------------------------------------------------------- /source/includes/entityref/_leadhistory.md: -------------------------------------------------------------------------------- 1 | # LeadHistory 2 | 3 | Read-only entity that represents the status and ClientCorporation history of a Lead. 4 | 5 | | **LeadHistory field** | **Type** | **Description** | **Not null** | **Read-only** | 6 | | --- | --- | --- | --- | --- | 7 | | id | Integer | Unique identifier for this entity. | X | X | 8 | | clientCorporation | To-one association | ClientCorporation of the associated Lead at the time this LeadHistory was created. | X | | 9 | | dateAdded | Timestamp | Date this LeadHistory was added. | X | X | 10 | | lead | To-one association | Lead associated with this LeadHistory. | X | X | 11 | | modifyingUser | To-one association | CorporateUser who modified the Lead associated with this LeadHistory. | X | X | 12 | | status | String (30) | Status of the associated Lead at the time this LeadHistory was created. | X | X | -------------------------------------------------------------------------------- /source/includes/entityref/_noteentity.md: -------------------------------------------------------------------------------- 1 | # NoteEntity 2 | 3 | Represents the Candidate, ClientContact, CorporateUser, JobOrder, or Placement associated with a Note. 4 | 5 | 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. 6 | 7 | |**NoteEntity field** | **Type** | **Description** | **Not null** | **Read-only** | 8 | | --- | --- | --- | --- | --- | 9 | | id | Integer | Unique identifier for this entity. | X | | 10 | | note | To-one association | Note associated with this NoteEntity. | | | 11 | | targetEntityID | Integer | Id of target entity to which the associated Note applies. | X | | 12 | | targetEntityName | String (50) | Name of target entity type. For Candidates ClientContacts, and CorporateUsers, specify “User” as the targetEntityName value. For JobOrders and Placements, specify the actual entity name as the targetEntityName value. | X | | -------------------------------------------------------------------------------- /source/includes/entityref/_opportunityhistory.md: -------------------------------------------------------------------------------- 1 | # OpportunityHistory 2 | 3 | Read-only entity that represents the history of certain fields of an Opportunity. 4 | 5 | | **OpportunityHistory field** | **Type** | **Description** | **Not null** | **Read-only** | 6 | | --- | --- | --- | --- | --- | 7 | | id | Integer | Unique identifier for this entity. | X | X | 8 | | dateAdded | Timestamp | Date this OpportunityHistory was added. | X | X | 9 | | dealValue | BigDecimal | Deal value of the associated Opportunity at the time this OpportunityHistory was created. | X | | 10 | | effectiveDate | Timestamp | Date the status change comes into effect for the associated Opportunity. | X | | 11 | | modifyingUser | To-one association | CorporateUser who modified the Opportunity associated with this OpportunityHistory. | X | X | 12 | | opportunity | To-one association | Opportunity associated with this OpportunityHistory. | X | X | 13 | | status | String (200) | Status of the associated Opportunity at the time this OpportunityHistory was created. | X | X | 14 | | weightedDealValue | BigDecimal | Weighted deal value of the associated Opportunity at the time this OpportunityHistory was created. | X | | 15 | | winProbabilityPercent | Double | Probability of winning the associated Opportunity at the time this OpportunityHistory was created. | X | | -------------------------------------------------------------------------------- /source/includes/entityref/_placementcommission.md: -------------------------------------------------------------------------------- 1 | # PlacementCommission 2 | 3 | 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. 4 | 5 | | **PlacementCommission field** | **Type** | **Description** | **Not null** | **Read-only** | 6 | | --- | --- | --- | --- | --- | 7 | | id | Integer | Unique identifier for this entity. | X | 8 | | comments | String (2147483647) | Free-text comments on this commission. | 9 | | commissionPercentage | Double | The commission amount, expressed as a percentage: for example, 0.05 = 5%. Saved as decimal. | X | 10 | | dateAdded | Timestamp | Date on which this record was created in the Bullhorn system. | X | 11 | | dateLastModified | Timestamp | Date on which the PlacementCommission was last modified. | X | X | 12 | | externalRecipient | String (100) | If the person who should receive the commission does not have a Bullhorn id, this field indicates that person's name. | 13 | | flatPayout | Double | The commission expressed as a flat sum. | X | 14 | | grossMarginPercentage | Double | The percentage of the total gross margin for the Placement that the commission recipient will receive. | X | 15 | | hourlyPayout | Double | The commission expressed as an hourly rate (e.g., $1.00 for each hour worked by the employee). | X | 16 | | placement | To-one association | Placement to which this commission pertains. | X | 17 | | role | String (50) | The commission recipient's role for the Placement (Sales, Recruiting, and so forth). | 18 | | status | String (30) | Status of this commission. | 19 | | user | To-one association | User who will receive the commission, if applicable. | -------------------------------------------------------------------------------- /source/includes/entityref/_screenerquestion.md: -------------------------------------------------------------------------------- 1 | # ScreenerQuestion 2 | 3 | The Screener Question entity enables users to define custom screening questions for Jobs. When a candidate applies and responds to these questions, their answers are mapped to corresponding fields on the Candidate entity, based on the user’s configuration. 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 74 | 75 | 76 | 77 | 78 | 79 | 80 |
ScreenerQuestion fieldsTypeDescriptionNot nullRead-only
idIntegerUnique identifier for this entity.XX
answerEntityTypeTo-one associationThe Bullhorn entity the applicant’s response will be mapped to.
answerFieldNameString (255)The field on the answerEntityType that the applicant’s answer should be mapped to.
dateAddedTimestampDate on which this record was created in the Bullhorn system.X
dateLastModifiedTimestampDate on which this record was last updated in the Bullhorn system.X
isDeletedBooleanIndicates whether this record has been marked as deleted in the Bullhorn system. Defaults to false.X
questionTextString (255)The text that applicants will see on job boards when applying to a Job.X
requiredBooleanIndicates if the question is required or optional. Defaults to false.X
-------------------------------------------------------------------------------- /source/includes/entityref/_sendout.md: -------------------------------------------------------------------------------- 1 | # Sendout 2 | 3 | Represents a sendout, which occurs when a Candidate's information is sent to a ClientCorporation to be evaluated for a particular job. 4 | 5 | | **Sendout field** | **Type** | **Description** | **Not null** | **Read-only** | 6 | | --- | --- | --- | --- | --- | 7 | | id | Integer | Unique identifier for this entity. | X | | 8 | | candidate | To-one association | Candidate being sent out. | X | | 9 | | clientContact | To-one association | ClientContact receiving the Sendout. | | | 10 | | clientCorporation | To-one association | Hiring company. | | | 11 | | dateAdded | Timestamp | Date on which this entity was created in the Bullhorn system. | X | | 12 | | email | String (100) | Email address to which the Sendout is sent. | | | 13 | | isRead | Boolean | Indicates whether the email has been opened. | X | | 14 | | jobOrder | To-one association | JobOrder for which the Candidate is being considered. | | | 15 | | user | To-one association | CorporateUser who initiated this Sendout. The default value is user who creates the Sendout. | X | | -------------------------------------------------------------------------------- /source/includes/entityref/_shifttype.md: -------------------------------------------------------------------------------- 1 | # ShiftType 2 | 3 | Is set at the corporation level to define various Shift time intervals (Morning, Afternoon, Evening, Overnight). Used for setting candidatePreferences. 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 |
ShiftType fieldsTypeDescriptionNot nullRead-only
idIntegerUnique identifier for this entity.XX
endTimeString (16)The end time for the associated ShiftType.X
iconString (50)Icon associated to the ShiftType.
isDeletedBooleanIndicates whether this record has been marked as deleted in the Bullhorn system.X
nameString (50)Name of the associated ShiftType.X
startTimeString (16)The start time for the associated ShiftType.X
67 | -------------------------------------------------------------------------------- /source/includes/entityref/_skill.md: -------------------------------------------------------------------------------- 1 | # Skill 2 | 3 | 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. 4 | 5 | | **Skill field** | **Type** | **Description** | **Not null** | **Read-Only** | 6 | | --- | --- | --- | --- | --- | 7 | | id | Integer | Unique identifier for this entity. | X | X | 8 | | enabled | Boolean | Indicates whether Skill is enabled. | | | 9 | | categories | To-many association | Categories with which this Skill is associated. | | | 10 | | name | String (100) | Name of this Skill. | X | X | -------------------------------------------------------------------------------- /source/includes/entityref/_specialty.md: -------------------------------------------------------------------------------- 1 | # Specialty 2 | 3 | Represents anty that can be associated with a job or held by a candidate. Specialties are associated with a parent Category entity. 4 | 5 | | **Specialty field** | **Type** | **Description** | **Not null** | **Read-only** | 6 | | --- | --- | --- | --- | --- | 7 | | id | Integer | Unique identifier for this entity. | X | X | 8 | | dateAdded | Timestamp | Date on which this record was created in the Bullhorn system. | X | X | 9 | | enabled | Boolean | Indicates whether category is available for use in the Bullhorn application. | X | X | 10 | | name | String (100) | Name of Specialty. | X | X | 11 | | parentCategory | Integer | Category that is parent of this Specialty. | X | X | -------------------------------------------------------------------------------- /source/includes/entityref/_state.md: -------------------------------------------------------------------------------- 1 | # State 2 | 3 | Represents a state or province within a nation.  4 | 5 | | **State field** | **Type** | **Description** | **Not null** | **Read-only** | 6 | | --- | --- | --- | --- | --- | 7 | | id | Integer | Unique identifier for this entity. | X | | 8 | | code | String (50) | Postal abbreviation of the state. | | | 9 | | country | To-one association | Nation that contains this state. | X | | 10 | | name | String | Name of the state. | X | | -------------------------------------------------------------------------------- /source/includes/entityref/_tearsheet.md: -------------------------------------------------------------------------------- 1 | # Tearsheet 2 | 3 | Represents a tearsheet. The Tearsheet entity supports the massUpdate operations. 4 | 5 | | **Tearsheet field** | **Type** | **Description** | **Not null** | **Read-only** | 6 | | --- | --- | --- | --- | --- | 7 | | id | Integer | Unique identifier for this entity. | X | | 8 | | candidates | To-many association | Candidates with which this Tearsheet is associated. The default fields | | | 9 | | clientContacts | To-many association | ClientContacts with which this Tearsheet is associated. | | | 10 | | dateAdded | Timestamp | Date on which the Tearsheet was created in the Bullhorn system. | X | | 11 | | dateLastModified | Timestamp | Date on which the Tearsheet was last modified. | X | X | 12 | | description | String (2147483647) | Free-text description. | | | 13 | | isDeleted | Boolean | Indicates whether this record is marked as deleted in the Bullhorn system. | X | | 14 | | 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. | | | 15 | | jobOrders | To-many association | JobOrders with which this Tearsheet is associated. | | | 16 | | name | String (100) | Name of this Tearsheet. | X | | 17 | | owner | To-one association | CorporateUser who is the primary owner of this Tearsheet. The default value is user who created the tearsheet. | | | 18 | | recipients | To-many association | Ids of TearsheetRecipients with which this Tearsheet is associated. | | | -------------------------------------------------------------------------------- /source/includes/entityref/_tearsheetmember.md: -------------------------------------------------------------------------------- 1 | # TearsheetMember 2 | 3 | Represents a tearsheet member.  4 | 5 | | **TearsheetMember field** | **Type** | **Description** | **Not null** | **Read-only** | 6 | | --- | --- | --- | --- | --- | 7 | | id | Integer | Unique identifier for this entity. | X | | 8 | | candidateRestrictionBits | Integer | Candidate restriction bits. | X | | 9 | | dateAdded | Timestamp | Date on which this record was created in the Bullhorn system. | X | | 10 | | person | To-one association | Person with whom this TearsheetMember is associated. | | | 11 | | tearsheet | To-one association | Tearsheet with which this TearsheetMember is associated. | | | -------------------------------------------------------------------------------- /source/includes/entityref/_tearsheetrecipient.md: -------------------------------------------------------------------------------- 1 | # TearsheetRecipient 2 | 3 | Represents a tearsheet recipient.  4 | 5 | | **TearsheetRecipient field** | **Type** | **Description** | **Not null** | **Read-only** | 6 | | --- | --- | --- | --- | --- | 7 | | id | Integer | Unique identifier for this entity. | X | | 8 | | candidateRestrictionBits | Integer | Candidate restriction bits. | X | | 9 | | dateAdded | Timestamp | Date on which this record was created in the Bullhorn system. | X | | 10 | | description | String (2147483647) | Free-text description. | | | 11 | | isDeleted | Boolean | Indicates whether this record is marked as deleted in the Bullhorn system. | X | | 12 | | isSent | Boolean | Indicates whether | | | 13 | | jobOrder | To-one association | JobOrder with which this TearsheetRecipient is associated. | | | 14 | | person | To-one association | Person with whom this TearsheetRecipient is associated. | | | 15 | | tearsheet | To-one association | Tearsheet with which this TearsheetRecipient is associated. | | | -------------------------------------------------------------------------------- /source/includes/entityref/_timeunit.md: -------------------------------------------------------------------------------- 1 | # TimeUnit 2 | 3 | Represents a time unit.  4 | 5 | | **TimeUnit field** | **Type** | **Description** | **Not null** | **Read-only** | 6 | | --- | --- | --- | --- | --- | 7 | | id | Integer | Unique identifier for this entity. | X | | 8 | | name | String (100) | Name of this TimeUnit. | X | | 9 | | timeMarker | Integer | Time marker, such as AM or PM. | X | | 10 | | weekDay | Integer | Day of the week. | X | | -------------------------------------------------------------------------------- /source/includes/entityref/_userhousingcomplexunit.md: -------------------------------------------------------------------------------- 1 | # UserHousingComplexUnit 2 | 3 | Read-only entity that represents a housing complex unit for a candidate.  4 | 5 | | **UserHousingComplexUnit field** | **Type** | **Description** | **Not null** | **Read-only** | 6 | | --- | --- | --- | --- | --- | 7 | | id | Integer | Unique identifier for this entity. | X | X | 8 | | candidate | To-one association | Candidate submitted for this job. | | | 9 | | comments | String (2147483647) | Free-text comments about this housing complex. | | | 10 | | customDate1 to 5 | Timestamp | Configurable date fields that can be used to store custom data depending on the needs of a particular deployment. | | | 11 | | customFloat1 to 5 | Double | Configurable text fields that can be used to store custom data depending on the needs of a particular deployment. | | | 12 | | customInt1 to 5 | Integer | Configurable numeric fields that can be used to store custom data depending on the needs of a particular deployment. | | | 13 | | customText1 to 5 | String (100) | Configurable text fields that can be used to store custom data depending on the needs of a particular deployment. | | | 14 | | customTextBlock1 to 5 | String (2147483647) | Configurable text fields that can be used to store custom data depending on the needs of a particular deployment. | | | 15 | | dateBegin | Timestamp | Begin date. | | | 16 | | dateEnd | Timestamp | End date. | | | 17 | | deduction | Double | | | | 18 | | isDeleted | Boolean | Indicates whether this record has been marked as deleted in the Bullhorn system. | X | | 19 | | placement | To-many association | Set of FurnitureDeliveries attached to this HousingComplexUnit. | | | 20 | | unit | To-one association | Associated HousingComplexUnit. | X | | -------------------------------------------------------------------------------- /source/includes/entityref/_workerscompensation.md: -------------------------------------------------------------------------------- 1 | # WorkersCompensation 2 | 3 | Represents workers compensation data. 4 | 5 | | **WorkersCompensation field** | **Type** | **Description** | **Not null** | **Read-only** | 6 | | --- | --- | --- | --- | --- | 7 | | id | Integer | Unique identifier for this entity. | X | X | 8 | | code | String | The code set for this WorkersCompensation. | X | | 9 | | dateAdded | Timestamp | Date on which this record was created in the Bullhorn system. | X | X | 10 | | dateLastModified | Timestamp | Date on which the WorkersCompensation was last modified. | X | X | 11 | | description | String | Description text about the WorkersCompensation. | | | 12 | | name | String | The name of the WorkersCompensation. | | | 13 | | rates | To-many association | Set of WorkersCompensationRate entities attached to this WorkersCompensation. | | | 14 | | state | String | State associated to this WorkersCompensation. | | | 15 | -------------------------------------------------------------------------------- /source/includes/entityref/_workerscompensationrate.md: -------------------------------------------------------------------------------- 1 | # WorkersCompensationRate 2 | 3 | Represents workers compensation rate data. 4 | 5 | | **WorkersCompensationRate field** | **Type** | **Description** | **Not null** | **Read-only** | 6 | | --- | --- | --- | --- | --- | 7 | | id | Integer | Unique identifier for this entity. | X | X | 8 | | compensation | To-one assocation | WorkersCompensation entity related to this rate. | X | | 9 | | dateAdded | Timestamp | Date on which this record was created in the Bullhorn system. | X | X | 10 | | dateLastModified | Timestamp | Date on which the WorkersCompensationRate was last modified. | X | X | 11 | | endDate | Timestamp | End date set for this WorkersCompensationRate. | X | | 12 | | rate | Double | Value of the rate. | X | | 13 | | startDate | Timestamp | Start date set for this WorkersCompensationRate. | X | | 14 | -------------------------------------------------------------------------------- /source/includes/entityref/paybill/_accountingperiod.md: -------------------------------------------------------------------------------- 1 | # Pay and Bill - AccountingPeriod 2 | 3 | Defines a financial period—typically marked by start and end dates—within which billing and revenue transactions are grouped, reported, and reconciled. 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 |
AccountingPeriod fieldsTypeDescriptionNot nullRead-only
idIntegerUnique identifier for this entity.XX
accountingPeriodDateDateAccounting Period date.X
-------------------------------------------------------------------------------- /source/includes/entityref/paybill/_batchgroup.md: -------------------------------------------------------------------------------- 1 | # Pay and Bill - BatchGroup 2 | 3 | Organizes related batches into one grouping to streamline the processing and management of bulk operations. 4 | Dynamically inserted via billing-sync-services. 5 | 6 | CRUD Access - READ 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 48 | 49 | 50 | 51 | 52 |
BatchGroup fieldsTypeDescriptionNot nullRead-only
idIntegerUnique identifier for this entity.XX
dateAddedTimestampDate the entity was added.XX
billingSyncBatchesTo-many association

BillingSyncBatches.

44 |

Default fields:

45 |
    46 |
  • id
    • 47 |
 X
53 | 54 | 55 | -------------------------------------------------------------------------------- /source/includes/entityref/paybill/_billingsyncbatch.md: -------------------------------------------------------------------------------- 1 | # Pay and Bill - BillingSyncBatch 2 | 3 | Represents a collection of billing records bundled together for efficient synchronization between Bullhorn and external billing systems. 4 | Dynamically inserted and updated via billing-sync-services. 5 | 6 | CRUD Access - READ 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 37 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 74 | 75 | 76 | 77 | 78 | 79 | 80 | 81 | 82 | 83 | 84 | 85 | 86 | 87 | 88 | 89 | 90 | 91 | 92 | 93 | 94 | 99 | 100 | 101 | 102 | 103 | 104 | 105 | 106 | 107 | 108 | 109 | 110 | 111 | 112 | 113 | 114 | 115 | 116 | 117 | 118 | 119 | 120 | 121 | 122 | 123 | 124 |
BillingSyncBatch fieldsTypeDescriptionNot nullRead-only
idIntegerUnique identifier for this entity.XX
batchGroup

To-many association

36 |

 

Batch group.

38 |

Default fields:

39 |
    40 |
  • id
    • 41 |
 X
billMasters

To-one association

BillMasters.

49 |

Default fields:

50 |
    51 |
  • id
    • 52 |
 X
dateAddedTimestampDate the entity was added.XX
dateLastModifiedTimestampDate last modified.XX
defaultBillableChargeTo-one associationDefault BillableCharge. X
defaultPayableChargeTo-one associationDefault PayableCharge. X
externalIDString (50)User facing unique identifier. X
payMastersTo-many association

PayMasters.

95 |

Default fields:

96 |
    97 |
  • id
    • 98 |
 X
periodEndDateDatePeriod end date. X
timeOfExternalEventTimestampTime of external event that initiated batch.XX
transactionOriginTo-one associationOrigin of transaction.  
125 | 126 | 127 | -------------------------------------------------------------------------------- /source/includes/entityref/paybill/_billingsyncerror.md: -------------------------------------------------------------------------------- 1 | # Pay and Bill - BillingSyncError 2 | 3 | Logs errors encountered during billing synchronization, capturing critical details for troubleshooting and ensuring data integrity. 4 | Dynamic insert and update via billing-sync-services. 5 | 6 | CRUD Access - READ 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 74 | 75 | 76 | 77 | 78 | 79 | 80 | 81 | 82 | 83 | 84 | 85 | 86 | 87 | 88 | 89 | 90 | 91 | 92 | 93 | 94 | 95 | 96 | 97 | 98 | 99 | 100 | 101 | 102 | 103 | 104 | 105 | 106 | 107 | 108 | 109 | 110 | 111 |
BillingSyncError fieldsTypeDescriptionNot nullRead-only
idIntegerUnique identifier for this entity.XX
acknowledgedByUserTo-one associationUser who acknowledges the error. X
acknowledgeDateTimestamp   
dateAddedTimestampDate the entity was added.XX
errorCodeString (100)Billing-sync error code.XX
externalIDString (50)User facing unique identifier. X
placementTo-one associationPlacement associated with this error. X
rawDataPacketString (2147483647)Raw data packet. X
rawErrorString (2147483647)Raw error. X
tokensString ( 2147483647)Tokens. X
transactionDateDateDate of transaction. X
transactionOriginTo-one associationTransaction origin. X
112 | 113 | 114 | -------------------------------------------------------------------------------- /source/includes/entityref/paybill/_billmastercustomerrequiredfield.md: -------------------------------------------------------------------------------- 1 | # Pay and Bill - BillMasterCustomerRequiredField 2 | 3 | An entity that represents a [Customer Required Field (CRF)](https://bullhorn.github.io/rest-api-docs/entityref.html#pay-and-bill-customerrequiredfieldconfiguration) associated with a [BillMaster](https://bullhorn.github.io/rest-api-docs/entityref.html#pay-and-bill-billmaster). 4 | 5 | CRUD Access - READ ONLY 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 68 | 69 | 70 | 71 | 72 | 73 | 74 | 75 | 76 | 77 | 78 | 79 | 80 | 81 | 82 | 83 | 84 | 85 | 86 | 87 | 88 | 89 | 90 | 91 | 92 | 93 |
Bill Master Customer Required Field fieldsTypeDescriptionNot nullRead-only
idIntegerUnique identifier for this entity.XX
billMasterTo-one association 36 |

The BillMaster associated with this CRF.

37 |

Default fields:

38 |
    39 |
  • id
    • 40 |
41 | 		XX
customerRequiredFieldMetaTo-one association 49 |

The CRF metadata defining this field.

50 |

Default fields:

51 |
    52 |
  • id
    • 53 |
54 | 		XX
customerRequiredFieldOptionTo-one association 62 |

The selected option for this CRF (if applicable).

63 |

Default fields:

64 |
    65 |
  • id
    • 66 |
67 | 		X
textValueStringThe text value for this CRF (if applicable).X
dateAddedTimestampDate on which this record was created in the Bullhorn system.XX
dateLastModifiedTimestampDate when this record was last modified.XX
94 | -------------------------------------------------------------------------------- /source/includes/entityref/paybill/_billmasterdiscountrate.md: -------------------------------------------------------------------------------- 1 | # Pay and Bill - BillMasterDiscountRate 2 | 3 | Represents an association between [BillMaster](https://bullhorn.github.io/rest-api-docs/entityref.html#pay-and-bill-billmaster) and a [DiscountRate](https://bullhorn.github.io/rest-api-docs/entityref.html#pay-and-bill-discountrate). 4 | 5 | CRUD Access - READ 6 | 7 | Entitlements - None 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 68 | 69 | 70 | 71 | 72 | 73 | 74 | 83 | 84 | 85 | 86 | 87 |
BillMasterDiscountRate fieldsTypeDescriptionNot nullRead-only
idIntegerUnique identifier for this entity.XX
billMasterTo-one association (BillMaster) 38 |

Associated Bill Master.

39 |

Default fields:

40 |
    41 |
  • id
    • 42 |
43 | 		XX
dateAddedTimestampDate the entity was added.XX
discountRateTo-one association (DiscountRate) 58 |

Associated Discount Rate.

59 |

Default fields:

60 |
    61 |
  • id
    • 62 |
  • title
    • 63 |
  • effectiveDate
    • 64 |
  • effectiveEndDate
    • 65 |
  • versionID
    • 66 |
67 | 		XX
ownerTo-one association (CorporateUser) 75 |

Associated Corporate User.

76 |

Default fields:

77 |
    78 |
  • id
    • 79 |
  • firstName
    • 80 |
  • lastName
    • 81 |
82 | 		X
88 | -------------------------------------------------------------------------------- /source/includes/entityref/paybill/_billmastersurchargerate.md: -------------------------------------------------------------------------------- 1 | # Pay and Bill - BillMasterSurchargeRate 2 | 3 | Represents an association between [BillMaster](https://bullhorn.github.io/rest-api-docs/entityref.html#pay-and-bill-billmaster) and a [SurchargeRate](https://bullhorn.github.io/rest-api-docs/entityref.html#pay-and-bill-surchargerate). 4 | 5 | CRUD Access - READ 6 | 7 | Entitlements - None 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 80 | 81 | 82 | 83 | 84 |
BillMasterSurchargeRate fieldsTypeDescriptionNot nullRead-only
idIntegerUnique Identifier for this entity.XX
billMasterTo-one association

Associated Bill Master.

38 |

Default fields:

39 |
    40 |
  • id
    • 41 |
42 | 		 XX
surchargeRateTo-one association

Associated Surcharge Rate.

50 |

Default fields:

51 |
    52 |
  • id
    • 53 |
  • title
    • 54 |
  • effectiveDate
    • 55 |
  • effectiveEndDate
    • 56 |
  • versionID
    • 57 |
58 | 		 XX
dateAddedTimestampDate the entity was added.XX
ownerTo-one association

Associated Corporate User.

73 |

Default fields:

74 |
    75 |
  • id
    • 76 |
  • firstName
    • 77 |
  • lastName
    • 78 |
79 | 		X
85 | -------------------------------------------------------------------------------- /source/includes/entityref/paybill/_billmastertransactiondistributionbatch.md: -------------------------------------------------------------------------------- 1 | # Pay and Bill - BillMasterTransactionDistributionBatch 2 | 3 | Read-only entity used to track which [BillMasterTransactions](https://bullhorn.github.io/rest-api-docs/entityref.html#pay-and-bill-billmastertransactions) are ready for revenue recognition distribution record creation 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 74 | 75 | 84 | 85 | 86 | 87 | 88 |
BillMasterTransactionDistributionBatch fieldsTypeDescriptionNot nullRead-only
idIntegerUnique identifier for this entity.XX
accountingDateDateAccounting Date.  
batchStatusTo-one association (BatchStatusLookup)Status of this entity.X
billableChargesTo-many association (BillableCharge)Billable Charges associated to this entity.
billMasterTransactionsTo-many association (Bill Master Transaction)Bill Master Transactions associated to this entity.
dateAddedTimestampDate on which the entity was created.XX
dateLastModifiedTimestampDate on which the entity was last modified.XX
ownerTo-one association (CorporateUser) 76 |

Corporate User who is the owner of this entity. The default value is the user who created the entity.

77 |

Default fields:

78 |
    79 |
  • id
    • 80 |
  • firstName
    • 81 |
  • lastName
    • 82 |
83 | 		X
-------------------------------------------------------------------------------- /source/includes/entityref/paybill/_billmastertransactionsalestaxdetail.md: -------------------------------------------------------------------------------- 1 | # Pay and Bill - BillMasterTransactionSalesTaxDetail 2 | 3 | Represents the denormalized details of a sales tax rate version for a [BillMasterTransactionSalesTaxRate](https://bullhorn.github.io/rest-api-docs/entityref.html#pay-and-bill-billmastertransactionsalestaxrate). 4 | 5 | CRUD Access - READ 6 | 7 | Entitlements - View Billable Charge 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 74 | 75 |
BillMasterTransactionSalesTaxDetail fieldsTypeDescriptionNot nullRead-only
idIntegerUnique Identifier for this entity.XX
allSalesTaxRateTo-one associationAssociated AllSalesTaxRate.X
billMasterTransactionSalesTaxRatesTo-many association

Associated BillMasterTransactionSalesTaxRates.

45 |

Default fields:

46 |
    47 |
  • id
    • 48 |
49 |

dateAddedTimestampDate the entity was added.XX
jurisdictionNameString (200)


rateBigDecimal
X
76 | -------------------------------------------------------------------------------- /source/includes/entityref/paybill/_billmastertransactionsurchargedetail.md: -------------------------------------------------------------------------------- 1 | # Pay and Bill - BillMasterTransactionSurchargeDetail 2 | 3 | Represents the denormalized details of a surcharge rate for a [BillMasterTransactionSurchargeRate](https://bullhorn.github.io/rest-api-docs/entityref.html#pay-and-bill-billmastertransactionsurchargerate). 4 | 5 | CRUD Access - READ 6 | 7 | Entitlements - View Billable Charge 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 74 | 75 | 76 | 77 | 78 | 79 | 80 | 81 | 82 | 83 | 84 | 85 | 86 | 87 | 88 | 89 | 90 | 91 | 92 | 93 | 94 | 95 |
BillMasterTransactionSurchargeDetail fieldsTypeDescriptionNot nullRead-only
idIntegerUnique Identifier for this entity.XX
billMasterTransactionSurchargeRatesTo-many association

Associated BillMasterTransactionSurchargeRates.

38 |

Default fields:

39 |
    40 |
  • id
    • 41 |
42 |

dateAddedTimestampDate the entity was added.XX
surchargeRateTo-one association

Associated Surcharge Rate.

57 |

Default fields:

58 |
    59 |
  • id
    • 60 |
  • label
    • 61 |
62 | 		XX
titleString (200)


rateDecimal (19, 6)


amountDecimal (19,6)


surchargeRateTypeTo-one association


96 | -------------------------------------------------------------------------------- /source/includes/entityref/paybill/_calendar.md: -------------------------------------------------------------------------------- 1 | # Pay and Bill - Calendar 2 | 3 | Represents a scheduling record that organizes events, appointments, and recurring patterns within the system, serving as the framework for time-based activities. 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 74 | 75 | 76 | 77 | 78 | 79 | 80 |
Calendar fieldsTypeDescriptionNot nullRead-only
idIntegerUnique identifier for this entity.XX
calendarFrequencyLookupTo-one associationCalendarFrequencyLookup.X
dateAddedTimestampDate the entity was added.XX
dateLastModifiedTimestampDate the entity was last modified.X
isCustomBooleanDesignates a calendar with customer generated instances.XX
labelString (100)Title for the calendar.X
offsetIntegerBeginning day for a calendar frequency pattern.
startDateDateX
81 | 82 | 83 | 84 | 85 | 86 | -------------------------------------------------------------------------------- /source/includes/entityref/paybill/_calendarfrequencylookup.md: -------------------------------------------------------------------------------- 1 | # Pay and Bill - CalendarFrequencyLookup 2 | 3 | Serves as a lookup table providing predefined frequency options (such as daily, weekly, monthly) that standardize recurrence intervals for calendar events. 4 | 5 | CRUD Access - READ 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 |
CalendarFrequencyLookup fieldsTypeDescriptionNot nullRead-only
idIntegerUnique identifier for this entity.XX
dateAddedTimestampX
dateLastModifiedTimestampX
isDeletedBooleanX
labelString (100)
62 | 63 | 64 | 65 | 66 | -------------------------------------------------------------------------------- /source/includes/entityref/paybill/_calendarinstance.md: -------------------------------------------------------------------------------- 1 | # Pay and Bill - CalendarInstance 2 | 3 | Denotes a specific scheduled occurrence generated from a recurring [Calendar](https://bullhorn.github.io/rest-api-docs/entityref.html#pay-and-bill-calendar) record, capturing the concrete date, time, and other instance-specific details. 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 74 |
CalendarInstance fieldsTypeDescriptionNot nullRead-only
idIntegerUnique identifier for this entity.XX
calendarTo-one associationCalendar.XX
dateAddedTimestampDate the entity was added.XX
dateLastModifiedTimestampDate the entity was last modified.X
endDateDateEnd date of the calendar instance.X
labelString (150)Title for the calendar instance.X
startDateDateStart date of the calendar instance.X
75 | 76 | 77 | 78 | 79 | -------------------------------------------------------------------------------- /source/includes/entityref/paybill/_citysalestaxrate.md: -------------------------------------------------------------------------------- 1 | # Pay and Bill - CitySalesTaxRate 2 | 3 | A SalesTaxRate with TaxJurisdictionTypeLookup = City -------------------------------------------------------------------------------- /source/includes/entityref/paybill/_clientcorporationbillrulesetversion.md: -------------------------------------------------------------------------------- 1 | # Pay and Bill - ClientCorporationBillRulesetVersion 2 | 3 | Represents a version entity for the [ClientCorporationBillRuleset](https://bullhorn.github.io/rest-api-docs/entityref.html#pay-and-bill-clientcorporationbillruleset) effective-dated entity. 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 |
ClientCorporationBillRulesetVersion fieldsTypeDescriptionNot nullRead-only
idIntegerUnique identifier for this entity.XX
dateAddedTimestampDate the entity was added.XX
dateLastModifiedTimestampDate the entity was last modified.XX
effectiveDateDateThis is the date when the record is effective.X
effectiveEndDateDateThis is the date until when the record is effective.
isFirstBooleanTrue if this is the first client corporation bill ruleset version.X
timeLaborEvalRulesTo-many associationTimeLaborEvalRule.
74 | -------------------------------------------------------------------------------- /source/includes/entityref/paybill/_clientcorporationpayrulesetversion.md: -------------------------------------------------------------------------------- 1 | # Pay and Bill - ClientCorporationPayRulesetVersion 2 | 3 | Represents a version entity for the [ClientCorporationPayRuleset](https://bullhorn.github.io/rest-api-docs/entityref.html#pay-and-bill-clientcorporationpayruleset) effective-dated entity. 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 |
ClientCorporationPayRulesetVersion fieldsTypeDescriptionNot nullRead-only
idIntegerUnique identifier for this entity.XX
dateAddedTimestampDate the entity was added.XX
dateLastModifiedTimestampDate the entity was last modified.XX
effectiveDateDateThis is the date when the record is effective.X
effectiveEndDateDateThis is the date until when the record is effective.
isFirstBooleanTrue if this is the first client corporation pay ruleset version.X
timeLaborEvalRulesTo-many associationTimeLaborEvalRule.
74 | -------------------------------------------------------------------------------- /source/includes/entityref/paybill/_countysalestaxrate.md: -------------------------------------------------------------------------------- 1 | # Pay and Bill - CountySalesTaxRate 2 | 3 | A SalesTaxRate with TaxJurisdictionTypeLookup = County -------------------------------------------------------------------------------- /source/includes/entityref/paybill/_customerrequiredfieldconfigurationversionoption.md: -------------------------------------------------------------------------------- 1 | # Pay and Bill - CustomerRequiredFieldConfigurationVersionOption 2 | 3 | An entity that represents the [CustomerRequiredFieldOptions](https://bullhorn.github.io/rest-api-docs/entityref.html#pay-and-bill-customerrequiredfieldoption) available for a particular [CustomerRequiredFieldConfigurationVersion](https://bullhorn.github.io/rest-api-docs/entityref.html#pay-and-bill-customerrequiredfieldconfigurationversion). 4 | 5 | CRUD ACCESS - READ ONLY 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 74 | 75 | 76 | 77 | 78 | 79 | 80 | 81 | 82 |
Customer Required Field Configuration Version Option fieldsTypeDescriptionNot nullRead-only
customerRequiredFieldConfigurationVersionOptionIdIntegerUnique identifier for this entity.XX
customerRequiredFieldConfigurationVersionMany-to-one association 36 |

The associated Customer Required Field version.

37 |

Default fields:

38 |
    39 |
  • id
    • 40 |
  • effectiveDate
    • 41 |
  • effectiveEndDate
    • 42 |
43 | 		XX
customerRequiredFieldOptionOne-to-One association 51 |

The associated Customer Required Field option.

52 |

Default fields:

53 |
    54 |
  • id
    • 55 |
56 | 		X
dateAddedTimeStampDate the entity was added.XX
dateLastModifiedTimeStampDate the entity was modified last.XX
sortOrderIntegerThe order this versionOption will use for sorting.X
83 | 84 | -------------------------------------------------------------------------------- /source/includes/entityref/paybill/_customerrequiredfieldplacementconfiguration.md: -------------------------------------------------------------------------------- 1 | # Pay and Bill - CustomerRequiredFieldPlacementConfiguration 2 | An entity that represents a Customer Required Field (CRF) configuration for a Placement. It extends CustomerRequiredFieldConfigurationBase to manage CRF versions. 3 | 4 | CRUD Access - READ ONLY 5 | 6 | Entitlements - View Customer Required Field Configuration 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 |
Customer Required Field Placement Configuration fieldsTypeDescriptionNot nullRead-only
idIntegerUnique identifier for this entity.XX
placementTo-one association 36 |

The placement associated with this CRF configuration.

37 |

Default fields:

38 |
    39 |
  • id
    • 40 |
41 | 		XX
versionsTo-many association 49 |

Collection of CustomerRequiredFieldConfigurationVersion objects associated with this configuration.

50 |

Ordered by effectiveDate.

51 | 		X
dateAddedTimestampDate on which this record was created in the Bullhorn system.XX
dateLastModifiedTimestampDate when this record was last modified.XX
71 | -------------------------------------------------------------------------------- /source/includes/entityref/paybill/_customerrequiredfieldvaluetypelookup.md: -------------------------------------------------------------------------------- 1 | # Pay and Bill - CustomerRequiredFieldValueTypeLookup 2 | 3 | Acts as a reference for the allowed data types for customer required fields, ensuring proper validation and consistency across record entries. 4 | 5 | CRUD Access - READ ONLY 6 | 7 | Entitlements - View Client Customer Required Field 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 |
Customer Required Field Value Type Lookup fieldsTypeDescriptionNot nullRead-only
idIntegerUnique identifier for this entity.XX
labelStringLabel for the value type.XX
isDeletedBooleanIndicates whether this record has been marked as deleted in the Bullhorn system.XX
50 | Pre-defined Values: 51 | 52 | Text (1) 53 | Custom Picker (2) 54 | Purchase Order (3) 55 | -------------------------------------------------------------------------------- /source/includes/entityref/paybill/_directdepositaccounttypelookup.md: -------------------------------------------------------------------------------- 1 | # Pay and Bill - DirectDepositAccountTypeLookup 2 | 3 | Provides a standardized set of lookup values that classify the types of [DirectDepositAccounts](https://bullhorn.github.io/rest-api-docs/entityref.html#pay-and-bill-directdepositaccount) (for example, checking or savings) used during payment processing. 4 | 5 | CRUD Access - READ 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 |
DirectDepositAccountTypeLookup fieldsTypeDescriptionNot nullRead-only
idIntegerUnique identifier for this entity.XX
hasIntegrationBooleanIndicates whether the Direct Deposit Account Type needs to be picked up by the API for processes like registration of a pay card.X
isDeletedBooleanWhether the direct deposit type is deletedX
isPayCardBooleanIdentifies whether the record is marked as a Pay Card account type within the Bullhorn systemX
labelString (50)Name of the Direct Deposit Type
-------------------------------------------------------------------------------- /source/includes/entityref/paybill/_districtsalestaxrate.md: -------------------------------------------------------------------------------- 1 | # Pay and Bill - DistrictSalesTaxRate 2 | 3 | A SalesTaxRate with TaxJurisdictionTypeLookup = District -------------------------------------------------------------------------------- /source/includes/entityref/paybill/_generalledgeraccount.md: -------------------------------------------------------------------------------- 1 | # Pay and Bill - GeneralLedgerAccount 2 | 3 | Identifies a specific account in the general ledger used to record and categorize financial transactions, supporting the overall accounting structure; including [EarnCodes](https://bullhorn.github.io/rest-api-docs/entityref.html#pay-and-bill-earncode) and [InvoiceTerms](https://bullhorn.github.io/rest-api-docs/entityref.html#pay-and-bill-invoiceterm). 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 63 | 64 | 65 | 66 | 67 | 68 | 70 | 72 | 73 | 74 | 75 | 76 | 77 | 78 | 80 | 81 | 82 | 83 | 84 | 85 | 86 | 88 | 89 | 90 | 91 | 92 | 93 | 94 | 96 | 97 | 98 | 99 | 100 |
GeneralLedgerAccount fieldsTypeDescriptionNot nullRead-only

id

Integer

Unique identifier for this entity.

X

 

externalAccountNumberString (100)

External account number.

 X 
externalAccountName

String (100)

External account name.

 X 
externalAccountType

String (100)

External account type.

X 
externalAccountDetailType

String (100)

External account detail type.

X 
isAccountsReceivable

Boolean

Is accounts receivable account.

62 |

The default value is false.

X 
isActive

Boolean

69 |

 

Is active account.

71 |

The default value is true.

X 
isBill

Boolean

Is bill account.

79 |

The default value is false.

X 
isDeleted

Boolean

Whether entity is deleted.

87 |

The default value is false.

X 
isPay

Boolean

Is pay account.

95 |

The default value is false.

X 
101 | 102 | 103 | -------------------------------------------------------------------------------- /source/includes/entityref/paybill/_generalledgersegment.md: -------------------------------------------------------------------------------- 1 | # Pay and Bill - GeneralLedgerSegment 2 | 3 | Represents a general ledger segment for assignment to [Placement](https://bullhorn.github.io/rest-api-docs/entityref.html#placement), [BillableCharge](https://bullhorn.github.io/rest-api-docs/entityref.html#pay-and-bill-billablecharge), and [PayableCharge](https://bullhorn.github.io/rest-api-docs/entityref.html#pay-and-bill-payablecharge). 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 64 | 65 | 66 | 67 | 68 |
GeneralLedgerSegment fieldsTypeDescriptionNot nullRead-only

id

Integer

Unique identifier for this entity.

X

 

externalSegmentNameString (100)

External segment  number.

 X 
externalSegmentNumber

String (100)

External segment name.

 X 
generalLedgerSegmentType

To-one association

GeneralLedger.XX
isActive

Boolean

Is active account.

55 |

The default value is true.

X 
isDeleted

Boolean

Whether entity is deleted.

63 |

The default value is false.

XX
69 | 70 | 71 | -------------------------------------------------------------------------------- /source/includes/entityref/paybill/_generalledgersegmenttype.md: -------------------------------------------------------------------------------- 1 | # Pay and Bill - GeneralLedgerSegmentType 2 | 3 | Provides a lookup reference that defines the various types or classifications of segments used within the general ledger, ensuring consistency in financial segmentation. 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 |
GeneralLedgerSegmentType fieldsTypeDescriptionNot nullRead-only
idIntegerUnique identifier for this entity.XX
descriptionString (100)Description. X X
segmentTypeString (100)Segment type.XX
46 | 47 | 48 | -------------------------------------------------------------------------------- /source/includes/entityref/paybill/_generalledgerservicecode.md: -------------------------------------------------------------------------------- 1 | # Pay and Bill - GeneralLedgerServiceCode 2 | 3 | pecifies a designated code that correlates services with their financial entries in the general ledger, ensuring that revenue and expense transactions are properly identified and allocated. 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 57 | 58 | 60 | 61 | 62 |
GeneralLedgerServiceCode fieldsTypeDescriptionNot nullRead-only
idIntegerUnique identifier for this entity.XX
externalServiceCodeNumberIntegerExternal service code number.X 
externalServiceCodeNameString (100)External service code name. X 
isActiveBoolean

Whether this Is active account.

48 |

The default value is true.

X 
isDeletedBoolean

Whether entity is deleted.

56 |

The default value is false.

X

X

59 |

 

63 | 64 | 65 | -------------------------------------------------------------------------------- /source/includes/entityref/paybill/_holidayinstance.md: -------------------------------------------------------------------------------- 1 | # Pay and Bill - HolidayInstance 2 | 3 | Denotes a specific occurrence of a [Holiday](https://bullhorn.github.io/rest-api-docs/entityref.html#pay-and-bill-holiday) on the calendar, created from recurring holiday definitions, and captures the exact date and any instance-specific details needed for operational adjustments. 4 | 5 | CRUD Access - READ. 6 | 7 | Entitlements - Manage Holidays. 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 74 | 75 | 76 | 77 |
HolidayInstance fieldsTypeDescriptionNot nullRead-only
idIntegerUnique identifier for this entity.XX
dateAddedTimestampDate the entity was added.XX
dateLastModifiedTimestampDate the entity was last modified.
endAtTimestampDate/time when the holiday instance will end.XX
holidayTo-one associationHoliday associated with the holiday instance.XX
modifyingUserTo-one associationCorporateUser that modified the entity.XX
startAtTimestampDate/time when the holiday instance will start.XX
78 | -------------------------------------------------------------------------------- /source/includes/entityref/paybill/_invoicestatementlineitemsurchargerate.md: -------------------------------------------------------------------------------- 1 | # Pay and Bill - InvoiceStatementLineItemSurchargeRate 2 | 3 | Represents the rounded subtotals for unique [SurchargeRate](https://bullhorn.github.io/rest-api-docs/entityref.html#pay-and-bill-surchargerate) tied to an [InvoiceStatementLineItem](https://bullhorn.github.io/rest-api-docs/entityref.html#pay-and-bill-invoicestatementlineitem). 4 | 5 | CRUD Access - READ 6 | 7 | Entitlements - View Any Invoice Statement 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 70 | 71 | 72 | 73 | 74 | 75 | 77 | 78 | 79 | 80 | 81 | 82 | 83 | 84 | 85 | 86 | 87 | 88 | 89 | 90 | 91 | 92 | 93 | 94 | 95 | 96 |
InvoiceStatementLineItemSurchargeRate fieldsTypeDescriptionNot nullRead-only
idIntegerUnique Identifier for this entity.XX
baseAmountBigDecimal
 XX
billMasterTransactionSurchargeDetailTo-one association

Associated BillMasterTransactionSurchargeDetail.

45 |

Default fields:

46 |
    47 |
  • id
    • 48 |
49 |

surchargetAmountBigDecimal
XX
surchargeRateTo-one association

Associated surcharge Rate.

64 |

Default fields:

65 |
    66 |
  • id
    • 67 |
  • label
    • 68 |
69 | 		XX
invoiceStatementLineItem

To-One association

76 |

(InvoiceStatementLineItem)

The Invoice Statement Line Item object tied to this entity.

rateBigDecimal
X
titleString (200)


97 | -------------------------------------------------------------------------------- /source/includes/entityref/paybill/_invoicestatementsurchargerate.md: -------------------------------------------------------------------------------- 1 | # Pay and Bill - InvoiceStatementSurchargeRate 2 | 3 | Represents the rounded subtotals for unique [SurchargeRate](https://bullhorn.github.io/rest-api-docs/entityref.html#pay-and-bill-surchargerate) tied to an [InvoiceStatement](https://bullhorn.github.io/rest-api-docs/entityref.html#pay-and-bill-invoicestatement). 4 | 5 | CRUD Access - READ 6 | 7 | Entitlements - View Any Invoice Statement 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 70 | 71 | 72 | 73 | 74 | 75 | 77 | 78 | 79 | 80 | 81 | 82 | 83 | 84 | 85 | 86 | 87 | 88 | 89 | 90 | 91 | 92 | 93 | 94 | 95 | 96 |
InvoiceStatementSurchargeRate fieldsTypeDescriptionNot nullRead-only
idIntegerUnique Identifier for this entity.XX
baseAmountBigDecimal
 XX
billMasterTransactionSurchargeDetailTo-one association

Associated BillMasterTransactionSurchargeDetail.

45 |

Default fields:

46 |
    47 |
  • id
    • 48 |
49 |

surchargeAmountBigDecimal
XX
surchargeRateTo-one association

Associated Surcharge Rate.

64 |

Default fields:

65 |
    66 |
  • id
    • 67 |
  • label
    • 68 |
69 | 		XX
invoiceStatement

To-One association

76 |

(InvoiceStatement)

The Invoice Statement object tied to this Invoice Statement Surcharge Rate.

rateBigDecimal
X
titleString (200)


97 | -------------------------------------------------------------------------------- /source/includes/entityref/paybill/_invoicestatementtemplate.md: -------------------------------------------------------------------------------- 1 | # Pay and Bill - InvoiceStatementTemplate 2 | 3 | Provides a predefined layout and formatting structure for generating invoice statements, ensuring that all necessary elements—like line items and totals—are consistently presented in billing documents. 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 74 | 75 | 76 | 77 | 78 | 79 | 80 | 81 | 82 | 83 | 84 | 85 | 86 | 87 | 88 | 89 | 90 | 91 | 92 | 93 | 94 | 95 | 96 | 97 | 98 | 99 | 100 | 101 | 102 | 103 | 104 | 105 | 106 | 107 | 108 |
InvoiceStatementTemplate fieldsTypeDescriptionNot nullRead-only
idIntegerUnique identifier for this entity.XX
contentSubTypeString (64)
contentTypeString (64)
dateAddedTimestampX
dateLastModifiedTimestampX
descriptionString (2147483647)X
directoryString (2147483647)
fileExtensionString (10)X
fileOwnerTo-one AssociationCorporateUser.
fileSizeIntegerX
nameString (255)X
typeString (100)X
109 | 110 | 111 | 112 | 113 | -------------------------------------------------------------------------------- /source/includes/entityref/paybill/_joborderbillrulesetversion.md: -------------------------------------------------------------------------------- 1 | # Pay and Bill - JobOrderBillRulesetVersion 2 | 3 | Represents a version entity for the JobOrderBillRuleset effective-dated entity. 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 |
JobOrderBillRulesetVersion fieldsTypeDescriptionNot nullRead-only
idIntegerUnique identifier for this entity.XX
dateAddedTimestampDate the entity was added.XX
dateLastModifiedTimestampDate the entity was last modified.XX
effectiveDateDateThis is the date when the record is effective.X
effectiveEndDateDateThis is the date until when the record is effective.
isFirstBooleanTrue if this is the first job order bill ruleset version.X
timeLaborEvalRulesTo-many associationTimeLaborEvalRule.
74 | -------------------------------------------------------------------------------- /source/includes/entityref/paybill/_joborderpayrulesetversion.md: -------------------------------------------------------------------------------- 1 | # Pay and Bill - JobOrderPayRulesetVersion 2 | 3 | Represents a version entity for the JobOrderPayRuleset effective-dated entity. 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 |
JobOrderPayRulesetVersion fieldsTypeDescriptionNot nullRead-only
idIntegerUnique identifier for this entity.XX
dateAddedTimestampDate the entity was added.XX
dateLastModifiedTimestampDate the entity was last modified.XX
effectiveDateDateThis is the date when the record is effective.X
effectiveEndDateDateThis is the date until when the record is effective.
isFirstBooleanTrue if this is the first job order pay ruleset version.X
timeLaborEvalRulesTo-many associationTimeLaborEvalRule.
74 | -------------------------------------------------------------------------------- /source/includes/entityref/paybill/_joborderratecardversion.md: -------------------------------------------------------------------------------- 1 | # Pay and Bill - JobOrderRateCardVersion 2 | 3 | Represents a version entity for the JobOrderRateCard effective-dated entity. 4 | For more information see [how rate card calculations work](https://bullhorn.github.io/Rate-Card-Entities-and-Calculations/) 5 | 6 | CRUD Access - CREATE, READ, UPDATE, DELETE. 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 77 | 78 | 79 | 80 | 81 |
JobOrderRateCardVersion fieldsTypeDescriptionNot nullRead-only
idIntegerUnique identifier for this entity.XX
dateAddedTimestampDate the entity was added.X
dateLastModifiedTimestampX
effectiveDateDateX
effectiveEndDateDate
isFirstBooleanX
jobOrderRateCardLineGroupsTo-many associationJobOrderRateCardLineGroup 72 |

Default fields:

73 |
    74 |
  • id
    • 75 |
76 | 		X
82 | 83 | 84 | 85 | 86 | 87 | 88 | -------------------------------------------------------------------------------- /source/includes/entityref/paybill/_legalBusinessEntity.md: -------------------------------------------------------------------------------- 1 | # Pay and Bill - LegalBusinessEntity 2 | 3 | Captures the formal, legally recognized details of a business entity—such as its legal name and structure—used for contractual, billing, and compliance purposes. 4 | 5 | | **LegalBusinessEntity field** | **Type** | **Description** | **Not null** | **Read-only** | 6 | | --- | --- | --- | --- | --- | 7 | | id | Integer | Unique identifier for this entity. | X | X | 8 | | countryID | Integer | The ID code representing the country associated with this legal business entity. | X | | 9 | | dateAdded | Timestamp | Date on which the entity was created. | X | | 10 | | defaultCurrencyUnit | To-one association | The currency unit assigned as the default for this legal business entity. | X | | 11 | | isDeleted | Boolean | Indicates whether this record has been marked as deleted in the Bullhorn system.| X | | 12 | | legalName | String | The long-form legal name of this legal business entity. | X | | 13 | | legalEntityNumber | String | The string value representing the legal business number for this entity. | X | | 14 | | shortName | String | The shortened name used to represent this legal business entity. | X | | 15 | | statusLookup | To-one association | An associated value representing the status of this legal business entity. A status of "Active" is a value of 1 and a status of "Inactive" is a value of 2. | X | | 16 | -------------------------------------------------------------------------------- /source/includes/entityref/paybill/_othersalestaxrate.md: -------------------------------------------------------------------------------- 1 | # Pay and Bill - OtherSalesTaxRate 2 | 3 | A SalesTaxRate with TaxJurisdictionTypeLookup = Other -------------------------------------------------------------------------------- /source/includes/entityref/paybill/_paybillcycle.md: -------------------------------------------------------------------------------- 1 | # Pay and Bill - PayBillCycle 2 | 3 | Defines a recurring time period or schedule over which payroll or payable transactions are processed, establishing the cycle for calculating and disbursing payments. 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 74 | 75 | 76 | 77 | 78 | 79 | 80 | 81 | 82 | 83 | 84 | 85 | 86 | 87 | 88 | 89 | 90 | 91 | 92 | 93 | 94 |
PayBillCycle fieldsTypeDescriptionNot nullRead-only
idIntegerUnique identifier for this entity.XX
billEvalEnabledBooleanEnabled for billing cycle.X
billingCalendarTo-one associationCalendar.
billingCalendarFrequencyLookupTo-one associationCalendarFrequencyLookup.
dateAddedTimestampDate the entity was added.XX
dateLastModifiedTimestampDate the entity was last modified.X
invoiceCycleEnabledBooleanEnabled for invoice cycle.X
labelString (100)LabelX
payEvalEnabledBooleanEnabled for pay cycle.X
timesheetEnabledBooleanEnabled for timesheet cycle.X
95 | 96 | 97 | 98 | 99 | -------------------------------------------------------------------------------- /source/includes/entityref/paybill/_paymaster.md: -------------------------------------------------------------------------------- 1 | # Pay and Bill - PayMaster 2 | 3 | Serves as the master record for a payroll cycle, aggregating overall payment details and linking together individual transactions for accurate financial reconciliation. 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 69 | 70 | 71 | 72 | 73 | 74 | 75 | 80 | 81 | 82 | 83 | 84 | 85 | 86 | 87 | 88 | 89 | 90 | 91 |
PayMaster fieldsTypeDescriptionNot nullRead-only
idIntegerUnique identifier for this entity.XX
billingSyncBatchTo-one association

Billing sync batch.

34 |

Default fields:

35 |
    36 |
  • id
    • 37 |
X 
canExportBoolean X 
earnCodeTo-one association

Earn code.

52 |

Default fields:

53 |
    54 |
  • id
    • 55 |
  • externalID
    • 56 |
  • title
    • 57 |
X 
payMasterTransactionsTo-many association

Pay master transaction.

65 |

Default fields:

66 |
    67 |
  • id
    • 68 |
 X
payableChargeTo-one association

Payable charge.

76 |

Default fields:

77 |
    78 |
  • id
    • 79 |
XX
transactionDate

Date

Transaction date.

X 
92 | 93 | 94 | -------------------------------------------------------------------------------- /source/includes/entityref/paybill/_placementbillrulesetversion.md: -------------------------------------------------------------------------------- 1 | # Pay and Bill - PlacementBillRulesetVersion 2 | 3 | Represents a version entity for the [PlacementBillRuleset](https://bullhorn.github.io/rest-api-docs/entityref.html#pay-and-bill-placementbillruleset) effective-dated entity. 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 |
PlacementBillRulesetVersion fieldsTypeDescriptionNot nullRead-only
idIntegerUnique identifier for this entity.XX
dateAddedTimestampDate the entity was added.XX
dateLastModifiedTimestampDate the entity was last modified.XX
effectiveDateDateThis is the date when the record is effective.X
effectiveEndDateDateThis is the date until when the record is effective.
isFirstBooleanTrue if this is the first placement bill ruleset version.X
timeLaborEvalRulesTo-many associationTimeLaborEvalRule.
74 | -------------------------------------------------------------------------------- /source/includes/entityref/paybill/_placementpayrulesetversion.md: -------------------------------------------------------------------------------- 1 | # Pay and Bill - PlacementPayRulesetVersion 2 | 3 | Represents a version entity for the [PlacementPayRuleset](https://bullhorn.github.io/rest-api-docs/entityref.html#pay-and-bill-placementpayruleset) effective-dated entity. 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 74 |
PlacementPayRulesetVersion fieldsTypeDescriptionNot nullRead-only
idIntegerUnique identifier for this entity.XX
dateAddedTimestampDate the entity was added.XX
dateLastModifiedTimestampDate the entity was last modified.XX
effectiveDateDateThis is the date when the record is effective.X
effectiveEndDateDateThis is the date until when the record is effective.
isFirstBooleanTrue if this is the first placement pay ruleset version.X
timeLaborEvalRulesTo-many associationTimeLaborEvalRule.
75 | -------------------------------------------------------------------------------- /source/includes/entityref/paybill/_placementratecardversion.md: -------------------------------------------------------------------------------- 1 | # Pay and Bill - PlacementRateCardVersion 2 | 3 | Represents a version entity for the [PlacementRateCard](https://bullhorn.github.io/rest-api-docs/entityref.html#pay-and-bill-placementratecard) effective-dated entity. 4 | For more information see [how rate card calculations work](https://bullhorn.github.io/Rate-Card-Entities-and-Calculations/) 5 | 6 | CRUD Access - CREATE, READ, UPDATE, DELETE. 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 77 | 78 | 79 | 80 | 81 |
PlacementRateCardVersion fieldsTypeDescriptionNot nullRead-only
idIDUnique identifier for this entity.XX
dateAddedTimestampDate the entity was added.XX
dateLastModifiedTimestampDate last modified.XX
effectiveDateDateX
effectiveEndDateDateX
isFirstBooleanX
placementRateCardLineGroupsTo-many associationPlacementRateCardLineGroup. 72 |

Default fields:

73 |
    74 |
  • id
    • 75 |
76 | 		X
82 | 83 | 84 | 85 | 86 | 87 | 88 | 89 | -------------------------------------------------------------------------------- /source/includes/entityref/paybill/_statesalestaxrate.md: -------------------------------------------------------------------------------- 1 | # Pay and Bill - StateSalesTaxRate 2 | 3 | A SalesTaxRate with TaxJurisdictionTypeLookup = State -------------------------------------------------------------------------------- /source/includes/entityref/paybill/_surchargerateversionearncode.md: -------------------------------------------------------------------------------- 1 | # Pay and Bill - SurchargeRateVersionEarnCode 2 | 3 | Association table for [SurchargeRateVersion](https://bullhorn.github.io/rest-api-docs/entityref.html#pay-and-bill-surchargerateversion) and [EarnCode](https://bullhorn.github.io/rest-api-docs/entityref.html#pay-and-bill-earncode) 4 | 5 | CRUD Access - CREATE, READ, DELETE 6 | 7 | Entitlements - None 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 38 | 46 | 47 | 48 | 49 | 50 | 51 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 74 | 75 | 76 | 77 | 78 | 79 | 80 |
SurchargeRateVersionEarnCode fieldsTypeDescriptionNot nullRead-only
idIntegerUnique Identifier for this entity.XX
surchargeRateVersion

To-one association

37 |

(SurchargeRateVersion)

SurchargeRateVersion associated with this entity.

39 |

Default fields:

40 |
    41 |
  • id
    • 42 |
  • effectiveDate
    • 43 |
  • effectiveEndDate
    • 44 |
45 | 		X
earnCode

To-one association

52 |

(EarnCode)

EarnCode associated with this entity.X
owner

To-one association

60 |

(CorporateUser)

CorporateUser who created this entity.X
dateAddedTimestampDate this entity was added.X
dateLastModifiedTimestampDate this entity was modified.X
81 | -------------------------------------------------------------------------------- /source/includes/entityref/paybill/_transactionorigin.md: -------------------------------------------------------------------------------- 1 | # Pay and Bill - TransactionOrigin 2 | 3 | Identifies the source or trigger of a transaction, helping to trace its origin whether it’s initiated by a specific event, user action, or system process. 4 | 5 | CRUD - READ 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 |
TransactionOrigin fieldsTypeDescriptionNot nullRead-only
idIntegerUnique identifier for this entity.XX
nameString (100)Name.  
41 | 42 | 43 | -------------------------------------------------------------------------------- /source/includes/entityref/paybill/_transactionstatus.md: -------------------------------------------------------------------------------- 1 | # Pay and Bill - TransactionStatus 2 | 3 | Indicates the current state of a transaction, which helps in monitoring its progress through various processing stages. 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 |
TransactionStatus fieldsTypeDescriptionNot nullRead-only
idIntegerUnique identifier for this entity.XX
nameString (100)Name.  
39 | 40 | 41 | -------------------------------------------------------------------------------- /source/includes/entityref/paybill/_transactiontype.md: -------------------------------------------------------------------------------- 1 | # Pay and Bill - TransactionType 2 | 3 | Categorizes a transaction by its nature—such as fee, adjustment, or payment—ensuring it is processed and reported correctly within the system. 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 |
TransactionType fieldsTypeDescriptionNot nullRead-only
idIntegerUnique identifier for this entity.XX
nameString (100)Name.  
39 | 40 | 41 | -------------------------------------------------------------------------------- /source/includes/entityref/paybill/_unbilledrevenuedistributionbatch.md: -------------------------------------------------------------------------------- 1 | # Pay and Bill - UnbilledRevenueDistributionBatch 2 | 3 | Groups unbilled revenue records into a single batch for systematic processing, enabling a streamlined transition from accrued revenue to invoicing. 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 74 | 75 | 76 | 77 | 78 | 79 | 80 | 81 | 88 | 89 | 90 | 91 | 92 | 93 | 94 | 99 | 100 | 101 | 102 | 103 |
UnbilledRevenueDistributionBatch fieldsTypeDescriptionNot nullRead-only
idIntegerUnique identifier for this entity.XX
batchStatus

To-one association

The associated BatchStatusLookup representing the status of the batch.

34 |

Default fields:

35 |
    36 |
  • id
    • 37 |
X
billableCharges

To-many association

The BillableCharges associated to this batch.

45 |

Default fields:

46 |
    47 |
  • id
    • 48 |
49 |

 

 
canvasReport

To-one association

CanvasReport associated with this batch.

57 |

Default fields:

58 |
    59 |
  • id
    • 60 |
 
dateAddedTimestampTimestamp representing when this batch was added. 
dateLastModifiedTimestampTimestamp representing when this batch was last modified. 
ownerTo-one association

The owner of this batch.

82 |

Default Fields:

83 |
    84 |
  • id
    • 85 |
  • firstName
    • 86 |
  • lastName
    • 87 |
  
unbilledRevenueDistributionsTo-many association

The UnbilledRevenueDistributions that are associated with this batch.

95 |

Default Fields:

96 |
    97 |
  • id
    • 98 |
 X
104 | 105 | 106 | -------------------------------------------------------------------------------- /source/index.html.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: API Reference 3 | 4 | language_tabs: 5 | - shell 6 | 7 | toc_footers: 8 | 9 | includes: 10 | - intro 11 | - authorization 12 | - get 13 | - errors 14 | - allcorpnotes 15 | - association 16 | - entitlements 17 | - entity 18 | - departmententities 19 | - myentities 20 | - file 21 | - find 22 | - login 23 | - massupdate 24 | - meta 25 | - options 26 | - ping 27 | - query 28 | - resume 29 | - savedsearch 30 | - search 31 | - services 32 | - settings 33 | - subscription 34 | - userheadshot 35 | 36 | search: true 37 | --- 38 | -------------------------------------------------------------------------------- /source/javascripts/all.js: -------------------------------------------------------------------------------- 1 | //= require ./lib/_energize 2 | //= require ./app/_lang 3 | //= require ./app/_search 4 | //= require ./app/_toc 5 | -------------------------------------------------------------------------------- /source/javascripts/all_nosearch.js: -------------------------------------------------------------------------------- 1 | //= require ./lib/_energize 2 | //= require ./app/_lang 3 | //= require ./app/_toc 4 | -------------------------------------------------------------------------------- /source/javascripts/app/_search.js: -------------------------------------------------------------------------------- 1 | //= require ../lib/_lunr 2 | //= require ../lib/_jquery 3 | //= require ../lib/_jquery.highlight 4 | (function () { 5 | 'use strict'; 6 | 7 | var content, searchResults; 8 | var highlightOpts = { element: 'span', className: 'search-highlight' }; 9 | 10 | var index = new lunr.Index(); 11 | 12 | index.ref('id'); 13 | index.field('title', { boost: 10 }); 14 | index.field('body'); 15 | index.pipeline.add(lunr.trimmer, lunr.stopWordFilter); 16 | 17 | $(populate); 18 | $(bind); 19 | 20 | function populate() { 21 | $('h1, h2').each(function() { 22 | var title = $(this); 23 | var body = title.nextUntil('h1, h2'); 24 | index.add({ 25 | id: title.prop('id'), 26 | title: title.text(), 27 | body: body.text() 28 | }); 29 | }); 30 | } 31 | 32 | function bind() { 33 | content = $('.content'); 34 | searchResults = $('.search-results'); 35 | 36 | $('#input-search').on('keyup', search); 37 | } 38 | 39 | function search(event) { 40 | unhighlight(); 41 | searchResults.addClass('visible'); 42 | 43 | // ESC clears the field 44 | if (event.keyCode === 27) this.value = ''; 45 | 46 | if (this.value) { 47 | var results = index.search(this.value).filter(function(r) { 48 | return r.score > 0.0001; 49 | }); 50 | 51 | if (results.length) { 52 | searchResults.empty(); 53 | $.each(results, function (index, result) { 54 | var elem = document.getElementById(result.ref); 55 | searchResults.append("
  • " + $(elem).text() + "
    • "); 56 | }); 57 | highlight.call(this); 58 | } else { 59 | searchResults.html('
  • '); 60 | $('.search-results li').text('No Results Found for "' + this.value + '"'); 61 | } 62 | } else { 63 | unhighlight(); 64 | searchResults.removeClass('visible'); 65 | } 66 | } 67 | 68 | function highlight() { 69 | if (this.value) content.highlight(this.value, highlightOpts); 70 | } 71 | 72 | function unhighlight() { 73 | content.unhighlight(highlightOpts); 74 | } 75 | })(); 76 | -------------------------------------------------------------------------------- /source/javascripts/app/_toc.js: -------------------------------------------------------------------------------- 1 | //= require ../lib/_jquery 2 | //= require ../lib/_jquery_ui 3 | //= require ../lib/_jquery.tocify 4 | //= require ../lib/_imagesloaded.min 5 | (function (global) { 6 | 'use strict'; 7 | 8 | var closeToc = function() { 9 | $(".tocify-wrapper").removeClass('open'); 10 | $("#nav-button").removeClass('open'); 11 | }; 12 | 13 | var makeToc = function() { 14 | global.toc = $("#toc").tocify({ 15 | selectors: 'h1, h2', 16 | extendPage: false, 17 | theme: 'none', 18 | smoothScroll: false, 19 | showEffectSpeed: 0, 20 | hideEffectSpeed: 180, 21 | ignoreSelector: '.toc-ignore', 22 | highlightOffset: 60, 23 | scrollTo: -1, 24 | scrollHistory: true, 25 | hashGenerator: function (text, element) { 26 | return element.prop('id'); 27 | } 28 | }).data('toc-tocify'); 29 | 30 | $("#nav-button").click(function() { 31 | $(".tocify-wrapper").toggleClass('open'); 32 | $("#nav-button").toggleClass('open'); 33 | return false; 34 | }); 35 | 36 | $(".page-wrapper").click(closeToc); 37 | $(".tocify-item").click(closeToc); 38 | }; 39 | 40 | // Hack to make already open sections to start opened, 41 | // instead of displaying an ugly animation 42 | function animate() { 43 | setTimeout(function() { 44 | toc.setOption('showEffectSpeed', 180); 45 | }, 50); 46 | } 47 | 48 | $(function() { 49 | makeToc(); 50 | animate(); 51 | setupLanguages($('body').data('languages')); 52 | $('.content').imagesLoaded( function() { 53 | global.toc.calculateHeights(); 54 | }); 55 | }); 56 | })(window); 57 | 58 | -------------------------------------------------------------------------------- /source/stylesheets/_icon-font.scss: -------------------------------------------------------------------------------- 1 | @font-face { 2 | font-family: 'slate'; 3 | src:font-url('slate.eot?-syv14m'); 4 | src:font-url('slate.eot?#iefix-syv14m') format('embedded-opentype'), 5 | font-url('slate.woff2?-syv14m') format('woff2'), 6 | font-url('slate.woff?-syv14m') format('woff'), 7 | font-url('slate.ttf?-syv14m') format('truetype'), 8 | font-url('slate.svg?-syv14m#slate') format('svg'); 9 | font-weight: normal; 10 | font-style: normal; 11 | } 12 | 13 | %icon { 14 | font-family: 'slate'; 15 | speak: none; 16 | font-style: normal; 17 | font-weight: normal; 18 | font-variant: normal; 19 | text-transform: none; 20 | line-height: 1; 21 | } 22 | 23 | %icon-exclamation-sign { 24 | @extend %icon; 25 | content: "\e600"; 26 | } 27 | %icon-info-sign { 28 | @extend %icon; 29 | content: "\e602"; 30 | } 31 | %icon-ok-sign { 32 | @extend %icon; 33 | content: "\e606"; 34 | } 35 | %icon-search { 36 | @extend %icon; 37 | content: "\e607"; 38 | } 39 | -------------------------------------------------------------------------------- /source/stylesheets/print.scss: -------------------------------------------------------------------------------- 1 | @charset "utf-8"; 2 | @import 'normalize'; 3 | @import 'variables'; 4 | @import 'icon-font'; 5 | 6 | /* 7 | Copyright 2008-2013 Concur Technologies, Inc. 8 | 9 | Licensed under the Apache License, Version 2.0 (the "License"); you may 10 | not use this file except in compliance with the License. You may obtain 11 | a copy of the License at 12 | 13 | http://www.apache.org/licenses/LICENSE-2.0 14 | 15 | Unless required by applicable law or agreed to in writing, software 16 | distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 17 | WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the 18 | License for the specific language governing permissions and limitations 19 | under the License. 20 | */ 21 | 22 | $print-color: #999; 23 | $print-color-light: #ccc; 24 | $print-font-size: 12px; 25 | 26 | body { 27 | @extend %default-font; 28 | } 29 | 30 | .tocify, .toc-footer, .lang-selector, .search, #nav-button { 31 | display: none; 32 | } 33 | 34 | .tocify-wrapper>img { 35 | margin: 0 auto; 36 | display: block; 37 | } 38 | 39 | .content { 40 | font-size: 12px; 41 | 42 | pre, code { 43 | @extend %code-font; 44 | @extend %break-words; 45 | border: 1px solid $print-color; 46 | border-radius: 5px; 47 | font-size: 0.8em; 48 | } 49 | 50 | pre { 51 | code { 52 | border: 0; 53 | } 54 | } 55 | 56 | pre { 57 | padding: 1.3em; 58 | } 59 | 60 | code { 61 | padding: 0.2em; 62 | } 63 | 64 | table { 65 | border: 1px solid $print-color; 66 | tr { 67 | border-bottom: 1px solid $print-color; 68 | } 69 | td,th { 70 | padding: 0.7em; 71 | } 72 | } 73 | 74 | p { 75 | line-height: 1.5; 76 | } 77 | 78 | a { 79 | text-decoration: none; 80 | color: #000; 81 | } 82 | 83 | h1 { 84 | @extend %header-font; 85 | font-size: 2.5em; 86 | padding-top: 0.5em; 87 | padding-bottom: 0.5em; 88 | margin-top: 1em; 89 | margin-bottom: $h1-margin-bottom; 90 | border: 2px solid $print-color-light; 91 | border-width: 2px 0; 92 | text-align: center; 93 | } 94 | 95 | h2 { 96 | @extend %header-font; 97 | font-size: 1.8em; 98 | margin-top: 2em; 99 | border-top: 2px solid $print-color-light; 100 | padding-top: 0.8em; 101 | } 102 | 103 | h1+h2, h1+div+h2 { 104 | border-top: none; 105 | padding-top: 0; 106 | margin-top: 0; 107 | } 108 | 109 | h3, h4 { 110 | @extend %header-font; 111 | font-size: 0.8em; 112 | margin-top: 1.5em; 113 | margin-bottom: 0.8em; 114 | text-transform: uppercase; 115 | } 116 | 117 | h5, h6 { 118 | text-transform: uppercase; 119 | } 120 | 121 | aside { 122 | padding: 1em; 123 | border: 1px solid $print-color-light; 124 | border-radius: 5px; 125 | margin-top: 1.5em; 126 | margin-bottom: 1.5em; 127 | line-height: 1.6; 128 | } 129 | 130 | aside:before { 131 | vertical-align: middle; 132 | padding-right: 0.5em; 133 | font-size: 14px; 134 | } 135 | 136 | aside.notice:before { 137 | @extend %icon-info-sign; 138 | } 139 | 140 | aside.warning:before { 141 | @extend %icon-exclamation-sign; 142 | } 143 | 144 | aside.success:before { 145 | @extend %icon-ok-sign; 146 | } 147 | } --------------------------------------------------------------------------------