Bamboohr

Creates a new employee record in the bamboohr system. this endpoint allows you to add a new employee to your company's hr database by providing essential information such as first name and last name. it's typically used when onboarding new hires or adding existing employees to the bamboohr system for the first time. the endpoint supports additional properties beyond the required fields, allowing for flexible and comprehensive employee data entry. however, it's important to note that this endpoint only initiates the employee record and may not include all possible employee information fields available in bamboohr.

Retrieves detailed information for a specific employee within a company's bamboohr system. this endpoint allows you to fetch comprehensive employee data using the employee's unique identifier. it's particularly useful when you need to access or display individual employee records, update employee information, or verify employee details. the endpoint returns all available fields for the employee, which may include personal information, job details, compensation data, and custom fields configured for the company. use this endpoint when you need specific, up-to-date information about a single employee. note that the exact fields returned may vary based on the company's bamboohr configuration and the permissions of the authenticated user making the request.

Retrieves the employee directory for a specified bamboohr company. this endpoint provides a list of employees within the company, including basic information such as names, job titles, and departments. it's useful for getting an overview of the company's workforce or for integrating employee data into other systems. the endpoint should be used when you need a comprehensive list of employees, but it may not include detailed information about each employee. for more specific or detailed employee data, consider using custom reports or individual employee endpoints instead. keep in mind that the amount and type of information returned may depend on the user's permissions within the bamboohr system.

Updates an employee's basic information in the bamboohr system. this endpoint allows you to modify an employee's first name and/or last name. it should be used when there's a need to correct or change an employee's name in the hr records, such as in cases of marriage, divorce, or legal name changes. the endpoint accepts partial updates, meaning you can update either the first name, last name, or both. any additional properties sent in the request will also be accepted due to the 'additionalproperties: true' setting, but their behavior is not specified in this schema. it's important to note that this endpoint only updates name information and should not be used for modifying other employee data such as contact details or job information.

This endpoint allows you to update a specific row in an employee's table within bamboohr. it is used to modify various aspects of an employee's record, such as their job information, location, or organizational structure. the endpoint is particularly useful for keeping employee data up-to-date when changes occur, such as promotions, transfers, or organizational restructuring. it's important to note that this endpoint updates a single row in a specific table, so multiple calls may be necessary for comprehensive employee record updates across different tables.

Creates or updates an employee benefit in the bamboohr system. this endpoint allows you to manage various aspects of an employee's benefit enrollment, including coverage details, financial contributions, and enrollment status. it's primarily used when setting up new benefits for an employee, making changes to existing benefits, or updating enrollment statuses. the endpoint is versatile, handling different types of benefits with various contribution structures for both employees and the company. it's important to note that while many fields are optional, they may be required depending on the specific benefit type and company policies. this endpoint should not be used for bulk updates or to retrieve benefit information; separate endpoints likely exist for those purposes.

This endpoint allows you to create a new dependent for an existing employee in the bamboohr system. it is used to add family members or other individuals who are dependent on the employee, which is crucial for benefits administration, tax purposes, and other hr-related tasks. the endpoint requires detailed information about the dependent, including personal details, contact information, and status indicators. it should be used when onboarding new employees with dependents, updating family information, or managing benefits enrollment periods. note that some fields contain sensitive personal information, so ensure proper data security measures are in place when using this endpoint.

This endpoint updates an employee's withholding information for tax purposes in the bamboohr system. it allows modification of federal, state, and local tax withholding amounts, including any additional withholdings, as well as specifying the applicable tax state and local jurisdiction. this tool should be used when there are changes to an employee's tax situation, such as filing status changes, additional jobs, or relocation. it's crucial for maintaining accurate payroll calculations and tax compliance. the endpoint doesn't calculate tax amounts; it only updates the stored values based on the provided information. users should ensure they have the correct withholding information before making updates, as incorrect data may lead to under or over-withholding of taxes.

Updates the direct deposit account information for a specific employee in the bamboohr system. this endpoint allows you to modify existing direct deposit accounts or add new ones for an employee. it's particularly useful when an employee changes their bank account, adjusts their deposit allocations, or wants to split their paycheck across multiple accounts. the endpoint requires the company domain and employee id in the url path, and accepts an array of account objects in the request body, each detailing the specifics of a direct deposit account. this tool should be used with caution as it directly affects an employee's payment method, and any errors could result in payroll issues.

Creates a new employee pay stub in the bamboohr system. this endpoint allows for the detailed recording of an employee's pay information for a specific pay period, including gross and net pay, taxes, deductions, and direct deposit allocations. it should be used when processing payroll to maintain accurate financial records for each employee. the endpoint captures both current pay period data and year-to-date totals, providing a comprehensive view of an employee's earnings and deductions. it's particularly useful for integrating external payroll systems with bamboohr, ensuring that hr records are synchronized with actual payroll data. note that this endpoint does not process actual payments; it only records the pay stub information in the bamboohr system.

