KeyPay API Reference

Home
About the API
- API Key Authentication
- OAuth2 Authentication
- OData Filtering
- .NET Client
- Using the API
Authentication
- Summary
- OAuth Token
- Single Sign On
- Single Sign On
- Single Sign On
Business
- Summary
- Assign Business Access
- Change the tax year
- Create Business Document
- Create New Business
- Create new payment file record
- Delete Business Document
- Delete payment file record
- Dismiss Business Notifications
- Get ATO Details
- Get Business Details
- Get Business Details by External ID
- Get Business Document Content
- Get Business Document Details
- Get Employee Portal Settings
- Get Rounding Rules
- Get User Business Access
- Get payment file by ID
- List All Business Access Users
- List Business Document Details
- List Business Notifications
- List Businesses
- List Entitlements
- List payment files
- Revoke Business Access
- Set ATO Details
- Set Rounding Rules
- Update Business Document Permissions
- Update Employee Portal Settings
- Update details of an associated user
- Update payment file record
Chart of Accounts
- Summary
- Bulk insert Journal Accounts
- Create a new Journal Account
- Delete Location Specific Chart of Accounts
- Delete an existing Journal Account
- Get Chart of Accounts
- Get Journal Account Types
- Get Journal Account by ID
- Get Journal Accounts
- Get Journal Service provider
- Get Journal Service providers
- Get Location Specific Chart of Accounts
- Update Chart of Accounts
- Update Journal Service provider
- Update Location Specific Chart of Accounts
- Update an existing Journal Account
Deduction Categories
- Summary
- Create Deduction Category
- Delete Deduction Category
- Get Deduction Category By ID
- List Deduction Categories
- Update Deduction Category
Employee
- Summary
- Activate Employee
- Create or Update Employee
- Delete Employee
- Delete Employee Profile Image
- Get Employee By External ID
- Get Employee By External Reference ID
- Get Employee By ID
- Get Employee Notes
- Get Employee Profile Image
- Get Employee Shift Conditions
- Get Employee Work Types
- Get Employee basic details by ID
- Get Leave Balances
- Get Opening Balances
- Get Pay Rates
- Get standard hours for employee
- Grant Kiosk Access
- List Employees
- List basic details for employees
- Revoke Kiosk Access
- Set Employee Notes
- Set Employee Profile Image
- Set Opening Balances
- Set standard hours for employee
- Update Employee
Employee Access
- Summary
- Get Employee Access for User
- Get Users With Access to Employee
- Grant Employee Access
- Revoke Employee Access
- Update Employee Access Record
Employee Bank Accounts
- Summary
- Create Bank Account
- Delete Bank Account
- Get Bank Account by ID
- List Bank Accounts
- Update Bank Account
Employee Benefits In Kind
- Summary
- Create benefit in kind
- Delete benefit in kind
- Get benefits in kind
- Get benefits in kinds
- Update an benefit in kind
Employee Documents
- Summary
- Create Employee Document
- Delete Employee Document
- Get Employee Document Content
- Get Employee Document Details
- Link Employee Document to Expense Request
- Link Employee Document to Leave Request
- Link Employee Document to Timesheet
- List Employee Documents
- Unlink Employee Document from Expense Request
- Unlink Employee Document from Leave Request
- Unlink Employee Document from Timesheet
- Update Employee Document Permissions
Employee Expense Categories
- Summary
- Create Employee Expense Category
- Delete Employee Expense Category
- Get Employee Expense Category by ID
- Get Tax Codes
- List Employee Expense Categories
- Update Employee Expense Category
Employee Expense Requests
- Summary
- Approve Expense Request
- Create Expense Request
- Decline Expense Request
- Delete Expense Request
- Get Expense Request by ID
- List Expense Requests
- Update Expense Request
- Upload Attachment to Expense Request
Employee Gains Or Profits Employee Share Plan
- Summary
- Create Gains or profits employee share plan
- Delete Gains or profits employee share plan
- Get Gains or profits employee share plan
- Get Gains or profits employee share plans
- Update an existing Gains or profits employee share plan
Employee Groups
- Summary
- Create Employee Group
- Delete Employee Group
- Get Employee Group by ID
- List Employee Groups
- Update Employee Group
Employee Income From Overseas Subject To Tax Remission
- Summary
- Create Income from overseas subject to tax remission
- Delete income from overseas subject to tax remission
- Get Income from overseas subject to tax remission
- Get Income from overseas subject to tax remissions
- Update an existing income from overseas subject to tax remission
Employee Income Tax Borne By Employer
- Summary
- Create income tax borne by employer
- Delete income tax borne by employer
- Get income tax borne by employer
- Get income tax borne by employer
- Update an existing income tax borne by employer
Employee Leave Allowances
- Summary
- Get Leave Allowances
- Set Leave Allowances
Employee Onboarding
- Summary
- Initiate Employee Self Service Onboarding
Employee Pay Rate Schedule
- Summary
- Create pay rate adjustment schedule record
- Delete pay rate adjustment schedule record
- Get pay rate adjustment schedule record by ID
- List pay rate adjustment schedule
- Update pay rate adjustment schedule record
Employee Qualifications
- Summary
- Add/Update Employee Qualification
- Create Employee Qualification Document
- Delete Employee Qualification
- Delete Employee Qualification Document
- Get Qualification Details
- Get Qualification Document File
- Get Qualification Document by ID
- Get Qualifications for Employee
- List Documents for Employee Qualification
Employee Self Service
- Summary
- Accept Roster Shift
- Accept Shift Swap
- Acknowledge Document
- Add Note to Shift
- Bulk Accept Roster Shift Swaps
- Bulk Accept Roster Shifts
- Bulk Cancel Roster Shift Swaps
- Bulk Decline Roster Shift Swaps
- Bulk Decline Roster Shifts
- Cancel Shift Swap
- Clock In Employee
- Clock Out Employee
- Create Bank Account
- Create Expense Request
- Create Leave Request
- Create Super Fund
- Create Unavailability
- Decline Roster Shift
- Decline Shift Swap
- Delete Attachment from Leave Request
- Delete Bank Account
- Delete Employee Profile Image
- Delete Expense Request
- Delete Leave Request
- Delete Super Fund
- Delete Timesheet
- Delete Unavailability
- Discard current shift
- Download Document
- Edit Timesheet
- Employees Eligible For Shift Swap
- End Break
- Estimate Leave Hours
- Find Matching Clock Off Roster Shift
- Find Matching Clock On Roster Shift
- Find Nearby Roster Shifts
- Get Bank Account by ID
- Get Dashboard
- Get Document Details by ID
- Get Emergency Contacts
- Get Employee Profile Image
- Get Employees
- Get Enabled Features
- Get Expense Categories
- Get Expense Payment Summary
- Get Expense Request by ID
- Get Expense Requests
- Get IRAS forms
- Get Iras Form PDF
- Get KiwiSaver Enrollment Options
- Get KiwiSaver options for employee
- Get Leave Balances
- Get Leave Categories
- Get Leave Request by ID
- Get Leaving employee form PDF
- Get Locations
- Get Lookup Data
- Get P60 certificate PDF
- Get P60 certificates
- Get Pay Slip by Pay Run ID
- Get Payment Summaries
- Get Payment Summary PDF
- Get Personal Details
- Get Roster Shift by ID
- Get Satisfaction Survey Results
- Get Shift Conditions
- Get Shift Notes
- Get Suburb
- Get Super Fund by ID
- Get Tax Codes
- Get Titles
- Get Work Types
- Get unavailability by ID
- List Bank Accounts
- List Leave Requests
- List Pay Slips
- List Roster Shifts
- List Super Funds
- List Timesheets
- List Unavailabilities
- List all Documents
- Mark Shift Notes Read
- Propose Shift Swap
- Recover Forgotten Password
- Register Device Token
- Search Suburbs
- Set Employee Profile Image
- Shifts
- Start Break
- Submit Satisfaction Survey
- Submit or Update Timesheet
- Unregister Device Token
- Update Bank Account
- Update Emergency Contacts
- Update Expense Request
- Update Leave Request
- Update Personal Details
- Update Super Fund
- Update Unavailability
- Upload Attachment to Expense Request
- Upload Attachment to Leave Request
Employee Super Funds
- Summary
- Create Super Fund
- Delete Super Fund
- Get Super Fund by ID
- List Super Funds
- Update Super Fund
Employer Liability Categories
- Summary
- Create Employer Liability Category
- Delete Employer Liability Category
- Get Employer Liability Category
- List Employer Liability Categories
- Update Employer Liability Category
Employing Entities
- Summary
- Create Employing Entity
- Delete Employing Entity
- Get Employing Entity By ID
- List Employing Entities
- Update Employing Entity
Employment Agreement
- Summary
- Bulk Evaluate Shift Costings
- Evaluate Shift Costings
- Get Employment Agreement by ID
- Get Shift Costings for Employee
- Get Shift Periods
- Get Shift Periods for Employee
- List Employment Agreements
Invoices
- Summary
- Get Business Invoice By ID
- Get Business Invoice PDF By ID
- Get Business Invoices
- Get Reseller Invoice By ID
- Get Reseller Invoices
- Get White Label Invoice By ID
- Get White Label Invoice PDF By ID
- Get White Label Invoices
Leave Allowances
- Summary
- Create Leave Allowance Template
- Delete Leave Allowance Template
- Get Leave Allowance Template by ID
- Get Leave Allowances for All Employees
- Get Leave Allowances for Employee
- List Leave Allowance Templates
- Set Leave Allowances
- Update Leave Allowance Template
Leave Categories
- Summary
- Create Leave Category
- Delete Leave Category
- Get Leave Category by ID
- List Leave Categories
- Update Leave Category
Leave Requests
- Summary
- List Leave Requests
Location
- Summary
- Create Location
- Delete Location
- Get Location By Id
- List Business Locations
- List Employee Locations
- Update Location
Lookup Data
- Summary
- List Employee Group Permission Types
- List Report Types
- List Time Zone Types
- List Time Zone Types
- List countries
- List gender options
Manager
- Summary
- Add Note to Shift
- Add an Employee
- Approve Expense Request
- Approve Leave Request
- Approve Timesheet
- Change PIN
- Check Employee
- Clock In Employee
- Clock Out Employee
- Create Leave Request
- Create Unavailability
- Create expense request
- Create kiosk timesheet line
- Create timesheet line
- Decline Expense Request
- Decline Leave Request
- Delete Employee Profile Image
- Delete Expense Request
- Delete Leave Request
- Delete Note from Shift
- Delete Timesheet
- Delete Unavailability
- Discard current shift
- Download Document
- Edit Expense Request
- Edit Timesheet
- End Break
- Estimate Leave Hours
- Find Matching Clock Off Roster Shift
- Find Matching Clock On Roster Shift
- Find Nearby Roster Shifts
- Get Business Expense Requests
- Get Business Timesheets
- Get Business Timesheets
- Get Businesses
- Get Employee Lookup Data
- Get Employee Profile Image
- Get Kiosk by ID
- Get Kiosks
- Get Leave Balances
- Get Leave Request Attachment
- Get Leave Request by ID
- Get List of Employees
- Get List of Locations
- Get Roster Shift by ID
- Get Roster Shifts
- Get Rounding Rules
- Get Shift Notes
- Get expense request
- Get expenses reference data
- Get the list of roles available
- Get timesheet
- Get timesheet reference data
- Initiate Employee Self Service Onboarding
- List Employee Groups
- List Employee Locations
- List Employee Locations
- List Expense Categories
- List Expense Request Employees
- List Expense Request Locations
- List Kiosk Staff
- List Leave Categories
- List Leave Categories
- List Leave Employees
- List Leave Locations
- List Leave Requests
- List Manager Roster Employees
- List Roster Employees
- List Roster Locations
- List Tax Codes
- List Timesheet Employees
- List Timesheet Locations
- Manage Roster Data
- Mark Shift Notes Read
- Overlapping Leave Requests
- Overlapping Leave Requests
- Reject Timesheet
- Send PIN Reset Email
- Send PIN Reset SMS
- Set Employee Profile Image
- Set Rounding Rules
- Shifts
- Start Break
- Stub Shift Timesheets
- Update Leave Request
- Update Unavailability
- Update comments in a timesheet
- Update kiosk timesheet line
- Update timesheet line
- Upload Attachment to Expense Request
- Verify Kiosk PIN
Pay Category
- Summary
- Create Pay Category
- Delete Pay Category
- Get Pay Category by ID
- List Pay Categories
- Update Pay Category
Pay Rate Templates
- Summary
- Create Pay Rate Template
- Delete Pay Rate Template
- Get Pay Rate Template by ID
- List Pay Rate Templates
- Update Pay Rate Template
Pay Run
- Summary
- Create Deductions
- Create Earnings Lines
- Create Employee Expenses
- Create Employer Liabilities
- Create Note for Employee
- Create Pay Run
- Create Pay Run (Async)
- Create Super Adjustments
- Create a withholding or clearance tax adjustment
- Create voluntary CPF contributions
- Delete Deduction
- Delete Earnings Line
- Delete Employee Expense
- Delete Employer Liability
- Delete Leave Accrual
- Delete Note for Employee
- Delete Pay Run
- Delete Pay Run Notation
- Delete Super Adjustment
- Delete a withholding or clearance tax adjustment
- Delete voluntary CPF contribution
- Finalise Pay Run
- Get Creation Status
- Get Deductions by Employee ID
- Get Earnings Lines by Employee ID
- Get Employee Expenses by Employee ID
- Get Employer Liabilities by Employee ID
- Get Giro Bank Payment File
- Get Journal Details
- Get Leave Accruals
- Get Leave Accruals for Employee
- Get Pay Run
- Get Pay Run Totals by Employee ID
- Get Pay Slip Data by Employee ID
- Get Pay Slip File
- Get Super Adjustments by Employee ID
- Get pay run payments
- Get voluntary CPF contributions by Employee ID
- Get withholding and clearance tax adjustments by Employee ID
- Include Employee
- List Deductions
- List Earnings Lines
- List Employee Expenses
- List Employer Liabilities
- List Pay Run Totals
- List Pay Run Totals for Employee
- List Pay Runs
- List Pay Slip Data
- List Super Adjustments
- List voluntary CPF contributions
- List withholding and clearance tax adjustments
- Recalculate
- Remove Employee from Pay Run
- Save Leave Accruals
- Set Pay Run Notation
- Set UI Unlock enabled
- Terminate Employee in Pay Run
- Unlock Pay Run
Pay Run Inclusions
- Summary
- Create Employee Deduction
- Create Employee Expense
- Create Employee Super Adjustment
- Create Employee Tax Adjustment
- Create Employer liability
- Delete Employee Deduction
- Delete Employee Expense
- Delete Employee Super Adjustment
- Delete Employee Tax Adjustment
- Delete Employer liability
- Get Employee Deduction by External Reference Id
- Get Employee Deduction by ID
- Get Employee Expense by ID
- Get Employee Super Adjustment by ID
- Get Employee Tax Adjustment by ID
- Get Employer liability by ID
- List Employee Deductions
- List Employee Deductions By External Reference Id
- List Employee Expenses
- List Employee Super Adjustments
- List Employee Tax Adjustments
- List Employer liabilities
- Update Employee Deduction
- Update Employee Expense
- Update Employee Super Adjustment
- Update Employee Tax Adjustment
- Update Employer liability
Pay Schedules
- Summary
- Create Pay Schedule
- Delete Pay Schedule
- Get Pay Schedule Metadata
- Get Pay Schedule by ID
- List Pay Schedules
- Update Pay Schedule
Payment Summaries
- Summary
- Generate Payment Summaries
- List Payment Summaries
- Publish Payment Summaries
- Unpublish Payment Summaries
Public Holiday
- Summary
- Add a public holiday
- Delete Public Holiday
- Delete Public Holiday by Date
- Get Public Holiday Details
- Get Public Holidays for Year
- Update Public Holiday
Qualifications
- Summary
- Create Qualification
- Delete Qualification
- Get Qualification by ID
- List Qualifications
- Update Qualification
Reporting
- Summary
- Birthday Report
- CPF lodgement report
- Costing Report
- Deductions Report
- Detailed Activity Report
- Employee Details Report
- Employee Details Report
- Employee Payment History Report
- Gross To Net Report
- Journal Report
- Leave Balances Report
- Leave Liability Report
- Pay Categories Report
- Pay Run Inclusions Report
- Roster vs Timesheet Comparison Report
- Timesheet Report
- Withholding Report
Reseller
- Summary
- Get Reseller by ID
- List Resellers
Roster Shifts
- Summary
- Find Matching Clock Off Roster Shift
- Find Matching Clock On Roster Shift
- Find Nearby Roster Shifts
- Get Roster Shifts
- Stub Shift Timesheets
Time and Attendance
- Summary
- Add Complete Shift for Employee
- Add Note to Shift
- Add an Employee
- Change PIN
- Check Employee
- Clock In Employee
- Clock Out Employee
- Create Kiosk
- Delete Kiosk
- Delete Note from Shift
- Discard current shift
- Employee Has Access
- End Break
- Get Employee Lookup Data
- Get Kiosk by ID
- Get Shift Notes
- List Kiosk Staff
- List Kiosks
- Mark Shift Notes Read
- Send PIN Reset Email
- Send PIN Reset SMS
- Shifts
- Start Break
- Update Kiosk
- Verify Kiosk PIN
Timesheets
- Summary
- Bulk Insert Timesheets
- Create timesheet line
- Delete timesheet line
- Get Business Timesheets
- Update timesheet line
- Update/Replace timesheets
Unavailability
- Summary
- Create Unavailability
- Delete Unavailability
- Get unavailability by ID
- List Unavailabilities
- Update Unavailability
User
- Summary
- Create New User
- Get User Details
Webhook
- Summary
- Delete Web Hook Registration
- Delete all Web Hook Registrations
- Get Web Hook Registration by ID
- List Web Hook Registrations
- Register Web Hook
- Test Web Hook
- Update Web Hook Registration
White Label
- Summary
- Active Employees Report
- Get White Label by ID
- List White Labels
- Signup Report
Work Types
- Summary
- Create Work Type
- Delete Work Type
- Get Work Type by ID
- List Work Types
- Update Work Type
OpenAPI specification
- Download

User

Description	HTTP Request
Create New User	POST /api/v2/user
Get User Details	GET /api/v2/user

Powered by DapperDox