Payroll Web Service
MethodPayrollSubmissionOperation
Payroll Web Service > All Operations Resource Group : PayrollSubmissionOperation (Method)
Request (PayrollSubmissionRequest)

The request body is of type PayrollSubmissionRequest.

LineItemIDToDelete Element PaymentValue Element PaymentCode Element Sequence OtherPayments Element EmployeePEPP Element EmployerPEPP Element EmployeeASC Element EmployeeAVC Element EmployeeRAC Element EmployeePRSA Element EmployerPRSA Element EmployeeRBS Element EmployerRBS Element PensionTracingNumber Element NonTaxableLumpSum Element TaxableLumpSum Element TaxableBenefits Element ShareBasedRemuneration Element GrossMedicalInsurance Element LPTDeducted Element USCPaid Element USCStatus Element PayForUSC Element EmployerPRSIPaid Element EmployeePRSIPaid Element InsurableWeeks Element PRSIClass Element Sequence PRSIClassDetail Element PRSIExemptionReason Element PRSIExempt Element PayForEmployerPRSI Element PayForEmployeePRSI Element IncomeTaxPaid Element PayForIncomeTax Element GrossPay Element PayDate Element ExclusionOrder Element IncomeTaxCalculationBasis Element RateCutOff Element Index Element Sequence TaxRate Element TaxCredits Element RPNNumber Element NumberOfPayPeriods Element PayPeriod Element PayFrequency Element ShadowPayroll Element Director Element LeaveDate Element StartDate Element DateOfBirth Element CountryCode Element Eircode Element County Element AddressLine Element Sequence Address Element FamilyName Element FirstName Element Sequence Name Element EmployerReference Element EmploymentID Element EmployeePPSN Element Sequence EmployeeID Element PreviousLineItemID Element LineItemID Element Sequence Payslip Element Version Element Name Element Sequence SoftwareUsed Element TaxYear Element PayrollRunReference Element AgentTain Element EmployerRegistrationNumber Element Sequence Header Element Count Element Index Element Sequence BatchReference Element SubmissionID Element Sequence PayrollSubmissionRequest Element

Overview

