Skip to docs navigation

Everee integration guide

Verified

How 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].

Open Everee on WEXTL →
  • Everee
  • WEXTL
  • Darwinbox
  • BrioHR
  • Breathe HR
  • Calamari
  • Charlie HR
  • Dayforce
  • ClockIt
  • Assembled
  • ClickTime
  • Base.vn
  • BuddyPunch
  • Combo HR
  • Clockify
  • actiTIME
  • BambooHR
  • Connecteam
  • Ashby
  • Affinda
  • CATS
  • Deel
  • Bullhorn
  • Cezanne HR
  • Achievers
  • Aladtec
  • Beamery
  • Ceipal
  • DailyPay
  • Breezy HR
  • BrightHR
  • 7Shifts
  • API KeytextRequired

    Log in to your admin portal, navigate to Integrations Hub → API, click the + icon, then select Create API Token (administrator permission required).[1]

  • Tenant IDtextRequired

    Your numeric company tenant ID, shown in the app. Everee requires it on every API request.[1]

  1. Log in to your WEXTL account, add the Everee node module to your workflow, and click Create new credential.
  2. Optional: In the Credential name field, enter a name for the credential.
  3. Enter the authentication credentials you copied from your Everee account, or follow the on-screen instructions to create the credential.
  4. If prompted, authenticate your account and confirm access.
  5. If you want to make changes to your credential in the future, follow the steps in Manage credentials →

Watch GL Mappings

TriggerFires for each new ledger mapping on a schedule.
Output fields[3]
FieldType
IDnumber
Categorytext
Transaction typetext
Transaction detailtext
Approval group IDtext
Work location IDtext
Gl codetext
Descriptiontext
Created atdate
Updated atdate

Watch Payables

TriggerRegular check for payable items.
Output fields[3]
FieldType
External IDtext
Company IDnumber
External worker IDtext
Typetext
Labeltext
Amountobject
Amounttext
Currencytext
Payable modeltext
Pay codetext
Timestampdate
Payment IDnumber
Payment statustext
Ttoc codenumber
Cost centersarray
Payable payment request IDnumber

Watch Payment Statements

TriggerRecurring check on pay statements of a worker.
Output fields[3]
FieldType
IDtext
Worker IDtext
Datedate
Pay period start datedate
Pay period end datedate
Gross earningsobject
Amounttext
Currencytext
Ytd gross earningsobject
Amounttext
Currencytext
Total taxes eeobject
Amounttext
Currencytext
Pre tax deductionsobject
Amounttext
Currencytext
Ytd pre tax deductionsobject
Amounttext
Currencytext
Post tax deductionsobject
Amounttext
Currencytext
Ytd post tax deductionsobject
Amounttext
Currencytext
Deferred compensationobject
Amounttext
Currencytext
Ytd deferred compensationobject
Amounttext
Currencytext
Net earningsobject
Amounttext
Currencytext
Ytd net earningsobject
Amounttext
Currencytext

Watch Shifts

TriggerRecurring look at logged shifts.
Output fields[3]
FieldType
Worker IDtext
Worked shift IDnumber
Legal work time zonetime
Shift start atobject
Effective punch attext
Shift end atobject
Effective punch attext
Verified atdate
Verified by user IDnumber
Effective pay rateobject
Amounttext
Currencytext
Pay rate overriddenboolean
Payable detailsobject
Total payable amountobject
Paidboolean
Shift breaksarray
Shift durationsobject
Shift durationtext
Paid break durationtext
Unpaid break durationtext
Regular time workedobject
Overtime workedobject
Double time workedobject

Watch Work Locations

TriggerScheduled feed of new work locations.
Output fields[3]
FieldType
IDnumber
Line 1text
Line 2text
Citytext
Statetext
Postal codetext
Latitudenumber
Longitudenumber
Time zonetime

Watch Worker Pay History

TriggerPeriodic pull of worker payments.
Output fields[3]
FieldType
Worker IDtext
Worker full nametext
Payment IDnumber
Pay stub datedate
Pay datedate
Gross earningsobject
Amounttext
Currencytext
Total taxes withheldobject
Amounttext
Currencytext
Total employer taxesobject
Amounttext
Currencytext
Total employer additional costobject
Amounttext
Currencytext
Total expenseobject
Amounttext
Currencytext
Pre tax deductionsobject
Amounttext
Currencytext
Post tax deductionsobject
Amounttext
Currencytext
Deferred compensationobject
Amounttext
Currencytext
Net earningsobject
Amounttext
Currencytext
Payable notesarray
Shift idsarray
Taxes withheldarray
Employer taxesarray

3other output fields

Get a Cost Center

ActionDisplay name and slot of one cost center.
Input fields[3]
FieldType
Cost center keyRequired
choice
Output fields[3]
FieldType
Cost center keytext
Display nametext
Slotnumber
Archived atdate

Get a Leave Policy

ActionTime-off policy with accrual settings.
Input fields[3]
FieldType
Policy IDRequired
text
Output fields[3]
FieldType
IDtext
Nametext
Descriptiontext
Period alignment methodtext
Effective datedate
Accrued leave typesarray
Front loaded leave typesarray
Unpaid front loaded leave typesarray

