Staffology - Apps Documentation

Requirements

To use Staffology on WEXTL you need an active account and an API access token from your account settings.[3]

Get your Staffology credentials

API KeypasswordRequired
Log into your account, click your profile image at the top of the screen, select “API Keys” from the menu, and create a new API key.
[1]

Connect Staffology in WEXTL

Log in to your WEXTL account, add the Staffology node module to your workflow, and click Create new credential.
Instant triggers use webhooks — click Create a webhook first when adding one, then create the credential.
Optional: In the Credential name field, enter a name for the credential.
Enter the authentication credentials you copied from your Staffology 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 →

Staffology node modules

The list below is a reference of every Staffology node module the integration supports. You will be able to pick any of them on the workflow canvas while building automations.

Open any Staffology node module below to inspect its input parameters, outputs, and connection requirements.

Watch EventsTrigger

Output fields[3]

Field	Type
Employer IDRequired	text
Webhook Event	choice

Watch JobsTrigger

Output fields[3]

Field	Type
ID	text
Employer ID	text
Employer name	text
Type	text
Name	text
Output format	text
Status	text
Execution start time	date
Time in queue	number
Execution time	number

4other output fields

Assess an EmployeeSearch

Input fields[3]

Field	Type
Employee	object
ID	choice
Birth Date	date
Age	number
Start Date	date
Leave Date	date
Is Exempt	boolean
Roles	array
Pensions	array
State Pension Age	number
Postponement Date	date
Period	object
Pay Period	text
Pay Date	date
Period Start Date	date
Period End Date	date
Pay Run Start Date	date
Pay Run End Date	date
Lower Earnings Threshold	number
Qualifying Threshold	number
Upper Earnings Threshold	number
Minimum Age	number
Pension Schemes	array
Assessments	array
Explanation	boolean
Limit	number

Output fields[3]

Field	Type
Assessment date	date
Earnings	number
Qualifying earnings	number
Reason	text
Action	text
Action date	date
Status	text
Letter	text
Letter sent date	date
Letter sent type	text

12other output fields

Get a BenefitAction

Input fields[3]

Field	Type
Employer IDRequired	choice

Output fields[3]

Field	Type
Tax year	text
Type	text
Declaration type	text
Benefit payrolled	array
Description	text
Value	number
Employee contribution	number
Start date	date
End date	date
Use pro rata	boolean

17other output fields

Get a BillAction

Input fields[3]

Field	Type
Bill IDRequired	choice

Output fields[3]

Field	Type
Year	number
Month	number
Payslip count	number
Previously billed payslip count	number
Net cost	number
Discount	number
Partner discount amount	number
Monthly minimum	number
Total	number
Paid	boolean

6other output fields

Get a Bill CSVAction

Input fields[3]

Field	Type
Bill IDRequired	choice

Output fields[3]

Field	Type
Type	text
Content	text
Model	object
Stream	text

Get a Cost CenterAction

Input fields[3]

Field	Type
Employer IDRequired	choice

Output fields[3]

Field	Type
Code	text
Title	text
Color	text
Accounting code	text
Employee count	number
Has journal overrides	boolean

Get a DepartmentAction

Input fields[3]

Field	Type
Employer IDRequired	choice

Output fields[3]

Field	Type
Code	text
Title	text
Color	text
Accounting code	text
Employee count	number
Has journal overrides	boolean

Get a Direct Debit MandateAction

Input fields[3]

Field	Type
Employer IDRequired	choice

Output fields[3]

Field	Type
Is completed	boolean
Mandate link	url
Customer link	url
Bank name	text
Account number ending	text
ID	text

Get a JobAction

Input fields[3]

Field	Type
Job IDRequired	choice

Output fields[3]

Field	Type
ID	text
Employer ID	text
Employer name	text
Type	text
Name	text
Output format	text
Status	text
Execution start time	date
Time in queue	number
Execution time	number

4other output fields

Get a Job FileAction

Input fields[3]

Field	Type
Job IDRequired	choice

Output fields[3]

Field	Type
file URL	url

Get a LoanAction

Input fields[3]

Field	Type
Employer IDRequired	choice

Output fields[3]

Field	Type
Issue date	date
Reference	text
Pay code	text
Loan amount	number
Period amount	number
Amount repaid	number
Previously paid	number
Balance	number
Is settled	boolean
Is paused	boolean

4other output fields

Get Account DetailsAction

Output fields[3]

Field	Type
Category	text
Email address	email
Pending email address	email
First name	text
Last name	text
Salutation	text
User identifier	text
Photo	text
Photo sas URL	text
Role	text

41other output fields

Get AE AssessmentAction

Input fields[3]

Field	Type
Employer IDRequired	choice

Output fields[3]

Field	Type
Assessment date	date
Employee state	text
Age	number
Uk worker	text
Pay period	text
Ordinal	number
Earnings in period	number
Qualifying earnings in period	number
Ae exclusion code	text
Status	text

9other output fields

Get an API KeyAction

Input fields[3]

Field	Type
IDRequired	choice

Output fields[3]

Field	Type
ID	text
Name	text
Metadata	object
URL	url

Get an Assessment LetterAction

Input fields[3]

Field	Type
Employer IDRequired	choice
IDRequired	text

Output fields[3]

Field	Type
Type	text
Content	text
Model	object
Stream	text

Get an Attachment Order DocumentAction

Input fields[3]

Field	Type
Employer IDRequired	choice

Output fields[3]

Field	Type
File URL	text

Get an Auto-Enrolment Assessment LetterAction

Input fields[3]

Field	Type
Employer IDRequired	choice

Output fields[3]

Field	Type
File Data	text

Get an EmployeeAction

Input fields[3]

Field	Type
Employer IDRequired	choice

Output fields[3]

Field	Type
Personal details	object
Address	object
Marital status	text
Title	text
First name	text
Middle name	text
Last name	text
Alternative email	email
Previous sur name	text
Email	email
Email payslip	boolean
Employment details	object
Cis	object
Department	object
Cis sub contractor	boolean
Payroll code	text
Job title	text
Workplace postcode	text
On hold	boolean
On furlough	boolean
Furlough start	text
Furlough end	text
Auto enrolment	object
Last assessment	object
Uk worker	text
Days to defer assessment	number
Defer by months not days	boolean
Exempt	boolean
Ae exclusion code	text
Ae postponement letter sent	boolean
Leave settings	object
Use default holiday type	boolean
Use default allowance reset date	boolean
Use default allowance	boolean
Use default accrue payment in lieu	boolean
Use default accrue payment in lieu rate	boolean
Use default accrue payment in lieu all gross pay	boolean
Use default holiday accrual basis	boolean
Use default accrue payment in lieu pay automatically	boolean
Use default accrue hours per day	boolean
Use default maximum accrue period	boolean
Right to work	object
Checked	boolean
Document type	text
Document ref	text
Document expiry	text
Note	text
Bank details	object
Bank name	text
Bank branch	text
Bank reference	text
Account name	text
Account number	text
Sort code	text
Note	text
Building society roll number	text
Pay options	object
Regular pay lines	array
Period	text
Ordinal	number
Method	text
Withhold tax refund if pay is zero	boolean
Tax and ni	object
Fps fields	object
Tags	array
Basis	text
National minimum wage	boolean
Tags	array
Holiday scheme unique ID	text
Aggregated service date	text

