KeyPay API Reference
Home
About the API
API Key Authentication
OAuth2 Authentication
OData Filtering
.NET Client
Using the API
ABA Settings
Summary
Get ABA Settings Record by ID
Update ABA Settings Record
Delete ABA Settings Record
List ABA Settings
Create ABA Settings Record
Authentication
Summary
OAuth Token
Single Sign On
Single Sign On
Single Sign On
Business
Summary
Dismiss Business Notifications
Get Business Details
Get Business Document Details
Update Business Document Permissions
Delete Business Document
List Business Document Details
Create Business Document
Get Business Details by External ID
Get Rounding Rules
Set Rounding Rules
List Businesses
Create New Business
Get Business Document Content
List Entitlements
Get ATO Details
Set ATO Details
List Business Notifications
List All Business Access Users
Assign Business Access
Update Business Access
Revoke Business Access
Get STP Registration Details
Apply STP Registration Details
Get User Business Access
Chart of Accounts
Summary
Get Journal Service providers
Get Location Specific Chart of Accounts
Update Location Specific Chart of Accounts
Delete Location Specific Chart of Accounts
Bulk insert Journal Accounts
Get Journal Accounts
Create a new Journal Account
Get Journal Account by ID
Update an existing Journal Account
Delete an existing Journal Account
Get Chart of Accounts
Update Chart of Accounts
Get Journal Service provider
Update Journal Service provider
Get Journal Account Types
Deduction Categories
Summary
Get Deduction Category By ID
Update Deduction Category
Delete Deduction Category
List Deduction Categories
Create Deduction Category
Employee
Summary
Get Employee Shift Conditions
Sync Employee to QBO
List basic details for employees
Get Employee Work Types
Revoke Kiosk Access
Delete Employee
Get Employee By External ID
Grant Kiosk Access
Get Employee basic details by ID
Activate Employee
Get Pay Rates
Get Leave Balances
Get Employee By External Reference ID
Get Opening Balances
Set Opening Balances
Get Employee Notes
Set Employee Notes
Get standard hours for employee
Set standard hours for employee
Get Employee By ID
Update Employee
List Employees
Create or Update Employee
Get Employee Profile Image
Set Employee Profile Image
Delete Employee Profile Image
Employee Access
Summary
Get Employee Access for User
Get Users With Access to Employee
Grant Employee Access
Update Employee Access Record
Revoke Employee Access
Employee Bank Accounts
Summary
List Bank Accounts
Create Bank Account
Update Bank Account
Get Bank Account by ID
Delete Bank Account
Employee Documents
Summary
Link Employee Document to Leave Request
Unlink Employee Document from Leave Request
Link Employee Document to Expense Request
Unlink Employee Document from Expense Request
List Employee Documents
Create Employee Document
Update Employee Document Permissions
Link Employee Document to Timesheet
Unlink Employee Document from Timesheet
Get Employee Document Details
Delete Employee Document
Get Employee Document Content
Employee Expense Categories
Summary
Get Tax Codes
List Employee Expense Categories
Create Employee Expense Category
Get Employee Expense Category by ID
Update Employee Expense Category
Delete Employee Expense Category
Employee Expense Requests
Summary
List Expense Requests
Create Expense Request
Get Expense Request by ID
Update Expense Request
Delete Expense Request
Decline Expense Request
Approve Expense Request
Upload Attachment to Expense Request
Employee Groups
Summary
List Employee Groups
Create Employee Group
Get Employee Group by ID
Update Employee Group
Delete Employee Group
Employee Leave Allowances
Summary
Get Leave Allowances
Set Leave Allowances
Employee Qualifications
Summary
Get Qualifications for Employee
Add/Update Employee Qualification
Delete Employee Qualification
List Documents for Employee Qualification
Create Employee Qualification Document
Get Qualification Details
Get Qualification Document File
Get Qualification Document by ID
Delete Employee Qualification Document
Employee Self Service
Summary
Get Pay Slip by Pay Run ID
Get Lookup Data
Get Tax Codes
Bulk Decline Roster Shift Swaps
Download Document
Get KiwiSaver Enrollment Options
Get P60 certificate PDF
Accept Roster Shift
Bulk Decline Roster Shifts
Get Enabled Features
Clock In Employee
Get Leaving employee form PDF
Discard current shift
Get KiwiSaver options for employee
Get Business Titles
Employees Eligible For Shift Swap
Get Payment Summaries
Get Shift Conditions
Get Satisfaction Survey Results
Submit Satisfaction Survey
Acknowledge Document
Get Work Types
Upload Attachment to Expense Request
List Leave Requests
Create Leave Request
List Bank Accounts
Create Bank Account
List Unavailabilities
Create Unavailability
Edit Timesheet
Delete Timesheet
Decline Roster Shift
Propose Shift Swap
Get Expense Request by ID
Update Expense Request
Delete Expense Request
Get Dashboard
Bulk Accept Roster Shift Swaps
Clock Out Employee
Find Matching Clock Off Roster Shift
Find Nearby Roster Shifts
List Super Funds
Create Super Fund
Find Matching Clock On Roster Shift
Get Bank Account by ID
Delete Bank Account
List Timesheets
Submit or Update Timesheet
Accept Shift Swap
Shifts
Get Employee Profile Image
Set Employee Profile Image
Delete Employee Profile Image
Get Document Details by ID
Get Expense Categories
Update Bank Account
Get Leave Request by ID
Update Leave Request
Delete Leave Request
List all Documents
Register Device Token
Get Locations
Bulk Accept Roster Shifts
Bulk Cancel Roster Shift Swaps
List Roster Shifts
List Pay Slips
Get Roster Shift by ID
Get Shift Notes
Add Note to Shift
Recover Forgotten Password
Get Super Fund by ID
Estimate Leave Hours
Start Break
Get Leave Categories
Get Emergency Contacts
Save Emergency Contacts
Cancel Shift Swap
Decline Shift Swap
Upload Attachment to Leave Request
Delete Attachment from Leave Request
Get Details
Save Details
End Break
Delete Super Fund
Get Employees
Unregister Device Token
Get Expense Requests
Create Expense Request
Update Super Fund
Get P60 certificates
Get Leave Balances
Get Payment Summary PDF
Mark Shift Notes Read
Get Expense Payment Summary
Get unavailability by ID
Update Unavailability
Delete Unavailability
Employee Super Funds
Summary
Delete Super Fund
List Super Funds
Create Super Fund
Get Super Fund by ID
Update Super Fund
Employer Liability Categories
Summary
Get Employer Liability Category
Update Employer Liability Category
Delete Employer Liability Category
List Employer Liability Categories
Create Employer Liability Category
Employing Entities
Summary
Get Employing Entity By ID
Update Employing Entity
Delete Employing Entity
List Employing Entities
Create Employing Entity
Employment Agreement
Summary
Get Shift Periods for Employee
Bulk Evaluate Shift Costings
Get Shift Periods
Get Employment Agreement by ID
Evaluate Shift Costings
List Employment Agreements
Get Shift Costings for Employee
Invoices
Summary
Get Reseller Invoice By ID
Get Business Invoices
Get Business Invoice By ID
Get Reseller Invoices
Get White Label Invoices
Get White Label Invoice By ID
Leave Allowances
Summary
Get Leave Allowances for Employee
List Leave Allowance Templates
Create Leave Allowance Template
Get Leave Allowance Template by ID
Update Leave Allowance Template
Delete Leave Allowance Template
Get Leave Allowances for All Employees
Set Leave Allowances
Leave Categories
Summary
Get Leave Category by ID
Update Leave Category
Delete Leave Category
List Leave Categories
Create Leave Category
Leave Requests
Summary
Approve Leave Request
Decline Leave Request
List Leave Requests
Get Leave Request by ID
Update Leave Request
Delete Leave Request
Estimate Leave Hours
Get Leave Requests for Employee
Create Leave Request
Location
Summary
Get Location By Id
Update Location
Delete Location
List Employee Locations
List Business Locations
Create Location
Lookup Data
Summary
List Employee Group Permission Types
List Report Types
List Time Zone Types
List Time Zone Types
Manager
Summary
Start Break
List Leave Requests
Get the list of roles available
Get Business Expense Requests
List Timesheet Employees
List Kiosk Staff
Add an Employee
Update Unavailability
Delete Unavailability
Send PIN Reset Email
Get Employee Lookup Data
Overlapping Leave Requests
Discard current shift
List Employee Locations
Create Leave Request
Get List of Employees
List Expense Request Employees
Stub Shift Timesheets
Send PIN Reset SMS
Get Roster Shifts
Get timesheet
Edit Timesheet
Delete Timesheet
List Expense Request Locations
List Leave Locations
Get List of Locations
Get Shift Notes
Add Note to Shift
Get Business Timesheets
Create timesheet line
Get Leave Request by ID
Update Leave Request
Delete Leave Request
Approve Leave Request
Check Employee
Reject Timesheet
Get Roster Shift by ID
List Tax Codes
Decline Leave Request
Find Nearby Roster Shifts
Update comments in a timesheet
List Employee Locations
List Leave Employees
Upload Attachment to Expense Request
List Leave Categories
Update timesheet line
Get expense request
Edit Expense Request
Delete Expense Request
Get Leave Request Attachment
Clock Out Employee
Get timesheet reference data
Get Kiosk by ID
Estimate Leave Hours
Decline Expense Request
List Expense Categories
Change PIN
Mark Shift Notes Read
End Break
List Manager Roster Employees
Get Rounding Rules
Set Rounding Rules
Delete Note from Shift
Get Business Timesheets
Create kiosk timesheet line
Download Document
Find Matching Clock On Roster Shift
Get Leave Balances
List Timesheet Locations
Find Matching Clock Off Roster Shift
Manage Roster Data
Update kiosk timesheet line
Verify Kiosk PIN
Get Employee Profile Image
Set Employee Profile Image
Delete Employee Profile Image
Get Kiosks
Clock In Employee
Get Businesses
List Roster Locations
List Employee Groups
Get expenses reference data
Create expense request
Approve Expense Request
Approve Timesheet
Shifts
List Leave Categories
Create Unavailability
Overlapping Leave Requests
List Roster Employees
Pay Category
Summary
Get Pay Category by ID
Update Pay Category
Delete Pay Category
List Pay Categories
Create Pay Category
Pay Rate Templates
Summary
Get Pay Rate Template by ID
Update Pay Rate Template
Delete Pay Rate Template
List Pay Rate Templates
Create Pay Rate Template
Pay Run
Summary
Get Leave Accruals
Save Leave Accruals
Delete Leave Accrual
List Pay Runs
Create Pay Run
Get Leave Accruals for Employee
List Employer Liabilities
Create Employer Liabilities
Delete Employer Liability
Get Employer Liabilities by Employee ID
List Employee Expenses
Create Employee Expenses
Delete Employee Expense
Get Pay Run Totals by Employee ID
Get pay run payments
List Deductions
Create Deductions
Delete Deduction
Get Pay Run
Delete Pay Run
Get Creation Status
List Pay Run Totals for Employee
Get Earnings Lines by Employee ID
Finalise Pay Run
Get ABA File
List Pay Slip Data
Create Pay Run (Async)
Get Pay Slip Data by Employee ID
Set Pay Run Notation
Delete Pay Run Notation
Unlock Pay Run
Terminate Employee in Pay Run
Recalculate
Get Pay Slip File
Get Super Adjustments by Employee ID
List Super Adjustments
Create Super Adjustments
Delete Super Adjustment
List Earnings Lines
Create Earnings Lines
Delete Earnings Line
List Pay Run Totals
Get Deductions by Employee ID
Remove Employee from Pay Run
Set UI Unlock enabled
Get Employee Expenses by Employee ID
Get Journal Details
Get PAYG Adjustments by Employee ID
List PAYG Adjustments
Create PAYG Adjustments
Delete PAYG Adjustment
Create Note for Employee
Delete Note for Employee
Pay Run Inclusions
Summary
Get Employee Tax Adjustment by ID
Update Employee Tax Adjustment
Delete Employee Tax Adjustment
Get Employer liability by ID
Update Employer liability
Delete Employer liability
List Employee Deductions
Create Employee Deduction
Get Employee Deduction by ID
Update Employee Deduction
Delete Employee Deduction
List Employee Super Adjustments
Create Employee Super Adjustment
List Employee Tax Adjustments
Create Employee Tax Adjustment
List Employer liabilities
Create Employer liability
Get Employee Super Adjustment by ID
Update Employee Super Adjustment
Delete Employee Super Adjustment
List Employee Expenses
Create Employee Expense
Get Employee Expense by ID
Update Employee Expense
Delete Employee Expense
Pay Schedules
Summary
Get Pay Schedule Metadata
List Pay Schedules
Create Pay Schedule
Get Pay Schedule by ID
Update Pay Schedule
Delete Pay Schedule
Payment Summaries
Summary
List Payment Summaries
Publish Payment Summaries
Generate Payment Summaries
Unpublish Payment Summaries
Public Holiday
Summary
Get Public Holiday Details
Update Public Holiday
Delete Public Holiday
Get Public Holidays for Year
Add a public holiday
Delete Public Holiday by Date
Qualifications
Summary
List Qualifications
Create Qualification
Get Qualification by ID
Update Qualification
Delete Qualification
Reporting
Summary
Gross To Net Report
Deductions Report
Leave Balances Report
Birthday Report
Super Contribution Report (By Super Fund)
Journal Report
Employee Details Report
Timesheet report
Detailed Activity Report
Pay Run Inclusions Report
Pay Categories Report
Pay Run Activity Report
roster vs timesheet comparison report
Employee Details Report
Costing Report
Super Contribution Report (By Employee)
Ordinary Time Earnings Report
Leave Liability Report
PAYG Report
Leave History Report
Payroll Tax Report
Employee Payment History Report
Reseller
Summary
Get Reseller by ID
List Resellers
Roster Shifts
Summary
Stub Shift Timesheets
Get Roster Shifts
Find Nearby Roster Shifts
Find Matching Clock On Roster Shift
Find Matching Clock Off Roster Shift
Super Funds
Summary
Search Super Funds
Get Self Managed Super Fund by ID
Update Self Managed Super Fund
List Self Managed Super Funds
Create Self Managed Super Fund
Time and Attendance
Summary
Get Employee Lookup Data
Get Shift Notes
Add Note to Shift
List Kiosk Staff
Add an Employee
Send PIN Reset Email
Send PIN Reset SMS
List Kiosks
Create Kiosk
Shifts
Clock Out Employee
End Break
Get Kiosk by ID
Update Kiosk
Delete Kiosk
Clock In Employee
Add Complete Shift for Employee
Verify Kiosk PIN
Change PIN
Check Employee
Discard current shift
Employee Has Access
Delete Note from Shift
Start Break
Mark Shift Notes Read
Timesheets
Summary
Get Business Timesheets
Create timesheet line
Update timesheet line
Delete timesheet line
Bulk Insert Timesheets
Update/Replace timesheets
Unavailability
Summary
List Unavailabilities
Create Unavailability
Get unavailability by ID
Update Unavailability
Delete Unavailability
User
Summary
Get User Details
Create New User
Webhook
Summary
List Web Hook Registrations
Register Web Hook
Delete all Web Hook Registrations
Get Web Hook Registration by ID
Update Web Hook Registration
Delete Web Hook Registration
Test Web Hook
White Label
Summary
Active Employees Report
Signup Report
List White Labels
Get White Label by ID
Work Types
Summary
List Work Types
Create Work Type
Get Work Type by ID
Update Work Type
Delete Work Type
OpenAPI specification
Download
Reseller
Description
HTTP Request
Get Reseller by ID
GET /api/v2/reseller/{id}
List Resellers
GET /api/v2/reseller