Get a Pay Statement

ActionTemporary link to a worker pay stub.
Input fields[3]
FieldType
Worker IDRequired
choice
DateRequired
date
Output fields[3]
FieldType
URLurl
Expires atdate

Get a Payable

ActionSingle payable with its payment state.
Input fields[3]
FieldType
External IDRequired
choice
Output fields[3]
FieldType
External IDtext
Company IDnumber
External worker IDtext
Typetext
Labeltext
Amountobject
Amounttext
Currencytext
Payable modeltext
Pay codetext
Timestampdate
Payment IDnumber
Payment statustext
Ttoc codenumber
Cost centersarray
Payable payment request IDnumber

Get a Payroll Calendar

ActionOne calendar with its start day and dates.
Input fields[3]
FieldType
Payroll Calendar IDRequired
choice
Output fields[3]
FieldType
IDtext
Display nametext
Pay period typetext
Weekly start daytext
Effective datedate

Get a Shift

ActionDetails of a single worked shift.
Input fields[3]
FieldType
Worked Shift IDRequired
text
Output fields[3]
FieldType
Worker IDtext
Worked shift IDnumber
Legal work time zonetime
Shift start atobject
Effective punch attext
Shift end atobject
Effective punch attext
Verified atdate
Verified by user IDnumber
Effective pay rateobject
Amounttext
Currencytext
Pay rate overriddenboolean
Cost centersarray
Payable detailsobject
Total payable amountobject
Paidboolean
Shift breaksarray
Shift durationsobject
Shift durationtext
Paid break durationtext
Unpaid break durationtext
Regular time workedobject
Overtime workedobject
Double time workedobject

Get a Work Location

ActionAddress and coordinates of one location.
Input fields[3]
FieldType
Work Location IDRequired
choice
Output fields[3]
FieldType
IDnumber
Line 1text
Line 2text
Citytext
Statetext
Postal codetext
Latitudenumber
Longitudenumber
Time zonetime

Get a Worker

ActionPersonal and onboarding details of a worker.
Input fields[3]
FieldType
Worker IDRequired
choice
Output fields[3]
FieldType
IDtext
First nametext
Middle nametext
Last nametext
Phone numbertext
Emailemail
Onboarding completeboolean
Hire datedate
Date of birthdate
Taxpayer identifiertext
Tin verification statustext
Typical weekly hoursnumber
Preferred payment methodtext
Approval groupobject
IDtext
Nametext
Positionobject
Pay typetext
Pay rateobject
Titletext
Home addressobject
Line 1text
Citytext
Statetext
Postal codetext
Bank accountsarray
Legal work addressobject
Use home addressboolean
Nametext
Addressobject

Get a Worker Bank Account

ActionDefault account and splits for one worker.
Input fields[3]
FieldType
Worker IDRequired
choice
Output fields[3]
FieldType
Defaultobject
Display nametext
Bank nametext
Account number last 4text
Routing numbertext
Account typetext
Deposits allowedboolean
Splitsarray

List Cost Centers

SearchCost centers with their keys and display names.
Input fields[3]
FieldType
Worker IDchoice
Lifecycle Statuschoice
Payroll Calendar IDtext
Limitnumber
Output fields[3]
FieldType
Cost center keytext
Display nametext
Slotnumber
Archived atdate

List Deduction Reconciliation

SearchDeductions reconciled over a pay period.
Input fields[3]
FieldType
Pay Period Start DateRequired
date
Pay Period End DateRequired
date
Categorychoice
Pay Codetext
Limitnumber
Output fields[3]
FieldType
Worker IDtext
Worked shift IDnumber
Legal work time zonetime
Shift start atobject
Effective punch attext
Shift end atobject
Effective punch attext
Verified atdate
Verified by user IDnumber
Effective pay rateobject
Amounttext
Currencytext
Pay rate overriddenboolean
Payable detailsobject
Total payable amountobject
Paidboolean
Shift breaksarray
Shift durationsobject
Shift durationtext
Paid break durationtext
Unpaid break durationtext
Regular time workedobject
Overtime workedobject
Double time workedobject

List GL Mappings

SearchLedger code mappings for payroll costs.
Input fields[3]
FieldType
Categorychoice
Approval Group IDtext
Work Location IDtext
Masterboolean
Limitnumber
Output fields[3]
FieldType
IDnumber
Categorytext
Transaction typetext
Transaction detailtext
Approval group IDtext
Work location IDtext
Gl codetext
Descriptiontext
Created atdate
Updated atdate

List Leave Policies

SearchLeave policies with names and effective dates.
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
IDtext
Nametext
Descriptiontext
Period alignment methodtext
Effective datedate
Accrued leave typesarray
Front loaded leave typesarray
Unpaid front loaded leave typesarray

List Payables

