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