6other output fields

Get an EmployerAction

Input fields[3]

Field	Type
IDRequired	choice

Output fields[3]

Field	Type
Address	object
Line 1	text
Line 2	text
Line 3	text
Line 4	text
Line 5	text
Post code	text
Country	text
Foreign country	text
Bank details	object
Country of bank	text
Iban	text
Swift bic	text
Bank name	text
Bank branch	text
Bank reference	text
Account name	text
Account number	text
Sort code	text
Note	text
Default pay options	object
Regular pay lines	array
Basic pay	number
Period	text
Ordinal	number
Method	text
Withhold tax refund if pay is zero	boolean
Tax and ni	object
Fps fields	object
Tags	array
Basis	text
Hmrc details	object
ID	text
Office number	text
Paye reference	text
Accounts office reference	text
Econ	text
Utr	text
Co tax	text
Employment allowance	boolean
Employment allowance max claim	number
Small employers relief	boolean
Default pension	object
ID	text
Pension scheme ID	text
Worker group ID	text
Pension scheme	object
Auto enrolled	boolean
Rti submission settings	object
ID	text
Sender type	text
Sender ID	text
Password	text
Exclude nil paid	boolean
Include hash cross ref	boolean
Auto submit fps	boolean
Auto submit eps	boolean
Test in live	boolean
Use test gateway	boolean
Leave settings	object
Use default holiday type	boolean
Use default allowance reset date	boolean
Use default allowance	boolean
Use default accrue payment in lieu	boolean
Use default accrue payment in lieu rate	boolean
Use default holiday accrual basis	boolean
Use default accrue payment in lieu pay automatically	boolean
Use default accrue hours per day	boolean
Use default maximum accrue period	boolean
Allowance reset date	text
Settings	object
Allow negative pay	boolean
Manual statutory pay lines enabled	boolean
Merge matching nominals enabled	boolean
Auto calc back pay for new starters	boolean
Pay code validation enabled	boolean
Calculate effective date salary changes	boolean
Group pay lines enabled	boolean
Contracted weeks	number
Full time contracted weeks	number
Full time contracted hours	number
Umbrella settings	object
Enabled	boolean
Charge per timesheet	number
Apprenticeship levy dedn rate	number
Holiday rate	number
Dpsb code	text
Expenses code	text
Gross deduction code	text
Holiday code	text
Cis fee code	text
Detail fee in comment	boolean
Auto enrolment settings	object
ID	text
Staging date	text
Cyclical reenrolment date	text
Previous cyclical reenrolment date	text
Default pension	object
Pension same as default	boolean
Days to defer assessment	number
Defer by months not days	boolean
Defer enrolment by	number
Defer enrolment by period type	text

46other output fields

Get an Employer GroupAction

Input fields[3]

Field	Type
CodeRequired	choice

Output fields[3]

Field	Type
Code	text
Employer count	number
Color	text
Name	text

Get Analysis CategoryAction

Input fields[3]

Field	Type
Employer IDRequired	text
Analysis Category IDRequired	choice

Output fields[3]

Field	Type
ID	text
Name	text

Get Analysis Category CodeAction

Input fields[3]

Field	Type
Employer IDRequired	choice

Output fields[3]

Field	Type
ID	text
Code	text
Title	text
Color	text
Accounting code	text

Get Attachment OrderAction

Input fields[3]

Field	Type
Employer IDRequired	choice

Output fields[3]

Field	Type
Type	text
Carry forward shortfall	boolean
Allow protected earnings	boolean
Auto deduction	boolean
Reference	text
Issue date	date
Apply from	date
Apply until	date
Deduction is percentage	boolean
Deduction	number

18other output fields

Get Bureau SettingsAction

Input fields[3]

Field	Type
Employer IDRequired	choice
IDRequired	text

Output fields[3]

Field	Type
Enable approvals	boolean
Processor user ID	text
Report pack ID	text
Is bacs client	boolean
Is bacs client for hmrc	boolean
Show contact card	boolean
ID	text

Get Employer DefaultsAction

Output fields[3]

Field	Type
Employer	object
Is owner	boolean
Role	text
ID	text
Name	text
Metadata	object
URL	text
Pay codes	boolean
CSV mappings	boolean
Departments	boolean
Rti	boolean
Users	boolean
Hmrc notice settings	boolean
Pay options	boolean
Working patterns	boolean
Occupational policies	boolean

3other output fields

Get Employer NoteAction

Input fields[3]

Field	Type
Employer IDRequired	choice

Output fields[3]

Field	Type
Title	text
Note text	text
Created by	text
Updated by	text
Document count	number
Documents	array
ID	text

Get Enrolment DatesAction

Input fields[3]

Field	Type
Employer IDRequired	choice

Output fields[3]

Field	Type
Available Dates	array

Get Last AE AssessmentAction

Input fields[3]

Field	Type
Employer IDRequired	choice

Output fields[3]

Field	Type
Assessment date	date
Employee state	text
Age	number
Uk worker	text
Pay period	text
Ordinal	number
Earnings in period	number
Qualifying earnings in period	number
Ae exclusion code	text
Status	text

9other output fields

Get Pending Letter CountsAction

Input fields[3]

Field	Type
Employer IDRequired	choice

Output fields[3]

Field	Type
Total Count	number

Get TenantAction

Input fields[3]

Field	Type
Tenant ID	text
Key	secret

Output fields[3]

Field	Type
Brand code	text
App name	text
Home URL	url
Head content	text
Log out URL	url
Login img URL	url
Home img URL	url
Fav icon	text
CSS colors file	text
CSS file	text

19other output fields

List AE AssessmentsSearch

Input fields[3]

Field	Type
Employer IDRequired	choice
Tax Year	choice
Limit	number

Output fields[3]

Field	Type
ID	text
Name	text
Metadata	object
URL	text

List Analysis CategoriesSearch

Input fields[3]

Field	Type
Employer IDRequired	choice
Limit	number

Output fields[3]

Field	Type
ID	text
Name	text
Metadata	object
URL	text

List Analysis Category CodesSearch

Input fields[3]

Field	Type
Employer IDRequired	choice
Limit	number

Output fields[3]

Field	Type
ID	text
Name	text
Metadata	object
URL	text

List API KeysSearch

Input fields[3]

Field	Type
Limit	number

Output fields[3]

Field	Type
ID	text
Name	text
Metadata	object
URL	url

List Attachment Order PaymentsSearch

Input fields[3]

Field	Type
Employer IDRequired	choice
Tax Year	choice
Limit	number

Output fields[3]

