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

Powered by DapperDox