Payday filing through our gateway service lets employers send us:
- employment information each pay cycle using the return service (employment information forms)
- new and departing employee information as needed using the employment service.
From 1 April 2021, we'll require all employers to use payday filing version 2.
Gateway service capability for employment information
The gateway service used for employment information is the return service. It provides the following capabilities through defined service operations:
|File||Lets employers submit employment information for a specific pay cycle and change employee details.|
|Prepop||Not applicable for payday filing.|
|Retrieve Status||Provides the processing status of previously submitted employment information for a specific pay cycle.|
|Retrieve Return||Provides a copy of previously submitted employment information for a specific pay cycle.|
|Retrieve Filing Obligation||Not applicable for payday filing.|
Gateway service capability for employee details
The gateway service used for employee details is the employment service. It provides the following capabilities through defined service operations:
|Create||Lets information for a new employee be submitted to us.|
|Update||Lets information for an existing employee be submitted, for example a KS10.|
|RetrieveList||Provides employee details previously submitted for an employee or all employees (depending on what has been requested).|
|Terminate||Lets an employer submit information about a departing employee.|
Payday filing business use cases
The following are examples of show sequences that can be used to achieve a specific business outcome for payday filing when calling the service operations through our gateway services.
- Employment service operations: C = Create, U = Update, RL = Retrieve List, T = Terminate
- Return service operations: F = File, RS = Retrieve Status, RR = Retrieve Return
- The numbers for each use case are the order in which these operations should be called when using these services.
|Use case||Employment service operation||Return service operation|
|1. Create employee details for employer||1|
|2. Update employee details||1|
|3. Submit departing employee details||1|
|4. Retrieve and update employee details
(*if resubmission is required)
|5. File payday return||1|
|6. Update previously submitted payday return||1|
|7. Check payday return status||2*||1|
|8. Retrieve payday return||1|
Please choose a Download
View and download the payday filing software developer kits.