SearchPayable amounts matching your filters.
Input fields[3]
FieldType
External Worker IDtext
Payable Payment Request IDtext
Payment IDtext
Paidboolean
Earning Timestamp Greater Thandate
Earning Timestamp Greater Than or Equal Todate
Earning Timestamp Less Thandate
Earning Timestamp Less Than or Equal Todate
Limitnumber
Output fields[3]
FieldType
External IDtext
Company IDnumber
External worker IDtext
Typetext
Labeltext
Amountobject
Amounttext
Currencytext
Payable modeltext
Pay codetext
Timestampdate
Payment IDnumber
Payment statustext
Ttoc codenumber
Cost centersarray
Payable payment request IDnumber

List Payments

SearchPayment records for a pay date or period.
Input fields[3]
FieldType
Pay datedate
Pay period start datedate
Pay period end datedate
Funding IDtext
Limitnumber
Output fields[3]
FieldType
IDtext
Worker IDtext
External worker IDtext
Pay period start datedate
Pay period end datedate
Pay datedate
Statustext
Funding IDtext
Total taxable wagesobject
Amounttext
Currencytext
Total non taxable payobject
Amounttext
Currencytext
Total employer taxobject
Amounttext
Currencytext
Total employer additional costsobject
Amounttext
Currencytext
Total net payobject
Amounttext
Currencytext
Taxable wagesarray
Non taxable payarray
Employer taxesarray
Employer additional costsarray
Employee tax withholdingsarray

2other output fields

List Payroll Calendars

SearchCalendars with display names and pay period types.
Input fields[3]
FieldType
Sortchoice
Include archivedboolean
Limitnumber
Output fields[3]
FieldType
IDtext
Display nametext
Pay period typetext
Monthly start daynumber
Effective datedate

List Payroll Cost Segments by Cost Center

SearchPayroll cost totals split by cost center.
Input fields[3]
FieldType
Cost center type keyRequired
text
Cost center valuesRequired
array
Ignore unknown cost center valuesboolean
Limitnumber
Output fields[3]
FieldType
Cost center type keytext
Cost center valuetext
Total wage amountobject
Amounttext
Currencytext
Total non taxable pay amountobject
Amounttext
Currencytext
Total employer tax amountobject
Amounttext
Currencytext
Total employer additional cost amountobject
Amounttext
Currencytext
Wage amountsarray
Non taxable pay amountsarray
Employer tax amountsarray
Employer additional cost amountsarray
Employee tax withholding amountsarray
Employee deduction amountsarray

List Payroll Cost Segments by Period

SearchPayroll cost totals split by earning period.
Input fields[3]
FieldType
Minimum earning datedate
Maximum earning datedate
Limitnumber
Output fields[3]
FieldType
Cost center type keytext
Cost center valuetext
Total wage amountobject
Amounttext
Currencytext
Total non taxable pay amountobject
Amounttext
Currencytext
Total employer tax amountobject
Amounttext
Currencytext
Total employer additional cost amountobject
Amounttext
Currencytext
Wage amountsarray
Non taxable pay amountsarray
Employer tax amountsarray
Employer additional cost amountsarray
Employee tax withholding amountsarray
Employee deduction amountsarray

List Shifts

SearchShift records narrowed by worker or payment.
Input fields[3]
FieldType
Worker IDchoice
External Worker IDarray
Payment IDarray
Minimum Work Location Start Datedate
Maximum Work Location Start Datedate
Minimum Work Location End Datedate
Maximum Work Location End Datedate
Limitnumber
Output fields[3]
FieldType
Worker IDtext
Worked shift IDnumber
Legal work time zonetime
Shift start atobject
Effective punch attext
Shift end atobject
Effective punch attext
Verified atdate
Verified by user IDnumber
Effective pay rateobject
Amounttext
Currencytext
Pay rate overriddenboolean
Payable detailsobject
Total payable amountobject
Paidboolean
Shift breaksarray
Shift durationsobject
Shift durationtext
Paid break durationtext
Unpaid break durationtext
Regular time workedobject
Overtime workedobject
Double time workedobject

List Work Locations

SearchWork locations with their address and time zone.
Input fields[3]
FieldType
External Worker IDtext
Payable Payment Request IDtext
Payment IDtext
Paidboolean
Earning Timestamp Greater Thandate
Earning Timestamp Greater Than or Equal Todate
Earning Timestamp Less Thandate
Earning Timestamp Less Than or Equal Todate
Limitnumber
Output fields[3]
FieldType
IDnumber
Line 1text
Line 2text
Citytext
Statetext
Postal codetext
Latitudenumber
Longitudenumber
Time zonetime

List Worker Pay History

SearchPast payments made to a worker.
Input fields[3]
FieldType
Worker IDRequired
choice
Limitnumber
Output fields[3]
FieldType
Worker IDtext
Worker full nametext
Payment IDnumber
Pay stub datedate
Pay datedate
Gross earningsobject
Amounttext
Currencytext
Total taxes withheldobject
Amounttext
Currencytext
Total employer taxesobject
Amounttext
Currencytext
Total employer additional costobject
Amounttext
Currencytext
Total expenseobject
Amounttext
Currencytext
Pre tax deductionsobject
Amounttext
Currencytext
Post tax deductionsobject
Amounttext
Currencytext
Deferred compensationobject
Amounttext
Currencytext
Net earningsobject
Amounttext
Currencytext
Payable notesarray
Shift idsarray
Taxes withheldarray
Employer taxesarray