PayrollSubmissionRequest
Employer's PAYE Payroll Submission Request.
Sequence
SubmissionID submissionID Simple Type
Data Item Ref: N/A. Unique submission identifier. Must be unique for submissions under a given employer's PAYE registration number. For batch submissions, all submissions should have the same SubmissionID and should have the BatchID and BatchCount populated.
BatchReference optional BatchReference Complex Type
Data Item Ref: N/A. Reference used when batching a submission into mulitple submissions. Current Batch Index and Total Batch Count required.
Sequence
Index xs:unsignedShort
Unique number for a submission in a batch submission. Must be between 1 and the total count of batches that make up the full payroll submission.
Count xs:unsignedShort
Total number of submissions contained in a batch submission.
Header SubmissionHeader Complex Type
Required header level elements for a payroll submission. For batch submission messages, the same header data should be included in each message.
Sequence
EmployerRegistrationNumber employerReg Simple Type
Data Item Ref: 1. Employer's PAYE Registration Number.
AgentTain optional agentTAIN Simple Type
Data Item Ref: 2. Tax Advisor Identification Number. Required if payroll submission is filed by agent on behalf of employer.
PayrollRunReference PayrollRunReference Simple Type
Data Item Ref: 4. Payroll Run Reference. Used to identify the Payroll event that the submission refers to e.g. ‘Site_1_Week_1’.
TaxYear dateYear Simple Type
Data Item Ref: 5. Used to identify the tax year to which the submission relates (YYYY).
SoftwareUsed SoftwareUsed Complex Type
Data Item Refs: 6 and 7. Third party software product identifier.
Sequence
Name defaultString Simple Type
Name of third party software product.
Version defaultString Simple Type
Version of third party software product.
Payslip 0..∞ Payslip Complex Type
List of payslips that make up the employer payroll submission. for Original submissions this should include at least one new payslip. For Correction submissions this should include any new or corrected payslips.
Sequence
LineItemID payrollRunLineItemID Simple Type
Data Item Ref: N/A. Unique reference to line item/s across submissions for a given payroll run. Used to uniquely identify individual line items for correction purposeses.
PreviousLineItemID optional payrollRunLineItemID Simple Type
Data Item Ref: N/A. Used to identify a previous version of this line item when corrections are made. Can only reference line items within the same payroll run.
EmployeeID optional EmployeeID Complex Type
Unique references to an employment for an employee. Includes PPSN and Employment ID.
Sequence
EmployeePPSN EmployeePPSN Simple Type
Data Item Ref: 8. Employee's PPS Number.
EmploymentID employmentID Simple Type
Data Item Ref: 14. Employment ID. Unique identifier for each distinct employment for an employee. To be set by the employer.
EmployerReference optional employerReference Simple Type
Data Item Ref: 13. Employee's internal staff identifier/reference. This will be Mandatory if the PPSN isn’t available and must remain unchanged in all submissions received until the PPSN is available. Optional if PPSN is available.
Name Name Complex Type
Employee Name. Mandatory.
Sequence
FirstName defaultString Simple Type
Data Item Ref: 9. The first name of the employee.
FamilyName defaultString Simple Type
Data Item Ref: 10. The surname/family name of the employee.
Address optional Address Complex Type
Elements required when Employee PPSN is not known.
Sequence
AddressLine 1..3 defaultString Simple Type
Data Item Ref: 11(a)-(c). The address will be Mandatory if the PPSN isn’t available. Line 1 of the employee's address is required.
County optional county Simple Type
Data Item Ref: 11(d). County element of the employee's address.
Eircode optional eircode Simple Type
Data Item Ref: 11(e). Employee's Eircode (if known). Used for Irish addresses only.
CountryCode optional countryCode Simple Type
Data Item Ref: 11(f). Country code element. Codes used at the International Standard for country codes ISO 3166 Alpha-3.
DateOfBirth optional xs:date
Data Item Ref: 12. Employee's Date of Birth - format YYYY-MM-DD . This will be Mandatory if the PPSN isn’t available.
StartDate optional xs:date
Data Item Ref: 15. Employment Start Date. Only include this for the first time you pay a new employee or if there is a correction being made to the StartDate.
LeaveDate optional xs:date
Data Item Ref: 16. Report this date when an employee is leaving (date contract terminates) or if employer ceases trading.
Director optional directorType Simple Type
Data Item Ref: 51. Director marker. Options allowed are Proprietary and NonProprietary.This should be included at start of Employment or if there is any change
ShadowPayroll optional xs:boolean
Data Item Ref: 52. Shadow Payroll Indicator. Set to true for shadow payment.
PayFrequency payFrequency Simple Type
Data Item Ref: 18. Pay Frequency. Options allowed are Weekly, Fortnightly, Monthly, FourWeekly, TwiceMonthly, Quarterly, BiAnnual, WkBasedMonthly, Annual and Other.
PayPeriod optional xs:short
Data Item Ref: 55. Pay Period. Options allowed are 1-53 determined by the payment date and pay frequency. Input options allowed are 1-53 where payment frequency is weekly, 1-27 for fortnightly, 1-24 for twice monthly, 1-12 for monthly, 1-14 for week-based monthly, 1-14 for four-weekly, 1-4 for quarterly, 1-2 for bi-annual, 1 for annual and 1-52 when payment frequency is other. Where an employee is on a week 1 basis, the pay period that would be applied by software were it not for week 1 basis should be reported (required from 2020 onwards).
NumberOfPayPeriods optional xs:short
Data Item Ref: 53. Expected number of pay periods in a full year. Options allowed are 13, 14, 26, 27, 52, 53 and Other. Used to determine whether a week 1 or cumulative RPN should be provided when an employee moves jobs or pay frequencies. (Required for certain pay periods).
RPNNumber optional rpnNumber Simple Type
Data Item Ref: 19. The number of the Revenue Payroll Notification (RPN) used to calculate deductions. This is mandatory when the RPN is used
TaxCredits optional defaultDecimal Simple Type
Data Item Ref: 21. Amount of tax credits available for use in the PAYE calculation. Where the employee is taxed on a cumulative basis, this will be the cumulative amount of tax credits for the pay period. This is mandatory when the RPN is not used.
TaxRate 0..∞ TaxRate Complex Type
Details of Rate Cut Offs. At least one TaxRate (with Index value of 1) is mandatory when the RPN is not used.
Sequence
Index xs:unsignedShort
Data Item Ref: N/A. Index of the tax rate. For example, Index of 1 would refer to tax rate 1.
RateCutOff defaultDecimal Simple Type
Data Item Ref: 20. Amount of Cut Off Point available for use in the PAYE calculation for selected rate. Where the employee is taxed on a week 1 basis, this will be the cut off point for the pay period. If the employee is taxed on the cumulative basis, this will be the cumulative cut off point for the pay period. This is mandatory when the RPN is not used.
IncomeTaxCalculationBasis optional IncomeTaxCalculationBasis Simple Type
Data Item Ref: 22. PAYE calculation basis used in the submission. Options allowed are Cumulative, Week1 and Emergency. This is mandatory when the RPN is not used.
ExclusionOrder optional xs:boolean
Data Item Ref: 23. This indicates that the Employer does not have to deduct Income Tax for the Employee. This will be either ‘True’ or ‘False’. Set to “true” if an exclusion order is on file for the employee.
PayDate xs:date
Data Item Ref: 17. Date Employee is being paid (YYYY-MM-DD ).
GrossPay defaultDecimal Simple Type
Data Item Ref: 24. Employee Gross Pay. Gross pay is the employee’s pay of any kind, including notional pay and share based remuneration and, before any pension contributions or salary sacrifice deductions are made.
PayForIncomeTax defaultDecimal Simple Type
Data Item Ref: 25. Pay for Income Tax. Gross pay reduced by allowable superannuation contributions, income continuance contributions, relevant reliefs such as SARP and approved salary sacrifice. Euro and Cent required.
IncomeTaxPaid defaultDecimal Simple Type
Data Item Ref: 26. Employee Tax deducted or refunded in this employment. Negative if tax refunded. Euro and Cent required.
PayForEmployeePRSI defaultDecimal Simple Type
Data Item Ref: 27. Pay subject to employee PRSI. Euro and Cent required.
PayForEmployerPRSI defaultDecimal Simple Type
Data Item Ref: 28. Pay subject to employer PRSI. Euro and Cent required.
PRSIExempt xs:boolean
Data Item Ref: 29. This field allows for the filing of returns for employees who are exempt from paying PRSI in Ireland. This will be either ‘true’ or ‘false’. 'True' if employee is exempt from paying PRSI in Ireland.
PRSIExemptionReason optional prsiExemptionReason Simple Type
Data Item Ref: 30. Reason for the PRSI Exemption in Ireland. This is Mandatory if PRSI exempt. Options include A1PortableDocument (A1 Portable Document from EU Member State), CertificateOfCoverage (Certificate of coverage under Social Security Bilateral Agreement), PostedWorkerOtherNotification (Other notification of exemption for posted workers), FamilyMember (Employment of certain family members), Under16 (Under 16 years of age), SocialWelfareScheme (Employment on certain social welfare schemes), Other.
PRSIClassDetail 0..∞ PRSIClassDetail Complex Type
PRSI Class, subclass and Insurable weeks detail.
Sequence
PRSIClass prsiClass Simple Type
Data Item Ref: 31. PRSI Class and Subclass. Weeks required where class is provided. This is Mandatory if not PRSI exempt.
InsurableWeeks xs:short
Data Item Ref: 32. Number of insurable weeks for each PRSI class accrued in this pay period. This is Mandatory if not PRSI exempt.
EmployeePRSIPaid optional defaultDecimal Simple Type
Data Item Ref: 33. Employee PRSI deducted. This is Mandatory if not PRSI exempt.
EmployerPRSIPaid optional defaultDecimal Simple Type
Data Item Ref: 34. Employer PRSI Paid. This is Mandatory if not PRSI exempt.
PayForUSC defaultDecimal Simple Type
Data Item Ref: 35. Pay for USC. Includes notional pay and all Superannuation and Income Continuance Scheme Contributions. Excludes DSP payments, Illness Benefit and payments of a similar nature under certain approved schemes.
USCStatus uscStatus Simple Type
Data Item Ref: 36. USC Status. Allowed values are Ordinary and Exempt.
USCPaid optional defaultDecimal Simple Type
Data Item Ref: 37. USC deducted or refunded in this employment. Negative if USC refunded. Required if USC Status is Ordinary.
LPTDeducted optional defaultDecimal Simple Type
Data Item Ref: 50. LPT Deducted. Local Property Tax amount paid. This is mandatory if applicable.
GrossMedicalInsurance optional defaultDecimal Simple Type
Data Item Ref: 38. Gross Medical Insurance paid by Employer for the Employee. This is mandatory if applicable.
ShareBasedRemuneration optional defaultDecimal Simple Type
Data Item Ref: 46. This is share-based remuneration consisting of shares in the employer company or a company that controls the employer company that is included in ‘Gross Pay’.
TaxableBenefits optional defaultDecimal Simple Type
Data Item Ref: 47. Taxable value of benefits provided to the employee. This is the amount of non-cash benefits (for example, private use of a company car, free or subsidised accommodation, preferential loans), other than company Share-based Remuneration (but including shares in companies that are not the employer company or a company that controls the employer company), that is included in ‘Gross Pay’. This is mandatory if applicable.
TaxableLumpSum optional defaultDecimal Simple Type
Data Item Ref: 48. Amount of taxable lump sum payment included in ‘Pay for Income Tax’. This is mandatory if applicable.
NonTaxableLumpSum optional defaultDecimal Simple Type
Data Item Ref: 49. Amount of lump sum payment not included in ‘Pay for Income Tax’, excluding statutory redundancy payments. This is mandatory if applicable.
PensionTracingNumber 0..∞ pensionTracingNumber Simple Type
Data Item Ref: 39. Pension Tracing Number. The format of the pension tracing number is “PBXXXXXX”, where XXXXXX is a number with up to 6 digits. E.g. PB123456. This is mandatory if applicable. Should only be provided when the Employee joins a pension or changes pension.
EmployerRBS optional defaultDecimal Simple Type
Data Item Ref: 40. Amount contributed by employer to Retirement Benefit Scheme.
EmployeeRBS optional defaultDecimal Simple Type
Data Item Ref: 41. Amount contributed by employee to Retirement Benefit Scheme.
EmployerPRSA optional defaultDecimal Simple Type
Data Item Ref: 42. Amount contributed by employer to Personal Retirement Savings Accounts (PRSA) scheme.
EmployeePRSA optional defaultDecimal Simple Type
Data Item Ref: 43. Amount contributed by employee to Personal Retirement Savings Accounts (PRSA) scheme.
EmployeeRAC optional defaultDecimal Simple Type
Data Item Ref: 44. Amount contributed by employee to Retirement Annuity Contracts (RAC) scheme.
EmployeeAVC optional defaultDecimal Simple Type
Data Item Ref: 45. Amount contributed by employee to Additional Voluntary Contributions (AVC) scheme.
EmployeeASC optional defaultDecimal Simple Type
Data Item Ref: 54. Amount contributed by employee to Additional Superannuation Contribution (ASC) scheme.
EmployerPEPP optional defaultDecimal Simple Type
Data Item Ref: 59. Amount contributed by employer to Pan-European Personal Pension Product (PEPP) scheme.
EmployeePEPP optional defaultDecimal Simple Type
Data Item Ref: 60. Amount contributed by employee to Pan-European Personal Pension Product (PEPP) scheme.
OtherPayments 0..∞ OtherPayments Complex Type
Other payments, payment code and payment value.
Sequence
PaymentCode paymentCode Simple Type
Data Item Ref: 57. Description of other payment. Options allowed are COVID19, EWSS, EWSS_PHR, CODE_1, CODE_2, CODE_3, CODE_4 and CODE_5
PaymentValue defaultDecimal Simple Type
paymentValue: Data Item Ref: 58. Payment amount.
LineItemIDToDelete 0..∞ payrollRunLineItemID Simple Type
For Correction submissions, this should include any line item IDs across the payroll run to be deleted.
200 Response (PayrollSubmissionResponse)