Posts unpaid pay stubs for a specific employee in the bamboohr system. this endpoint allows you to add or update information about pay periods for which an employee has not been paid. it's useful for tracking delayed payments, managing payroll discrepancies, or recording periods of unpaid leave. the function requires the employee's id and an array of unpaid period dates. use this when you need to update an employee's payroll record with periods that haven't been compensated yet. note that this endpoint doesn't process payments; it only records the unpaid periods for tracking and future processing.

This endpoint allows you to add a new time tracking record for an employee in the bamboohr system. it's used to log hours worked, including regular and overtime hours, along with associated details such as pay rates, job codes, and organizational information. the endpoint is essential for accurate time tracking, payroll processing, and reporting within bamboohr. use this when you need to manually input or programmatically add time entries for employees, ensuring that all required fields are provided and optional fields are included as needed for your specific payroll and reporting requirements.

This endpoint allows you to post a comment on a specific application in bamboohr's applicant tracking system. it's used to add notes, feedback, or any relevant information to an applicant's file during the recruitment process. the endpoint requires the company domain and application id to identify where the comment should be added, along with the comment text itself. it's particularly useful for collaboration among hiring team members, documenting interview feedback, or noting important details about an applicant. this function should be used whenever there's a need to update an application with new information in a comment format. note that this endpoint only handles adding comments and does not provide functionality for reading or modifying existing comments.

This endpoint allows you to associate an employee with a specific benefit group in bamboohr for a defined period. it's used when you need to enroll an employee in a new benefits package or update their existing benefits enrollment. the association can be set for a specific time frame or left open-ended for ongoing enrollment. this tool is particularly useful for hr administrators managing employee benefits, especially during onboarding, annual enrollment periods, or when an employee's benefit status changes. note that this endpoint only creates the association; it doesn't provide details about the benefits themselves or handle the actual enrollment process in specific benefit plans.

This endpoint creates a new company benefit in bamboohr. it allows hr administrators to set up various types of employee benefits, including health insurance, retirement plans, and reimbursement programs. the endpoint captures essential details such as benefit type, start and end dates, deduction information, and compliance with aca requirements. use this endpoint when adding a new benefit offering or updating an existing benefit with new terms. it's particularly useful during open enrollment periods or when changing benefit providers. note that this endpoint does not enroll employees in the benefit; it only sets up the benefit at the company level.

Adds a new time off history item to an employee's record in bamboohr. this endpoint is used to retroactively add time off requests to an employee's history, which is useful for maintaining accurate records of past time off, especially when backfilling data or correcting historical entries. it allows hr administrators to ensure that an employee's time off history is complete and up-to-date, which is crucial for accurate leave balance calculations and reporting. the endpoint requires the company domain and employee id to be specified in the url path, ensuring that the time off history item is added to the correct employee's record.

This endpoint allows you to add or update a time off request for a specific employee in bamboohr. it's used to submit new time off requests or modify existing ones, providing detailed information about the request such as start and end dates, type of time off, and any associated notes. this tool is essential for managing employee leave and maintaining accurate records of time off within the bamboohr system. it should be used whenever an employee needs to request time off or when hr needs to update an existing time off request. the endpoint doesn't handle approval workflows directly; it's primarily for creating and updating request data.

The "store time tracking clock entries" endpoint allows you to create or update multiple time tracking entries for employees in bamboohr. this endpoint is used to record working hours, including start and end times, dates, and optional project, task, and note information. it's particularly useful for batch processing of time entries, such as at the end of a pay period or when synchronizing data from another system. use this endpoint when you need to add new time entries or modify existing ones in bulk. it supports creating new entries and updating existing ones by specifying the entry id. the endpoint is designed for efficiency, allowing multiple entries to be processed in a single api call. note that this endpoint does not handle time entry approval workflows or payroll calculations directly. it's primarily for data entry and updates. ensure that the employee ids, project ids, and task ids used in the request correspond to valid entities in your bamboohr system to avoid errors.

This endpoint allows you to store or update multiple time tracking hour entries for employees in bamboohr. it's designed for bulk creation or modification of timesheet entries, enabling efficient management of employee work hours, project time allocation, and task tracking. use this endpoint when you need to submit time entries for one or more employees, associate work hours with specific projects or tasks, or update existing time entries. the endpoint is particularly useful for integrating external time tracking systems with bamboohr or for automating the process of time entry submission. note that while you can create multiple entries in a single request, each entry must contain the required fields (employeeid, date, and hours) to be valid. optional fields allow for more detailed time tracking and management capabilities.

This endpoint creates a new job application in the bamboohr applicant tracking system. it allows for the submission of a candidate's personal information, professional details, and supporting documents for a specific job opening. the endpoint accepts multipart/form-data, enabling the upload of resume and cover letter files along with text-based information. it should be used when a new candidate applies for a job or when bulk-uploading applications from external sources. the endpoint requires at minimum the candidate's first name, last name, and the job id, but allows for a comprehensive application with optional fields covering everything from contact details to educational background.