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 set-up 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 set-up issue Gateway Solution Setup
4	Unauthorised delegation	Access is not permitted for the requester to perform this operation for the submitted identifier. Usually a set-up issue outside of the PayGlobal application, refer to your company's myIR Account
5	Unauthorised vendor	The vendor provided is not authorised to use these suite of services. Usually a set-up issue outside of the PayGlobal application, refer to your company's myIR Account
7	Account type not supported	Usually a set-up issue outside of the PayGlobal application, refer to your company's 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	No valid filing obligations were found. This could be completely acceptable if they were not expecting to have any filing obligations.
106	Operation not available for major form type	This is schematic check. PayGlobal customers are unlikely to receive this message. Please contact PayGlobal Customer Support if you do.
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.
140	Invalid minor for type	This is schematic check. PayGlobal customers are unlikely to receive this message. Please contact PayGlobal Customer Support if you do.
145	Return held for processing	The return is not visible because it is in a non-amendable error. These submissions will be marked in a non-sending able error state. See Discharge Obligations

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
131	Duplicate line items	There are two or more line items with the same referenceID (i.e Employee and tax code) in the same submission. PayGlobal customers should not get this error. If this error occurs could be sign of corrupted data within your database. It is recommended to contact PayGlobal Support immediately.
132	Reverse/replace can only be used for an amendment	PayGlobal does not support the Payday Amendment service. Therefore no customers should ever receive this error.
134	Invalid employee IRD number	This error may only occur if you are adding IRD numbers into PayGlobal via any means except directly via the Employee record UI. If you are bringing IRD numbers into PayGlobal via the API, currently you need to validate employee's IRD and Tax Codes manually via the employee record. It is recommended to setup a grid report on the Employee table that has at least the following column on it to help you find any employees that may trigger this error before you process your pays and attempt to submit the corresponding EI submission: Is Onboarding to PayGlobal (Employee.IsOnboarding)
136	Nil return not indicated despite missing line items	PayGlobal customers should not get this error. If the submission was a genuine nil return, i.e. you processed and closed a pay that had NO reportable employees in it, then the submission should always report ‘isNilReturn’ is 'true'. If the submission was not a genuine nil return and you get this error please contact PayGlobal Support.
137	ReferenceId is required for all line items	PayGlobal customers should not get this error. The ReferenceId is the PayGlobal Employee code and Tax Code. If you get this error please contact PayGlobal Support
160	Duplicate payday submission	A payday submission has already been submitted for the same account, period, paydate, and request payload in the last hour. This error is may only occur in the following circumstances: Two users simultaneously accessing the Payday Manager Tool at the same time. One user sends a pay, the other user has not had a chance to refresh their screen and sees the the pay same pay is still sendable. A user has chosen to send the pay via FileUpload. Unless a submission is sent via the Gateway, IRD can't inform PayGlobal. This is a limitation of the IRD's payday filing service given they allow employers to use 3 methods of getting EI data to them interchangeably.
161	Payday date not in filing period	Payday date is not in the same month as the filing period (e.g. payday date 31/03/2019 and filing period 30/04/2019). You need to login to your company MyIR account and ensure you have the correct filing periods open. Or, you need to check the dates of the pay you have just closed are correct, if those are incorrect you will need to roll-back the pay and correct your linked accumlator records (typically the PTD and TTD) and potentially also check the actual Payment date is correct too.
162	Period has non-payday return	The return filing period already has an EMS / IR348 filed. As a Gateway filer, this would only happen if someone had generated an EI File and uploaded it manually. Or someone has logged directly into the company MyIR account and manually entered the details for the period. As per error code 160, unless a submission is sent via the Gateway, IRD can't inform PayGlobal of any updates to a particular pay period.
163	Pay period end date before pay period start	PayGlobal customers should not get these errors if you create your Pay period calendars using our Period Calendar Creation Tool or if you attempt to add/edit any of the accumulator records (PTD, TTD, YTD etc). The system will prevent end date before start date set-ups from being allowed. However, if you are using other methods to set-up your calendars then those validations won't be actioned on import/SQL updates therefore you may need to check your calendar set-ups. Please content PayGlobal Support if you require assistance.
164	Period to far in the future	Requested filing period is too far into the future and unavailable for filing at this time (maximum two months in advance). It would be very uncommon for any employer to be in a position whereby it was 100% known exactly what they needed to pay their employees that far in advance.
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.