The response body is of type PayrollSubmissionResponse.

Description Element Path Element Code Element Sequence ValidationWarning Element Description Element Path Element Code Element Sequence ValidationError Element AcknowledgementID Element AcknowledgementStatus Element Sequence PayrollSubmissionResponse Element

Overview

PayrollSubmissionResponse
Acknowledges the receipt of an Employer's PAYE Payroll Submission Request, or Validation Errors if validation failed.
Sequence
AcknowledgementStatus acknowledgementStatus Simple Type
Acknowledgement status for Employer's PAYE Payroll Submission Request. Possible values are Acknowledged or Rejected.
AcknowledgementID optional acknowledgementID Simple Type
Unique ID for acknowledged requests - to be used for technical support if required.
ValidationError 0..∞ Error Complex Type
List of Submission Validation Errors (if any).
Sequence
Code errorCode Simple Type
Technical Error Code - to be used for mapping to error messages.
Path optional errorPath Simple Type
Path to error in schema, if available.
Description errorDescription Simple Type
Technical description of error.
ValidationWarning 0..∞ Warning Complex Type
List of Submission Validation Warnings (if any).
Sequence
Code warningCode Simple Type
Technical Code for warning - to be used for mapping to warning messages.
Path optional warningPath Simple Type
Path to warning in schema, if available.
Description warningDescription Simple Type
Technical description of warning.
Example
<?xml version="1.0" encoding="UTF-8"?>
<!--Document History:
======== Version 0.9 ====================================
i. Document Created 30/06/2017
======== Version 0.10 ====================================
ii. Document updated on 07/09/2017: 
        Renamed the element: “Class" (type="pc:prsiClass") to “PRSIClass”
        Revenue Payroll Instruction changed to Revenue Payroll Notification and RPI changed to RPN
