Gateway - IR Error Messages

Overview

To stop the pay data for the pay sequence from being submitted to IR via the Gateway solution - see Payday Reporting Manager - Discharge Obligation.

IR Errors

IRD provide the following link to assist employers who use the MyIR app to address any errors with their Payday data - https://www.ird.govt.nz/employing-staff/payday-filing/filing-employment-information-electronically/myir-error-information-and-help.

The only problem with the IRD page is that it doesn't give you their IR Error code only the description. The tables below show the IR error codes that IRD cater for.

Generic Gateway security response codes

The following response codes are common to all Gateway Service calls. These errors your security validation set

IRD Code	Standard Message	Details
-1	An unknown error has occurred
0		0 indicates a successful web service call. Note: 0 does not display a standard message
1	Authentication failure	Authentication failure means the token provided is not a valid token. Usually setup issue - refer to checklist in Gateway Solution Setup
2	Authentication failure means the token provided is not a valid token	No oAuth token in HTTP header. Usually setup issue Gateway Solution Setup
4	Unauthorised delegation	Access is not permitted for the requester to perform this operation for the submitted identifier. Usually setup issue refer to myIR Account
5	Unauthorised vendor	The vendor provided is not authorised to use these suite of services. Usually a setup issue refer to myIR Account
7	Account type not supported	Usually a setup issue refer to myIR Account

Generic Gateway Return response codes

The following response codes are most of the specific to Return Gateway calls and usually indicate an issue with Pay/filing period you are submitting

IRD Code	Standard Message	Details
100	Invalid request data	Could not extract data from XML payload. If this occurs contact PayGlobal Customer Support for further assistance.
101	Unable to file return	An error has occurred while filing return. This may be due to invalid information in the specific return form fields. There is likely to be more than one error for the submission, you may need to review other errors to understand the cause. Otherwise contact PayGlobal Customer Support for further assistance
102	ID/Account type not valid	The account type / ID submitted does not exist.
103	No return found	No return exists on the selected filing period. This error should only occur for PayGlobal customers if there has been a problem caused due to a need to do a DB restore.
104	Invalid filing period	Filing period does not exist. You need to login to MyIR and ensure you have your filing periods open.
105	No filing obligations found
106	Operation not available for major form type
107	Duplicate return	There is already a return for this period/paydate (for EI). Most likely another user has submitted the EI via FileUpload or do it manually via MyIR. Unlikely but still possible, is two users both pressing Send on the same submission at the same time.
108	Return locked for processing	Return locked for processing―try again later. If still locked after an hour, contact PayGlobal Customer Support.
109	Invalid Amend Reason	PayGlobal customer WONT get this error because PayGlobal/MYOB does not support the IR Payday Amendment Service.

Employment Information-specific response codes

The following are some of the response codes are specific to EI Return Service calls:

IRD Code	Standard Message	Details
175	Invalid request data	familyTaxCredits can only be used by Ministry of Social Development (MSD). This error is not applicable to any PAYROLL solution. PayGlobal customers will not get this error.
176	taxCreditPayrollDonations cannot exceed payeSchedularTaxDeductions	PayGlobal customers should not get these errors. Depending on the circumstances, to prevent the errors from occurring the offending Deduction transaction(s) either has the Total amount reduced from its original amount or no amount is deducted at all. The Process pay audit log gives a warning advising what happened and instruction to check the amounts
177	Sum of payeSchedularTaxDeductions, kiwisaverDeductions, studentLoansDeductions, slcirDeductions, slborDeductions and childSupportDeductions cannot exceed the sum of grossEarnings and essEarnings
178	earningsNotLiableACC cannot exceed grossEarnings and essEarnings
179	Employees not allowed kiwisaverDeductions or kiwisaverEmployerContributions on WT tax code	PayGlobal customers should not get this error from v4.74 onwards, as process pay checks the employee's tax code (WT) and looks for KiwiSaver contributions and will provide warnings when added/editing transactions. The pay will also fail to process, therefore you won't be able to create EI file in the first place until you fix your data.