About this integration
PEO and HR outsourcing platform for payroll, benefits, and compliance. This integration exposes its full API as workflow modules.
The integration includes 2 triggers, 21 search modules and 33 actions. Connections use basic authentication.
How to connect
The credential form asks for URL, Username, Password, and PEO ID.
Prefer the interactive builder form? Open it on the app page.
Enter your credentials below. WEXTL stores them encrypted and uses them only to call the API on your behalf.
You can set up a web service using this Guide
| Field | Type | Help |
|---|---|---|
URLRequired | url | Your cloud instance url e.g https://<your-company>.prismhr.com/prismhr-api/ |
UsernameRequired | text | The web service user ID, created within PrismHR System Parameters. |
PasswordRequired | password | The password defined for this web service user |
PEO IDRequired | text | The unique identifier that identifies the web services user account |
Use it in workflow automation
Start with Watch Job Applicants, then add Accept a Timesheet.
The canvas below runs Watch Job Applicants into Accept a Timesheet — watch the video, then drop a node onto the canvas.
Select the Watch Manual Checks trigger and the workflow fires automatically when the event occurs — no polling required.
Then add Calculate a Manual Check as the next node. Branch, filter, or hand off to other integrations from there.
The integration includes 35 ready-made modules for HR work — each run logs its inputs and outputs for debugging.
PrismHR workflow on the canvas: Watch Manual Checks then Calculate a Manual Check
Triggers, searches and actions
Browse every PrismHR module field below: 2 triggers, 21 searchs, and 33 actions you can drop onto the canvas.
Triggers
This integration includes 2 triggers — start a workflow the moment something changes in the app.
- Watch Job Applicants
- Watch Manual Checks
Searches
Use any of 21 search modules to retrieve records without leaving the workflow canvas.
- Get an Absence Journal
- Get an Employee
- Get a Payroll Schedule
- Get a Pending Bill
- Get Bulk Outstanding Invoices
16more searches
Actions
This integration includes 33 action modules — create, update, or delete records as part of any workflow.
- Accept a Timesheet
- Add a Pending Bill
- Add Employee Absence
- Adjust PTO
- Approve or Deny a PTO Request
28more actions
Explore the fields available for each PrismHR trigger, search, and action.
Triggers
Output fields
| Field | Type |
|---|---|
ID | text |
Apply date | date |
Last name | text |
First name | text |
Middle name | text |
Hire date | date |
Location code | text |
Client ID | text |
Output fields
| Field | Type |
|---|---|
Client ID | text |
Employee ID | text |
Check date | date |
Voucher type | text |
Bank account code | text |
Check number | text |
Tip gross receipts | number |
Pay period | text |
Deduction period | text |
Work shift | text |
Period start date | text |
Period end date | text |
Pay codes | array |
Deduction codes | array |
Reference | text |
Checksum | text |
Status | text |
Payroll number | text |
Voucher number | text |
Bank account desc | text |
2other output fields
Searches
Input fields
| Field | Type |
|---|---|
Client IDRequired | choice |
Journal IDRequired | array |
Journal Identifier | text |
Limit | number |
Output fields
| Field | Type |
|---|---|
Journal ID | text |
Employee ID | text |
Absence code | text |
Absence date | text |
Hours | text |
Comment | text |
Is paid | text |
Journal type | text |
Accrued hours | text |
Carry over hours | text |
Accrued thru date | text |
Register type | text |
Input fields
| Field | Type |
|---|---|
Client IDRequired | choice |
Options | choice |
Output fields
| Field | Type |
|---|---|
ID | text |
Last name | text |
First name | text |
Middle initial | text |
Preferred name | text |
Person | object |
Ethnic code | text |
Birth date | text |
Driver license ID | text |
Cobra ssn | text |
Employer ids | array |
Cobra only | boolean |
Geo code | text |
Marital status | text |
Married date | text |
Smoker | text |
Contact information | object |
Address line 1 | text |
Address line 2 | text |
City | text |
State | text |
Zipcode | text |
Zip suffix | text |
County | text |
School district | text |
Home phone | text |
Mobile phone | text |
Client | object |
Employee status | text |
Status class | text |
Status date | text |
Employee type | text |
Type class | text |
Type date | text |
Transfer info | array |
Property | array |
Hawaii med waivers | array |
Job code | text |
Compensation | object |
Ssn | text |
Pay group | text |
Pay period | text |
Pay period info | array |
Default hours | text |
Pay method | text |
Allocation template ID | text |
Pay allocation | array |
Standard hours | text |
State tax | array |
Direct deposit | object |
Ach status | text |
Voucher type | text |
Suppress account print | boolean |
Ach voucher | array |
Direct deposit checksum | text |
Hsa | object |
Hsa deposit settings | array |
Ach checksum | text |
Employee events | object |
Employee event | array |
Health | object |
Allergy | array |
Condition | array |
Program | array |
Height | text |
Weight | text |
Blood type | text |
Blood rh | text |
Blood donor | boolean |
Donate date last | text |
Donate date next | text |
Skills and education | object |
Skill checksum | text |
Skill | array |
School | array |
Osha 10certified | boolean |
Absence journal ID | array |
Benefit enrollment completed | boolean |
Scheduled deduction | array |
New hire questions | array |
Enrollment in progress | object |
Enrollment in progress | boolean |
Enrollment type | text |
Input fields
| Field | Type |
|---|---|
Schedule CodeRequired | text |
Output fields
| Field | Type |
|---|---|
Session ID | text |
Schedule code | text |
Description | text |
Pay period | text |
Pay day | text |
Pay period end | text |
Period end bef aft | text |
First pay day | text |
First period ends | text |
First period end bef aft | text |
Second pay day | text |
Second period ends | text |
Second period end bef aft | text |
Monthly occurs | text |
Day of week | text |
Day of month | text |
Checksum | text |
Allowed pay period options | array |
Update payroll schedule result | object |
Schedule code | text |
Update messages | array |
Input fields
| Field | Type |
|---|---|
Client IDRequired | choice |
Event | text |
Start Bill Date | date |
End Bill Date | date |
Status | choice |
Output fields
| Field | Type |
|---|---|
Bill date | text |
Event | text |
Billing units | text |
Bill rate | text |
Bill amount | text |
Employee ID | text |
Pay group | text |
Payroll type | text |
Location | text |
Division | text |
Department | text |
Shift | text |
Project | text |
Comment | text |
Cost amount | text |
Repeat thru date | text |
Repeat cycle | text |
Bill status | text |
Entry reference | text |
Checksum | text |
2other output fields
Input fields
| Field | Type |
|---|---|
Client ID | choice |
Download ID | text |
Show Only Deposit Match | text |
Output fields
| Field | Type |
|---|---|
ID | text |
Last name | text |
First name | text |
Middle initial | text |
Preferred name | text |
Person | object |
Ethnic code | text |
Birth date | text |
Driver license ID | text |
Cobra ssn | text |
Employer ids | array |
Cobra only | boolean |
Geo code | text |
Marital status | text |
Married date | text |
Smoker | text |
Contact information | object |
Address line 1 | text |
Address line 2 | text |
City | text |
State | text |
Zipcode | text |
Zip suffix | text |
County | text |
School district | text |
Home phone | text |
Mobile phone | text |
Client | object |
Employee status | text |
Status class | text |
Status date | text |
Employee type | text |
Type class | text |
Type date | text |
Transfer info | array |
Property | array |
Hawaii med waivers | array |
Job code | text |
Compensation | object |
Ssn | text |
Pay group | text |
Pay period | text |
Pay period info | array |
Default hours | text |
Pay method | text |
Allocation template ID | text |
Pay allocation | array |
Standard hours | text |
State tax | array |
Direct deposit | object |
Ach status | text |
Voucher type | text |
Suppress account print | boolean |
Ach voucher | array |
Direct deposit checksum | text |
Hsa | object |
Hsa deposit settings | array |
Ach checksum | text |
Employee events | object |
Employee event | array |
Health | object |
Allergy | array |
Condition | array |
Program | array |
Height | text |
Weight | text |
Blood type | text |
Blood rh | text |
Blood donor | boolean |
Donate date last | text |
Donate date next | text |
Skills and education | object |
Skill checksum | text |
Skill | array |
School | array |
Osha 10certified | boolean |
Absence journal ID | array |
Benefit enrollment completed | boolean |
Scheduled deduction | array |
New hire questions | array |
Enrollment in progress | object |
Enrollment in progress | boolean |
Enrollment type | text |
Input fields
| Field | Type |
|---|---|
In Active | boolean |
Limit | number |
Output fields
| Field | Type |
|---|---|
Client ID | text |
Client name | text |
Legal name | text |
Status | text |
Input fields
| Field | Type |
|---|---|
Document Type IDRequired | choice |
Limit | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Label | text |
Description | text |
Scope | text |
Default path | text |
Status | text |
Reserved | text |
User role | array |
Input fields
| Field | Type |
|---|---|
Client IDRequired | choice |
Limit | number |
Output fields
| Field | Type |
|---|---|
Event code | text |
Effective date | text |
Description | text |
Action date | date |
Comment | text |
Input fields
| Field | Type |
|---|---|
Client IDRequired | choice |
As of Status Date | date |
Status Class | choice |
Type Class | choice |
Limit | number |
Input fields
| Field | Type |
|---|---|
GL Code | text |
Limit | number |
Output fields
| Field | Type |
|---|---|
Account code | text |
Account code desc | text |
Input fields
| Field | Type |
|---|---|
TypeRequired | choice |
Output fields
| Field | Type |
|---|---|
Error code | text |
Error message | text |
Extension | object |
Any | object |
Gl journal results | array |
Gl invoice results | array |
Input fields
| Field | Type |
|---|---|
G/L CompanyRequired | text |
Invoice DateRequired | text |
Include Posted | text |
Output fields
| Field | Type |
|---|---|
Error code | text |
Error message | text |
Extension | object |
Any | object |
Gl invoice detail | object |
Un posted invoice total | number |
Posted invoice total | number |
Un posted receipt total | number |
Posted receipt total | number |
Unposted gl invoice details | array |
Posted gl invoice details | array |
Info messages | array |
Input fields
| Field | Type |
|---|---|
Client IDRequired | choice |
List Name | text |
Application Date | date |
Last Name | text |
Limit | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Apply date | date |
Last name | text |
First name | text |
Middle name | text |
Hire date | date |
Location code | text |
Client ID | text |
Input fields
| Field | Type |
|---|---|
Client IDRequired | choice |
Check Date | date |
Check Status | choice |
Reference | text |
Output fields
| Field | Type |
|---|---|
Client ID | text |
Employee ID | text |
Check date | date |
Voucher type | text |
Bank account code | text |
Check number | text |
Tip gross receipts | number |
Pay period | text |
Deduction period | text |
Work shift | text |
Period start date | text |
Period end date | text |
Pay codes | array |
Deduction codes | array |
Reference | text |
Checksum | text |
Status | text |
Payroll number | text |
Voucher number | text |
Bank account desc | text |
2other output fields
Input fields
| Field | Type |
|---|---|
Client List | choice |
Download ID | text |
From Date | date |
Task | choice |
Output fields
| Field | Type |
|---|---|
Error code | text |
Error message | text |
Extension | object |
Any | object |
Download ID | text |
Build status | text |
Data object | text |
Warnings | text |
Input fields
| Field | Type |
|---|---|
Client IDRequired | choice |
Limit | number |
Output fields
| Field | Type |
|---|---|
Register type | text |
Register type description | text |
Carry over hours | text |
Accrued hours ytd | text |
Used hours ytd | text |
Year end date | text |
Accrued thru | text |
Last carry over | text |
Pto plan ID | text |
Benefit start | text |
Carry over expires | text |
Carry over expire flag | boolean |
Journal ID | array |
Accrued flag | boolean |
Prior year | array |
Stop pto accruals | boolean |
Input fields
| Field | Type |
|---|---|
Client IDRequired | choice |
Limit | number |
Output fields
| Field | Type |
|---|---|
Register type | text |
Register type description | text |
Carry over hours | text |
Accrued hours ytd | text |
Used hours ytd | text |
Year end date | text |
Accrued thru | text |
Last carry over | text |
Pto plan ID | text |
Benefit start | text |
Carry over expires | text |
Carry over expire flag | boolean |
Journal ID | array |
Accrued flag | boolean |
Prior year | array |
Stop pto accruals | boolean |
Input fields
| Field | Type |
|---|---|
Client IDRequired | choice |
Batch ID | text |
Year | text |
Batch Type | choice |
Include Details | boolean |
Sort | choice |
Output fields
| Field | Type |
|---|---|
Payroll history | array |
Employee sort details | array |
Pay code sort details | array |
Project sort details | array |
Position sort details | array |
Dept sort details | array |
Div sort details | array |
Loc sort details | array |
Shift sort details | array |
Input fields
| Field | Type |
|---|---|
Client IDRequired | choice |
Limit | number |
Output fields
| Field | Type |
|---|---|
Contact ID | text |
Contact type | text |
Contact name | text |
Contact title | text |
Contact phone | text |
Contact phone ext | text |
Contact email | text |
Contact address | text |
Contact city | text |
Contact state | text |
Contact zip | text |
Contact zip suffix | text |
Comments | text |
Checksum | text |
Contact cell phone | text |
Input fields
| Field | Type |
|---|---|
Client IDRequired | choice |
Leave Type | text |
PTO Starts After Date | date |
Statuses | choice |
Limit | number |
Output fields
| Field | Type |
|---|---|
Employee ID | text |
Name | text |
Leave type | text |
Leave type description | text |
Status | text |
Leave request | text |
Checksum | text |
Start date | text |
End date | text |
Comments | text |
Leave dates | array |
Vouchers | array |
Leave hours | number |
Leave hour details | array |
Absence code reason | text |
Pto register type code | text |
Approver ID | text |
Deny reason | text |
Input fields
| Field | Type |
|---|---|
Client IDRequired | choice |
Batch IDRequired | text |
Output fields
| Field | Type |
|---|---|
Error code | text |
Error message | text |
Extension | object |
Any | object |
Batch ID | text |
Time sheet data list | array |
Actions
Input fields
| Field | Type |
|---|---|
Client IDRequired | choice |
User IDRequired | text |
Batch ListRequired | array |
Batch | text |
Upload IDRequired | text |
Input fields
| Field | Type |
|---|---|
Client IDRequired | choice |
Bill DateRequired | text |
EventRequired | text |
Billing UnitsRequired | text |
Bill RateRequired | text |
Bill AmountRequired | text |
Pay Group | text |
Payroll Type | text |
Location | text |
Division | text |
Department | text |
Shift | text |
Project | text |
Comment | text |
Cost Amount | text |
Repeat Thru Date | text |
Repeat Cycle | choice |
Bill Status | text |
Input fields
| Field | Type |
|---|---|
Client IDRequired | choice |
Absence CodeRequired | text |
Date AbsentRequired | date |
Hours AbsentRequired | text |
Comment | text |
Input fields
| Field | Type |
|---|---|
Client IDRequired | choice |
Register TypeRequired | text |
Effective DateRequired | date |
Accrued Hours | number |
Carry Over Hours | number |
Accrued Through Date | date |
Comment | text |
Output fields
| Field | Type |
|---|---|
Employee ID | text |
Client ID | text |
Journal ID | text |
Update messages | array |
Input fields
| Field | Type |
|---|---|
Client IDRequired | choice |
Requested ActionRequired | choice |
Deny Reason | text |
Multi-Step Approval | boolean |
Input fields
| Field | Type |
|---|---|
Client IDRequired | choice |
Check DateRequired | date |
Voucher TypeRequired | choice |
Bank Account CodeRequired | text |
Check NumberRequired | text |
Period Start DateRequired | date |
Period End DateRequired | date |
Tip Gross Receipts | number |
Pay Period | choice |
Deduction Period | choice |
Work Shift | text |
Pay Codes | array |
Deduction Codes | array |
Session ID | text |
Calculation Only | boolean |
Optional Tax Calculation Overrides | array |
Output fields
| Field | Type |
|---|---|
Client ID | text |
Employee ID | text |
Check date | text |
Voucher type | text |
Bank account code | text |
Check number | text |
Tip gross receipts | number |
Pay period | text |
Deduction period | text |
Work shift | text |
Period start date | text |
Period end date | text |
Pay codes | array |
Deduction codes | array |
Reference | text |
Checksum | text |
Status | text |
Payroll number | text |
Voucher number | text |
Bank account desc | text |
3other output fields
Input fields
| Field | Type |
|---|---|
Client IDRequired | choice |
Import Batch IDRequired | text |
Output fields
| Field | Type |
|---|---|
Error code | text |
Error message | text |
Extension | object |
Any | object |
Cancelled hires | text |
Input fields
| Field | Type |
|---|---|
Client IDRequired | choice |
Input fields
| Field | Type |
|---|---|
Client IDRequired | choice |
Import Batch IDRequired | text |
Output fields
| Field | Type |
|---|---|
Error code | text |
Error message | text |
Extension | object |
Any | object |
Commit result | object |
Commit error | array |
Committed hire | array |
Input fields
| Field | Type |
|---|---|
Client NameRequired | text |
Legal NameRequired | text |
Primary PEORequired | text |
Payroll Representative IDRequired | text |
Service TypeRequired | choice |
Status CodeRequired | text |
Status DateRequired | date |
GeoCodeRequired | text |
CountyRequired | text |
Address Line 1Required | text |
CityRequired | text |
State CodeRequired | text |
ZIP CodeRequired | text |
Corporation TypeRequired | choice |
Session IDRequired | text |
Client IDRequired | number |
Address Line 2 | text |
ZIP Suffix | text |
Client Category Code | text |
Cost Center | text |
10other input fields
Output fields
| Field | Type |
|---|---|
Client entry result | object |
Client ID | text |
Failure message | array |
Input fields
| Field | Type |
|---|---|
Apply DateRequired | date |
Sort NameRequired | text |
Last NameRequired | text |
First NameRequired | text |
Address Line 1Required | text |
Address Line 2Required | text |
ZIP CodeRequired | text |
ZIP SuffixRequired | text |
CityRequired | text |
State CodeRequired | text |
Maiden NameRequired | text |
Residential Start DateRequired | date |
Location CodeRequired | text |
Suffix NameRequired | text |
Prior Date FromRequired | date |
Prior Date ToRequired | date |
Prior LocationRequired | text |
Military From DateRequired | date |
Military To DateRequired | date |
Military RankRequired | text |
51other input fields
Output fields
| Field | Type |
|---|---|
ID | text |
Apply date | text |
Sort name | text |
Last name | text |
First name | text |
Middle name | text |
Address line 1 | text |
Address line 2 | text |
Zip code | text |
Zip suffix | text |
Day phone | text |
Eve phone | text |
Type of work | text |
Avail date | text |
Apply positions | array |
Referral source | text |
Ssn | text |
Gender | text |
Ethnic code | text |
Vietnam vet | text |
53other output fields
Input fields
| Field | Type |
|---|---|
Client IDRequired | choice |
Contact TypeRequired | text |
Contact NameRequired | text |
Contact Title | text |
Contact Phone | text |
Contact Phone Extension | text |
Contact Email | |
Comments | text |
Contact Address | text |
Contact City | text |
Contact State | text |
Contact ZIP | text |
Contact ZIP Suffix | text |
Geolocation Code | text |
Contact Cell Phone | text |
Output fields
| Field | Type |
|---|---|
Contact ID | text |
Input fields
| Field | Type |
|---|---|
Schedule CodeRequired | text |
DescriptionRequired | text |
Pay PeriodRequired | choice |
Pay Day | choice |
Pay Period End | text |
Period End Before/After | choice |
First Pay Day | text |
First Period Ends | text |
First Period End Before/After | choice |
Second Pay Day | text |
Second Period Ends | text |
Second Period End Before/After | choice |
Monthly Occurs | choice |
Day Of Week | choice |
Day Of Month | number |
Checksum | text |
Allowed Pay Period Options | array |
Update Payroll Schedule Result | object |
Schedule CodeRequired | text |
Update Messages | array |
Output fields
| Field | Type |
|---|---|
Batch num | text |
Input fields
| Field | Type |
|---|---|
Schedule CodeRequired | text |
DescriptionRequired | text |
Pay PeriodRequired | choice |
Pay Day | choice |
Pay Period End | text |
Period End Before/After | choice |
First Pay Day | text |
First Period Ends | text |
First Period End Before/After | choice |
Second Pay Day | text |
Second Period Ends | text |
Second Period End Before/After | choice |
Monthly Occurs | choice |
Day Of Week | choice |
Day Of Month | number |
Checksum | text |
Allowed Pay Period Options | array |
Available Pay Day Options | array |
Available Second Pay Day Options | array |
Available Period End Before/After Options | array |
1other input field
Output fields
| Field | Type |
|---|---|
Session ID | text |
Schedule code | text |
Description | text |
Pay period | text |
Pay day | text |
Pay period end | text |
Period end bef aft | text |
First pay day | text |
First period ends | text |
First period end bef aft | text |
Second pay day | text |
Second period ends | text |
Second period end bef aft | text |
Monthly occurs | text |
Day of week | text |
Day of month | text |
Checksum | text |
Allowed pay period options | array |
Update payroll schedule result | object |
Schedule code | text |
Update messages | array |
Input fields
| Field | Type |
|---|---|
Client IDRequired | choice |
ReferenceRequired | text |
Input fields
| Field | Type |
|---|---|
Client IDRequired | choice |
Bill DateRequired | text |
EventRequired | text |
Billing UnitsRequired | text |
Bill RateRequired | text |
Bill AmountRequired | text |
Entry ReferenceRequired | text |
Pay Group | text |
Payroll Type | text |
Location | text |
Division | text |
Department | text |
Shift | text |
Project | text |
Comment | text |
Cost Amount | text |
Repeat Thru Date | text |
Repeat Cycle | choice |
Bill Status | text |
Checksum | text |
Input fields
| Field | Type |
|---|---|
Client IDRequired | choice |
Translation Table | text |
Use Global New Hire | boolean |
Ignore New Hire Optional Fields | boolean |
New Hire Employee | array |
Output fields
| Field | Type |
|---|---|
Error code | text |
Error message | text |
Extension | object |
Any | object |
Import result | object |
Import batch ID | text |
Import error | array |
Imported hire | array |
Input fields
| Field | Type |
|---|---|
MethodRequired | choice |
Headers | array |
Header | object |
Query String | array |
Parameter | object |
Body | text |
Output fields
| Field | Type |
|---|---|
Body | text |
Headers | object |
Status code | number |
Input fields
| Field | Type |
|---|---|
Client IDRequired | choice |
Task IDRequired | choice |
Prehire IDRequired | array |
Prehire ID | text |
Action | choice |
Input fields
| Field | Type |
|---|---|
Client IDRequired | choice |
Reactivation StatusRequired | text |
Reactivation DateRequired | date |
Reactivation ReasonRequired | text |
Reactivation Employment Type | text |
Output fields
| Field | Type |
|---|---|
Error code | text |
Error message | text |
Extension | object |
Any | object |
Validate terminate result | object |
Employee ID | text |
Validate messages | array |
Terminate messages | array |
Input fields
| Field | Type |
|---|---|
Client IDRequired | choice |
User IDRequired | text |
Batch ListRequired | array |
Batch | text |
Upload IDRequired | text |
Input fields
| Field | Type |
|---|---|
Client IDRequired | choice |
Input fields
| Field | Type |
|---|---|
Client IDRequired | choice |
Leave StatusRequired | text |
Leave Effective DateRequired | date |
Reason CodeRequired | text |
Planned Return From Leave Date | date |
Input fields
| Field | Type |
|---|---|
Client IDRequired | choice |
Absence CodeRequired | text |
Start DateRequired | date |
End DateRequired | date |
Leave DetailsRequired | array |
Comment | text |
Output fields
| Field | Type |
|---|---|
Leave ID | text |
Input fields
| Field | Type |
|---|---|
Client IDRequired | choice |
Termination Status CodeRequired | text |
Reason CodeRequired | text |
Termination DateRequired | date |
Termination ReasonRequired | text |
Turn Off ACHRequired | text |
Force ApprovalRequired | boolean |
Last Day WorkedRequired | date |
Provider Notified OnRequired | date |
Okay To Rehire | text |
Create COBRA Record | text |
COBRA Qualifying Event | text |
COBRA Qualifying Event Date | date |
Unpaid PTO Payout | array |
Output fields
| Field | Type |
|---|---|
Error code | text |
Error message | text |
Extension | object |
Any | object |
Validate terminate result | object |
Employee ID | text |
Validate messages | array |
Terminate messages | array |
Input fields
| Field | Type |
|---|---|
Client IDRequired | choice |
Contact TypeRequired | text |
Contact NameRequired | text |
Contact Title | text |
Contact Phone | text |
Contact Phone Extension | text |
Contact Email | |
Comments | text |
Contact Address | text |
Contact City | text |
Contact State | text |
Contact ZIP | text |
Contact ZIP Suffix | text |
Geolocation Code | text |
Contact Cell Phone | text |
Input fields
| Field | Type |
|---|---|
Schedule CodeRequired | text |
DescriptionRequired | text |
Pay PeriodRequired | choice |
Pay Day | choice |
Pay Period End | text |
Period End Before/After | choice |
First Pay Day | text |
First Period Ends | text |
First Period End Before/After | choice |
Second Pay Day | text |
Second Period Ends | text |
Second Period End Before/After | choice |
Monthly Occurs | choice |
Day Of Week | choice |
Day Of Month | number |
Checksum | text |
Allowed Pay Period Options | array |
Update Payroll Schedule Result | object |
Schedule CodeRequired | text |
Update Messages | array |
Output fields
| Field | Type |
|---|---|
Session ID | text |
Schedule code | text |
Description | text |
Pay period | text |
Pay day | text |
Pay period end | text |
Period end bef aft | text |
First pay day | text |
First period ends | text |
First period end bef aft | text |
Second pay day | text |
Second period ends | text |
Second period end bef aft | text |
Monthly occurs | text |
Day of week | text |
Day of month | text |
Checksum | text |
Allowed pay period options | array |
Update payroll schedule result | object |
Schedule code | text |
Update messages | array |
Input fields
| Field | Type |
|---|---|
Client NameRequired | text |
Legal NameRequired | text |
Primary PEORequired | text |
Payroll Representative IDRequired | text |
Service TypeRequired | choice |
Status CodeRequired | text |
Status DateRequired | date |
GeoCodeRequired | text |
CountyRequired | text |
Address Line 1Required | text |
CityRequired | text |
State CodeRequired | text |
ZIP CodeRequired | text |
Corporation TypeRequired | choice |
Session IDRequired | text |
Client IDRequired | number |
Address Line 2 | text |
ZIP Suffix | text |
Client Category Code | text |
Cost Center | text |
10other input fields
Output fields
| Field | Type |
|---|---|
Client master checksum | text |
Update message | text |
Input fields
| Field | Type |
|---|---|
Client IDRequired | choice |
Direct DepositRequired | object |
ACH StatusRequired | choice |
Voucher TypeRequired | text |
Suppress Account Print | boolean |
ACH VoucherRequired | array |
Input fields
| Field | Type |
|---|---|
Client IDRequired | choice |
ManagerRequired | text |
Paid Thru Date | date |
Provider Notified On | date |
Override Work Geocode | choice |
Last Worked Date | date |
Home Location | text |
Home Division | text |
Home Department | text |
Work Shift | text |
Project Cost Center | text |
Work Group Code | text |
Reports To | text |
Benefit Group | text |
Retirement Benefit Group | text |
Work Phone | text |
Work Phone Extension | text |
Work Email | |
Client Employee ID | text |
Union Code | text |
62other input fields
Output fields
| Field | Type |
|---|---|
Error code | text |
Error message | text |
Extension | object |
Any | object |
Update message | text |
Person checksum | text |
Client checksum | text |
Compensation checksum | text |
Input fields
| Field | Type |
|---|---|
Client ID | choice |
ScopeRequired | choice |
File DataRequired | text |
File NameRequired | text |
DescriptionRequired | text |
Document Type | choice |
Input fields
| Field | Type |
|---|---|
Client IDRequired | choice |
Template IDRequired | text |
User IDRequired | text |
Batch ListRequired | array |
Batch | text |
File DataRequired | text |
Output fields
| Field | Type |
|---|---|
Error code | text |
Error message | text |
Extension | object |
Any | object |
Import result | object |
Import file records | text |
Upload key | text |
Import failure | array |
Input fields
| Field | Type |
|---|---|
Client IDRequired | choice |
Termination Status CodeRequired | text |
Reason CodeRequired | text |
Termination DateRequired | date |
Termination ReasonRequired | text |
Turn Off ACHRequired | text |
Force ApprovalRequired | boolean |
Last Day WorkedRequired | date |
Provider Notified OnRequired | date |
Okay to Rehire | choice |
Create COBRA Record | text |
COBRA Qualifying Event | choice |
COBRA Qualifying Event Date | date |
Output fields
| Field | Type |
|---|---|
Validate terminate result | object |
Employee ID | text |
Validate messages | array |
Terminate messages | array |
Unpaid pto payout | array |