Requirements
Connecting PrimePay takes an active account plus OAuth client credentials, granted by signing in with your account — no other setup is required.[3]
Get your PrimePay credentials
You’ll be redirected to sign in and approve access — your password is never shared with WEXTL.
Connect PrimePay in WEXTL
- Log in to your WEXTL account, add the PrimePay 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 PrimePay 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 →
Notes
Credentials are org-scoped; share them with teammates from the Credentials picker on any of its nodes.For detailed information on connecting an application, see Connect an application →
PrimePay node modules
The list below is a reference of every PrimePay node module the integration supports. You will be able to pick any of them on the workflow canvas while building automations.
Expand any PrimePay node module below to see exactly what it takes in, what it returns, and what connection it needs.
Watch Activity CodeTrigger
| Field | Type |
|---|---|
| Payment frequency | text |
| Pay unit code | text |
| Edt w2code | text |
| Edt code | text |
| Check tag description | text |
Watch Benefit PlanTrigger
| Field | Type |
|---|---|
| Payment frequency | text |
| Pay unit code | text |
| Edt w2code | text |
| Edt code | text |
| Check tag description | text |
Watch Benefit Plan DataTrigger
| Field | Type |
|---|---|
| Comp plan code | text |
| Comp plan desc | text |
| Comp plan desc short | text |
| Comp plan document | text |
| Comp plan type | text |
Watch Benefit Rate Adjustment AmountTrigger
| Field | Type |
|---|---|
| Rate adjustment code | text |
| Ee monthly amount | number |
| Effective date | date |
| End date | date |
| Er monthly amount | number |
Watch Benefit Rate AdjustmentsTrigger
| Field | Type |
|---|---|
| Comp plan code | text |
| Effective date | date |
| End date | date |
| From benefit coverage code | text |
| From benefit election | text |
Watch Budget PositionsTrigger
| Field | Type |
|---|---|
| Position code | text |
| Pos org rel event | text |
| Pos org percent | number |
| Org code | text |
| End date | date |
Watch Deduction ClassesTrigger
| Field | Type |
|---|---|
| Payment frequency description | text |
| Payment frequency | text |
| Pay unit code | text |
| Pay period match code description | text |
| Pay period match code | text |
Watch Dependent DataTrigger
| Field | Type |
|---|---|
| Birth date | date |
| City | text |
| Country code | text |
| Company code | text |
| Country code description | text |
Watch Dependent EnvironmentTrigger
| Field | Type |
|---|---|
| Benefit plan code | text |
| Benefit subclass | text |
| Dependent ID | text |
| Dep identity | text |
| Effective date | date |
Watch Direct DepositsTrigger
| Field | Type |
|---|---|
| Account activate immediate | text |
| Bank account number | text |
| Bank account status | text |
| Bank account type | text |
| Bank account usage | text |
Watch Financial Plan ElectionTrigger
| Field | Type |
|---|---|
| Benefit option code | text |
| Benefit plan code | text |
| Benefit sub class description | text |
| Benefitcalc type | text |
| Benefitcalc type description | text |
Watch Garnishment PayeesTrigger
| Field | Type |
|---|---|
| Active deductions | number |
| Bank account number | text |
| Bank account type | text |
| Bank account type description | text |
| Bank name | text |
Watch JobsTrigger
| Field | Type |
|---|---|
| Comp plan description | text |
| Comp plan code | text |
| Eeo code | text |
| Eeo code description | text |
| Effective date | date |
Watch LocationTrigger
| Field | Type |
|---|---|
| City | text |
| Company location type | text |
| Company location type description | text |
| Country code | text |
| Effective date | date |
Watch Location Scoped AdministrationTrigger
| Field | Type |
|---|---|
| Effective date | date |
| End date | date |
| Emp no | text |
| Person location rel type | text |
| Location code | text |
Watch Managing PositionTrigger
| Field | Type |
|---|---|
| Company code | text |
| Company name | text |
| Tax quarter | number |
| Tax month | number |
| Period start date | date |
Watch Marital StatusTrigger
| Field | Type |
|---|---|
| Benefit action requested | text |
| Effective date | date |
| End date | date |
| Marital status | text |
| Marital status description | text |
Watch OrganizationTrigger
| Field | Type |
|---|---|
| Effective date | text |
| End date | date |
| New org code | text |
| Org code | text |
| Org desc search | text |
Watch Organization Scoped AdministrationTrigger
| Field | Type |
|---|---|
| Effective date | text |
| End date | text |
| Emp no | text |
| Person organization rel type | text |
| Org code | text |
Watch Pay ProcessTrigger
| Field | Type |
|---|---|
| Company code | text |
| Company name | text |
| Tax quarter | number |
| Tax month | number |
| Period start date | date |
Watch Pay Unit EDT RelationshipTrigger
| Field | Type |
|---|---|
| Edt code from | text |
| Edt code from description | text |
| Edt code to | text |
| Edt code to description | text |
| Edt relationship class | text |
Watch Pay Unit PeriodsTrigger
| Field | Type |
|---|---|
| Check date | date |
| Pay entry cut off | text |
| Pay period | number |
| Pay unit code | text |
| Pay year | number |
Watch Pay Unit Scoped AdministrationTrigger
| Field | Type |
|---|---|
| Effective date | date |
| End date | date |
| Emp no | text |
| Person pay unit rel type | text |
| Pay unit code | text |
Watch PaymentsTrigger
| Field | Type |
|---|---|
| Net ID | text |
| Emp no | text |
| Person payment type | text |
| Paymentarrears option | text |
| Payment source | text |
Watch Person AddressTrigger
| Field | Type |
|---|---|
| Address type | text |
| Address type description | text |
| City | text |
| Country code | text |
| Emp no | text |
Watch Person Benefit ElectionTrigger
| Field | Type |
|---|---|
| Additionaldeductionamount | number |
| Benefit action code | text |
| Benefit action code description | text |
| Benefit election | text |
| Benefit option code | text |
Watch Person Benefit PlanTrigger
| Field | Type |
|---|---|
| Comp plan code | text |
| Comp plan desc | text |
| Effective date | date |
| End date | date |
| Pos title | text |
Watch Person CompensationTrigger
| Field | Type |
|---|---|
| Comp amount | number |
| Comp event | text |
| Comp limit | number |
| Comp limit code | text |
| Comp limit code description | text |
Watch Person Compensation TotalTrigger
| Field | Type |
|---|---|
| Comp amount | number |
| Comp effective date | text |
| Comp end date | date |
| Comp event | text |
| Comp event description | text |
Watch Person DataTrigger
| Field | Type |
|---|---|
| City | text |
| Country code | text |
| Email address | text |
| Emp no | text |
| Empl hire date | date |
Watch Person Disability StatusTrigger
| Field | Type |
|---|---|
| Comments | text |
| Disability code | text |
| Effective date | date |
| End date | date |
| Emp no | text |
Watch Person EmailTrigger
| Field | Type |
|---|---|
| Effective date | date |
| Emp no | text |
| End date | date |
| Net contact type | text |
| Net ID | text |
Watch Person EmploymentTrigger
| Field | Type |
|---|---|
| Benefit status | text |
| Benefit status description | text |
| Effective date | date |
| Emp no | text |
| Empl benefithire date | date |
Watch Person LocationTrigger
| Field | Type |
|---|---|
| Effective date | date |
| End date | date |
| Emp no | text |
| Floor mail stop | text |
| Location code | text |
Watch Person Misc DeductionTrigger
| Field | Type |
|---|---|
| Arrears limit | number |
| Currency code | text |
| Currency code description | text |
| Cutback code | text |
| Deduction arrears type | text |
Watch Person NameTrigger
| Field | Type |
|---|---|
| Effective date | date |
| Emp no | text |
| End date | date |
| Fname | text |
| Lname | text |
Watch Person PayrollTrigger
| Field | Type |
|---|---|
| Net ID | text |
| Emp no | text |
| Payunitrelationship description | text |
| Effective date | date |
| End date | date |
Watch Person PositionTrigger
| Field | Type |
|---|---|
| Effective date | date |
| Emp no | text |
| End date | date |
| Net ID | text |
| Partial percent | number |
Watch Person Tax ElectionTrigger
| Field | Type |
|---|---|
| Additional withhold amount | number |
| Additional withhold percent | number |
| Dont process this tax | text |
| Effective date | date |
| Election status | text |
Watch Person TimeTrigger
| Field | Type |
|---|---|
| Activity code | text |
| Budget org code | text |
| Deduction class | text |
| Edt code | text |
| Edt code description | text |
Watch Person Veteran StatusTrigger
| Field | Type |
|---|---|
| Country code | text |
| Discharge date | date |
| Veteran disability | text |
| Veteran service award | text |
| Veteran service campaign | text |
Watch Person VitalsTrigger
| Field | Type |
|---|---|
| Birth country code | text |
| Birth date | date |
| Birth state province code | text |
| Birthplace | text |
| Death date | date |
Watch Phone NumbersTrigger
| Field | Type |
|---|---|
| Effective date | date |
| Emp no | text |
| End date | date |
| Net ID | text |
| Phone contact type | text |
Watch PositionTrigger
| Field | Type |
|---|---|
| Company officer | text |
| Eeo code | text |
| Eeo code description | text |
| Effective date | date |
| End date | date |
Watch Position Comp PlanTrigger
| Field | Type |
|---|---|
| Comp plan code | text |
| Effective date | date |
| End date | date |
| Position comp plan pid | number |
| Position compplan event | text |
Watch Position Comp Plan TagTrigger
| Field | Type |
|---|---|
| Positioncode | text |
| Effectivedate | date |
| Compplantagtype | text |
| Positioncompplantag | number |
| Enddate | date |
Watch Position LocationTrigger
| Field | Type |
|---|---|
| Effective date | date |
| End date | date |
| Location code | text |
| Position code | text |
Watch Position Matrix OrganizationTrigger
| Field | Type |
|---|---|
| Effective date | date |
| End date | date |
| Matrix org code | text |
| Pos org rel event | text |
| Position code | text |
Watch Position OrganizationTrigger
| Field | Type |
|---|---|
| Effective date | date |
| End date | date |
| Org code | text |
| Organization type | text |
| Pos org rel event | text |
Watch Position Plan CompensationTrigger
| Field | Type |
|---|---|
| Comp amount | number |
| Effective date | date |
| End date | date |
| Currency code | text |
| Edt code | text |
Watch Position StructureTrigger
| Field | Type |
|---|---|
| Effective date | date |
| End date | date |
| Pos pos rel | text |
| Pos rel event | text |
| Position code | text |
Watch Salary Grade RegionTrigger
| Field | Type |
|---|---|
| Companyid | number |
| Effective date | date |
| End date | date |
| Salary graderegion | text |
| Salary graderegion desc | text |
Watch Salary GradesTrigger
| Field | Type |
|---|---|
| Effective date | date |
| End date | date |
| Grade | text |
| Grade xid | text |
| Guidelinesapply | text |
Watch Salary GradesTrigger
| Field | Type |
|---|---|
| Effective date | date |
| End date | date |
| Region xid | text |
| Grade xid | text |
| Edt code | text |
Watch Target EarningsTrigger
| Field | Type |
|---|---|
| Effective date | date |
| End date | date |
| Region xid | text |
| Grade xid | text |
| Edt code | text |
Watch Welcome EmailsTrigger
| Field | Type |
|---|---|
| Contact type | text |
| Contact type description | text |
| Create time | date |
| Format | text |
| Format description | text |
Watch Worker's Compensation PlanTrigger
| Field | Type |
|---|---|
| Benefit plan desc | text |
| Benefit plan code | text |
| Benefit subclass | text |
| Carrier code | text |
| Carrier contract name | text |
Watch Workers' Compensation RatesTrigger
| Field | Type |
|---|---|
| Benefit adjustment rate | number |
| Benefit amount | number |
| Benefit calc type | text |
| Benefit cost rate | number |
| Benefit premium rate | number |
Create an Activity CodeSearch
Get an Employer DocumentAction
| Field | Type |
|---|---|
Document TypeRequired | text |
Employee Unique IDRequired | text |
List Activity CodesSearch
List AddressesSearch
List Benefit ElectionsSearch
List Benefit PlansSearch
List Benefit Program DataSearch
List Benefit Rate Adjustment AmountsSearch
List Benefit Rate AdjustmentsSearch
List BTO BalancesSearch
List Budget Organizations for a PositionSearch
| Field | Type |
|---|---|
| Organization | object |
| Operator | choice |
| Value | text |
| Employee Hire Date | object |
| Operator | choice |
| Date | date |
| Employee Fulltime Percent | object |
| Operator | choice |
| Percent | number |
| State Province Code | object |
| Operator | choice |
| List of States | array |
| Limit | number |
| Field | Type |
|---|---|
| Position code | text |
| Pos org rel event | text |
| Pos org percent | number |
| Org code | text |
| End date | date |
List Company-Level AdministratorsSearch
List Deduction ClassesSearch
List DepartmentsSearch
| Field | Type |
|---|---|
| Limit | number |
List Dependent DataSearch
List Dependent EnrollmentsSearch
List Direct ReportsSearch
List Disability StatusSearch
List EDT CodesSearch
List Emergency ContactsSearch
List Employee Direct DepositsSearch
| Field | Type |
|---|---|
Employee IDRequired | text |
| Limit | number |
List Employee EarningsSearch
| Field | Type |
|---|---|
Employee IDRequired | text |
| Limit | number |
List Employee Tax ReasonsSearch
| Field | Type |
|---|---|
Employee IDRequired | text |
| Limit | number |
List Employee TaxesSearch
| Field | Type |
|---|---|
Employee IDRequired | text |
| Limit | number |
List Employee User Defined DataSearch
| Field | Type |
|---|---|
Employee IDRequired | text |
| Limit | number |
List Employee Worker CompSearch
| Field | Type |
|---|---|
Employee IDRequired | text |
| Limit | number |
List EmployeesSearch
| Field | Type |
|---|---|
Employee IDRequired | text |
| Limit | number |
List Employer DeductionsSearch
| Field | Type |
|---|---|
| Limit | number |
List Employer DocumentsSearch
| Field | Type |
|---|---|
| Limit | number |
List Employer JobsSearch
| Field | Type |
|---|---|
| Limit | number |
List Employer NotesSearch
| Field | Type |
|---|---|
| Limit | number |
List Employer ProjectsSearch
| Field | Type |
|---|---|
| Limit | number |
List Financial Plan DeductionsSearch
| Field | Type |
|---|---|
| Organization | object |
| Operator | choice |
| Value | text |
| Employee Hire Date | object |
| Operator | choice |
| Date | date |
| Employee Fulltime Percent | object |
| Operator | choice |
| Percent | number |
| State Province Code | object |
| Operator | choice |
| List of States | array |
| Limit | number |
| Field | Type |
|---|---|
| Emp no | text |
| Pay process ID | number |
| 401(k) contribution ( employee) | text |
List Financial Plan EarningsSearch
| Field | Type |
|---|---|
| Organization | object |
| Operator | choice |
| Value | text |
| Employee Hire Date | object |
| Operator | choice |
| Date | date |
| Employee Fulltime Percent | object |
| Operator | choice |
| Percent | number |
| State Province Code | object |
| Operator | choice |
| List of States | array |
| Limit | number |
| Field | Type |
|---|---|
| Emp no | text |
| Pay process ID | number |
| Pay amount | number |
| Pay amount ytd | number |
| Pay period hours | number |
List Financial Plan ElectionsSearch
List Frequency CodesSearch
List Garnishment PayeesSearch
List Job FamilySearch
List Job Workers Compensation ProfilesSearch
List JobsSearch
List Location Scoped AdministratorsSearch
List LocationsSearch
List Managing PositionsSearch
List Marital StatusesSearch
List Organization IdentitiesSearch
List Organization Scoped AdministratorsSearch
List OrganizationsSearch
List Pay Period Match CodesSearch
List Pay ProcessesSearch
List Pay Time Control BatchesSearch
List Pay Unit EDT RelationshipsSearch
List Pay Unit PeriodsSearch
List Pay Unit Scoped AdministratorsSearch
List Pay UnitsSearch
List Payroll EntriesSearch
| Field | Type |
|---|---|
Payroll IDRequired | text |
| Limit | number |
List PeopleSearch
List Person Benefit PlansSearch
List Person CompensationSearch
List Person Compensation TotalSearch
List Person Direct DepositsSearch
List Person EmailsSearch
List Person EmploymentSearch
List Person IdentitiesSearch
List Person LocationsSearch
List Person Misc DeductionsSearch
List Person NamesSearch
List Person New Hire Reporting StatusSearch
List Person PaymentsSearch
List Person PayrollSearch
List Person PhoneSearch
List Person PositionsSearch
List Person Tax ElectionsSearch
List Person Tax PaymentsSearch
List Person TimeSearch
List Person Veteran StatusSearch
List Person VitalsSearch
List Position Comp Plan TagsSearch
| Field | Type |
|---|---|
| Organization | object |
| Operator | choice |
| Value | text |
| Employee Hire Date | object |
| Operator | choice |
| Date | date |
| Employee Fulltime Percent | object |
| Operator | choice |
| Percent | number |
| State Province Code | object |
| Operator | choice |
| List of States | array |
| Limit | number |
| Field | Type |
|---|---|
| Positioncode | text |
| Effectivedate | date |
| Compplantagtype | text |
| Positioncompplantag | number |
| Enddate | date |
List Position LocationsSearch
| Field | Type |
|---|---|
| Organization | object |
| Operator | choice |
| Value | text |
| Employee Hire Date | object |
| Operator | choice |
| Date | date |
| Employee Fulltime Percent | object |
| Operator | choice |
| Percent | number |
| State Province Code | object |
| Operator | choice |
| List of States | array |
| Limit | number |
| Field | Type |
|---|---|
| Effective date | date |
| End date | date |
| Location code | text |
| Position code | text |
List Position MatricesSearch
| Field | Type |
|---|---|
| Organization | object |
| Operator | choice |
| Value | text |
| Employee Hire Date | object |
| Operator | choice |
| Date | date |
| Employee Fulltime Percent | object |
| Operator | choice |
| Percent | number |
| State Province Code | object |
| Operator | choice |
| List of States | array |
| Limit | number |
| Field | Type |
|---|---|
| Effective date | date |
| End date | date |
| Matrix org code | text |
| Pos org rel event | text |
| Position code | text |
List Position OrganizationsSearch
| Field | Type |
|---|---|
| Organization | object |
| Operator | choice |
| Value | text |
| Employee Hire Date | object |
| Operator | choice |
| Date | date |
| Employee Fulltime Percent | object |
| Operator | choice |
| Percent | number |
| State Province Code | object |
| Operator | choice |
| List of States | array |
| Limit | number |
| Field | Type |
|---|---|
| Effective date | date |
| End date | date |
| Org code | text |
| Organization type | text |
| Pos org rel event | text |
List Position Plan CompensationSearch
| Field | Type |
|---|---|
| Organization | object |
| Operator | choice |
| Value | text |
| Employee Hire Date | object |
| Operator | choice |
| Date | date |
| Employee Fulltime Percent | object |
| Operator | choice |
| Percent | number |
| State Province Code | object |
| Operator | choice |
| List of States | array |
| Limit | number |
| Field | Type |
|---|---|
| Comp amount | number |
| Effective date | date |
| End date | date |
| Currency code | text |
| Edt code | text |
List Position StructuresSearch
List PositionsSearch
| Field | Type |
|---|---|
| Organization | object |
| Operator | choice |
| Value | text |
| Employee Hire Date | object |
| Operator | choice |
| Date | date |
| Employee Fulltime Percent | object |
| Operator | choice |
| Percent | number |
| State Province Code | object |
| Operator | choice |
| List of States | array |
| Limit | number |
| Field | Type |
|---|---|
| Company officer | text |
| Eeo code | text |
| Eeo code description | text |
| Effective date | date |
| End date | date |
List Positions Comp PlanSearch
| Field | Type |
|---|---|
| Organization | object |
| Operator | choice |
| Value | text |
| Employee Hire Date | object |
| Operator | choice |
| Date | date |
| Employee Fulltime Percent | object |
| Operator | choice |
| Percent | number |
| State Province Code | object |
| Operator | choice |
| List of States | array |
| Limit | number |
| Field | Type |
|---|---|
| Comp plan code | text |
| Effective date | date |
| End date | date |
| Position comp plan pid | number |
| Position compplan event | text |
List Salary Grade RangesSearch
List Salary Grade RegionsSearch
List Salary GradesSearch
List Salesforce InvoicesSearch
| Field | Type |
|---|---|
| Limit | number |
List Salesforce Price for EmployerSearch
| Field | Type |
|---|---|
| Limit | number |
List Target EarningsSearch
List Tax Control BatchesSearch
List Web Service Process ExecutionsSearch
List Welcome EmailsSearch
List Workers' Compensation CodesSearch
List Workers' Compensation PlansSearch
List Workers' Compensation RatesSearch
Update Activity CodeSearch
Calculate Payroll EntriesAction
| Field | Type |
|---|---|
Payroll IDRequired | text |
| Employee Data | array |
KeyRequired | text |
| Value | text |
Create a Benefit PlanAction
Create a Benefit Rate Adjustment DescriptionAction
| Field | Type |
|---|---|
Comp Plan Code CodeRequired | text |
Effective DateRequired | date |
Rate Adjustment CodeRequired | text |
Rate Adjustment DescriptionRequired | text |
To Benefit SubclassRequired | text |
Create a Company Workers PlanAction
| Field | Type |
|---|---|
Effective DateRequired | date |
End DateRequired | date |
Country CodeRequired | text |
State/Province CodeRequired | text |
Carrier CodeRequired | text |
| Field | Type |
|---|---|
| Benefit plan desc | text |
| Benefit plan code | text |
| Benefit subclass | text |
| Carrier code | text |
| Carrier contract name | text |
Create a Company-Level AdministratorAction
Create a Compensation PlanAction
Create a Financial Plan ElectionAction
| Field | Type |
|---|---|
| Financial Plan Data | array |
Create a LocationAction
| Field | Type |
|---|---|
Company CodeRequired | text |
Location CodeRequired | text |
Location DescriptionRequired | text |
CityRequired | text |
State/Province CodeRequired | text |
| Field | Type |
|---|---|
| Location codes | object |
| Persisted | boolean |
| Location address | object |
| Persisted | boolean |
| Company location relationship | object |
| Persisted | boolean |
Create a Marital StatusAction
| Field | Type |
|---|---|
Benefit Action RequestedRequired | choice |
Marital StatusRequired | choice |
Marital Status EventRequired | choice |
| Effective Date | date |
| End Date | date |
Create a Pay UnitAction
| Field | Type |
|---|---|
| Pay Unit Data | array |
Create a PersonAction
| Field | Type |
|---|---|
Employee NumberRequired | text |
Employment StatusRequired | choice |
Effective DateRequired | date |
First NameRequired | text |
Last NameRequired | text |
| Field | Type |
|---|---|
| Person phone | object |
| Persisted | boolean |
| Person position relationship | object |
| Persisted | boolean |
| Emp no identity | object |
| Persisted | boolean |
| Person address | object |
| Persisted | boolean |
| Person location | object |
| Persisted | boolean |
Create a PTO PlanAction
| Field | Type |
|---|---|
Effective DateRequired | date |
Compensation Plan CodeRequired | text |
PTO Plan DescriptionRequired | text |
PTO Plan External IDRequired | text |
PTO Minimum Worked Hours RequiredRequired | number |
| Field | Type |
|---|---|
| Effective date | date |
| Comp plan code | text |
| Pto plan desc | text |
| Pto plan xid | text |
| Benefit sub class | text |
Create a Tax Control BatchAction
Create a Workers' Compensation CodeAction
Create a Workers' Compensation RateAction
Create Additional EarningsAction
| Field | Type |
|---|---|
| Additional Earnings | array |
Create an Emergency ContactAction
| Field | Type |
|---|---|
Contact's NameRequired | text |
Contact's Priority OrderRequired | number |
Country CodeRequired | text |
RelationshipRequired | text |
PhonesRequired | array |
Create an EmployeeAction
| Field | Type |
|---|---|
| Employee Data | array |
KeyRequired | text |
| Value | text |
Create an OrganizationAction
| Field | Type |
|---|---|
| Organization Code | array |
Create Dependent DataAction
| Field | Type |
|---|---|
IdentityRequired | text |
Identity TypeRequired | text |
Birth DateRequired | date |
Dependent RelationshipRequired | choice |
Dependent StatusRequired | choice |
| Field | Type |
|---|---|
| Key | object |
| Ssn | text |
| Dependent description | object |
| Persisted | boolean |
| Dependent identity | object |
| Persisted | boolean |
| Dependent names | object |
| Persisted | boolean |
| Dependent address | object |
| Persisted | boolean |
Create Employer DocumentsAction
| Field | Type |
|---|---|
| Employee Data | array |
KeyRequired | text |
| Value | text |
Create or Update a Benefit Rate Adjustment AmountAction
| Field | Type |
|---|---|
Rate Adjustment CodeRequired | text |
EE Monthly AmountRequired | number |
Effective DateRequired | date |
ER Monthly AmountRequired | number |
| End Date | date |
Create or Update a GarnishmentAction
| Field | Type |
|---|---|
Employee NumberRequired | text |
Net IDRequired | text |
| Arrears Limit | number |
| Currency Code | text |
| Currency Code Description | text |
Create or Update a Garnishment PayeeAction
| Field | Type |
|---|---|
| Garnishment Payees | array |
Create or Update a JobAction
| Field | Type |
|---|---|
Effective DateRequired | date |
Job CodeRequired | text |
Job External IDRequired | text |
EEO CodeRequired | choice |
Management ClassRequired | choice |
Create or Update a Job FamilyAction
| Field | Type |
|---|---|
Job Family DescriptionRequired | text |
Job Family CodeRequired | text |
| Company Code | text |
| Enabled | text |
Create or Update a Job Workers Compensation ProfileAction
Create or Update a Location-Scoped AdministratorAction
| Field | Type |
|---|---|
Effective DateRequired | date |
Employee Number, Network ID or SSNRequired | text |
Role NameRequired | choice |
Location CodeRequired | text |
| End Date | date |
Create or Update a Managing PositionAction
| Field | Type |
|---|---|
Effective DateRequired | date |
Managing PositionRequired | text |
Position Position RelationRequired | text |
Position Relation EventRequired | text |
Position CodeRequired | text |
Create or Update a Pay ProcessAction
| Field | Type |
|---|---|
Pay YearRequired | number |
Pay PeriodRequired | number |
Disbursement TypeRequired | choice |
Check DateRequired | date |
Pay Process TypeRequired | choice |
Create or Update a Pay Time Control BatchAction
| Field | Type |
|---|---|
Pay Unit CodeRequired | text |
Period End DateRequired | date |
Pay Time Control Batch CodeRequired | text |
| Batch Name | text |
Create or Update a Pay Unit EDT CodeAction
| Field | Type |
|---|---|
Callback URLRequired | url |
EventsRequired | array |
ScopeRequired | choice |
| Token | text |
Create or Update a Pay Unit EDT RelationshipAction
| Field | Type |
|---|---|
Pay Unit CodeRequired | text |
EDT Code FromRequired | text |
EDT Code ToRequired | text |
EDT Relationship ClassRequired | choice |
EDT Relationship TypeRequired | choice |
Create or Update a Pay Unit PeriodAction
| Field | Type |
|---|---|
Check DateRequired | date |
Pay PeriodRequired | number |
Pay Unit CodeRequired | text |
Pay YearRequired | number |
Period End DateRequired | date |
Create or Update a Pay Unit Scoped AdministratorAction
| Field | Type |
|---|---|
Effective DateRequired | date |
Employee Number or Network IDRequired | text |
Role NameRequired | choice |
Pay Unit CodeRequired | text |
| End Date | date |
| Field | Type |
|---|---|
| Person phone | object |
| Persisted | boolean |
| Person position relationship | object |
| Persisted | boolean |
| Emp no identity | object |
| Persisted | boolean |
| Person address | object |
| Persisted | boolean |
| Person location | object |
| Persisted | boolean |
Create or Update a Person Benefit ElectionAction
| Field | Type |
|---|---|
Additional Deduction AmountRequired | number |
Benefit Action CodeRequired | text |
Benefit Coverage CodeRequired | text |
Benefit ElectionRequired | text |
Benefit Plan CodeRequired | text |
Create or Update a Person CompensationAction
| Field | Type |
|---|---|
Compensation AmountRequired | number |
Compensation EventRequired | choice |
Compensation LimitRequired | number |
Compensation Limit CodeRequired | text |
Currency CodeRequired | text |
| Field | Type |
|---|---|
| Person phone | object |
| Persisted | boolean |
| Person position relationship | object |
| Persisted | boolean |
| Emp no identity | object |
| Persisted | boolean |
| Person address | object |
| Persisted | boolean |
| Person location | object |
| Persisted | boolean |
Create or Update a Person Direct DepositAction
Create or Update a Person LocationAction
| Field | Type |
|---|---|
Effective DateRequired | date |
Employee NumberRequired | text |
Location CodeRequired | text |
| End Date | date |
| Floor Mail Stop | text |
Create or Update a Person Misc DeductionAction
| Field | Type |
|---|---|
EEO CodeRequired | choice |
Effective DateRequired | date |
FLSA CodeRequired | choice |
FLSA ProfileRequired | choice |
Position CodeRequired | text |
| Field | Type |
|---|---|
Employee NumberRequired | text |
Net IDRequired | text |
| Arrears Limit | number |
| Currency Code | text |
| Currency Code Description | text |
Create or Update a Person NameAction
| Field | Type |
|---|---|
Effective DateRequired | date |
Employee NumberRequired | text |
First NameRequired | text |
Last NameRequired | text |
| End Date | date |
Create or Update a Person New Hire ReportingAction
| Field | Type |
|---|---|
| Person New Hire Reporting (NHR) Status | array |
Create or Update a Person PaymentAction
| Field | Type |
|---|---|
Employee NumberRequired | text |
Person Payment CodeRequired | text |
HoursRequired | number |
Effective DateRequired | date |
EDT CodeRequired | text |
Create or Update a Person PayrollAction
| Field | Type |
|---|---|
Employee NumberRequired | text |
Pay Unit RelationshipRequired | text |
Effective DateRequired | date |
| Pay Unit Relationship Description | text |
| End Date | date |
Create or Update a Person PhoneAction
| Field | Type |
|---|---|
Effective DateRequired | date |
Employee NumberRequired | text |
Phone NumberRequired | text |
| End Date | date |
| Phone Contact Type | choice |
Create or Update a Person TimeAction
| Field | Type |
|---|---|
Net IDRequired | text |
Pay Time Control Batch CodeRequired | text |
Person Time CodeRequired | text |
Work Start DateRequired | date |
| EDT Code | choice |
Create or Update a Person's AddressAction
Create or Update a Person's Disability StatusAction
| Field | Type |
|---|---|
| Person Disability | array |
Create or Update a Person's PasswordAction
Create or Update a Person's PositionAction
Create or Update a Person's Tax ElectionAction
Create or Update a Person's Tax PaymentAction
Create or Update a PositionAction
| Field | Type |
|---|---|
EEO CodeRequired | choice |
Effective DateRequired | date |
FLSA CodeRequired | choice |
FLSA ProfileRequired | choice |
Position CodeRequired | text |
| Field | Type |
|---|---|
| Position organization relationship | object |
| Persisted | boolean |
| Position matrix organization relationship | object |
| Persisted | boolean |
| Position | object |
| Persisted | boolean |
| Managing position | object |
| Persisted | boolean |
| Key | object |
| Position code | text |
Create or Update a Position Comp PlanAction
| Field | Type |
|---|---|
Comp Plan CodeRequired | text |
Effective DateRequired | date |
Position Comp Plan EventRequired | choice |
Position Comp Plan Relation TypeRequired | choice |
Position CodeRequired | text |
Create or Update a Position Comp Plan TagAction
| Field | Type |
|---|---|
Position CodeRequired | text |
Position Comp Plan TagRequired | text |
Comp Plan Tag TypeRequired | text |
Effective DateRequired | date |
| End Date | date |
Create or Update a Position in an OrganizationAction
| Field | Type |
|---|---|
| Position Organization | array |
Create or Update a Position LocationAction
| Field | Type |
|---|---|
| Position Location | array |
Create or Update a Position Matrix OrganizationAction
| Field | Type |
|---|---|
| Position Matrix Organization | array |
Create or Update a Position-Organization BudgetAction
| Field | Type |
|---|---|
| Position Budget Organization Data | array |
Create or Update a Salary Grade RegionAction
| Field | Type |
|---|---|
| Salary Grade Region | array |
Create or Update an Employment RecordAction
| Field | Type |
|---|---|
Effective DateRequired | date |
Employee Number or Network IDRequired | text |
Benefit Hire DateRequired | date |
Employment ClassRequired | choice |
Employment EventRequired | choice |
| Field | Type |
|---|---|
| Person phone | object |
| Persisted | boolean |
| Person position relationship | object |
| Persisted | boolean |
| Emp no identity | object |
| Persisted | boolean |
| Person address | object |
| Persisted | boolean |
| Person location | object |
| Persisted | boolean |
Create or Update Dependent EnrollmentAction
| Field | Type |
|---|---|
Employee NumberRequired | text |
Dependent IdentityRequired | text |
Dependent Identity TypeRequired | text |
Benefit Plan CodeRequired | text |
Selected OptionRequired | text |
| Field | Type |
|---|---|
| Position organization relationship | object |
| Persisted | boolean |
| Position matrix organization relationship | object |
| Persisted | boolean |
| Position | object |
| Persisted | boolean |
| Managing position | object |
| Persisted | boolean |
| Key | object |
| Position code | text |
Create or Update Organization-Scoped AdministratorsAction
| Field | Type |
|---|---|
Effective DateRequired | date |
Employee No or Network IDRequired | text |
Role NameRequired | choice |
Organization CodeRequired | text |
Organization TypeRequired | text |
Create or Update Pay Period Match CodeAction
Create or Update Person Veteran StatusAction
| Field | Type |
|---|---|
Country CodeRequired | text |
Veteran StatusRequired | choice |
Employee Number or Net IDRequired | text |
| Discharge Date | date |
| Veteran Disability | text |
Create or Update Person VitalsAction
| Field | Type |
|---|---|
Effective DateRequired | date |
Employee Number or Network IDRequired | text |
| Birth Country Code | choice |
| Birth Date | date |
| Birth State/Province Code | choice |
Create or Update Personal IdentityAction
| Field | Type |
|---|---|
Network IDRequired | text |
IdentityRequired | text |
Identity TypeRequired | choice |
Create or Update Position Plan CompensationAction
| Field | Type |
|---|---|
Position CodeRequired | text |
Effective DateRequired | date |
Compensation AmountRequired | number |
Currency CodeRequired | choice |
EDT CodeRequired | text |
Create or Update Salary Grade RangesAction
Create or Update Salary GradesAction
Create or Update Target EarningsAction
Create Payroll EntriesAction
| Field | Type |
|---|---|
Payroll IDRequired | text |
| Employee Data | array |
KeyRequired | text |
| Value | text |
Delete a Benefit Rate Adjustment AmountAction
| Field | Type |
|---|---|
Rate Adjustment CodeRequired | text |
EE Monthly AmountRequired | number |
Effective DateRequired | date |
ER Monthly AmountRequired | number |
| End Date | date |
Delete a Company-Level AdministratorAction
Delete a Compensation PlanAction
| Field | Type |
|---|---|
| Organization Code | array |
Delete a Garnishment PayeeAction
| Field | Type |
|---|---|
| Garnishment Payees | array |
Delete a JobAction
| Field | Type |
|---|---|
Effective DateRequired | date |
Job CodeRequired | text |
Delete a Job FamilyAction
| Field | Type |
|---|---|
Job Family CodeRequired | text |
Delete a Location Scoped AdministratorAction
| Field | Type |
|---|---|
Effective DateRequired | date |
Employee Number, Network ID or SSNRequired | text |
Role NameRequired | choice |
Location CodeRequired | text |
Delete a Pay Period Match CodeAction
Delete a Pay Time Control BatchAction
| Field | Type |
|---|---|
| Batch Name | text |
| Pay Time Control Batch Code | text |
Delete a Pay Unit EDT RelationshipAction
| Field | Type |
|---|---|
Pay Unit CodeRequired | text |
EDT Code FromRequired | text |
EDT Code ToRequired | text |
EDT Relationship ClassRequired | choice |
EDT Relationship TypeRequired | choice |
Delete a Pay Unit PeriodAction
| Field | Type |
|---|---|
Check DateRequired | date |
Pay PeriodRequired | number |
Pay Unit CodeRequired | text |
Pay YearRequired | number |
Period End DateRequired | date |
Delete a Pay Unit Scoped AdministratorAction
| Field | Type |
|---|---|
Effective DateRequired | date |
Employee Number or Network IDRequired | text |
Role NameRequired | choice |
Pay Unit CodeRequired | text |
| Field | Type |
|---|---|
| Person phone | object |
| Persisted | boolean |
| Person position relationship | object |
| Persisted | boolean |
| Emp no identity | object |
| Persisted | boolean |
| Person address | object |
| Persisted | boolean |
| Person location | object |
| Persisted | boolean |
Delete a Payroll EntryAction
| Field | Type |
|---|---|
Payroll IDRequired | text |
| Employee Data | array |
KeyRequired | text |
| Value | text |
Delete a Person CompensationAction
| Field | Type |
|---|---|
Earnings CodeRequired | choice |
Employee NumberRequired | text |
Effective DateRequired | date |
Delete a Person Disability StatusAction
| Field | Type |
|---|---|
Effective DateRequired | date |
Employee Number or Network IDRequired | text |
Delete a Person LocationAction
| Field | Type |
|---|---|
Effective DateRequired | date |
Employee NumberRequired | text |
Location CodeRequired | text |
| Field | Type |
|---|---|
| Person phone | object |
| Persisted | boolean |
| Person position relationship | object |
| Persisted | boolean |
| Emp no identity | object |
| Persisted | boolean |
| Person address | object |
| Persisted | boolean |
| Person location | object |
| Persisted | boolean |
Delete a Person Misc DeductionAction
Delete a Person New Hire ReportingAction
| Field | Type |
|---|---|
New Hire Status CodeRequired | choice |
EmployeeRequired | text |
Delete a Person PhoneAction
| Field | Type |
|---|---|
Employee NumberRequired | text |
Phone Contact TypeRequired | text |
Effective DateRequired | date |
Delete a Person TimeAction
| Field | Type |
|---|---|
Pay Time Control Batch CodeRequired | text |
Person Time CodeRequired | text |
Delete a Person's Veteran StatusAction
| Field | Type |
|---|---|
Employee NumberRequired | text |
Delete a PTOAction
| Field | Type |
|---|---|
| Effective Date | date |
| Compensation Plan Code | text |
| PTO Plan Description | text |
| PTO Plan External ID | text |
| PTO Minimum Worked Hours Required | number |
| Field | Type |
|---|---|
| Effective date | date |
| Comp plan code | text |
| Pto plan desc | text |
| Pto plan xid | text |
| Benefit sub class | text |
Delete a Salary Grade RegionAction
| Field | Type |
|---|---|
| Salary Grade Region | array |
Delete an Activity CodeAction
| Field | Type |
|---|---|
Activity CodeRequired | choice |
Pay Unit CodeRequired | choice |
Effective DateRequired | date |
Delete an Emergency ContactAction
| Field | Type |
|---|---|
Contact OrderRequired | choice |
Employee NumberRequired | choice |
Network IdentityRequired | choice |
Delete an Employer JobAction
| Field | Type |
|---|---|
| Employee Data | array |
KeyRequired | text |
| Value | text |
Delete an Employer ProjectAction
| Field | Type |
|---|---|
| Employee Data | array |
KeyRequired | text |
| Value | text |
Delete Dependent EnrollmentAction
| Field | Type |
|---|---|
Employee NumberRequired | text |
Dependent IdentityRequired | text |
Dependent Identity TypeRequired | text |
Benefit Plan CodeRequired | text |
Selected OptionRequired | text |
| Field | Type |
|---|---|
| Position organization relationship | object |
| Persisted | boolean |
| Position matrix organization relationship | object |
| Persisted | boolean |
| Position | object |
| Persisted | boolean |
| Managing position | object |
| Persisted | boolean |
| Key | object |
| Position code | text |
Delete Financial Plan ElectionAction
| Field | Type |
|---|---|
| Financial Plan Data | array |
Delete Organization Scoped AdministratorAction
| Field | Type |
|---|---|
Effective DateRequired | date |
Role NameRequired | choice |
Organization CodeRequired | text |
Organization TypeRequired | text |
Delete Salary Grade RangeAction
Delete Salary GradesAction
Save or Update an Accrual RuleAction
| Field | Type |
|---|---|
Accrual IDRequired | text |
| Employee Data | array |
KeyRequired | text |
| Value | text |
Submit Payroll EntriesAction
| Field | Type |
|---|---|
Payroll IDRequired | text |
Update a Company Workers' PlanAction
| Field | Type |
|---|---|
Effective DateRequired | date |
End DateRequired | date |
Country CodeRequired | text |
State/Province CodeRequired | text |
Carrier CodeRequired | text |
| Field | Type |
|---|---|
| Benefit plan desc | text |
| Benefit plan code | text |
| Benefit subclass | text |
| Carrier code | text |
| Carrier contract name | text |
Update a Compensation PlanAction
Update a Direct DepositAction
| Field | Type |
|---|---|
Employee IDRequired | text |
| Employee Direct Deposits | array |
Update a LocationAction
| Field | Type |
|---|---|
Company CodeRequired | text |
Location CodeRequired | text |
Location DescriptionRequired | text |
CityRequired | text |
State/Province CodeRequired | text |
| Field | Type |
|---|---|
| Location codes | object |
| Persisted | boolean |
| Location address | object |
| Persisted | boolean |
| Company location relationship | object |
| Persisted | boolean |
Update a Payroll EntryAction
| Field | Type |
|---|---|
Payroll IDRequired | text |
| Employee Data | array |
KeyRequired | text |
| Value | text |
Update a PTOAction
| Field | Type |
|---|---|
Effective DateRequired | date |
Compensation Plan CodeRequired | text |
PTO Plan DescriptionRequired | text |
PTO Plan External IDRequired | text |
PTO Minimum Worked Hours RequiredRequired | number |
| Field | Type |
|---|---|
| Effective date | date |
| Comp plan code | text |
| Pto plan desc | text |
| Pto plan xid | text |
| Benefit sub class | text |
Update a Tax Control BatchAction
Update a Web Service Process ExecutionAction
| Field | Type |
|---|---|
Process IDRequired | text |
| Estimated Execution Seconds | number |
| Percent Complete | number |
| Is Success | choice |
| Processing Errors | text |
Update a Workers' Compensation CodeAction
Update a Workers' Compensation RateAction
Update Additional EarningsAction
| Field | Type |
|---|---|
| Additional Earnings | array |
Update an Emergency ContactAction
| Field | Type |
|---|---|
Contact's NameRequired | text |
Contact's Priority OrderRequired | number |
Country CodeRequired | text |
RelationshipRequired | text |
PhonesRequired | array |
Update an EmployeeAction
| Field | Type |
|---|---|
| Employee Data | array |
KeyRequired | text |
| Value | text |
Update an Employee AuxiliaryAction
| Field | Type |
|---|---|
| Employee Data | array |
KeyRequired | text |
| Value | text |
Update an Employer JobAction
| Field | Type |
|---|---|
| Employee Data | array |
KeyRequired | text |
| Value | text |
Update an Employer ProjectAction
| Field | Type |
|---|---|
| Employee Data | array |
KeyRequired | text |
| Value | text |
Update Benefit PlanAction
Update Company OrganizationAction
| Field | Type |
|---|---|
| Organization Code | array |
Update Employee EarningsAction
| Field | Type |
|---|---|
Employee IDRequired | text |
| Employee Earning | object |
| Amount | number |
| Client Earning ID | text |
| Effective Date | date |
| Expiration Date | date |
| Multiplier | number |
| Rate | number |
| Standard Hours | number |
| Earning Calculation Method Code | text |
| Client Department ID | text |
| Is Deleted | text |
| Client Earning ID | text |
| Earning Code | text |
| Employee Unique ID | text |
Update Employer DepartmentsAction
| Field | Type |
|---|---|
| Employee Data | array |
KeyRequired | text |
| Value | text |
Update Financial Plan ElectionAction
| Field | Type |
|---|---|
| Financial Plan Data | array |
Update PTO BalanceAction
| Field | Type |
|---|---|
| PTO Balance | array |
Templates
Look for PrimePay templates in the WEXTL template library.
Browse templates →Explore alternative apps
- Bullhorn[2]Recruiting ATS and CRM for staffing agencies and talent teams.
- AchieversEmployee recognition and engagement platform for celebrations, rewards, and newsfeeds.
- AladtecWorkforce scheduling and timekeeping for public safety and healthcare teams.
- BeameryTalent lifecycle CRM for recruiting, talent pooling, campaigns, and workforce planning.
- Breezy HRApplicant tracking and recruiting platform for posting jobs, sourcing candidates, and hiring.
References
- WEXTL® PrimePay Source Code connector implementation.
- Our users use cases and automations.
- Official API Documentation for PrimePay.
- WEXTL® visual workflow builder data.
Last updated: Jul 24, 2026 18:12