# Everee Documentation

> Documentation for Everee

## Guides: Getting Started
- [Everee Integration API](https://developer.everee.com/docs/introduction.md)
- [Requests & Responses](https://developer.everee.com/docs/requests-responses.md)
- [Authentication & API Tokens](https://developer.everee.com/docs/authentication-api-tokens.md)
- [Company Instances & Multiple EINs](https://developer.everee.com/docs/multiple-ein-company-instances.md)
- [Rate Limits](https://developer.everee.com/docs/rate-limits.md)

## Guides: Common Workflows
- [Worker Onboarding](https://developer.everee.com/docs/worker-data-and-onboarding.md)
- [Paying Workers](https://developer.everee.com/docs/paying-workers.md)

## Guides: Embedding Experiences
- [Overview](https://developer.everee.com/docs/everee-embed.md): Deliver a native experience without building it from scratch.
- [How to Embed Experiences](https://developer.everee.com/docs/how-to-embed-components-guide.md)
- [Worker Onboarding](https://developer.everee.com/docs/worker-onboarding.md)
- [Everee Visa® Pay Card Signup](https://developer.everee.com/docs/embedding-everee-pay-card.md)
- [Component Events](https://developer.everee.com/docs/handling-events.md)
  - [React Native: ReactNativeWebview library](https://developer.everee.com/docs/react-native-reactnativewebview-library.md)
  - [Web & React: <iframe>](https://developer.everee.com/docs/web-react-iframe.md)
  - [Native iOS: WKWebView](https://developer.everee.com/docs/native-ios-wkwebview.md)
  - [Native Android: WebView](https://developer.everee.com/docs/native-android-webview.md)
  - [Flutter: webview_flutter](https://developer.everee.com/docs/flutter-webview_flutter.md)

## Guides: Webhook Events
- [Webhook Events Overview](https://developer.everee.com/docs/events-overview.md)

## Guides: Migration Guides
- [Complying with the OBBBA overtime rule](https://developer.everee.com/docs/complying-with-obbba-overtime-rule.md)
- [Paying-out Payables with regular payroll](https://developer.everee.com/docs/september-24-asap-payouts-for-payables.md)
- [Leave Policy module](https://developer.everee.com/docs/migrating-to-the-leave-policies-module.md)

## Guides: White Label
- [Branding & User Access](https://developer.everee.com/docs/branding-user-access.md)

## API Reference: Timesheets API
- [⏰ Start here! Guide to the Timesheets API](https://developer.everee.com/reference/using-the-timesheets-api.md)
- [Update classified hours for entire pay period](https://developer.everee.com/reference/update-classified-hours-for-pay-period-bulk.md)
- [Create a shift on an employee’s timesheet](https://developer.everee.com/reference/add-a-shift-to-an-employees-time-card.md): Add a shift to an employee’s timesheet to record hours worked on the clock.
- [Update a shift on an employee’s timesheet](https://developer.everee.com/reference/update-a-shift-on-an-employees-time-card.md): This endpoint allows you to make changes to shifts already recorded on a worker's timesheet.
- [Delete a shift on an employee’s timesheet](https://developer.everee.com/reference/delete-a-shift-on-an-employees-time-card.md): Delete a shift by ID.
- [Retrieve a shift by ID](https://developer.everee.com/reference/retrieve-shift-by-id.md): Retrieves one shift using its ID.
- [List shifts on an employee’s timesheet](https://developer.everee.com/reference/listing-shifts-on-an-employees-time-card.md): Lists shifts recorded on employees' timesheets. These shifts can be filtered by employee and start/end dates. Date parameters named "*-work-location-*" are respective to the time zone of employees'…

## API Reference: Payables API
- [💵 Guide to the Payables API](https://developer.everee.com/reference/payables-api-guide.md)
- [Create or update payable item](https://developer.everee.com/reference/createpayable.md): Creates or updates a payable item.
- [Create Payable Items (bulk)](https://developer.everee.com/reference/createpayablesbulk.md): Creates new Payables in bulk.
- [Prepare Payable Items for Payout](https://developer.everee.com/reference/createpayablepaymentrequest.md): Prepares outstanding payable items for approval and payout. After calling this endpoint, payments will be available in the Payments screen in the admin portal.
- [Update Payable Item by ID](https://developer.everee.com/reference/updatepayable.md): Update a payable item's data fields. Only unpaid payable items may be updated.
- [Get Payable Item by ID](https://developer.everee.com/reference/getpayable.md): Retrieve a payable item. Includes a 'paymentStatus' field if payment has been requested for this payable item.
- [List Payable Items](https://developer.everee.com/reference/listpayables.md): Retrieve a paged list of payable items. Can be filtered by various parameters.
- [List Unpaid Payable Items](https://developer.everee.com/reference/getpayablesunpaidforworker.md): Retrieve a paged list of unpaid payable items for a worker. These payable items have not yet been paid-out.
- [Delete Payable Item by ID](https://developer.everee.com/reference/deletepayable.md): Delete a payable item. Only unpaid payable items may be deleted.
- [Delete payable items by ID (bulk)](https://developer.everee.com/reference/delete-payable-items-by-id-bulk.md)

## API Reference: Embedded Experience API
- [Create embedded experience URL](https://developer.everee.com/reference/create-embedded-experience-url.md): Creates a magic link for an embedded experience that can be started by opening the returned URL in a webview.
- [Create contractor for embedded onboarding](https://developer.everee.com/reference/add-a-contractor-for-embedded-onboarding.md): The rest of the contractor’s information will be captured during the embedded onboarding process. Note that this operation will designate the worker as a 1099-issued contractor without a formal…
- [Create employee for embedded onboarding](https://developer.everee.com/reference/add-an-employee-for-embedded-onboarding.md): The rest of the employee’s information will be captured during the embedded onboarding process. Note that this operation will designate the worker as a W2-issued employee with a formal employment…

## API Reference: Create Worker API
- [Look up hiring status for a worker](https://developer.everee.com/reference/look-up-hiring-status-for-a-worker.md)
- [Kick off onboarding for a contractor](https://developer.everee.com/reference/kick-off-onboarding-for-a-contractor.md): Onboarding a contractor requires minimal data to be sent from a client since the rest of the contractor’s information will be captured during the Everee-managed onboarding process. Note that this…
- [Kick off onboarding for an employee](https://developer.everee.com/reference/kick-off-onboarding-for-an-employee.md): Creates a partial profile for a new employee, requiring only minimal data. The rest of the employee’s information will be captured during an Everee-managed onboarding process or directly entered by a…
- [Create a complete contractor record](https://developer.everee.com/reference/add-a-complete-contractor-record.md): A client can choose to add a complete contractor record directly. Note that this operation will designate the worker as a 1099-issued contractor without a formal employment relationship.  The client…
- [Create a complete employee record](https://developer.everee.com/reference/add-a-complete-employee-record.md): Creates a complete employee profile, with all details necessary for the employee to receive ACH direct deposit payments through Everee.
- [Rehire a worker](https://developer.everee.com/reference/rehire-a-worker.md): Rehires a worker who was previously terminated and is eligible for rehire, restoring their existing profile rather than creating a new one.
- [Separate an employee](https://developer.everee.com/reference/separate-an-employee.md): Separates (terminates) a W-2 employee's active employment.
- [Separate a contractor](https://developer.everee.com/reference/separate-a-contractor.md): Separates (terminates) a 1099 contractor's active contract.

## API Reference: Worker Data API
- [List workers](https://developer.everee.com/reference/list-workers.md): Clients can retrieve a list of worker data structures on demand.
- [Search for workers](https://developer.everee.com/reference/search-workers.md): Searches for workers using a string search term.
- [Get worker by ID](https://developer.everee.com/reference/retrieve-a-worker.md): Clients can retrieve the whole worker data structure on demand.
- [Get Everee access invitation](https://developer.everee.com/reference/get-access-details-for-worker.md): Retrieve the "invitation URL" for a worker.
- [Get accrued leave balances](https://developer.everee.com/reference/get-accrued-leave-balances.md): Retrieve the "invitation URL" for a worker.
- [Update personal information](https://developer.everee.com/reference/update-personal-information.md): Clients can update a worker's personal information, including name and date of birth.
- [Update default position & compensation](https://developer.everee.com/reference/update-position-compensation.md): Schedules a change to a W-2 employee's position and/or compensation.
- [Update approval group](https://developer.everee.com/reference/update-approval-group.md)
- [Update payment preferences](https://developer.everee.com/reference/update-payment-preferences.md): Update a worker’s payout settings on behalf of the worker. You can specify whether a worker should be paid via a Pay Card rather than the default setting of ACH-based direct deposit (if available).

## API Reference: Payroll Expenses API
- [📈 Guide to the Payroll Expenses API](https://developer.everee.com/reference/payroll-expenses-api-guide.md)
- [Get payroll expenses by pay period (or date range)](https://developer.everee.com/reference/get-payroll-expenses-by-date-range.md)
- [Get payroll expenses by cost centers](https://developer.everee.com/reference/get-payroll-expenses-by-cost-centers.md)

## API Reference: Early Pay API
- [💸 How Early Pay works](https://developer.everee.com/reference/how-early-pay-works.md)
- [Get Early Pay Status](https://developer.everee.com/reference/get-earnings-on-demand-status.md)
- [Request Early Pay](https://developer.everee.com/reference/request-earnings-on-demand.md)

## API Reference: REAL TIME PAYROLL API
- [Update Real Time Payroll enrollment](https://developer.everee.com/reference/update-real-time-payroll-enrollment.md)

## API Reference: ORGANIZATION API
- [Create a work location](https://developer.everee.com/reference/add-work-location.md): Create new Work Locations using this API endpoint.
- [Update a work location's details](https://developer.everee.com/reference/update-worker-work-location.md): Update a work location's address or name with this endpoint.
- [Archive a work location](https://developer.everee.com/reference/archive-work-location.md): Marks an existing work location as "archived", which removes it from the list of active work locations and frees its "name" value for re-use.
- [Create an approval group](https://developer.everee.com/reference/add-approval-group.md): Retrieve a list of existing Approval Groups using this API.

## API Reference: Leave Policies API
- [List leave policies](https://developer.everee.com/reference/list-leave-policies.md)

## API Reference: Files & Forms API
- [Get W-4 tax withholding settings](https://developer.everee.com/reference/get-w-4-tax-withholding-settings.md): Retrieve a worker's W-4 tax withholding settings. These are the elections made on a federal Form W-4, and they affect the calculation and withholding of federal income tax. Retrieving a worker’s W-4…
- [Get Form W-9 info](https://developer.everee.com/reference/get-w9-info.md): Retrieve a worker's W-9 taxpayer identification info. Retrieving a worker’s W-9 info requires specifying a date for which the info is effective.

## API Reference: Worker Payment History API
- [Retrieve a worker’s pay history](https://developer.everee.com/reference/retrieve-a-workers-pay-history.md): Clients can retrieve a list of payments that have been paid-out to workers. Items returned from these endpoints represent payments that have been successfully processed for deposit.

## API Reference: W-2 Payroll Gross Earnings API
- [Create gross earning for W-2 payroll](https://developer.everee.com/reference/add-gross-earning.md): Adds a single "gross earning" record of a single earning type, rate, count (or duration), and optionally an "external ID" that uniquely identifies the earning in your system.
- [Create bulk gross earnings for W-2 payroll](https://developer.everee.com/reference/add-bulk-gross-earnings.md): Adds multiple "gross earning" records in one operation, each consisting of a single earning type, rate, count (or duration), and optionally a unique "external ID" that identifies the earning in your…
- [Delete gross earnings for W-2 payroll](https://developer.everee.com/reference/delete-gross-earnings-by-date-range.md): Deletes "gross earning" records between a start and end date (inclusive) that have not yet been included in an approved payroll run.  This operation can be used to "clear" gross earnings as part of…

## API Reference: Reference
- [Worker](https://developer.everee.com/reference/workers.md)
- [Earning types](https://developer.everee.com/reference/earning-types.md)