Field	Type
Attachment order	object
ID	text
Name	text
Metadata	object
URL	url
Tax year	text
Pay period	text
Date	date
Description	text
Attachable pay	number
Protected pay	number
Other attachment order deductions	number
Desired deduction	number
Shortfall	number

8other output fields

List Attachment OrdersSearch

Input fields[3]

Field	Type
Employer IDRequired	choice
Limit	number

Output fields[3]

Field	Type
ID	text
Name	text
Metadata	object
URL	text

List Average Holiday Pay HistorySearch

Input fields[3]

Field	Type
Employer IDRequired	choice
Limit	number

Output fields[3]

Field	Type
ID	text
Employee ID	text
Employee role ID	text
Tax year	text
Pay period	text
Period number	number
Pay amount	number
Hours	number
Days	number
Is statutory pay only	boolean

1other output field

List BenefitsSearch

Input fields[3]

Field	Type
Employer IDRequired	choice
Limit	number

Output fields[3]

Field	Type
ID	text
Name	text
Metadata	object
URL	url

List BillsSearch

Input fields[3]

Field	Type
Limit	number

Output fields[3]

Field	Type
ID	text
Name	text
Metadata	object
URL	url

List Bureau EmployersSearch

Input fields[3]

Field	Type
Limit	number

Output fields[3]

Field	Type
Is owner	boolean
Role	text
ID	text
Name	text
Metadata	object
URL	text

List CIS300sSearch

Input fields[3]

Field	Type
Employer IDRequired	choice
Tax YearRequired	choice
Limit	number

Output fields[3]

Field	Type
ID	text
Name	text
Metadata	object
URL	url

List Cost CentersSearch

Input fields[3]

Field	Type
Employer IDRequired	choice
Limit	number

Output fields[3]

Field	Type
ID	text
Name	text
Metadata	object
URL	url

List DepartmentsSearch

Input fields[3]

Field	Type
Employer IDRequired	choice
Limit	number

Output fields[3]

Field	Type
ID	text
Name	text
Metadata	object
URL	url

List Employee LettersSearch

Input fields[3]

Field	Type
Employer IDRequired	choice
Tax Year	choice
Limit	number

Output fields[3]

Field	Type
Employee ID	text
Employee unique ID	number
Payroll code	text
Employee name	text
Email address	email
Roles	text
Assessment ID	text
Is joint assessment	boolean
Period	number
Letter type	text

3other output fields

List EmployeesSearch

Input fields[3]

Field	Type
Employer IDRequired	choice
Status	choice
Pension Scheme ID	text
Sort By	choice
Sort Descending	boolean
Limit	number

Output fields[3]

Field	Type
ID	text
Name	text
Metadata	object
URL	url

List Employer GroupsSearch

Input fields[3]

Field	Type
Limit	number

Output fields[3]

Field	Type
ID	text
Name	text
Metadata	object
URL	url

List Employer NotesSearch

Input fields[3]

Field	Type
Employer IDRequired	choice
Limit	number

Output fields[3]

Field	Type
ID	text
Name	text
Metadata	object
URL	url

List EmployersSearch

Input fields[3]

Field	Type
Limit	number

Output fields[3]

Field	Type
Is owner	boolean
Role	text
ID	text
Name	text
Metadata	object
URL	text

List Enrolment AssessmentsSearch

Input fields[3]

Field	Type
Employer IDRequired	choice
Limit	number

Output fields[3]

Field	Type
Employee ID	text
Employee role ID	text
Pay run ID	text
Reason	text
Assessment date	date
Start date	date
End date	date
Age	number
Lower earnings threshold	number
Qualifying threshold	number

13other output fields

List JobsSearch

Input fields[3]

Field	Type
Employer IDRequired	choice
Job TypeRequired	choice
Limit	number

Output fields[3]

Field	Type
ID	text
Employer ID	text
Employer name	text
Type	text
Name	text
Output format	text
Status	text
Execution start time	date
Time in queue	number
Execution time	number

4other output fields

List LoansSearch

Input fields[3]

Field	Type
Employer IDRequired	choice
Limit	number

Output fields[3]

Field	Type
ID	text
Name	text
Metadata	object
URL	url

List Pending LettersSearch

Input fields[3]

Field	Type
Employer IDRequired	choice
Limit	number

Output fields[3]

Field	Type
Employee ID	text
Employee unique ID	number
Payroll code	text
Employee name	text
Email address	email
Roles	text
Assessment ID	text
Is joint assessment	boolean
Period	number
Letter type	text

3other output fields

List User EmployeesSearch

Input fields[3]

Field	Type
Limit	number

Output fields[3]

Field	Type
Is owner	boolean
Role	text
ID	text
Name	text
Metadata	object
URL	text

Add an Attachment Order DocumentAction

Input fields[3]

Field	Type
Employer IDRequired	choice
FileRequired	text
File NameRequired	text

Change Email AddressAction

Input fields[3]

Field	Type
Email Address	email

Output fields[3]

Field	Type
Category	text
Email address	email
Pending email address	email
First name	text
Last name	text
Salutation	text
User identifier	text
Photo	text
Photo sas URL	text
Role	text

41other output fields

Create a BenefitAction

Input fields[3]

Field	Type
Employer IDRequired	choice
Tax YearRequired	choice
TypeRequired	choice
Declaration TypeRequired	choice
Benefit Payrolled	array
Description	text
Value	number
Employee Contribution	number
Start Date	date
End Date	date

17other input fields

Output fields[3]

Field	Type
Tax year	text
Type	text
Declaration type	text
Benefit payrolled	array
Description	text
Value	number
Employee contribution	number
Start date	date
End date	date
Use pro rata	boolean

17other output fields

Create a Cost CenterAction

Input fields[3]

Field	Type
Employer IDRequired	choice
CodeRequired	text
TitleRequired	text
Color	text
Accounting Code	text
Employee Count	number
Has Journal Overrides	boolean

Output fields[3]

Field	Type
Code	text
Title	text
Color	text
Accounting code	text
Employee count	number
Has journal overrides	boolean

Create a DepartmentAction

Input fields[3]

Field	Type
Employer IDRequired	choice
CodeRequired	text
TitleRequired	text
ColorRequired	text
Employee CountRequired	number
Accounting Code	text
Has Journal Overrides	boolean

Output fields[3]

Field	Type
Code	text
Title	text
Color	text
Accounting code	text
Employee count	number
Has journal overrides	boolean

Create a LoanAction

Input fields[3]

Field	Type
Employer IDRequired	choice
Issue DateRequired	date
Reference	text
Pay Code	text
Loan Amount	number
Period Amount	number
Amount Repaid	number
Previously Paid	number
Balance	number
Is Settled	boolean

4other input fields

Output fields[3]

Field	Type
Issue date	date
Reference	text
Pay code	text
Loan amount	number
Period amount	number
Amount repaid	number
Previously paid	number
Balance	number
Is settled	boolean
Is paused	boolean

4other output fields

Create an AccountAction

Input fields[3]