======== Version 1.0 Milestone 1 ====================================
iii. Document updated on 17/11/2017: 
        Renamed the element: "RunReference" to "PayrollRunReference"
        Renamed the element: "PPSN" to "EmployeePPSN"
        Renamed the element: "calculationBasis" to "IncomeTaxCalculationBasis"
        Removed the element: "SubmissionType" 
======== Version 1.0 Milestone 2 ====================================
iv. Document updated on 09/02/2018:
        Dates re-formatted
======== Version 1.0 Release Candidate 2 ===========
v. Document updated on 24/05/2018
     Updated ENUM Values to reflect schematic changes
-->
<pay:PayrollSubmissionRequest xmlns:pay="http://www.ros.ie/schemas/paye-employers/v1/payroll/" xmlns="http://www.ros.ie/schemas/paye-employers/v1/payroll/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.ros.ie/schemas/paye-employers/v1/payroll/payroll-schema.xsd">
    <pay:SubmissionID>01</pay:SubmissionID>
    <pay:Header>
        <pay:EmployerRegistrationNumber>3980609P</pay:EmployerRegistrationNumber>
        <pay:PayrollRunReference>00001</pay:PayrollRunReference>
        <pay:TaxYear>2019</pay:TaxYear>
        <pay:SoftwareUsed>
            <pay:Name>The Software</pay:Name>
            <pay:Version>Version 10.0</pay:Version>
        </pay:SoftwareUsed>
    </pay:Header>
    <pay:Payslip>
        <pay:LineItemID>E1-v1</pay:LineItemID>
        <pay:EmployeeID>
            <pay:EmployeePPSN>00000008P</pay:EmployeePPSN>
            <pay:EmploymentID>1</pay:EmploymentID>
        </pay:EmployeeID>
        <pay:Name>
            <pay:FirstName>Ann</pay:FirstName>
            <pay:FamilyName>Doe</pay:FamilyName>
        </pay:Name>
        <pay:PayFrequency>WEEKLY</pay:PayFrequency>
        <pay:PayPeriod>5</pay:PayPeriod>
        <pay:RPNNumber>5</pay:RPNNumber>
        <pay:TaxCredits>63.46</pay:TaxCredits>
        <pay:TaxRate>
            <pay:Index>1</pay:Index>
            <pay:RateCutOff>650</pay:RateCutOff>
        </pay:TaxRate>
        <pay:IncomeTaxCalculationBasis>CUMULATIVE</pay:IncomeTaxCalculationBasis>
        <pay:PayDate>2019-02-01</pay:PayDate>
        <pay:GrossPay>307.50</pay:GrossPay>
        <pay:PayForIncomeTax>307.50</pay:PayForIncomeTax>
        <pay:IncomeTaxPaid>0.00</pay:IncomeTaxPaid>
        <pay:PayForEmployeePRSI>307.50</pay:PayForEmployeePRSI>
        <pay:PayForEmployerPRSI>307.50</pay:PayForEmployerPRSI>
        <pay:PRSIExempt>false</pay:PRSIExempt>
        <pay:PRSIClassDetail>
            <pay:PRSIClass>A0</pay:PRSIClass>
            <pay:InsurableWeeks>5</pay:InsurableWeeks>
        </pay:PRSIClassDetail>
        <pay:EmployeePRSIPaid>0.00</pay:EmployeePRSIPaid>
        <pay:EmployerPRSIPaid>33.06</pay:EmployerPRSIPaid>
        <pay:PayForUSC>307.50</pay:PayForUSC>
        <pay:USCStatus>ORDINARY</pay:USCStatus>
        <pay:USCPaid>3.07</pay:USCPaid>
        <pay:LPTDeducted>3.67</pay:LPTDeducted>
    </pay:Payslip>