3other output fields

List Worker Pay Statements

SearchPay stubs issued to one worker.
Input fields[3]
FieldType
Worker IDRequired
choice
Start datedate
End datedate
Limitnumber
Output fields[3]
FieldType
IDtext
Worker IDtext
Datedate
Pay period start datedate
Pay period end datedate
Gross earningsobject
Amounttext
Currencytext
Ytd gross earningsobject
Amounttext
Currencytext
Total taxes eeobject
Amounttext
Currencytext
Pre tax deductionsobject
Amounttext
Currencytext
Ytd pre tax deductionsobject
Amounttext
Currencytext
Post tax deductionsobject
Amounttext
Currencytext
Ytd post tax deductionsobject
Amounttext
Currencytext
Deferred compensationobject
Amounttext
Currencytext
Ytd deferred compensationobject
Amounttext
Currencytext
Net earningsobject
Amounttext
Currencytext
Ytd net earningsobject
Amounttext
Currencytext

List Workers

SearchWorkers matching your filters.
Input fields[3]
FieldType
Worker IDchoice
Lifecycle Statuschoice
Payroll Calendar IDtext
Limitnumber
Output fields[3]
FieldType
IDtext
First nametext
Middle nametext
Last nametext
Phone numbertext
Emailemail
Onboarding completeboolean
Hire datedate
Date of birthdate
Taxpayer identifiertext
Tin verification statustext
Typical weekly hoursnumber
Preferred payment methodtext
Approval groupobject
IDtext
Nametext
Positionobject
Pay typetext
Pay rateobject
Titletext
Home addressobject
Line 1text
Citytext
Statetext
Postal codetext
Bank accountsarray
Legal work addressobject
Use home addressboolean
Nametext
Addressobject

Apply a Benefit Deduction

ActionStarts a benefit deduction for a worker.
Input fields[3]
FieldType
Worker IDRequired
choice
Pay CodeRequired
text
Deduction Amountobject
Employee amountRequired
object
Period TypeRequired
choice
Employer Amountobject
Lifetime Limitobject
Amounttext
Currencytext
HSA Limit Typechoice
Effective Datedate
Effective End Datedate
Output fields[3]
FieldType
Worker IDtext
Pay codetext
Statustext
Effective datedate

Apply a Retirement Deduction

ActionStarts a retirement plan deduction.
Input fields[3]
FieldType
Worker IDRequired
choice
Pay CodeRequired
text
Deduction Amountobject
Employee AmountRequired
object
Period TypeRequired
choice
Deduction Percentageobject
Employee PercentageRequired
number
Limitobject
Employer Match Tiersarray
Match RateRequired
number
Percent of WagesRequired
number
Effective Datedate
Effective End Datedate
Output fields[3]
FieldType
Worker IDtext
Pay codetext
Statustext
Effective datedate

Archive a Work Location

ActionMarks a location as archived.
Input fields[3]
FieldType
Work Location IDRequired
choice

Create a Bank Account Split

ActionRoutes part of each payment to a bank account.
Input fields[3]
FieldType
Worker IDRequired
choice
Split NumberRequired
choice
Display NameRequired
text
Routing NumberRequired
text
Account TypeRequired
choice
Percent Per PaymentRequired
text
Account Numbertext
Output fields[3]
FieldType
Display nametext
Bank nametext
Account number last 4text
Routing numbertext
Account typetext
Percent per paymenttext
Deposits allowedboolean
Split numbernumber

Create a Contractor

ActionRegisters a contractor with tax and bank details.
Input fields[3]
FieldType
First nameRequired
text
Last nameRequired
text
Phone numberRequired
text
EmailRequired
email
Hire dateRequired
date
Home addressRequired
object
Address line 1Required
text
CityRequired
text
StateRequired
text
Postal codeRequired
text
Address line 2text
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 addressboolean
Work location IDtext
W-9 form responseRequired
object
Entity or individual nameRequired
text
Tax classificationRequired
choice
Business nametext
LLC tax classificationchoice
Social Security numbertext
Employer identification numbertext
Exempt payee codetext
FATCA reporting exemption codetext
Effective datedate
Onboarding completeboolean
External worker IDtext
Approval group IDtext
Middle nametext
Correction Authorizedboolean
Output fields[3]
FieldType
IDtext
First nametext
Middle nametext
Last nametext
Phone numbertext
Emailemail
Onboarding completeboolean
Hire datedate
Date of birthdate
Taxpayer identifiertext
Tin verification statustext
Typical weekly hoursnumber
Preferred payment methodtext
Approval groupobject
IDtext
Nametext
Positionobject
Pay typetext
Pay rateobject
Titletext
Home addressobject
Line 1text
Citytext
Statetext
Postal codetext
Bank accountsarray
Legal work addressobject
Use home addressboolean
Nametext
Addressobject