Field	Type
Category	choice
Email Address	email
Pending Email Address	email
First Name	text
Last Name	text
Salutation	text
User Identifier	text
Photo	text
Photo SAS URL	text
Role	choice

43other input fields

Output fields[3]

Field	Type
Category	text
Email address	email
Pending email address	email
First name	text
Last name	text
Salutation	text
User identifier	text
Photo	text
Photo sas URL	text
Role	text

41other output fields

Create an API KeyAction

Input fields[3]

Field	Type
NameRequired	text
Metadata	object
URLRequired	url

Output fields[3]

Field	Type
ID	text
Name	text
Metadata	object
URL	url

Create an Attachment OrderAction

Input fields[3]

Field	Type
Employer IDRequired	choice
TypeRequired	choice
ReferenceRequired	text
Issue DateRequired	date
Apply FromRequired	date
Carry Forward ShortfallRequired	boolean
Allow Protected EarningsRequired	boolean
Auto DeductionRequired	boolean
Deduction Is PercentageRequired	boolean
DeductionRequired	number

18other input fields

Output fields[3]

Field	Type
Type	text
Carry forward shortfall	boolean
Allow protected earnings	boolean
Auto deduction	boolean
Reference	text
Issue date	date
Apply from	date
Apply until	date
Deduction is percentage	boolean
Deduction	number

18other output fields

Create an EmployeeAction

Input fields[3]

Field	Type
Employer IDRequired	choice
Personal Details	object
Address	object
Marital Status	text
Title	text
First Name	text
Middle Name	text
Last Name	text
Alternative Email	email
Previous Surname	text
Email	email
Email Payslip	boolean
Employment Details	object
CIS	object
Department	object
CIS Subcontractor	boolean
Payroll Code	text
Job Title	text
Workplace Postcode	text
On Hold	boolean
On Furlough	boolean
Furlough Start Date	date
Furlough End Date	date
Auto Enrolment	object
Last Assessment	object
UK Worker	choice
Days to Defer Assessment	number
Defer by Months Not Days	boolean
Exempt	boolean
AE Exclusion Code	choice
AE Postponement Letter Sent	boolean
Leave Settings	object
Use Default Holiday Type	boolean
Use Default Allowance Reset Date	boolean
Use Default Allowance	boolean
Use Default Accrue Payment in Lieu	boolean
Use Default Accrue Payment in Lieu Rate	boolean
Use Default Accrue Payment in Lieu All Gross Pay	boolean
Use Default Holiday Accrual Basis	boolean
Use Default Accrue Payment in Lieu Pay Automatically	boolean
Use Default Accrue Hours Per Day	boolean
Use Default Maximum Accrue Period	boolean
Right to Work	object
Checked	boolean
Document Type	choice
Document Reference	text
Document Expiry	date
Note	text
Bank Details	object
Bank Name	text
Bank Branch	text
Bank Reference	text
Account Name	text
Account Number	text
Sort Code	text
Note	text
Building Society Roll Number	text
Pay Options	object
Regular Pay Lines	array
Period	choice
Ordinal	number
Method	choice
Withhold Tax Refund If Pay Is Zero	boolean
Tax and NI	object
FPS Fields	object
Tags	array
Basis	choice
National Minimum Wage	boolean
Tags	array
Holiday Scheme Unique ID	text

7other input fields

Output fields[3]

Field	Type
Personal details	object
Address	object
Marital status	text
Title	text
First name	text
Middle name	text
Last name	text
Alternative email	email
Previous sur name	text
Email	email
Email payslip	boolean
Employment details	object
Cis	object
Department	object
Cis sub contractor	boolean
Payroll code	text
Job title	text
Workplace postcode	text
On hold	boolean
On furlough	boolean
Furlough start	text
Furlough end	text
Auto enrolment	object
Last assessment	object
Uk worker	text
Days to defer assessment	number
Defer by months not days	boolean
Exempt	boolean
Ae exclusion code	text
Ae postponement letter sent	boolean
Leave settings	object
Use default holiday type	boolean
Use default allowance reset date	boolean
Use default allowance	boolean
Use default accrue payment in lieu	boolean
Use default accrue payment in lieu rate	boolean
Use default accrue payment in lieu all gross pay	boolean
Use default holiday accrual basis	boolean
Use default accrue payment in lieu pay automatically	boolean
Use default accrue hours per day	boolean
Use default maximum accrue period	boolean
Right to work	object
Checked	boolean
Document type	text
Document ref	text
Document expiry	text
Note	text
Bank details	object
Bank name	text
Bank branch	text
Bank reference	text
Account name	text
Account number	text
Sort code	text
Note	text
Building society roll number	text
Pay options	object
Regular pay lines	array
Period	text
Ordinal	number
Method	text
Withhold tax refund if pay is zero	boolean
Tax and ni	object
Fps fields	object
Tags	array
Basis	text
National minimum wage	boolean
Tags	array
Holiday scheme unique ID	text
Aggregated service date	text

6other output fields

Create an EmployerAction

Input fields[3]

Field	Type
Address	object
Line 1	text
Line 2	text
Line 3	text
Line 4	text
Line 5	text
Post Code	text
Country	text
Foreign Country	text
Bank Details	object
Country Of Bank	text
IBAN	text
SWIFT/BIC	text
Bank Name	text
Bank Branch	text
Bank Reference	text
Account Name	text
Account Number	text
Sort Code	text
Note	text
Default Pay Options	object
Regular Pay Lines	array
Period	choice
Ordinal	number
Method	choice
Withhold Tax Refund If Pay Is Zero	boolean
Tax and NI	object
FPS Fields	object
Tags	array
Basis	choice
National Minimum Wage	boolean
HMRC Details	object
ID	text
Office Number	text
PAYE Reference	text
Accounts Office Reference	text
ECON	text
UTR	text
Company Tax	text
Employment Allowance	boolean
Employment Allowance Max Claim	number
Small Employers Relief	boolean
Default Pension	object
ID	text
Pension Scheme ID	text
Worker Group ID	text
Pension Scheme	object
Auto Enrolled	boolean
RTI Submission Settings	object
ID	text
Sender Type	text
Sender ID	text
Password	text
Exclude Nil Paid	boolean
Include Hash Cross Reference	boolean
Auto Submit FPS	boolean
Auto Submit EPS	boolean
Test in Live	boolean
Use Test Gateway	boolean

Output fields[3]

Field	Type
Address	object
Line 1	text
Line 2	text
Line 3	text
Line 4	text
Line 5	text
Post code	text
Country	text
Foreign country	text
Bank details	object
Country of bank	text
Iban	text
Swift bic	text
Bank name	text
Bank branch	text
Bank reference	text
Account name	text
Account number	text
Sort code	text
Note	text
Default pay options	object
Regular pay lines	array
Basic pay	number
Period	text
Ordinal	number
Method	text
Withhold tax refund if pay is zero	boolean
Tax and ni	object
Fps fields	object
Tags	array
Basis	text
Hmrc details	object
ID	text
Office number	text
Paye reference	text
Accounts office reference	text
Econ	text
Utr	text
Co tax	text
Employment allowance	boolean
Employment allowance max claim	number
Small employers relief	boolean
Default pension	object
ID	text
Pension scheme ID	text
Worker group ID	text
Pension scheme	object
Auto enrolled	boolean
Rti submission settings	object
ID	text
Sender type	text
Sender ID	text
Password	text
Exclude nil paid	boolean
Include hash cross ref	boolean
Auto submit fps	boolean
Auto submit eps	boolean
Test in live	boolean
Use test gateway	boolean
Leave settings	object
Use default holiday type	boolean
Use default allowance reset date	boolean
Use default allowance	boolean
Use default accrue payment in lieu	boolean
Use default accrue payment in lieu rate	boolean
Use default holiday accrual basis	boolean
Use default accrue payment in lieu pay automatically	boolean
Use default accrue hours per day	boolean
Use default maximum accrue period	boolean
Allowance reset date	text
Settings	object
Allow negative pay	boolean
Manual statutory pay lines enabled	boolean
Merge matching nominals enabled	boolean
Auto calc back pay for new starters	boolean
Pay code validation enabled	boolean
Calculate effective date salary changes	boolean
Group pay lines enabled	boolean
Contracted weeks	number
Full time contracted weeks	number
Full time contracted hours	number
Umbrella settings	object
Enabled	boolean
Charge per timesheet	number
Apprenticeship levy dedn rate	number
Holiday rate	number
Dpsb code	text
Expenses code	text
Gross deduction code	text
Holiday code	text
Cis fee code	text
Detail fee in comment	boolean
Auto enrolment settings	object
ID	text
Staging date	text
Cyclical reenrolment date	text
Previous cyclical reenrolment date	text
Default pension	object
Pension same as default	boolean
Days to defer assessment	number
Defer by months not days	boolean
Defer enrolment by	number
Defer enrolment by period type	text

46other output fields

Create an Employer GroupAction

Input fields[3]

Field	Type
Code	text
Employer Count	number
Color	text
Name	text

Output fields[3]

Field	Type
Code	text
Employer count	number
Color	text
Name	text

Create Analysis CategoryAction

Input fields[3]

Field	Type
Employer IDRequired	choice
NameRequired	text

Output fields[3]

Field	Type
ID	text
Name	text

Create Analysis Category CodeAction

Input fields[3]

Field	Type
Employer IDRequired	choice
CodeRequired	text
TitleRequired	text
ColorRequired	text
Accounting CodeRequired	text

Output fields[3]

Field	Type
ID	text
Code	text
Title	text
Color	text
Accounting code	text

Create Average Holiday Pay HistoryAction

Input fields[3]

Field	Type
Employer IDRequired	choice
Payroll Details	array

Output fields[3]

Field	Type
ID	text
Employee ID	text
Employee role ID	text
Tax year	text
Pay period	text
Period number	number
Pay amount	number
Hours	number
Days	number
Is statutory pay only	boolean

1other output field

Create CIS300Action

Input fields[3]

Field	Type
Employer IDRequired	choice
Tax YearRequired	choice
Tax Month	number
Employee Count	number
Employment Status Declaration	boolean
Verification Declaration	boolean
Information Correct Declaration	boolean
Inactivity Declaration	boolean
CIS Return	object
Contractor	object
Subcontractor	array
Nil Return	text
Declarations	object
IR Mark	text

3other input fields

Output fields[3]

Field	Type
Tax month	number
Employee count	number
Employment status declaration	boolean
Verification declaration	boolean
Information correct declaration	boolean
Inactivity declaration	boolean
Cis return	object
Contractor	object
Subcontractor	array
Nil return	text
Declarations	object
I rmark	text
XML	text
Tax year	text

3other output fields

Create Employee EnrollmentAction

Input fields[3]

Field	Type
Employer IDRequired	choice
Role IDRequired	text
Pay Run IDRequired	text
ReasonRequired	choice
Assessment DateRequired	date
Period Start DateRequired	date
Period End DateRequired	date
Age	number
Lower Earnings Threshold	number
Qualifying Threshold	number

15other input fields

Output fields[3]

Field	Type
Assessment date	date
Earnings	number
Qualifying earnings	number
Reason	text
Action	text
Action date	date
Status	text
Letter	text
Letter sent date	date
Letter sent type	text

12other output fields

Create Employer NoteAction

Input fields[3]

Field	Type
Employer IDRequired	choice
TitleRequired	text
Note TextRequired	text
Created By	text
Updated By	text
Document Count	number
Documents	array

Output fields[3]

Field	Type
Title	text
Note text	text
Created by	text
Updated by	text
Document count	number
Documents	array
ID	text

Delete a BenefitAction

Input fields[3]

Field	Type
Employer IDRequired	choice

Delete a Cost CenterAction

Input fields[3]

Field	Type
Employer IDRequired	choice

Delete a DepartmentAction

Input fields[3]

Field	Type
Employer IDRequired	choice

Output fields[3]

Field	Type
Code	text
Title	text
Color	text
Accounting code	text
Employee count	number
Has journal overrides	boolean

Delete a LoanAction

Input fields[3]

Field	Type
Employer IDRequired	choice

Output fields[3]

Field	Type
Issue date	date
Reference	text
Pay code	text
Loan amount	number
Period amount	number
Amount repaid	number
Previously paid	number
Balance	number
Is settled	boolean
Is paused	boolean

4other output fields

Delete AE AssessmentAction

Input fields[3]

Field	Type
Employer IDRequired	choice

Delete an API KeyAction

Input fields[3]

Field	Type
IDRequired	choice

Delete an Attachment Order DocumentAction

Input fields[3]

Field	Type
Employer IDRequired	choice

Delete an EmployeeAction

Input fields[3]

Field	Type
Employer IDRequired	choice

Delete an Employee PhotoAction

Input fields[3]

Field	Type
Employer IDRequired	choice

Output fields[3]

Field	Type
Personal details	object
Address	object
Marital status	text
Title	text
First name	text
Middle name	text
Last name	text
Alternative email	email
Previous sur name	text
Email	email
Email payslip	boolean
Employment details	object
Cis	object
Department	object
Cis sub contractor	boolean
Payroll code	text
Job title	text
Workplace postcode	text
On hold	boolean
On furlough	boolean
Furlough start	text
Furlough end	text
Auto enrolment	object
Last assessment	object
Uk worker	text
Days to defer assessment	number
Defer by months not days	boolean
Exempt	boolean
Ae exclusion code	text
Ae postponement letter sent	boolean
Leave settings	object
Use default holiday type	boolean
Use default allowance reset date	boolean
Use default allowance	boolean
Use default accrue payment in lieu	boolean
Use default accrue payment in lieu rate	boolean
Use default accrue payment in lieu all gross pay	boolean
Use default holiday accrual basis	boolean
Use default accrue payment in lieu pay automatically	boolean
Use default accrue hours per day	boolean
Use default maximum accrue period	boolean
Right to work	object
Checked	boolean
Document type	text
Document ref	text
Document expiry	text
Note	text
Bank details	object
Bank name	text
Bank branch	text
Bank reference	text
Account name	text
Account number	text
Sort code	text
Note	text
Building society roll number	text
Pay options	object
Regular pay lines	array
Period	text
Ordinal	number
Method	text
Withhold tax refund if pay is zero	boolean
Tax and ni	object
Fps fields	object
Tags	array
Basis	text
National minimum wage	boolean
Tags	array
Holiday scheme unique ID	text
Aggregated service date	text

6other output fields

Delete an EmployerAction

Input fields[3]

Field	Type
IDRequired	choice

Delete an Employer GroupAction

Input fields[3]

Field	Type
CodeRequired	choice

Delete Analysis CategoryAction

Input fields[3]

Field	Type
Employer IDRequired	choice

Delete Analysis Category CodeAction

Input fields[3]

Field	Type
Employer IDRequired	choice

Delete Attachment OrderAction

Input fields[3]

Field	Type
Employer IDRequired	choice

Delete Average Holiday Pay HistoryAction

Input fields[3]

Field	Type
Employer IDRequired	choice

Output fields[3]

Field	Type
ID	text
Employee ID	text
Employee role ID	text
Tax year	text
Pay period	text
Period number	number
Pay amount	number
Hours	number
Days	number
Is statutory pay only	boolean

1other output field

Delete Completed JobsAction

Input fields[3]

Field	Type
Job IDRequired	choice

Delete Direct Debit MandateAction

Input fields[3]

Field	Type
Employer IDRequired	choice

Delete Employer NoteAction

Input fields[3]

Field	Type
Employer IDRequired	choice

Make an API Calluniversal

Input fields[3]

Field	Type
URLRequired	text
MethodRequired	choice
Headers	array
Header	object
Query String	array
Parameter	object
Body	text

Output fields[3]

Field	Type
Body	text
Headers	object
Status code	number

Mark as On HoldAction

Input fields[3]

Field	Type
Employer IDRequired	choice

Mark Assessment Letter as SentAction

Input fields[3]

Field	Type
Employer IDRequired	choice

Mark CIS300 as SentAction

Input fields[3]

Field	Type
Employer IDRequired	choice

Output fields[3]

Field	Type
Tax month	number
Employee count	number
Employment status declaration	boolean
Verification declaration	boolean
Information correct declaration	boolean
Inactivity declaration	boolean
Cis return	object
Contractor	object
Subcontractor	array
Nil return	text
Declarations	object
I rmark	text
XML	text
Tax year	text

3other output fields

Mark Letter as SentAction

Input fields[3]

Field	Type
Employer IDRequired	choice
IDRequired	text

Rehire an EmployeeAction

Input fields[3]

Field	Type
Employer IDRequired	choice

Resend Verification EmailAction

No fields documented.

Send an Auto-Enrolment Assessment LetterAction

Input fields[3]

Field	Type
Employer IDRequired	choice

Output fields[3]

Field	Type
To name	text
To email	email
Subject	text
Button text	text
Button link	text
Body preview	text
Body	text
After btn body	text
Status	text
Status date	date

5other output fields

Send Assessment Email LetterAction

Input fields[3]

Field	Type
Employer IDRequired	choice
IDRequired	text

Output fields[3]

Field	Type
To name	text
To email	email
Subject	text
Button text	text
Button link	text
Body preview	text
Body	text
After btn body	text
Status	text
Status date	date

5other output fields

Set Employer DefaultsAction

Input fields[3]

Field	Type
Employer	object
Is OwnerRequired	boolean
RoleRequired	text
IDRequired	text
NameRequired	text
Metadata	object
URL	url
Pay Codes	boolean
CSV Mappings	boolean
Departments	boolean
RTI	boolean
Users	boolean
HMRC Notice Settings	boolean
Pay Options	boolean
Working Patterns	boolean
Occupational Policies	boolean

3other input fields

Output fields[3]

Field	Type
Employer	object
Is owner	boolean
Role	text
ID	text
Name	text
Metadata	object
URL	text
Pay codes	boolean
CSV mappings	boolean
Departments	boolean
Rti	boolean
Users	boolean
Hmrc notice settings	boolean
Pay options	boolean
Working patterns	boolean
Occupational policies	boolean

3other output fields

Setup Direct Debit MandateAction

Input fields[3]

Field	Type
Employer IDRequired	choice

Output fields[3]

Field	Type
Return URL	url

Update a BenefitAction

Input fields[3]

Field	Type
Employer IDRequired	choice
Tax Year	choice
Type	choice
Declaration Type	choice
Benefit Payrolled	array
Description	text
Value	number
Employee Contribution	number
Start Date	date
End Date	date

18other input fields

Output fields[3]

Field	Type
Tax year	text
Type	text
Declaration type	text
Benefit payrolled	array
Description	text
Value	number
Employee contribution	number
Start date	date
End date	date
Use pro rata	boolean

17other output fields

Update a Cost CenterAction

Input fields[3]

Field	Type
Employer IDRequired	choice
Code	text
Title	text
Color	text
Accounting Code	text
Employee Count	number
Has Journal Overrides	boolean

Output fields[3]

Field	Type
Code	text
Title	text
Color	text
Accounting code	text
Employee count	number
Has journal overrides	boolean

Update a DepartmentAction

Input fields[3]

Field	Type
Employer IDRequired	choice
Code	text
Title	text
Color	text
Employee CountRequired	number
Accounting Code	text
Has Journal Overrides	boolean

Output fields[3]

Field	Type
Code	text
Title	text
Color	text
Accounting code	text
Employee count	number
Has journal overrides	boolean

Update a LoanAction

Input fields[3]

Field	Type
Employer IDRequired	choice
Issue Date	date
Reference	text
Pay Code	text
Loan Amount	number
Period Amount	number
Amount Repaid	number
Previously Paid	number
Balance	number
Is Settled	boolean

4other input fields

Output fields[3]

Field	Type
Issue date	date
Reference	text
Pay code	text
Loan amount	number
Period amount	number
Amount repaid	number
Previously paid	number
Balance	number
Is settled	boolean
Is paused	boolean

4other output fields

Update an EmployeeAction

Input fields[3]

