About this integration
Cloud-based UK payroll and HR software for managing employees, employers, pension auto-enrolment, and CIS300 submissions. Use it from the workflow canvas with no custom glue script required.
This integration exposes 2 triggers, 52 search modules and 66 actions as workflow nodes. Authentication uses basic authentication. Webhook-based triggers fire instantly without polling.
How to connect
The credential form asks for API Key.
Prefer the interactive builder form? Open it on the app page.
Enter your credentials below. WEXTL stores them encrypted and uses them only to call the API on your behalf.
| Field | Type | Help |
|---|---|---|
API KeyRequired | password | 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. |
Use it in workflow automation
Start with Watch Events, then add Add an Attachment Order Document.
The canvas below runs Watch Events into Add an Attachment Order Document — watch the video, then drop a node onto the canvas.
Select the Watch Jobs trigger and the workflow fires automatically when the event occurs — no polling required.
Then add Delete Completed Jobs as the next node. Branch, filter, or hand off to other integrations from there.
The integration includes 68 ready-made modules for HR work — each run logs its inputs and outputs for debugging.
Staffology workflow on the canvas: Watch Jobs then Delete Completed Jobs
Triggers, searches and actions
Use the tables below to inspect Staffology's 2 triggers, 52 search modules, and 66 actions.
Triggers
2 triggers fire automatically when specified events occur — no polling or cron job needed.
- Watch Events
- Watch Jobs
Searches
Fetch data on demand using 52 search modules that query the app during a run.
- Assess an Employee
- Get a Benefit
- Get a Bill
- Get a Bill CSV
- Get Account Details
47more searches
Actions
66 action modules cover the full range of create, update, and delete operations.
- Add an Attachment Order Document
- Change Email Address
- Create a Benefit
- Create a Cost Center
- Create a Department
61more actions
Explore the fields available for each Staffology trigger, search, and action.
Triggers
Output fields
| Field | Type |
|---|---|
Employer IDRequired | text |
Webhook Event | choice |
Output fields
| 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
Searches
Input fields
| 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
| 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
Input fields
| Field | Type |
|---|---|
Employer IDRequired | choice |
Output fields
| 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
Input fields
| Field | Type |
|---|---|
Bill IDRequired | choice |
Output fields
| 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
Input fields
| Field | Type |
|---|---|
Bill IDRequired | choice |
Output fields
| Field | Type |
|---|---|
Type | text |
Content | text |
Model | object |
Stream | text |
Output fields
| Field | Type |
|---|---|
Category | text |
Email address | |
Pending email address | |
First name | text |
Last name | text |
Salutation | text |
User identifier | text |
Photo | text |
Photo sas URL | text |
Role | text |
41other output fields
Input fields
| Field | Type |
|---|---|
Employer IDRequired | choice |
Output fields
| Field | Type |
|---|---|
Code | text |
Title | text |
Color | text |
Accounting code | text |
Employee count | number |
Has journal overrides | boolean |
Input fields
| Field | Type |
|---|---|
Employer IDRequired | choice |
Output fields
| Field | Type |
|---|---|
Code | text |
Title | text |
Color | text |
Accounting code | text |
Employee count | number |
Has journal overrides | boolean |
Input fields
| Field | Type |
|---|---|
Employer IDRequired | choice |
Output fields
| Field | Type |
|---|---|
Is completed | boolean |
Mandate link | url |
Customer link | url |
Bank name | text |
Account number ending | text |
ID | text |
Input fields
| Field | Type |
|---|---|
Employer IDRequired | choice |
Output fields
| 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
Input fields
| Field | Type |
|---|---|
Job IDRequired | choice |
Output fields
| 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
Input fields
| Field | Type |
|---|---|
Job IDRequired | choice |
Output fields
| Field | Type |
|---|---|
file URL | url |
Input fields
| Field | Type |
|---|---|
Employer IDRequired | choice |
Output fields
| 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
Input fields
| Field | Type |
|---|---|
Employer IDRequired | text |
Analysis Category IDRequired | choice |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Input fields
| Field | Type |
|---|---|
Employer IDRequired | choice |
Output fields
| Field | Type |
|---|---|
ID | text |
Code | text |
Title | text |
Color | text |
Accounting code | text |
Input fields
| Field | Type |
|---|---|
IDRequired | choice |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Metadata | object |
URL | url |
Input fields
| Field | Type |
|---|---|
Employer IDRequired | choice |
IDRequired | text |
Output fields
| Field | Type |
|---|---|
Type | text |
Content | text |
Model | object |
Stream | text |
Input fields
| Field | Type |
|---|---|
Employer IDRequired | choice |
Output fields
| Field | Type |
|---|---|
File URL | text |
Input fields
| Field | Type |
|---|---|
Employer IDRequired | choice |
Output fields
| Field | Type |
|---|---|
File Data | text |
Input fields
| Field | Type |
|---|---|
Employer IDRequired | choice |
Output fields
| Field | Type |
|---|---|
Personal details | object |
Address | object |
Marital status | text |
Title | text |
First name | text |
Middle name | text |
Last name | text |
Alternative email | |
Previous sur name | text |
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
Input fields
| Field | Type |
|---|---|
IDRequired | choice |
Output fields
| 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
Input fields
| Field | Type |
|---|---|
CodeRequired | choice |
Output fields
| Field | Type |
|---|---|
Code | text |
Employer count | number |
Color | text |
Name | text |
Input fields
| Field | Type |
|---|---|
Employer IDRequired | choice |
Output fields
| 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
Input fields
| Field | Type |
|---|---|
Employer IDRequired | choice |
IDRequired | text |
Output fields
| 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 |
Output fields
| 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
Input fields
| Field | Type |
|---|---|
Employer IDRequired | choice |
Output fields
| Field | Type |
|---|---|
Title | text |
Note text | text |
Created by | text |
Updated by | text |
Document count | number |
Documents | array |
ID | text |
Input fields
| Field | Type |
|---|---|
Employer IDRequired | choice |
Output fields
| Field | Type |
|---|---|
Available Dates | array |
Input fields
| Field | Type |
|---|---|
Employer IDRequired | choice |
Output fields
| 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
Input fields
| Field | Type |
|---|---|
Employer IDRequired | choice |
Output fields
| Field | Type |
|---|---|
Total Count | number |
Input fields
| Field | Type |
|---|---|
Tenant ID | text |
Key | secret |
Output fields
| 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
Input fields
| Field | Type |
|---|---|
Employer IDRequired | choice |
Tax Year | choice |
Limit | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Metadata | object |
URL | text |
Input fields
| Field | Type |
|---|---|
Employer IDRequired | choice |
Limit | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Metadata | object |
URL | text |
Input fields
| Field | Type |
|---|---|
Employer IDRequired | choice |
Limit | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Metadata | object |
URL | text |
Input fields
| Field | Type |
|---|---|
Limit | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Metadata | object |
URL | url |
Input fields
| Field | Type |
|---|---|
Employer IDRequired | choice |
Tax Year | choice |
Limit | number |
Output fields
| 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
Input fields
| Field | Type |
|---|---|
Employer IDRequired | choice |
Limit | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Metadata | object |
URL | text |
Input fields
| Field | Type |
|---|---|
Employer IDRequired | choice |
Limit | number |
Output fields
| 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
Input fields
| Field | Type |
|---|---|
Employer IDRequired | choice |
Limit | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Metadata | object |
URL | url |
Input fields
| Field | Type |
|---|---|
Limit | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Metadata | object |
URL | url |
Input fields
| Field | Type |
|---|---|
Limit | number |
Output fields
| Field | Type |
|---|---|
Is owner | boolean |
Role | text |
ID | text |
Name | text |
Metadata | object |
URL | text |
Input fields
| Field | Type |
|---|---|
Employer IDRequired | choice |
Tax YearRequired | choice |
Limit | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Metadata | object |
URL | url |
Input fields
| Field | Type |
|---|---|
Employer IDRequired | choice |
Limit | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Metadata | object |
URL | url |
Input fields
| Field | Type |
|---|---|
Employer IDRequired | choice |
Limit | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Metadata | object |
URL | url |
Input fields
| Field | Type |
|---|---|
Employer IDRequired | choice |
Tax Year | choice |
Limit | number |
Output fields
| Field | Type |
|---|---|
Employee ID | text |
Employee unique ID | number |
Payroll code | text |
Employee name | text |
Email address | |
Roles | text |
Assessment ID | text |
Is joint assessment | boolean |
Period | number |
Letter type | text |
3other output fields
Input fields
| Field | Type |
|---|---|
Employer IDRequired | choice |
Status | choice |
Pension Scheme ID | text |
Sort By | choice |
Sort Descending | boolean |
Limit | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Metadata | object |
URL | url |
Input fields
| Field | Type |
|---|---|
Limit | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Metadata | object |
URL | url |
Input fields
| Field | Type |
|---|---|
Employer IDRequired | choice |
Limit | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Metadata | object |
URL | url |
Input fields
| Field | Type |
|---|---|
Limit | number |
Output fields
| Field | Type |
|---|---|
Is owner | boolean |
Role | text |
ID | text |
Name | text |
Metadata | object |
URL | text |
Input fields
| Field | Type |
|---|---|
Employer IDRequired | choice |
Limit | number |
Output fields
| 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
Input fields
| Field | Type |
|---|---|
Employer IDRequired | choice |
Job TypeRequired | choice |
Limit | number |
Output fields
| 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
Input fields
| Field | Type |
|---|---|
Employer IDRequired | choice |
Limit | number |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Metadata | object |
URL | url |
Input fields
| Field | Type |
|---|---|
Employer IDRequired | choice |
Limit | number |
Output fields
| Field | Type |
|---|---|
Employee ID | text |
Employee unique ID | number |
Payroll code | text |
Employee name | text |
Email address | |
Roles | text |
Assessment ID | text |
Is joint assessment | boolean |
Period | number |
Letter type | text |
3other output fields
Input fields
| Field | Type |
|---|---|
Limit | number |
Output fields
| Field | Type |
|---|---|
Is owner | boolean |
Role | text |
ID | text |
Name | text |
Metadata | object |
URL | text |
Actions
Input fields
| Field | Type |
|---|---|
Employer IDRequired | choice |
FileRequired | text |
File NameRequired | text |
Input fields
| Field | Type |
|---|---|
Email Address |
Output fields
| Field | Type |
|---|---|
Category | text |
Email address | |
Pending email address | |
First name | text |
Last name | text |
Salutation | text |
User identifier | text |
Photo | text |
Photo sas URL | text |
Role | text |
41other output fields
Input fields
| 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
| 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
Input fields
| Field | Type |
|---|---|
Employer IDRequired | choice |
CodeRequired | text |
TitleRequired | text |
Color | text |
Accounting Code | text |
Employee Count | number |
Has Journal Overrides | boolean |
Output fields
| Field | Type |
|---|---|
Code | text |
Title | text |
Color | text |
Accounting code | text |
Employee count | number |
Has journal overrides | boolean |
Input fields
| Field | Type |
|---|---|
Employer IDRequired | choice |
CodeRequired | text |
TitleRequired | text |
ColorRequired | text |
Employee CountRequired | number |
Accounting Code | text |
Has Journal Overrides | boolean |
Output fields
| Field | Type |
|---|---|
Code | text |
Title | text |
Color | text |
Accounting code | text |
Employee count | number |
Has journal overrides | boolean |
Input fields
| 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
| 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
Input fields
| Field | Type |
|---|---|
Category | choice |
Email Address | |
Pending Email Address | |
First Name | text |
Last Name | text |
Salutation | text |
User Identifier | text |
Photo | text |
Photo SAS URL | text |
Role | choice |
43other input fields
Output fields
| Field | Type |
|---|---|
Category | text |
Email address | |
Pending email address | |
First name | text |
Last name | text |
Salutation | text |
User identifier | text |
Photo | text |
Photo sas URL | text |
Role | text |
41other output fields
Input fields
| Field | Type |
|---|---|
Employer IDRequired | choice |
NameRequired | text |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Input fields
| Field | Type |
|---|---|
Employer IDRequired | choice |
CodeRequired | text |
TitleRequired | text |
ColorRequired | text |
Accounting CodeRequired | text |
Output fields
| Field | Type |
|---|---|
ID | text |
Code | text |
Title | text |
Color | text |
Accounting code | text |
Input fields
| Field | Type |
|---|---|
NameRequired | text |
Metadata | object |
URLRequired | url |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Metadata | object |
URL | url |
Input fields
| 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
| 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
Input fields
| 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 | |
Previous Surname | text |
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
| Field | Type |
|---|---|
Personal details | object |
Address | object |
Marital status | text |
Title | text |
First name | text |
Middle name | text |
Last name | text |
Alternative email | |
Previous sur name | text |
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
Input fields
| 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
| 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
Input fields
| Field | Type |
|---|---|
Code | text |
Employer Count | number |
Color | text |
Name | text |
Output fields
| Field | Type |
|---|---|
Code | text |
Employer count | number |
Color | text |
Name | text |
Input fields
| Field | Type |
|---|---|
Employer IDRequired | choice |
Payroll Details | array |
Output fields
| 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
Input fields
| 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
| 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
Input fields
| 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
| 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
Input fields
| Field | Type |
|---|---|
Employer IDRequired | choice |
TitleRequired | text |
Note TextRequired | text |
Created By | text |
Updated By | text |
Document Count | number |
Documents | array |
Output fields
| Field | Type |
|---|---|
Title | text |
Note text | text |
Created by | text |
Updated by | text |
Document count | number |
Documents | array |
ID | text |
Input fields
| Field | Type |
|---|---|
Employer IDRequired | choice |
Input fields
| Field | Type |
|---|---|
Employer IDRequired | choice |
Input fields
| Field | Type |
|---|---|
Employer IDRequired | choice |
Output fields
| Field | Type |
|---|---|
Code | text |
Title | text |
Color | text |
Accounting code | text |
Employee count | number |
Has journal overrides | boolean |
Input fields
| Field | Type |
|---|---|
Employer IDRequired | choice |
Input fields
| Field | Type |
|---|---|
Employer IDRequired | choice |
Output fields
| 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
Input fields
| Field | Type |
|---|---|
Employer IDRequired | choice |
Input fields
| Field | Type |
|---|---|
Employer IDRequired | choice |
Input fields
| Field | Type |
|---|---|
IDRequired | choice |
Input fields
| Field | Type |
|---|---|
Employer IDRequired | choice |
Input fields
| Field | Type |
|---|---|
Employer IDRequired | choice |
Input fields
| Field | Type |
|---|---|
Employer IDRequired | choice |
Output fields
| Field | Type |
|---|---|
Personal details | object |
Address | object |
Marital status | text |
Title | text |
First name | text |
Middle name | text |
Last name | text |
Alternative email | |
Previous sur name | text |
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
Input fields
| Field | Type |
|---|---|
IDRequired | choice |
Input fields
| Field | Type |
|---|---|
CodeRequired | choice |
Input fields
| Field | Type |
|---|---|
Employer IDRequired | choice |
Input fields
| Field | Type |
|---|---|
Employer IDRequired | choice |
Output fields
| 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
Input fields
| Field | Type |
|---|---|
Job IDRequired | choice |
Input fields
| Field | Type |
|---|---|
Employer IDRequired | choice |
Input fields
| Field | Type |
|---|---|
Employer IDRequired | choice |
Input fields
| Field | Type |
|---|---|
URLRequired | text |
MethodRequired | choice |
Headers | array |
Header | object |
Query String | array |
Parameter | object |
Body | text |
Output fields
| Field | Type |
|---|---|
Body | text |
Headers | object |
Status code | number |
Input fields
| Field | Type |
|---|---|
Employer IDRequired | choice |
Input fields
| Field | Type |
|---|---|
Employer IDRequired | choice |
Input fields
| Field | Type |
|---|---|
Employer IDRequired | choice |
Output fields
| 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
Input fields
| Field | Type |
|---|---|
Employer IDRequired | choice |
IDRequired | text |
Input fields
| Field | Type |
|---|---|
Employer IDRequired | choice |
No fields documented.
Input fields
| Field | Type |
|---|---|
Employer IDRequired | choice |
Output fields
| Field | Type |
|---|---|
To name | text |
To 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
Input fields
| Field | Type |
|---|---|
Employer IDRequired | choice |
IDRequired | text |
Output fields
| Field | Type |
|---|---|
To name | text |
To 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
Input fields
| 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
| 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
Input fields
| Field | Type |
|---|---|
Employer IDRequired | choice |
Output fields
| Field | Type |
|---|---|
Return URL | url |
Input fields
| 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
| 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
Input fields
| Field | Type |
|---|---|
Employer IDRequired | choice |
Code | text |
Title | text |
Color | text |
Accounting Code | text |
Employee Count | number |
Has Journal Overrides | boolean |
Output fields
| Field | Type |
|---|---|
Code | text |
Title | text |
Color | text |
Accounting code | text |
Employee count | number |
Has journal overrides | boolean |
Input fields
| Field | Type |
|---|---|
Employer IDRequired | choice |
Code | text |
Title | text |
Color | text |
Employee CountRequired | number |
Accounting Code | text |
Has Journal Overrides | boolean |
Output fields
| Field | Type |
|---|---|
Code | text |
Title | text |
Color | text |
Accounting code | text |
Employee count | number |
Has journal overrides | boolean |
Input fields
| 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
| 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
Input fields
| Field | Type |
|---|---|
Employer IDRequired | choice |
NameRequired | text |
Output fields
| Field | Type |
|---|---|
ID | text |
Name | text |
Input fields
| Field | Type |
|---|---|
Employer IDRequired | choice |
TitleRequired | text |
ColorRequired | text |
Accounting CodeRequired | text |
Output fields
| Field | Type |
|---|---|
ID | text |
Code | text |
Title | text |
Color | text |
Accounting code | text |
Input fields
| 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 | |
Previous Surname | text |
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
| Field | Type |
|---|---|
Personal details | object |
Address | object |
Marital status | text |
Title | text |
First name | text |
Middle name | text |
Last name | text |
Alternative email | |
Previous sur name | text |
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
Input fields
| 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
| 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
Input fields
| Field | Type |
|---|---|
CodeRequired | choice |
Employer Count | number |
Color | text |
Name | text |
Output fields
| Field | Type |
|---|---|
Code | text |
Employer count | number |
Color | text |
Name | text |
Input fields
| 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
| 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
Input fields
| 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
| 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
Input fields
| Field | Type |
|---|---|
Employer IDRequired | choice |
Payroll Details | array |
Output fields
| 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
Input fields
| 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
| 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 |
Input fields
| 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
| 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
Input fields
| Field | Type |
|---|---|
Employer IDRequired | choice |
Title | text |
Note Text | text |
Created By | text |
Updated By | text |
Document Count | number |
Documents | array |
Output fields
| Field | Type |
|---|---|
Title | text |
Note text | text |
Created by | text |
Updated by | text |
Document count | number |
Documents | array |
ID | text |
Input fields
| Field | Type |
|---|---|
FileRequired | text |
File NameRequired | text |
Output fields
| Field | Type |
|---|---|
Category | text |
Email address | |
Pending email address | |
First name | text |
Last name | text |
Salutation | text |
User identifier | text |
Photo | text |
Photo sas URL | text |
Role | text |
41other output fields
Input fields
| Field | Type |
|---|---|
Category | choice |
Email Address | |
Pending Email Address | |
First Name | text |
Last Name | text |
Salutation | text |
User Identifier | text |
Photo | text |
Photo SAS URL | text |
Role | choice |
41other input fields
Output fields
| Field | Type |
|---|---|
Category | text |
Email address | |
Pending email address | |
First name | text |
Last name | text |
Salutation | text |
User identifier | text |
Photo | text |
Photo sas URL | text |
Role | text |
41other output fields
Input fields
| Field | Type |
|---|---|
Employer IDRequired | choice |
FileRequired | text |
File NameRequired | text |
Output fields
| Field | Type |
|---|---|
Personal details | object |
Address | object |
Marital status | text |
Title | text |
First name | text |
Middle name | text |
Last name | text |
Alternative email | |
Previous sur name | text |
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
Input fields
| Field | Type |
|---|---|
U | text |
K | text |
Output fields
| Field | Type |
|---|---|
Response Data | boolean |