Create a Cost Center

ActionAdds a cost center with its key and job type.
Input fields[3]
FieldType
Cost Center KeyRequired
text
Job Typeobject
Display NameRequired
text
Slotchoice
Output fields[3]
FieldType
Cost center keytext
Display nametext
Slotnumber
Archived atdate

Create a Leave Policy

ActionDefines how workers earn or receive leave.
Input fields[3]
FieldType
NameRequired
text
Period alignment methodRequired
choice
Accrued leave typesarray
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 rulesarray
Front-loaded leave typesarray
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 proratedboolean
Tenure award rulesarray
Unpaid front-loaded leave typesarray
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 proratedboolean
Tenure award rulesarray
Output fields[3]
FieldType
IDtext
Nametext
Descriptiontext
Period alignment methodtext
Effective datedate
Accrued leave typesarray
Front loaded leave typesarray
Unpaid front loaded leave typesarray

Create a Payable

ActionRecords a payable amount for a worker.
Input fields[3]
FieldType
External IDRequired
text
LabelRequired
text
AmountRequired
object
Amountnumber
Currencytext
Payable ModelRequired
choice
Pay CodeRequired
text
TimestampRequired
date
TypeRequired
text
Correction Authorizedboolean
Worker IDtext
External Worker IDtext
Unit Rateobject
Amountnumber
Currencytext
Unit Countnumber
Work Location IDtext
TTOC Codenumber
Cost Centersarray
TypeRequired
text
ValueRequired
text
Output fields[3]
FieldType
External IDtext
Company IDnumber
External worker IDtext
Typetext
Labeltext
Amountobject
Amounttext
Currencytext
Payable modeltext
Pay codetext
Timestampdate
Payment IDnumber
Payment statustext
Ttoc codenumber
Cost centersarray
Payable payment request IDnumber

Create a Payroll Calendar

ActionAdds a calendar for pay periods and start days.
Input fields[3]
FieldType
Display nameRequired
text
Pay period typeRequired
choice
Effective dateRequired
date
Weekly start daychoice
Monthly start daynumber
Output fields[3]
FieldType
IDtext
Display nametext
Pay period typetext
Weekly start daytext
Effective datedate

Create a Shift

ActionLogs a block of worked time.
Input fields[3]
FieldType
Worker IDRequired
choice
External Worker IDRequired
text
Shift StartRequired
date
Shift Enddate
Correction Authorizedboolean
Create Breaksarray
Segment Config CodeRequired
text
Break DurationRequired
text
Effective Hourly Pay Rateobject
Amounttext
Currencytext
Display Hourly Pay Rateobject
Amounttext
Currencytext
Work Location IDnumber
Workers Comp Class Codetext
Tax Calculation Config Codechoice
Correction Payment Timeframechoice
Fully Classified Hoursarray
TypeRequired
choice
StartRequired
number
EndRequired
number
Hourly Pay RateRequired
object
Notetext
Cost Centersarray
TypeRequired
text
ValueRequired
text
Output fields[3]
FieldType
Worker IDtext
Worked shift IDnumber
Legal work time zonetime
Shift start atobject
Effective punch attext
Shift end atobject
Effective punch attext
Verified atdate
Verified by user IDnumber
Effective pay rateobject
Amounttext
Currencytext
Pay rate overriddenboolean
Cost centersarray
Payable detailsobject
Total payable amountobject
Paidboolean
Shift breaksarray
Shift durationsobject
Shift durationtext
Paid break durationtext
Unpaid break durationtext
Regular time workedobject
Overtime workedobject
Double time workedobject

Create a Work Location

ActionAdds a location with a name and address.
Input fields[3]
FieldType
NameRequired
text
Address line 1Required
text
CityRequired
text
StateRequired
text
Postal codeRequired
text
Effective dateRequired
date
Address line 2text
Phone numbertext
Latitudenumber
Longitudenumber
External IDtext
Output fields[3]
FieldType
IDnumber
Line 1text
Line 2text
Citytext
Statetext
Postal codetext
Latitudenumber
Longitudenumber
Time zonetime

Create an Employee

ActionRegisters an employee with pay and tax setup.
Input fields[3]
FieldType
First nameRequired
text
Last nameRequired
text
Taxpayer identifierRequired
text
Date of birthRequired
date
Phone numberRequired
text
EmailRequired
email
Middle nametext
Home addressRequired
object
Address line 1Required
text
CityRequired
text
StateRequired
text
Postal codeRequired
text
Address line 2text
Legal work addressRequired
object
Use home addressboolean
Work location IDnumber
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 schedulechoice
Payroll calendar IDtext
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 overtimeboolean

6other input fields

Output fields[3]
FieldType
IDtext
First nametext
Middle nametext
Last nametext
Phone numbertext
Emailemail
Onboarding completeboolean
Hire datedate
Date of birthdate
Taxpayer identifiertext
Tin verification statustext
Typical weekly hoursnumber
Preferred payment methodtext
Approval groupobject
IDtext
Nametext
Positionobject
Pay typetext
Pay rateobject
Titletext
Home addressobject
Line 1text
Citytext
Statetext
Postal codetext
Bank accountsarray
Legal work addressobject
Use home addressboolean
Nametext
Addressobject