Field	Type
Employer IDRequired	choice
Personal Details	object
Address	object
Marital Status	text
Title	text
First Name	text
Middle Name	text
Last Name	text
Alternative Email	email
Previous Surname	text
Email	email
Email Payslip	boolean
Employment Details	object
CIS	object
Department	object
CIS Subcontractor	boolean
Payroll Code	text
Job Title	text
Workplace Postcode	text
On Hold	boolean
On Furlough	boolean
Furlough Start Date	date
Furlough End Date	date
Auto Enrolment	object
Last Assessment	object
UK Worker	choice
Days to Defer Assessment	number
Defer by Months Not Days	boolean
Exempt	boolean
AE Exclusion Code	choice
AE Postponement Letter Sent	boolean
Leave Settings	object
Use Default Holiday Type	boolean
Use Default Allowance Reset Date	boolean
Use Default Allowance	boolean
Use Default Accrue Payment in Lieu	boolean
Use Default Accrue Payment in Lieu Rate	boolean
Use Default Accrue Payment in Lieu All Gross Pay	boolean
Use Default Holiday Accrual Basis	boolean
Use Default Accrue Payment in Lieu Pay Automatically	boolean
Use Default Accrue Hours Per Day	boolean
Use Default Maximum Accrue Period	boolean
Right to Work	object
Checked	boolean
Document Type	choice
Document Reference	text
Document Expiry	date
Note	text
Bank Details	object
Bank Name	text
Bank Branch	text
Bank Reference	text
Account Name	text
Account Number	text
Sort Code	text
Note	text
Building Society Roll Number	text
Pay Options	object
Regular Pay Lines	array
Period	choice
Ordinal	number
Method	choice
Withhold Tax Refund If Pay Is Zero	boolean
Tax and NI	object
FPS Fields	object
Tags	array
Basis	choice
National Minimum Wage	boolean
Tags	array
Holiday Scheme Unique ID	text

7other input fields

Output fields[3]

Field	Type
Personal details	object
Address	object
Marital status	text
Title	text
First name	text
Middle name	text
Last name	text
Alternative email	email
Previous sur name	text
Email	email
Email payslip	boolean
Employment details	object
Cis	object
Department	object
Cis sub contractor	boolean
Payroll code	text
Job title	text
Workplace postcode	text
On hold	boolean
On furlough	boolean
Furlough start	text
Furlough end	text
Auto enrolment	object
Last assessment	object
Uk worker	text
Days to defer assessment	number
Defer by months not days	boolean
Exempt	boolean
Ae exclusion code	text
Ae postponement letter sent	boolean
Leave settings	object
Use default holiday type	boolean
Use default allowance reset date	boolean
Use default allowance	boolean
Use default accrue payment in lieu	boolean
Use default accrue payment in lieu rate	boolean
Use default accrue payment in lieu all gross pay	boolean
Use default holiday accrual basis	boolean
Use default accrue payment in lieu pay automatically	boolean
Use default accrue hours per day	boolean
Use default maximum accrue period	boolean
Right to work	object
Checked	boolean
Document type	text
Document ref	text
Document expiry	text
Note	text
Bank details	object
Bank name	text
Bank branch	text
Bank reference	text
Account name	text
Account number	text
Sort code	text
Note	text
Building society roll number	text
Pay options	object
Regular pay lines	array
Period	text
Ordinal	number
Method	text
Withhold tax refund if pay is zero	boolean
Tax and ni	object
Fps fields	object
Tags	array
Basis	text
National minimum wage	boolean
Tags	array
Holiday scheme unique ID	text
Aggregated service date	text

6other output fields

Update an EmployerAction

Input fields[3]

Field	Type
IDRequired	choice
Address	object
Line 1	text
Line 2	text
Line 3	text
Line 4	text
Line 5	text
Post Code	text
Country	text
Foreign Country	text
Bank Details	object
Country Of Bank	text
IBAN	text
SWIFT/BIC	text
Bank Name	text
Bank Branch	text
Bank Reference	text
Account Name	text
Account Number	text
Sort Code	text
Note	text
Default Pay Options	object
Regular Pay Lines	array
Period	choice
Ordinal	number
Method	choice
Withhold Tax Refund If Pay Is Zero	boolean
Tax and NI	object
FPS Fields	object
Tags	array
Basis	choice
National Minimum Wage	boolean
HMRC Details	object
ID	text
Office Number	text
PAYE Reference	text
Accounts Office Reference	text
ECON	text
UTR	text
Company Tax	text
Employment Allowance	boolean
Employment Allowance Max Claim	number
Small Employers Relief	boolean
Default Pension	object
ID	text
Pension Scheme ID	text
Worker Group ID	text
Pension Scheme	object
Auto Enrolled	boolean
RTI Submission Settings	object
ID	text
Sender Type	text
Sender ID	text
Password	text
Exclude Nil Paid	boolean
Include Hash Cross Reference	boolean
Auto Submit FPS	boolean
Auto Submit EPS	boolean
Test in Live	boolean
Use Test Gateway	boolean

Output fields[3]

Field	Type
Address	object
Line 1	text
Line 2	text
Line 3	text
Line 4	text
Line 5	text
Post code	text
Country	text
Foreign country	text
Bank details	object
Country of bank	text
Iban	text
Swift bic	text
Bank name	text
Bank branch	text
Bank reference	text
Account name	text
Account number	text
Sort code	text
Note	text
Default pay options	object
Regular pay lines	array
Basic pay	number
Period	text
Ordinal	number
Method	text
Withhold tax refund if pay is zero	boolean
Tax and ni	object
Fps fields	object
Tags	array
Basis	text
Hmrc details	object
ID	text
Office number	text
Paye reference	text
Accounts office reference	text
Econ	text
Utr	text
Co tax	text
Employment allowance	boolean
Employment allowance max claim	number
Small employers relief	boolean
Default pension	object
ID	text
Pension scheme ID	text
Worker group ID	text
Pension scheme	object
Auto enrolled	boolean
Rti submission settings	object
ID	text
Sender type	text
Sender ID	text
Password	text
Exclude nil paid	boolean
Include hash cross ref	boolean
Auto submit fps	boolean
Auto submit eps	boolean
Test in live	boolean
Use test gateway	boolean
Leave settings	object
Use default holiday type	boolean
Use default allowance reset date	boolean
Use default allowance	boolean
Use default accrue payment in lieu	boolean
Use default accrue payment in lieu rate	boolean
Use default holiday accrual basis	boolean
Use default accrue payment in lieu pay automatically	boolean
Use default accrue hours per day	boolean
Use default maximum accrue period	boolean
Allowance reset date	text
Settings	object
Allow negative pay	boolean
Manual statutory pay lines enabled	boolean
Merge matching nominals enabled	boolean
Auto calc back pay for new starters	boolean
Pay code validation enabled	boolean
Calculate effective date salary changes	boolean
Group pay lines enabled	boolean
Contracted weeks	number
Full time contracted weeks	number
Full time contracted hours	number
Umbrella settings	object
Enabled	boolean
Charge per timesheet	number
Apprenticeship levy dedn rate	number
Holiday rate	number
Dpsb code	text
Expenses code	text
Gross deduction code	text
Holiday code	text
Cis fee code	text
Detail fee in comment	boolean
Auto enrolment settings	object
ID	text
Staging date	text
Cyclical reenrolment date	text
Previous cyclical reenrolment date	text
Default pension	object
Pension same as default	boolean
Days to defer assessment	number
Defer by months not days	boolean
Defer enrolment by	number
Defer enrolment by period type	text

46other output fields

Update an Employer GroupAction

Input fields[3]

