Everee integration guide
VerifiedHow to connect Everee to WEXTL and use its 6 triggers and 61 actions in your workflows. About Everee: Manage workers, payables, shifts, payroll and leave policies in Everee.
- 6 triggers
- 23 searches
- 38 actions
- Polling
- Auth: API key
AI-assisted documentation38 min read
This documentation is compiled from our integration source code, internal specs for Everee, its official API documentation and anonymized requests logs we collect from our support team[2].
Requirements
Get your Everee credentials
Connect Everee in WEXTL
- Log in to your WEXTL account, add the Everee node module to your workflow, and click Create new credential.
- Optional: In the Credential name field, enter a name for the credential.
- Enter the authentication credentials you copied from your Everee account, or follow the on-screen instructions to create the credential.
- If prompted, authenticate your account and confirm access.
- If you want to make changes to your credential in the future, follow the steps in Manage credentials →
Everee triggers and actions on WEXTL
The list below is a reference of every Everee node module the integration supports. You will be able to pick any of them on the workflow canvas while building automations.
Expand any Everee node module below to see exactly what it takes in, what it returns, and what connection it needs.
Watch GL Mappings
TriggerFires for each new ledger mapping on a schedule.
| Field | Type |
|---|---|
| ID | number |
| Category | text |
| Transaction type | text |
| Transaction detail | text |
| Approval group ID | text |
| Work location ID | text |
| Gl code | text |
| Description | text |
| Created at | date |
| Updated at | date |
Watch Payables
TriggerRegular check for payable items.
| Field | Type |
|---|---|
| External ID | text |
| Company ID | number |
| External worker ID | text |
| Type | text |
| Label | text |
| Amount | object |
| Amount | text |
| Currency | text |
| Payable model | text |
| Pay code | text |
| Timestamp | date |
| Payment ID | number |
| Payment status | text |
| Ttoc code | number |
| Cost centers | array |
| Payable payment request ID | number |
Watch Payment Statements
TriggerRecurring check on pay statements of a worker.
| Field | Type |
|---|---|
| ID | text |
| Worker ID | text |
| Date | date |
| Pay period start date | date |
| Pay period end date | date |
| Gross earnings | object |
| Amount | text |
| Currency | text |
| Ytd gross earnings | object |
| Amount | text |
| Currency | text |
| Total taxes ee | object |
| Amount | text |
| Currency | text |
| Pre tax deductions | object |
| Amount | text |
| Currency | text |
| Ytd pre tax deductions | object |
| Amount | text |
| Currency | text |
| Post tax deductions | object |
| Amount | text |
| Currency | text |
| Ytd post tax deductions | object |
| Amount | text |
| Currency | text |
| Deferred compensation | object |
| Amount | text |
| Currency | text |
| Ytd deferred compensation | object |
| Amount | text |
| Currency | text |
| Net earnings | object |
| Amount | text |
| Currency | text |
| Ytd net earnings | object |
| Amount | text |
| Currency | text |
Watch Shifts
TriggerRecurring look at logged shifts.
| Field | Type |
|---|---|
| Worker ID | text |
| Worked shift ID | number |
| Legal work time zone | time |
| Shift start at | object |
| Effective punch at | text |
| Shift end at | object |
| Effective punch at | text |
| Verified at | date |
| Verified by user ID | number |
| Effective pay rate | object |
| Amount | text |
| Currency | text |
| Pay rate overridden | boolean |
| Payable details | object |
| Total payable amount | object |
| Paid | boolean |
| Shift breaks | array |
| Shift durations | object |
| Shift duration | text |
| Paid break duration | text |
| Unpaid break duration | text |
| Regular time worked | object |
| Overtime worked | object |
| Double time worked | object |
Watch Work Locations
TriggerScheduled feed of new work locations.
| Field | Type |
|---|---|
| ID | number |
| Line 1 | text |
| Line 2 | text |
| City | text |
| State | text |
| Postal code | text |
| Latitude | number |
| Longitude | number |
| Time zone | time |
Watch Worker Pay History
TriggerPeriodic pull of worker payments.
| Field | Type |
|---|---|
| Worker ID | text |
| Worker full name | text |
| Payment ID | number |
| Pay stub date | date |
| Pay date | date |
| Gross earnings | object |
| Amount | text |
| Currency | text |
| Total taxes withheld | object |
| Amount | text |
| Currency | text |
| Total employer taxes | object |
| Amount | text |
| Currency | text |
| Total employer additional cost | object |
| Amount | text |
| Currency | text |
| Total expense | object |
| Amount | text |
| Currency | text |
| Pre tax deductions | object |
| Amount | text |
| Currency | text |
| Post tax deductions | object |
| Amount | text |
| Currency | text |
| Deferred compensation | object |
| Amount | text |
| Currency | text |
| Net earnings | object |
| Amount | text |
| Currency | text |
| Payable notes | array |
| Shift ids | array |
| Taxes withheld | array |
| Employer taxes | array |
3other output fields
Get a Cost Center
ActionDisplay name and slot of one cost center.
| Field | Type |
|---|---|
Cost center keyRequired | choice |
| Field | Type |
|---|---|
| Cost center key | text |
| Display name | text |
| Slot | number |
| Archived at | date |
Get a Leave Policy
ActionTime-off policy with accrual settings.
| Field | Type |
|---|---|
Policy IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Description | text |
| Period alignment method | text |
| Effective date | date |
| Accrued leave types | array |
| Front loaded leave types | array |
| Unpaid front loaded leave types | array |
Get a Pay Statement
ActionTemporary link to a worker pay stub.
| Field | Type |
|---|---|
Worker IDRequired | choice |
DateRequired | date |
| Field | Type |
|---|---|
| URL | url |
| Expires at | date |
Get a Payable
ActionSingle payable with its payment state.
| Field | Type |
|---|---|
External IDRequired | choice |
| Field | Type |
|---|---|
| External ID | text |
| Company ID | number |
| External worker ID | text |
| Type | text |
| Label | text |
| Amount | object |
| Amount | text |
| Currency | text |
| Payable model | text |
| Pay code | text |
| Timestamp | date |
| Payment ID | number |
| Payment status | text |
| Ttoc code | number |
| Cost centers | array |
| Payable payment request ID | number |
Get a Payroll Calendar
ActionOne calendar with its start day and dates.
| Field | Type |
|---|---|
Payroll Calendar IDRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Display name | text |
| Pay period type | text |
| Weekly start day | text |
| Effective date | date |
Get a Shift
ActionDetails of a single worked shift.
| Field | Type |
|---|---|
Worked Shift IDRequired | text |
| Field | Type |
|---|---|
| Worker ID | text |
| Worked shift ID | number |
| Legal work time zone | time |
| Shift start at | object |
| Effective punch at | text |
| Shift end at | object |
| Effective punch at | text |
| Verified at | date |
| Verified by user ID | number |
| Effective pay rate | object |
| Amount | text |
| Currency | text |
| Pay rate overridden | boolean |
| Cost centers | array |
| Payable details | object |
| Total payable amount | object |
| Paid | boolean |
| Shift breaks | array |
| Shift durations | object |
| Shift duration | text |
| Paid break duration | text |
| Unpaid break duration | text |
| Regular time worked | object |
| Overtime worked | object |
| Double time worked | object |
Get a Work Location
ActionAddress and coordinates of one location.
| Field | Type |
|---|---|
Work Location IDRequired | choice |
| Field | Type |
|---|---|
| ID | number |
| Line 1 | text |
| Line 2 | text |
| City | text |
| State | text |
| Postal code | text |
| Latitude | number |
| Longitude | number |
| Time zone | time |
Get a Worker
ActionPersonal and onboarding details of a worker.
| Field | Type |
|---|---|
Worker IDRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| First name | text |
| Middle name | text |
| Last name | text |
| Phone number | text |
| Onboarding complete | boolean |
| Hire date | date |
| Date of birth | date |
| Taxpayer identifier | text |
| Tin verification status | text |
| Typical weekly hours | number |
| Preferred payment method | text |
| Approval group | object |
| ID | text |
| Name | text |
| Position | object |
| Pay type | text |
| Pay rate | object |
| Title | text |
| Home address | object |
| Line 1 | text |
| City | text |
| State | text |
| Postal code | text |
| Bank accounts | array |
| Legal work address | object |
| Use home address | boolean |
| Name | text |
| Address | object |
Get a Worker Bank Account
ActionDefault account and splits for one worker.
| Field | Type |
|---|---|
Worker IDRequired | choice |
| Field | Type |
|---|---|
| Default | object |
| Display name | text |
| Bank name | text |
| Account number last 4 | text |
| Routing number | text |
| Account type | text |
| Deposits allowed | boolean |
| Splits | array |
List Cost Centers
SearchCost centers with their keys and display names.
| Field | Type |
|---|---|
| Worker ID | choice |
| Lifecycle Status | choice |
| Payroll Calendar ID | text |
| Limit | number |
| Field | Type |
|---|---|
| Cost center key | text |
| Display name | text |
| Slot | number |
| Archived at | date |
List Deduction Reconciliation
SearchDeductions reconciled over a pay period.
| Field | Type |
|---|---|
Pay Period Start DateRequired | date |
Pay Period End DateRequired | date |
| Category | choice |
| Pay Code | text |
| Limit | number |
| Field | Type |
|---|---|
| Worker ID | text |
| Worked shift ID | number |
| Legal work time zone | time |
| Shift start at | object |
| Effective punch at | text |
| Shift end at | object |
| Effective punch at | text |
| Verified at | date |
| Verified by user ID | number |
| Effective pay rate | object |
| Amount | text |
| Currency | text |
| Pay rate overridden | boolean |
| Payable details | object |
| Total payable amount | object |
| Paid | boolean |
| Shift breaks | array |
| Shift durations | object |
| Shift duration | text |
| Paid break duration | text |
| Unpaid break duration | text |
| Regular time worked | object |
| Overtime worked | object |
| Double time worked | object |
List GL Mappings
SearchLedger code mappings for payroll costs.
| Field | Type |
|---|---|
| Category | choice |
| Approval Group ID | text |
| Work Location ID | text |
| Master | boolean |
| Limit | number |
| Field | Type |
|---|---|
| ID | number |
| Category | text |
| Transaction type | text |
| Transaction detail | text |
| Approval group ID | text |
| Work location ID | text |
| Gl code | text |
| Description | text |
| Created at | date |
| Updated at | date |
List Leave Policies
SearchLeave policies with names and effective dates.
| Field | Type |
|---|---|
| Limit | number |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Description | text |
| Period alignment method | text |
| Effective date | date |
| Accrued leave types | array |
| Front loaded leave types | array |
| Unpaid front loaded leave types | array |
List Payables
SearchPayable amounts matching your filters.
| Field | Type |
|---|---|
| External Worker ID | text |
| Payable Payment Request ID | text |
| Payment ID | text |
| Paid | boolean |
| Earning Timestamp Greater Than | date |
| Earning Timestamp Greater Than or Equal To | date |
| Earning Timestamp Less Than | date |
| Earning Timestamp Less Than or Equal To | date |
| Limit | number |
| Field | Type |
|---|---|
| External ID | text |
| Company ID | number |
| External worker ID | text |
| Type | text |
| Label | text |
| Amount | object |
| Amount | text |
| Currency | text |
| Payable model | text |
| Pay code | text |
| Timestamp | date |
| Payment ID | number |
| Payment status | text |
| Ttoc code | number |
| Cost centers | array |
| Payable payment request ID | number |
List Payments
SearchPayment records for a pay date or period.
| Field | Type |
|---|---|
| Pay date | date |
| Pay period start date | date |
| Pay period end date | date |
| Funding ID | text |
| Limit | number |
| Field | Type |
|---|---|
| ID | text |
| Worker ID | text |
| External worker ID | text |
| Pay period start date | date |
| Pay period end date | date |
| Pay date | date |
| Status | text |
| Funding ID | text |
| Total taxable wages | object |
| Amount | text |
| Currency | text |
| Total non taxable pay | object |
| Amount | text |
| Currency | text |
| Total employer tax | object |
| Amount | text |
| Currency | text |
| Total employer additional costs | object |
| Amount | text |
| Currency | text |
| Total net pay | object |
| Amount | text |
| Currency | text |
| Taxable wages | array |
| Non taxable pay | array |
| Employer taxes | array |
| Employer additional costs | array |
| Employee tax withholdings | array |
2other output fields
List Payroll Calendars
SearchCalendars with display names and pay period types.
| Field | Type |
|---|---|
| Sort | choice |
| Include archived | boolean |
| Limit | number |
| Field | Type |
|---|---|
| ID | text |
| Display name | text |
| Pay period type | text |
| Monthly start day | number |
| Effective date | date |
List Payroll Cost Segments by Cost Center
SearchPayroll cost totals split by cost center.
| Field | Type |
|---|---|
Cost center type keyRequired | text |
Cost center valuesRequired | array |
| Ignore unknown cost center values | boolean |
| Limit | number |
| Field | Type |
|---|---|
| Cost center type key | text |
| Cost center value | text |
| Total wage amount | object |
| Amount | text |
| Currency | text |
| Total non taxable pay amount | object |
| Amount | text |
| Currency | text |
| Total employer tax amount | object |
| Amount | text |
| Currency | text |
| Total employer additional cost amount | object |
| Amount | text |
| Currency | text |
| Wage amounts | array |
| Non taxable pay amounts | array |
| Employer tax amounts | array |
| Employer additional cost amounts | array |
| Employee tax withholding amounts | array |
| Employee deduction amounts | array |
List Payroll Cost Segments by Period
SearchPayroll cost totals split by earning period.
| Field | Type |
|---|---|
| Minimum earning date | date |
| Maximum earning date | date |
| Limit | number |
| Field | Type |
|---|---|
| Cost center type key | text |
| Cost center value | text |
| Total wage amount | object |
| Amount | text |
| Currency | text |
| Total non taxable pay amount | object |
| Amount | text |
| Currency | text |
| Total employer tax amount | object |
| Amount | text |
| Currency | text |
| Total employer additional cost amount | object |
| Amount | text |
| Currency | text |
| Wage amounts | array |
| Non taxable pay amounts | array |
| Employer tax amounts | array |
| Employer additional cost amounts | array |
| Employee tax withholding amounts | array |
| Employee deduction amounts | array |
List Shifts
SearchShift records narrowed by worker or payment.
| Field | Type |
|---|---|
| Worker ID | choice |
| External Worker ID | array |
| Payment ID | array |
| Minimum Work Location Start Date | date |
| Maximum Work Location Start Date | date |
| Minimum Work Location End Date | date |
| Maximum Work Location End Date | date |
| Limit | number |
| Field | Type |
|---|---|
| Worker ID | text |
| Worked shift ID | number |
| Legal work time zone | time |
| Shift start at | object |
| Effective punch at | text |
| Shift end at | object |
| Effective punch at | text |
| Verified at | date |
| Verified by user ID | number |
| Effective pay rate | object |
| Amount | text |
| Currency | text |
| Pay rate overridden | boolean |
| Payable details | object |
| Total payable amount | object |
| Paid | boolean |
| Shift breaks | array |
| Shift durations | object |
| Shift duration | text |
| Paid break duration | text |
| Unpaid break duration | text |
| Regular time worked | object |
| Overtime worked | object |
| Double time worked | object |
List Work Locations
SearchWork locations with their address and time zone.
| Field | Type |
|---|---|
| External Worker ID | text |
| Payable Payment Request ID | text |
| Payment ID | text |
| Paid | boolean |
| Earning Timestamp Greater Than | date |
| Earning Timestamp Greater Than or Equal To | date |
| Earning Timestamp Less Than | date |
| Earning Timestamp Less Than or Equal To | date |
| Limit | number |
| Field | Type |
|---|---|
| ID | number |
| Line 1 | text |
| Line 2 | text |
| City | text |
| State | text |
| Postal code | text |
| Latitude | number |
| Longitude | number |
| Time zone | time |
List Worker Pay History
SearchPast payments made to a worker.
| Field | Type |
|---|---|
Worker IDRequired | choice |
| Limit | number |
| Field | Type |
|---|---|
| Worker ID | text |
| Worker full name | text |
| Payment ID | number |
| Pay stub date | date |
| Pay date | date |
| Gross earnings | object |
| Amount | text |
| Currency | text |
| Total taxes withheld | object |
| Amount | text |
| Currency | text |
| Total employer taxes | object |
| Amount | text |
| Currency | text |
| Total employer additional cost | object |
| Amount | text |
| Currency | text |
| Total expense | object |
| Amount | text |
| Currency | text |
| Pre tax deductions | object |
| Amount | text |
| Currency | text |
| Post tax deductions | object |
| Amount | text |
| Currency | text |
| Deferred compensation | object |
| Amount | text |
| Currency | text |
| Net earnings | object |
| Amount | text |
| Currency | text |
| Payable notes | array |
| Shift ids | array |
| Taxes withheld | array |
| Employer taxes | array |
3other output fields
List Worker Pay Statements
SearchPay stubs issued to one worker.
| Field | Type |
|---|---|
Worker IDRequired | choice |
| Start date | date |
| End date | date |
| Limit | number |
| Field | Type |
|---|---|
| ID | text |
| Worker ID | text |
| Date | date |
| Pay period start date | date |
| Pay period end date | date |
| Gross earnings | object |
| Amount | text |
| Currency | text |
| Ytd gross earnings | object |
| Amount | text |
| Currency | text |
| Total taxes ee | object |
| Amount | text |
| Currency | text |
| Pre tax deductions | object |
| Amount | text |
| Currency | text |
| Ytd pre tax deductions | object |
| Amount | text |
| Currency | text |
| Post tax deductions | object |
| Amount | text |
| Currency | text |
| Ytd post tax deductions | object |
| Amount | text |
| Currency | text |
| Deferred compensation | object |
| Amount | text |
| Currency | text |
| Ytd deferred compensation | object |
| Amount | text |
| Currency | text |
| Net earnings | object |
| Amount | text |
| Currency | text |
| Ytd net earnings | object |
| Amount | text |
| Currency | text |
List Workers
SearchWorkers matching your filters.
| Field | Type |
|---|---|
| Worker ID | choice |
| Lifecycle Status | choice |
| Payroll Calendar ID | text |
| Limit | number |
| Field | Type |
|---|---|
| ID | text |
| First name | text |
| Middle name | text |
| Last name | text |
| Phone number | text |
| Onboarding complete | boolean |
| Hire date | date |
| Date of birth | date |
| Taxpayer identifier | text |
| Tin verification status | text |
| Typical weekly hours | number |
| Preferred payment method | text |
| Approval group | object |
| ID | text |
| Name | text |
| Position | object |
| Pay type | text |
| Pay rate | object |
| Title | text |
| Home address | object |
| Line 1 | text |
| City | text |
| State | text |
| Postal code | text |
| Bank accounts | array |
| Legal work address | object |
| Use home address | boolean |
| Name | text |
| Address | object |
Apply a Benefit Deduction
ActionStarts a benefit deduction for a worker.
| Field | Type |
|---|---|
Worker IDRequired | choice |
Pay CodeRequired | text |
| Deduction Amount | object |
Employee amountRequired | object |
Period TypeRequired | choice |
| Employer Amount | object |
| Lifetime Limit | object |
| Amount | text |
| Currency | text |
| HSA Limit Type | choice |
| Effective Date | date |
| Effective End Date | date |
| Field | Type |
|---|---|
| Worker ID | text |
| Pay code | text |
| Status | text |
| Effective date | date |
Apply a Retirement Deduction
ActionStarts a retirement plan deduction.
| Field | Type |
|---|---|
Worker IDRequired | choice |
Pay CodeRequired | text |
| Deduction Amount | object |
Employee AmountRequired | object |
Period TypeRequired | choice |
| Deduction Percentage | object |
Employee PercentageRequired | number |
| Limit | object |
| Employer Match Tiers | array |
Match RateRequired | number |
Percent of WagesRequired | number |
| Effective Date | date |
| Effective End Date | date |
| Field | Type |
|---|---|
| Worker ID | text |
| Pay code | text |
| Status | text |
| Effective date | date |
Archive a Work Location
ActionMarks a location as archived.
| Field | Type |
|---|---|
Work Location IDRequired | choice |
Create a Bank Account Split
ActionRoutes part of each payment to a bank account.
| Field | Type |
|---|---|
Worker IDRequired | choice |
Split NumberRequired | choice |
Display NameRequired | text |
Routing NumberRequired | text |
Account TypeRequired | choice |
Percent Per PaymentRequired | text |
| Account Number | text |
| Field | Type |
|---|---|
| Display name | text |
| Bank name | text |
| Account number last 4 | text |
| Routing number | text |
| Account type | text |
| Percent per payment | text |
| Deposits allowed | boolean |
| Split number | number |
Create a Contractor
ActionRegisters a contractor with tax and bank details.
| Field | Type |
|---|---|
First nameRequired | text |
Last nameRequired | text |
Phone numberRequired | text |
EmailRequired | |
Hire dateRequired | date |
Home addressRequired | object |
Address line 1Required | text |
CityRequired | text |
StateRequired | text |
Postal codeRequired | text |
| Address line 2 | text |
Date of birthRequired | date |
Bank accountRequired | object |
Account nameRequired | text |
Account typeRequired | choice |
Routing numberRequired | text |
Account numberRequired | text |
Legal work addressRequired | object |
| Use home address | boolean |
| Work location ID | text |
W-9 form responseRequired | object |
Entity or individual nameRequired | text |
Tax classificationRequired | choice |
| Business name | text |
| LLC tax classification | choice |
| Social Security number | text |
| Employer identification number | text |
| Exempt payee code | text |
| FATCA reporting exemption code | text |
| Effective date | date |
| Onboarding complete | boolean |
| External worker ID | text |
| Approval group ID | text |
| Middle name | text |
| Correction Authorized | boolean |
| Field | Type |
|---|---|
| ID | text |
| First name | text |
| Middle name | text |
| Last name | text |
| Phone number | text |
| Onboarding complete | boolean |
| Hire date | date |
| Date of birth | date |
| Taxpayer identifier | text |
| Tin verification status | text |
| Typical weekly hours | number |
| Preferred payment method | text |
| Approval group | object |
| ID | text |
| Name | text |
| Position | object |
| Pay type | text |
| Pay rate | object |
| Title | text |
| Home address | object |
| Line 1 | text |
| City | text |
| State | text |
| Postal code | text |
| Bank accounts | array |
| Legal work address | object |
| Use home address | boolean |
| Name | text |
| Address | object |
Create a Cost Center
ActionAdds a cost center with its key and job type.
| Field | Type |
|---|---|
Cost Center KeyRequired | text |
| Job Type | object |
Display NameRequired | text |
| Slot | choice |
| Field | Type |
|---|---|
| Cost center key | text |
| Display name | text |
| Slot | number |
| Archived at | date |
Create a Leave Policy
ActionDefines how workers earn or receive leave.
| Field | Type |
|---|---|
NameRequired | text |
Period alignment methodRequired | choice |
| Accrued leave types | array |
Leave type nameRequired | text |
Eligible after employed daysRequired | number |
Eligible after worked hoursRequired | number |
Accrual ratio worked hoursRequired | number |
Accruable while on paid time offRequired | boolean |
Base award ruleRequired | object |
| Tenure award rules | array |
| Front-loaded leave types | array |
Leave type nameRequired | text |
Eligible after employed daysRequired | number |
Eligible after worked hoursRequired | number |
Front-loaded period typeRequired | choice |
Base award ruleRequired | object |
| Initial front-loaded balance prorated | boolean |
| Tenure award rules | array |
| Unpaid front-loaded leave types | array |
Leave type nameRequired | text |
Eligible after employed daysRequired | number |
Eligible after worked hoursRequired | number |
Front-loaded period typeRequired | choice |
Base award ruleRequired | object |
| Initial front-loaded balance prorated | boolean |
| Tenure award rules | array |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Description | text |
| Period alignment method | text |
| Effective date | date |
| Accrued leave types | array |
| Front loaded leave types | array |
| Unpaid front loaded leave types | array |
Create a Payable
ActionRecords a payable amount for a worker.
| Field | Type |
|---|---|
External IDRequired | text |
LabelRequired | text |
AmountRequired | object |
| Amount | number |
| Currency | text |
Payable ModelRequired | choice |
Pay CodeRequired | text |
TimestampRequired | date |
TypeRequired | text |
| Correction Authorized | boolean |
| Worker ID | text |
| External Worker ID | text |
| Unit Rate | object |
| Amount | number |
| Currency | text |
| Unit Count | number |
| Work Location ID | text |
| TTOC Code | number |
| Cost Centers | array |
TypeRequired | text |
ValueRequired | text |
| Field | Type |
|---|---|
| External ID | text |
| Company ID | number |
| External worker ID | text |
| Type | text |
| Label | text |
| Amount | object |
| Amount | text |
| Currency | text |
| Payable model | text |
| Pay code | text |
| Timestamp | date |
| Payment ID | number |
| Payment status | text |
| Ttoc code | number |
| Cost centers | array |
| Payable payment request ID | number |
Create a Payroll Calendar
ActionAdds a calendar for pay periods and start days.
| Field | Type |
|---|---|
Display nameRequired | text |
Pay period typeRequired | choice |
Effective dateRequired | date |
| Weekly start day | choice |
| Monthly start day | number |
| Field | Type |
|---|---|
| ID | text |
| Display name | text |
| Pay period type | text |
| Weekly start day | text |
| Effective date | date |
Create a Shift
ActionLogs a block of worked time.
| Field | Type |
|---|---|
Worker IDRequired | choice |
External Worker IDRequired | text |
Shift StartRequired | date |
| Shift End | date |
| Correction Authorized | boolean |
| Create Breaks | array |
Segment Config CodeRequired | text |
Break DurationRequired | text |
| Effective Hourly Pay Rate | object |
| Amount | text |
| Currency | text |
| Display Hourly Pay Rate | object |
| Amount | text |
| Currency | text |
| Work Location ID | number |
| Workers Comp Class Code | text |
| Tax Calculation Config Code | choice |
| Correction Payment Timeframe | choice |
| Fully Classified Hours | array |
TypeRequired | choice |
StartRequired | number |
EndRequired | number |
Hourly Pay RateRequired | object |
| Note | text |
| Cost Centers | array |
TypeRequired | text |
ValueRequired | text |
| Field | Type |
|---|---|
| Worker ID | text |
| Worked shift ID | number |
| Legal work time zone | time |
| Shift start at | object |
| Effective punch at | text |
| Shift end at | object |
| Effective punch at | text |
| Verified at | date |
| Verified by user ID | number |
| Effective pay rate | object |
| Amount | text |
| Currency | text |
| Pay rate overridden | boolean |
| Cost centers | array |
| Payable details | object |
| Total payable amount | object |
| Paid | boolean |
| Shift breaks | array |
| Shift durations | object |
| Shift duration | text |
| Paid break duration | text |
| Unpaid break duration | text |
| Regular time worked | object |
| Overtime worked | object |
| Double time worked | object |
Create a Work Location
ActionAdds a location with a name and address.
| Field | Type |
|---|---|
NameRequired | text |
Address line 1Required | text |
CityRequired | text |
StateRequired | text |
Postal codeRequired | text |
Effective dateRequired | date |
| Address line 2 | text |
| Phone number | text |
| Latitude | number |
| Longitude | number |
| External ID | text |
| Field | Type |
|---|---|
| ID | number |
| Line 1 | text |
| Line 2 | text |
| City | text |
| State | text |
| Postal code | text |
| Latitude | number |
| Longitude | number |
| Time zone | time |
Create an Employee
ActionRegisters an employee with pay and tax setup.
| Field | Type |
|---|---|
First nameRequired | text |
Last nameRequired | text |
Taxpayer identifierRequired | text |
Date of birthRequired | date |
Phone numberRequired | text |
EmailRequired | |
| Middle name | text |
Home addressRequired | object |
Address line 1Required | text |
CityRequired | text |
StateRequired | text |
Postal codeRequired | text |
| Address line 2 | text |
Legal work addressRequired | object |
| Use home address | boolean |
| Work location ID | number |
Bank accountRequired | object |
Account nameRequired | text |
Account typeRequired | choice |
Routing numberRequired | text |
Account numberRequired | text |
Pay typeRequired | choice |
Pay rateRequired | object |
Hire dateRequired | date |
| Pay schedule | choice |
| Payroll calendar ID | text |
Typical weekly hoursRequired | number |
Withholding settingsRequired | object |
Have exactly two jobsRequired | boolean |
Count of childrenRequired | number |
Count of other dependentsRequired | number |
Other income annuallyRequired | object |
Deductions annuallyRequired | object |
Extra withholdings monthlyRequired | object |
ExemptRequired | boolean |
Marital statusRequired | choice |
| Eligible for overtime | boolean |
6other input fields
| Field | Type |
|---|---|
| ID | text |
| First name | text |
| Middle name | text |
| Last name | text |
| Phone number | text |
| Onboarding complete | boolean |
| Hire date | date |
| Date of birth | date |
| Taxpayer identifier | text |
| Tin verification status | text |
| Typical weekly hours | number |
| Preferred payment method | text |
| Approval group | object |
| ID | text |
| Name | text |
| Position | object |
| Pay type | text |
| Pay rate | object |
| Title | text |
| Home address | object |
| Line 1 | text |
| City | text |
| State | text |
| Postal code | text |
| Bank accounts | array |
| Legal work address | object |
| Use home address | boolean |
| Name | text |
| Address | object |
Create Payables in Bulk
ActionBatch entry of payable amounts.
| Field | Type |
|---|---|
| List of Payables | array |
| Field | Type |
|---|---|
| External ids | array |
Delete a Bank Account Split
ActionDeletes a worker payment split.
| Field | Type |
|---|---|
Worker IDRequired | choice |
Split NumberRequired | choice |
Delete a GL Mapping
ActionRemoves one ledger code mapping.
| Field | Type |
|---|---|
Mapping IDRequired | choice |
Delete a Leave Policy
ActionRemoves one time-off policy.
| Field | Type |
|---|---|
Policy IDRequired | text |
Delete a Payable
ActionRemoves one payable amount.
| Field | Type |
|---|---|
External IDRequired | choice |
| Correction Authorized | boolean |
Delete a Payroll Calendar
ActionDeletes one calendar of pay periods.
| Field | Type |
|---|---|
Payroll Calendar IDRequired | choice |
Delete a Shift
ActionRemoves one logged shift.
| Field | Type |
|---|---|
Worked Shift IDRequired | text |
| Correction Authorized | boolean |
Delete a Worker Profile
ActionDeletes the profile of one employee or contractor.
| Field | Type |
|---|---|
Worker IDRequired | text |
Look Up a Hiring Status
ActionHiring scenario for a matched person.
| Field | Type |
|---|---|
| Taxpayer Identifier | text |
| Phone Number | text |
| First Name | text |
| Last Name | text |
| Date of Birth | date |
| External Worker ID | text |
| Field | Type |
|---|---|
| Hiring scenario | text |
| Worker ID | text |
| External worker ID | text |
| Full name | text |
| Phone number | text |
| Taxpayer identifier | text |
| Employment type | text |
| Activity details | object |
| Active | boolean |
| Active reason | text |
| Most recent hire date | text |
| Hiring details | object |
| Eligible for hire | boolean |
| Eligible for hire reason | text |
Make an API Call
universalCustom Everee REST API request.
| Field | Type |
|---|---|
URLRequired | text |
MethodRequired | choice |
| Headers | array |
| Header | object |
| Query String | array |
| Parameter | object |
| Body | text |
| Field | Type |
|---|---|
| Body | text |
| Headers | object |
| Status code | number |
Prepare Payables
ActionReadies payables for payment.
| Field | Type |
|---|---|
| External IDs | array |
| Worker IDs | array |
| External Worker IDs | array |
| External Types | array |
| Include Workers on Regular Pay Cycle | boolean |
| Tenant ID | number |
| Field | Type |
|---|---|
| Payable count | number |
| Company ID | number |
Rehire a Worker
ActionBrings a former worker back.
| Field | Type |
|---|---|
Worker IDRequired | text |
Rehire DateRequired | date |
| Approval Group ID | number |
| Use Home Address | boolean |
| Work Location ID | text |
| Employee Position | object |
Pay TypeRequired | choice |
Pay RateRequired | object |
Expected Weekly HoursRequired | number |
| SOC Code | text |
| Title | text |
| Worker Compensation Class ID | text |
| Eligible for Overtime | boolean |
| Cost Centers | array |
| Field | Type |
|---|---|
| ID | text |
| First name | text |
| Middle name | text |
| Last name | text |
| Phone number | text |
| Onboarding complete | boolean |
| Hire date | date |
| Date of birth | date |
| Taxpayer identifier | text |
| Tin verification status | text |
| Typical weekly hours | number |
| Preferred payment method | text |
| Approval group | object |
| ID | text |
| Name | text |
| Position | object |
| Pay type | text |
| Pay rate | object |
| Title | text |
| Home address | object |
| Line 1 | text |
| City | text |
| State | text |
| Postal code | text |
| Bank accounts | array |
| Legal work address | object |
| Use home address | boolean |
| Name | text |
| Address | object |
Separate a Contractor
ActionCloses out a contractor relationship.
| Field | Type |
|---|---|
Worker IDRequired | text |
Date of SeparationRequired | date |
Eligible for RehireRequired | boolean |
Contractor Separation TypeRequired | choice |
Benefits Enrollment End DateRequired | date |
| Notes | text |
Separate an Employee
ActionCloses out an employee with optional payouts.
| Field | Type |
|---|---|
Worker IDRequired | text |
Date of SeparationRequired | date |
Eligible for RehireRequired | boolean |
Pay SeveranceRequired | boolean |
Employee Separation TypeRequired | choice |
Benefits Enrollment End DateRequired | date |
Pay Out Time Off BalancesRequired | boolean |
| Severance Amount | object |
| Amount | text |
| Currency | text |
| Notes | text |
| Time Off Separation Categories | array |
Earning TypeRequired | text |
Payoff TypeRequired | choice |
| Percentage Amount | number |
| Maximum Hours Amount | number |
Start a Contractor Onboarding
ActionOpens the contractor onboarding flow.
| Field | Type |
|---|---|
First nameRequired | text |
Last nameRequired | text |
Phone numberRequired | text |
EmailRequired | |
Hire dateRequired | date |
Legal work addressRequired | object |
| Use home address | boolean |
| Work location ID | text |
| State unemployment tax location ID | text |
| Middle name | text |
| Approval group ID | text |
| Worker ID | text |
| Document groups | array |
| Field | Type |
|---|---|
| ID | text |
| First name | text |
| Middle name | text |
| Last name | text |
| Phone number | text |
| Onboarding complete | boolean |
| Hire date | date |
| Date of birth | date |
| Taxpayer identifier | text |
| Tin verification status | text |
| Typical weekly hours | number |
| Preferred payment method | text |
| Approval group | object |
| ID | text |
| Name | text |
| Position | object |
| Pay type | text |
| Pay rate | object |
| Title | text |
| Home address | object |
| Line 1 | text |
| City | text |
| State | text |
| Postal code | text |
| Bank accounts | array |
| Legal work address | object |
| Use home address | boolean |
| Name | text |
| Address | object |
Start an Employee Onboarding
ActionBegins onboarding with pay and hire details.
| Field | Type |
|---|---|
First nameRequired | text |
Last nameRequired | text |
Phone numberRequired | text |
EmailRequired | |
Pay typeRequired | choice |
Pay rateRequired | object |
| Amount | text |
| Currency | text |
Typical weekly hoursRequired | number |
Hire dateRequired | date |
Legal work addressRequired | object |
| Use home address | boolean |
| Work location ID | text |
| State unemployment tax location ID | text |
| Middle name | text |
| Pay schedule | choice |
| Payroll calendar ID | text |
| Eligible for overtime | boolean |
| Approval group ID | text |
| Time-off policy ID | text |
| Cost centers | array |
TypeRequired | text |
ValueRequired | text |
| Worker ID | text |
| Document groups | array |
| Field | Type |
|---|---|
| ID | text |
| First name | text |
| Middle name | text |
| Last name | text |
| Phone number | text |
| Onboarding complete | boolean |
| Hire date | date |
| Date of birth | date |
| Taxpayer identifier | text |
| Tin verification status | text |
| Typical weekly hours | number |
| Preferred payment method | text |
| Approval group | object |
| ID | text |
| Name | text |
| Position | object |
| Pay type | text |
| Pay rate | object |
| Title | text |
| Home address | object |
| Line 1 | text |
| City | text |
| State | text |
| Postal code | text |
| Bank accounts | array |
| Legal work address | object |
| Use home address | boolean |
| Name | text |
| Address | object |
Update a Leave Policy
ActionRenames a time-off policy or rewrites its text.
| Field | Type |
|---|---|
Policy IDRequired | text |
| Name | text |
| Description | text |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Description | text |
| Period alignment method | text |
| Effective date | date |
| Accrued leave types | array |
| Front loaded leave types | array |
| Unpaid front loaded leave types | array |
Update a Payable
ActionEdits a payable amount.
| Field | Type |
|---|---|
External IDRequired | choice |
LabelRequired | text |
AmountRequired | object |
| Amount | number |
| Currency | text |
Payable ModelRequired | choice |
Pay CodeRequired | text |
TimestampRequired | date |
TypeRequired | text |
| Correction Authorized | boolean |
| Worker ID | text |
| External Worker ID | text |
| Unit Rate | object |
| Amount | number |
| Currency | text |
| Unit Count | number |
| Work Location ID | text |
| TTOC Code | number |
| Cost Centers | array |
TypeRequired | text |
ValueRequired | text |
| Field | Type |
|---|---|
| External ID | text |
| Company ID | number |
| External worker ID | text |
| Type | text |
| Label | text |
| Amount | object |
| Amount | text |
| Currency | text |
| Payable model | text |
| Pay code | text |
| Timestamp | date |
| Payment ID | number |
| Payment status | text |
| Ttoc code | number |
| Cost centers | array |
| Payable payment request ID | number |
Update a Shift
ActionChanges the times or rates of a logged shift.
| Field | Type |
|---|---|
Worked Shift IDRequired | text |
Worker IDRequired | choice |
External Worker IDRequired | text |
Shift StartRequired | date |
| Shift End | date |
| Correction Authorized | boolean |
| Create Breaks | array |
Segment Config CodeRequired | text |
Break DurationRequired | text |
| Effective Hourly Pay Rate | object |
| Amount | text |
| Currency | text |
| Display Hourly Pay Rate | object |
| Amount | text |
| Currency | text |
| Work Location ID | number |
| Workers Comp Class Code | text |
| Tax Calculation Config Code | choice |
| Correction Payment Timeframe | choice |
| Fully Classified Hours | array |
TypeRequired | choice |
StartRequired | number |
EndRequired | number |
Hourly Pay RateRequired | object |
| Note | text |
| Cost Centers | array |
TypeRequired | text |
ValueRequired | text |
| Field | Type |
|---|---|
| Worker ID | text |
| Worked shift ID | number |
| Legal work time zone | time |
| Shift start at | object |
| Effective punch at | text |
| Shift end at | object |
| Effective punch at | text |
| Verified at | date |
| Verified by user ID | number |
| Effective pay rate | object |
| Amount | text |
| Currency | text |
| Pay rate overridden | boolean |
| Cost centers | array |
| Payable details | object |
| Total payable amount | object |
| Paid | boolean |
| Shift breaks | array |
| Shift durations | object |
| Shift duration | text |
| Paid break duration | text |
| Unpaid break duration | text |
| Regular time worked | object |
| Overtime worked | object |
| Double time worked | object |
Update a Work Location
ActionEdits the address or name of a location.
| Field | Type |
|---|---|
Work Location IDRequired | choice |
| Name | text |
| Address line 1 | text |
| City | text |
| State | text |
| Postal code | text |
| Effective date | date |
| Address line 2 | text |
| Phone number | text |
| Latitude | number |
| Longitude | number |
| External ID | text |
| Field | Type |
|---|---|
| ID | number |
| Line 1 | text |
| Line 2 | text |
| City | text |
| State | text |
| Postal code | text |
| Latitude | number |
| Longitude | number |
| Time zone | time |
Update the Default Bank Account of a Worker
ActionEdits where a worker is paid by default.
| Field | Type |
|---|---|
Worker IDRequired | choice |
Account NameRequired | text |
Account TypeRequired | choice |
Routing NumberRequired | text |
Account NumberRequired | text |
| Field | Type |
|---|---|
| ID | text |
| First name | text |
| Middle name | text |
| Last name | text |
| Phone number | text |
| Onboarding complete | boolean |
| Hire date | date |
| Date of birth | date |
| Taxpayer identifier | text |
| Tin verification status | text |
| Typical weekly hours | number |
| Preferred payment method | text |
| Approval group | object |
| ID | text |
| Name | text |
| Position | object |
| Pay type | text |
| Pay rate | object |
| Title | text |
| Home address | object |
| Line 1 | text |
| City | text |
| State | text |
| Postal code | text |
| Bank accounts | array |
| Legal work address | object |
| Use home address | boolean |
| Name | text |
| Address | object |
Update the Home Address of a Worker
ActionChanges where a worker lives.
| Field | Type |
|---|---|
Worker IDRequired | choice |
Line 1Required | text |
CityRequired | text |
StateRequired | text |
Postal CodeRequired | text |
Effective DateRequired | date |
| Line 2 | text |
| Field | Type |
|---|---|
| ID | text |
| First name | text |
| Middle name | text |
| Last name | text |
| Phone number | text |
| Onboarding complete | boolean |
| Hire date | date |
| Date of birth | date |
| Taxpayer identifier | text |
| Tin verification status | text |
| Typical weekly hours | number |
| Preferred payment method | text |
| Approval group | object |
| ID | text |
| Name | text |
| Position | object |
| Pay type | text |
| Pay rate | object |
| Title | text |
| Home address | object |
| Line 1 | text |
| City | text |
| State | text |
| Postal code | text |
| Bank accounts | array |
| Legal work address | object |
| Use home address | boolean |
| Name | text |
| Address | object |
Update the Legal Work Location of a Worker
ActionMoves a worker to a different legal work location.
| Field | Type |
|---|---|
Worker IDRequired | choice |
Use Home AddressRequired | boolean |
Effective DateRequired | date |
| Work Location ID | text |
| State Unemployment Tax Location ID | text |
| Field | Type |
|---|---|
| ID | text |
| First name | text |
| Middle name | text |
| Last name | text |
| Phone number | text |
| Onboarding complete | boolean |
| Hire date | date |
| Date of birth | date |
| Taxpayer identifier | text |
| Tin verification status | text |
| Typical weekly hours | number |
| Preferred payment method | text |
| Approval group | object |
| ID | text |
| Name | text |
| Position | object |
| Pay type | text |
| Pay rate | object |
| Title | text |
| Home address | object |
| Line 1 | text |
| City | text |
| State | text |
| Postal code | text |
| Bank accounts | array |
| Legal work address | object |
| Use home address | boolean |
| Name | text |
| Address | object |
Update the Personal Information of a Worker
ActionNames, preferences and sizes for a worker.
| Field | Type |
|---|---|
Worker IDRequired | choice |
First NameRequired | text |
Last NameRequired | text |
| Middle Name | text |
| Date of Birth | date |
| Shirt Size | text |
| Partner Shirt Size | text |
| Dietary Restrictions | text |
| Preferred Name | text |
| Field | Type |
|---|---|
| ID | text |
| First name | text |
| Middle name | text |
| Last name | text |
| Phone number | text |
| Onboarding complete | boolean |
| Hire date | date |
| Date of birth | date |
| Taxpayer identifier | text |
| Tin verification status | text |
| Typical weekly hours | number |
| Preferred payment method | text |
| Approval group | object |
| ID | text |
| Name | text |
| Position | object |
| Pay type | text |
| Pay rate | object |
| Title | text |
| Home address | object |
| Line 1 | text |
| City | text |
| State | text |
| Postal code | text |
| Bank accounts | array |
| Legal work address | object |
| Use home address | boolean |
| Name | text |
| Address | object |
Update the Position of a Worker
ActionEdits the compensation and role of a worker.
| Field | Type |
|---|---|
Worker IDRequired | choice |
Pay typeRequired | choice |
Pay rateRequired | object |
| Amount | text |
| Currency | text |
Expected weekly hoursRequired | number |
Effective dateRequired | date |
| Title | text |
| Default worker compensation class code | text |
| SOC code | text |
| Cost centers | array |
TypeRequired | text |
ValueRequired | text |
| Field | Type |
|---|---|
| ID | text |
| First name | text |
| Middle name | text |
| Last name | text |
| Phone number | text |
| Onboarding complete | boolean |
| Hire date | date |
| Date of birth | date |
| Taxpayer identifier | text |
| Tin verification status | text |
| Typical weekly hours | number |
| Preferred payment method | text |
| Approval group | object |
| ID | text |
| Name | text |
| Position | object |
| Pay type | text |
| Pay rate | object |
| Title | text |
| Home address | object |
| Line 1 | text |
| City | text |
| State | text |
| Postal code | text |
| Bank accounts | array |
| Legal work address | object |
| Use home address | boolean |
| Name | text |
| Address | object |
Upsert a GL Mapping
ActionCreates or changes ledger code mappings.
| Field | Type |
|---|---|
| Mappings | array |
CategoryRequired | choice |
GL CodeRequired | text |
| Transaction Type | text |
| Transaction Detail | text |
| Approval Group ID | text |
| Work Location ID | text |
| Description | text |
| Field | Type |
|---|---|
| ID | number |
| Category | text |
| Transaction type | text |
| Transaction detail | text |
| Approval group ID | text |
| Work location ID | text |
| Gl code | text |
| Description | text |
| Created at | date |
| Updated at | date |
Templates
Look for Everee templates in the WEXTL template library.
Browse templates →Other HR integrations on WEXTL
Darwinbox[2]Enterprise HR platform to recruit, onboard and manage payroll and performance.
BrioHRHR management platform for employee data, leave, payroll-ready records, and people operations.
Breathe HRCloud HR software for employee records, leave, onboarding, and people management.
CalamariHR leave, attendance, and timesheet management for growing teams.
Charlie HRHR admin for team members, leave, salaries, and company records.
References
- WEXTL® Everee Source Code connector implementation.
- Our users use cases and automations.
- Official API Documentation for Everee.
- WEXTL® visual workflow builder data.
Last updated: Nov 13, 2026 10:56
How we write our apps documentation
How we compile these docs: sources, the role of AI, and how we verify.






