Create Payables in Bulk

ActionBatch entry of payable amounts.
Input fields[3]
FieldType
List of Payablesarray
Output fields[3]
FieldType
External idsarray

Delete a Bank Account Split

ActionDeletes a worker payment split.
Input fields[3]
FieldType
Worker IDRequired
choice
Split NumberRequired
choice

Delete a GL Mapping

ActionRemoves one ledger code mapping.
Input fields[3]
FieldType
Mapping IDRequired
choice

Delete a Leave Policy

ActionRemoves one time-off policy.
Input fields[3]
FieldType
Policy IDRequired
text

Delete a Payable

ActionRemoves one payable amount.
Input fields[3]
FieldType
External IDRequired
choice
Correction Authorizedboolean

Delete a Payroll Calendar

ActionDeletes one calendar of pay periods.
Input fields[3]
FieldType
Payroll Calendar IDRequired
choice

Delete a Shift

ActionRemoves one logged shift.
Input fields[3]
FieldType
Worked Shift IDRequired
text
Correction Authorizedboolean

Delete a Worker Profile

ActionDeletes the profile of one employee or contractor.
Input fields[3]
FieldType
Worker IDRequired
text

Look Up a Hiring Status

ActionHiring scenario for a matched person.
Input fields[3]
FieldType
Taxpayer Identifiertext
Emailemail
Phone Numbertext
First Nametext
Last Nametext
Date of Birthdate
External Worker IDtext
Output fields[3]
FieldType
Hiring scenariotext
Worker IDtext
External worker IDtext
Full nametext
Emailemail
Phone numbertext
Taxpayer identifiertext
Employment typetext
Activity detailsobject
Activeboolean
Active reasontext
Most recent hire datetext
Hiring detailsobject
Eligible for hireboolean
Eligible for hire reasontext

Make an API Call

universalCustom Everee REST API request.
Input fields[3]
FieldType
URLRequired
text
MethodRequired
choice
Headersarray
Headerobject
Query Stringarray
Parameterobject
Bodytext
Output fields[3]
FieldType
Bodytext
Headersobject
Status codenumber

Prepare Payables

ActionReadies payables for payment.
Input fields[3]
FieldType
External IDsarray
Worker IDsarray
External Worker IDsarray
External Typesarray
Include Workers on Regular Pay Cycleboolean
Tenant IDnumber
Output fields[3]
FieldType
Payable countnumber
Company IDnumber

Rehire a Worker

ActionBrings a former worker back.
Input fields[3]
FieldType
Worker IDRequired
text
Rehire DateRequired
date
Approval Group IDnumber
Use Home Addressboolean
Work Location IDtext
Employee Positionobject
Pay TypeRequired
choice
Pay RateRequired
object
Expected Weekly HoursRequired
number
SOC Codetext
Titletext
Worker Compensation Class IDtext
Eligible for Overtimeboolean
Cost Centersarray
Output fields[3]
FieldType
IDtext
First nametext
Middle nametext
Last nametext
Phone numbertext
Emailemail
Onboarding completeboolean
Hire datedate
Date of birthdate
Taxpayer identifiertext
Tin verification statustext
Typical weekly hoursnumber
Preferred payment methodtext
Approval groupobject
IDtext
Nametext
Positionobject
Pay typetext
Pay rateobject
Titletext
Home addressobject
Line 1text
Citytext
Statetext
Postal codetext
Bank accountsarray
Legal work addressobject
Use home addressboolean
Nametext
Addressobject

Separate a Contractor

ActionCloses out a contractor relationship.
Input fields[3]
FieldType
Worker IDRequired
text
Date of SeparationRequired
date
Eligible for RehireRequired
boolean
Contractor Separation TypeRequired
choice
Benefits Enrollment End DateRequired
date
Notestext

Separate an Employee

ActionCloses out an employee with optional payouts.
Input fields[3]
FieldType
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 Amountobject
Amounttext
Currencytext
Notestext
Time Off Separation Categoriesarray
Earning TypeRequired
text
Payoff TypeRequired
choice
Percentage Amountnumber
Maximum Hours Amountnumber

Start a Contractor Onboarding

ActionOpens the contractor onboarding flow.
Input fields[3]
FieldType
First nameRequired
text
Last nameRequired
text
Phone numberRequired
text
EmailRequired
email
Hire dateRequired
date
Legal work addressRequired
object
Use home addressboolean
Work location IDtext
State unemployment tax location IDtext
Middle nametext
Approval group IDtext
Worker IDtext
Document groupsarray
Output fields[3]
FieldType
IDtext
First nametext
Middle nametext
Last nametext
Phone numbertext
Emailemail
Onboarding completeboolean
Hire datedate
Date of birthdate
Taxpayer identifiertext
Tin verification statustext
Typical weekly hoursnumber
Preferred payment methodtext
Approval groupobject
IDtext
Nametext
Positionobject
Pay typetext
Pay rateobject
Titletext
Home addressobject
Line 1text
Citytext
Statetext
Postal codetext
Bank accountsarray
Legal work addressobject
Use home addressboolean
Nametext
Addressobject

