KeyPay API Reference

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

Reseller

Description	HTTP Request
List Resellers	GET /api/v2/reseller
Get Reseller by ID	GET /api/v2/reseller/{id}

Powered by DapperDox