Field	Type
CodeRequired	choice
Employer Count	number
Color	text
Name	text

Output fields[3]

Field	Type
Code	text
Employer count	number
Color	text
Name	text

Update Analysis CategoryAction

Input fields[3]

Field	Type
Employer IDRequired	choice
NameRequired	text

Output fields[3]

Field	Type
ID	text
Name	text

Update Analysis Category CodeAction

Input fields[3]

Field	Type
Employer IDRequired	choice
TitleRequired	text
ColorRequired	text
Accounting CodeRequired	text

Output fields[3]

Field	Type
ID	text
Code	text
Title	text
Color	text
Accounting code	text

Update Assessment StateAction

Input fields[3]

Field	Type
Employer IDRequired	choice
State	choice
Status	choice
State Date	date
Pension Scheme ID	text
Worker Group ID	text
Start Action Already Reported	boolean
End Action Already Reported	boolean
Pension ID	text

Output fields[3]

Field	Type
Assessment date	date
Employee state	text
Age	number
Uk worker	text
Pay period	text
Ordinal	number
Earnings in period	number
Qualifying earnings in period	number
Ae exclusion code	text
Status	text

9other output fields

Update Attachment OrderAction

Input fields[3]

Field	Type
Employer IDRequired	choice
Type	choice
ReferenceRequired	text
Issue DateRequired	date
Apply FromRequired	date
Carry Forward ShortfallRequired	boolean
Allow Protected EarningsRequired	boolean
Auto DeductionRequired	boolean
Deduction Is PercentageRequired	boolean
DeductionRequired	number

18other input fields

Output fields[3]

Field	Type
Type	text
Carry forward shortfall	boolean
Allow protected earnings	boolean
Auto deduction	boolean
Reference	text
Issue date	date
Apply from	date
Apply until	date
Deduction is percentage	boolean
Deduction	number

18other output fields

Update Average Holiday Pay HistoryAction

Input fields[3]

Field	Type
Employer IDRequired	choice
Payroll Details	array

Output fields[3]

Field	Type
ID	text
Employee ID	text
Employee role ID	text
Tax year	text
Pay period	text
Period number	number
Pay amount	number
Hours	number
Days	number
Is statutory pay only	boolean

1other output field

Update Bureau SettingsAction

Input fields[3]

Field	Type
Employer IDRequired	choice
IDRequired	text
Enable ApprovalsRequired	boolean
Processor User IDRequired	choice
Report Pack IDRequired	text
Is BACS ClientRequired	boolean
Is BACS Client for HMRCRequired	boolean
Show Contact CardRequired	boolean

Output fields[3]

Field	Type
Enable approvals	boolean
Processor user ID	text
Report pack ID	text
Is bacs client	boolean
Is bacs client for hmrc	boolean
Show contact card	boolean
ID	text

Update CIS300Action

Input fields[3]

Field	Type
Employer IDRequired	choice
Tax Year	choice
Tax Month	number
Employee Count	number
Employment Status Declaration	boolean
Verification Declaration	boolean
Information Correct Declaration	boolean
Inactivity Declaration	boolean
CIS Return	object
Contractor	object
Subcontractor	array
Nil Return	text
Declarations	object
IR Mark	text

3other input fields

Output fields[3]

Field	Type
Tax month	number
Employee count	number
Employment status declaration	boolean
Verification declaration	boolean
Information correct declaration	boolean
Inactivity declaration	boolean
Cis return	object
Contractor	object
Subcontractor	array
Nil return	text
Declarations	object
I rmark	text
XML	text
Tax year	text

3other output fields

Update Employer NoteAction

Input fields[3]

Field	Type
Employer IDRequired	choice
Title	text
Note Text	text
Created By	text
Updated By	text
Document Count	number
Documents	array

Output fields[3]

Field	Type
Title	text
Note text	text
Created by	text
Updated by	text
Document count	number
Documents	array
ID	text

Update User PhotoAction

Input fields[3]

Field	Type
FileRequired	text
File NameRequired	text

Output fields[3]

Field	Type
Category	text
Email address	email
Pending email address	email
First name	text
Last name	text
Salutation	text
User identifier	text
Photo	text
Photo sas URL	text
Role	text

41other output fields

Update User ProfileAction

Input fields[3]

Field	Type
Category	choice
Email Address	email
Pending Email Address	email
First Name	text
Last Name	text
Salutation	text
User Identifier	text
Photo	text
Photo SAS URL	text
Role	choice

41other input fields

Output fields[3]

Field	Type
Category	text
Email address	email
Pending email address	email
First name	text
Last name	text
Salutation	text
User identifier	text
Photo	text
Photo sas URL	text
Role	text

41other output fields

Upload an Employee PhotoAction

Input fields[3]

Field	Type
Employer IDRequired	choice
FileRequired	text
File NameRequired	text

Output fields[3]

Field	Type
Personal details	object
Address	object
Marital status	text
Title	text
First name	text
Middle name	text
Last name	text
Alternative email	email
Previous sur name	text
Email	email
Email payslip	boolean
Employment details	object
Cis	object
Department	object
Cis sub contractor	boolean
Payroll code	text
Job title	text
Workplace postcode	text
On hold	boolean
On furlough	boolean
Furlough start	text
Furlough end	text
Auto enrolment	object
Last assessment	object
Uk worker	text
Days to defer assessment	number
Defer by months not days	boolean
Exempt	boolean
Ae exclusion code	text
Ae postponement letter sent	boolean
Leave settings	object
Use default holiday type	boolean
Use default allowance reset date	boolean
Use default allowance	boolean
Use default accrue payment in lieu	boolean
Use default accrue payment in lieu rate	boolean
Use default accrue payment in lieu all gross pay	boolean
Use default holiday accrual basis	boolean
Use default accrue payment in lieu pay automatically	boolean
Use default accrue hours per day	boolean
Use default maximum accrue period	boolean
Right to work	object
Checked	boolean
Document type	text
Document ref	text
Document expiry	text
Note	text
Bank details	object
Bank name	text
Bank branch	text
Bank reference	text
Account name	text
Account number	text
Sort code	text
Note	text
Building society roll number	text
Pay options	object
Regular pay lines	array
Period	text
Ordinal	number
Method	text
Withhold tax refund if pay is zero	boolean
Tax and ni	object
Fps fields	object
Tags	array
Basis	text
National minimum wage	boolean
Tags	array
Holiday scheme unique ID	text
Aggregated service date	text

6other output fields

Verify Email AddressAction

Input fields[3]

Field	Type
U	text
K	text

Output fields[3]

Field	Type
Response Data	boolean

Templates

Look for Staffology templates in the WEXTL template library.

Browse templates →

Explore alternative apps

More apps in HR category →

References

WEXTL® Staffology Source Code connector implementation.
Our users use cases and automations.
Official API Documentation for Staffology.
WEXTL® visual workflow builder data.

Last updated: Jul 21, 2026 15:23

How we write our apps documentation

How we compile these docs — sources, AI's role, and how we verify.