Start an Employee Onboarding

ActionBegins onboarding with pay and hire details.
Input fields[3]
FieldType
First nameRequired
text
Last nameRequired
text
Phone numberRequired
text
EmailRequired
email
Pay typeRequired
choice
Pay rateRequired
object
Amounttext
Currencytext
Typical weekly hoursRequired
number
Hire dateRequired
date
Legal work addressRequired
object
Use home addressboolean
Work location IDtext
State unemployment tax location IDtext
Middle nametext
Pay schedulechoice
Payroll calendar IDtext
Eligible for overtimeboolean
Approval group IDtext
Time-off policy IDtext
Cost centersarray
TypeRequired
text
ValueRequired
text
Worker IDtext
Document groupsarray
Output fields[3]
FieldType
IDtext
First nametext
Middle nametext
Last nametext
Phone numbertext
Emailemail
Onboarding completeboolean
Hire datedate
Date of birthdate
Taxpayer identifiertext
Tin verification statustext
Typical weekly hoursnumber
Preferred payment methodtext
Approval groupobject
IDtext
Nametext
Positionobject
Pay typetext
Pay rateobject
Titletext
Home addressobject
Line 1text
Citytext
Statetext
Postal codetext
Bank accountsarray
Legal work addressobject
Use home addressboolean
Nametext
Addressobject

Update a Leave Policy

ActionRenames a time-off policy or rewrites its text.
Input fields[3]
FieldType
Policy IDRequired
text
Nametext
Descriptiontext
Output fields[3]
FieldType
IDtext
Nametext
Descriptiontext
Period alignment methodtext
Effective datedate
Accrued leave typesarray
Front loaded leave typesarray
Unpaid front loaded leave typesarray

Update a Payable

ActionEdits a payable amount.
Input fields[3]
FieldType
External IDRequired
choice
LabelRequired
text
AmountRequired
object
Amountnumber
Currencytext
Payable ModelRequired
choice
Pay CodeRequired
text
TimestampRequired
date
TypeRequired
text
Correction Authorizedboolean
Worker IDtext
External Worker IDtext
Unit Rateobject
Amountnumber
Currencytext
Unit Countnumber
Work Location IDtext
TTOC Codenumber
Cost Centersarray
TypeRequired
text
ValueRequired
text
Output fields[3]
FieldType
External IDtext
Company IDnumber
External worker IDtext
Typetext
Labeltext
Amountobject
Amounttext
Currencytext
Payable modeltext
Pay codetext
Timestampdate
Payment IDnumber
Payment statustext
Ttoc codenumber
Cost centersarray
Payable payment request IDnumber

Update a Shift

ActionChanges the times or rates of a logged shift.
Input fields[3]
FieldType
Worked Shift IDRequired
text
Worker IDRequired
choice
External Worker IDRequired
text
Shift StartRequired
date
Shift Enddate
Correction Authorizedboolean
Create Breaksarray
Segment Config CodeRequired
text
Break DurationRequired
text
Effective Hourly Pay Rateobject
Amounttext
Currencytext
Display Hourly Pay Rateobject
Amounttext
Currencytext
Work Location IDnumber
Workers Comp Class Codetext
Tax Calculation Config Codechoice
Correction Payment Timeframechoice
Fully Classified Hoursarray
TypeRequired
choice
StartRequired
number
EndRequired
number
Hourly Pay RateRequired
object
Notetext
Cost Centersarray
TypeRequired
text
ValueRequired
text
Output fields[3]
FieldType
Worker IDtext
Worked shift IDnumber
Legal work time zonetime
Shift start atobject
Effective punch attext
Shift end atobject
Effective punch attext
Verified atdate
Verified by user IDnumber
Effective pay rateobject
Amounttext
Currencytext
Pay rate overriddenboolean
Cost centersarray
Payable detailsobject
Total payable amountobject
Paidboolean
Shift breaksarray
Shift durationsobject
Shift durationtext
Paid break durationtext
Unpaid break durationtext
Regular time workedobject
Overtime workedobject
Double time workedobject

Update a Work Location

ActionEdits the address or name of a location.
Input fields[3]
FieldType
Work Location IDRequired
choice
Nametext
Address line 1text
Citytext
Statetext
Postal codetext
Effective datedate
Address line 2text
Phone numbertext
Latitudenumber
Longitudenumber
External IDtext
Output fields[3]
FieldType
IDnumber
Line 1text
Line 2text
Citytext
Statetext
Postal codetext
Latitudenumber
Longitudenumber
Time zonetime

Update the Default Bank Account of a Worker

ActionEdits where a worker is paid by default.
Input fields[3]
FieldType
Worker IDRequired
choice
Account NameRequired
text
Account TypeRequired
choice
Routing NumberRequired
text
Account NumberRequired
text
Output fields[3]
FieldType
IDtext
First nametext
Middle nametext
Last nametext
Phone numbertext
Emailemail
Onboarding completeboolean
Hire datedate
Date of birthdate
Taxpayer identifiertext
Tin verification statustext
Typical weekly hoursnumber
Preferred payment methodtext
Approval groupobject
IDtext
Nametext
Positionobject
Pay typetext
Pay rateobject
Titletext
Home addressobject
Line 1text
Citytext
Statetext
Postal codetext
Bank accountsarray
Legal work addressobject
Use home addressboolean
Nametext
Addressobject

Update the Home Address of a Worker

ActionChanges where a worker lives.
Input fields[3]
FieldType
Worker IDRequired
choice
Line 1Required
text
CityRequired
text
StateRequired
text
Postal CodeRequired
text
Effective DateRequired
date
Line 2text
Output fields[3]
FieldType
IDtext
First nametext
Middle nametext
Last nametext
Phone numbertext
Emailemail
Onboarding completeboolean
Hire datedate
Date of birthdate
Taxpayer identifiertext
Tin verification statustext
Typical weekly hoursnumber
Preferred payment methodtext
Approval groupobject
IDtext
Nametext
Positionobject
Pay typetext
Pay rateobject
Titletext
Home addressobject
Line 1text
Citytext
Statetext
Postal codetext
Bank accountsarray
Legal work addressobject
Use home addressboolean
Nametext
Addressobject

Update the Legal Work Location of a Worker

ActionMoves a worker to a different legal work location.
Input fields[3]
FieldType
Worker IDRequired
choice
Use Home AddressRequired
boolean
Effective DateRequired
date
Work Location IDtext
State Unemployment Tax Location IDtext
Output fields[3]
FieldType
IDtext
First nametext
Middle nametext
Last nametext
Phone numbertext
Emailemail
Onboarding completeboolean
Hire datedate
Date of birthdate
Taxpayer identifiertext
Tin verification statustext
Typical weekly hoursnumber
Preferred payment methodtext
Approval groupobject
IDtext
Nametext
Positionobject
Pay typetext
Pay rateobject
Titletext
Home addressobject
Line 1text
Citytext
Statetext
Postal codetext
Bank accountsarray
Legal work addressobject
Use home addressboolean
Nametext
Addressobject

Update the Personal Information of a Worker

ActionNames, preferences and sizes for a worker.
Input fields[3]
FieldType
Worker IDRequired
choice
First NameRequired
text
Last NameRequired
text
Middle Nametext
Date of Birthdate
Shirt Sizetext
Partner Shirt Sizetext
Dietary Restrictionstext
Preferred Nametext
Output fields[3]
FieldType
IDtext
First nametext
Middle nametext
Last nametext
Phone numbertext
Emailemail
Onboarding completeboolean
Hire datedate
Date of birthdate
Taxpayer identifiertext
Tin verification statustext
Typical weekly hoursnumber
Preferred payment methodtext
Approval groupobject
IDtext
Nametext
Positionobject
Pay typetext
Pay rateobject
Titletext
Home addressobject
Line 1text
Citytext
Statetext
Postal codetext
Bank accountsarray
Legal work addressobject
Use home addressboolean
Nametext
Addressobject

Update the Position of a Worker

ActionEdits the compensation and role of a worker.
Input fields[3]
FieldType
Worker IDRequired
choice
Pay typeRequired
choice
Pay rateRequired
object
Amounttext
Currencytext
Expected weekly hoursRequired
number
Effective dateRequired
date
Titletext
Default worker compensation class codetext
SOC codetext
Cost centersarray
TypeRequired
text
ValueRequired
text
Output fields[3]
FieldType
IDtext
First nametext
Middle nametext
Last nametext
Phone numbertext
Emailemail
Onboarding completeboolean
Hire datedate
Date of birthdate
Taxpayer identifiertext
Tin verification statustext
Typical weekly hoursnumber
Preferred payment methodtext
Approval groupobject
IDtext
Nametext
Positionobject
Pay typetext
Pay rateobject
Titletext
Home addressobject
Line 1text
Citytext
Statetext
Postal codetext
Bank accountsarray
Legal work addressobject
Use home addressboolean
Nametext
Addressobject

Upsert a GL Mapping

ActionCreates or changes ledger code mappings.
Input fields[3]
FieldType
Mappingsarray
CategoryRequired
choice
GL CodeRequired
text
Transaction Typetext
Transaction Detailtext
Approval Group IDtext
Work Location IDtext
Descriptiontext
Output fields[3]
FieldType
IDnumber
Categorytext
Transaction typetext
Transaction detailtext
Approval group IDtext
Work location IDtext
Gl codetext
Descriptiontext
Created atdate
Updated atdate

Look for Everee templates in the WEXTL template library.

Browse templates →
  1. WEXTL® Everee Source Code connector implementation.
  2. Our users use cases and automations.
  3. Official API Documentation for Everee.
  4. 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.