</pay:PayrollSubmissionRequest>
<?xml version="1.0" encoding="UTF-8"?>
<!--Document History:
======== Version 0.9 ====================================
i. Document Created 30/06/2017
======== Version 1.0 Milestone 1 ====================================
iii. Document updated on 17/11/2017: 
        Renamed the element: "RunReference" to "PayrollRunReference"
        Removed the element: "SubmissionType"
======== Version 1.0 Release Candidate 2 ===========
v. Document updated on 24/05/2018
     Updated ENUM Values to reflect schematic changes
-->
<pay:CheckPayrollSubmissionResponse xmlns:pay="http://www.ros.ie/schemas/paye-employers/v1/payroll/" xmlns="http://www.ros.ie/schemas/paye-employers/v1/payroll/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.ros.ie/schemas/paye-employers/v1/payroll/payroll-schema.xsd">
    <pay:SubmissionID>05</pay:SubmissionID>
    <pay:Status>COMPLETED</pay:Status>
    <pay:BatchCount>6</pay:BatchCount>
    <pay:BatchStatus>
        <pay:Index>1</pay:Index>
        <pay:Status>COMPLETED</pay:Status>
    </pay:BatchStatus>
    <pay:SubmissionHeader>
        <pay:EmployerRegistrationNumber>4587256A</pay:EmployerRegistrationNumber>
        <pay:PayrollRunReference>0000001</pay:PayrollRunReference>
        <pay:TaxYear>2019</pay:TaxYear>
        <pay:SoftwareUsed>
            <pay:Name>The Software</pay:Name>
            <pay:Version>Version10.0</pay:Version>
        </pay:SoftwareUsed>
    </pay:SubmissionHeader>
    <pay:SubmissionSummary>
        <pay:TaxOnIncome>1334.48</pay:TaxOnIncome>
        <pay:PRSI>1535.55</pay:PRSI>
        <pay:USC>333.94</pay:USC>
        <pay:LPT>48.75</pay:LPT>
        <pay:PayslipCount>6</pay:PayslipCount>
        <pay:PayslipToDeleteCount>0</pay:PayslipToDeleteCount>
    </pay:SubmissionSummary>
</pay:CheckPayrollSubmissionResponse>
See Also
All Operations Resource Group | Payroll Web Service

Please register for our PIT Support Help Desk for the following: