ROS Payroll Reporting Message Guide

ROS_Payroll_Reporting_Message_guide

User Manual: Pdf

Open the PDF directly: View PDF PDF.
Page Count: 6

PAYE Modernisation
ROS Payroll Reporting Message Guide
2
Message Guide
Contents
Latest Version History .................................................................................................................. 3
Audience ......................................................................................................................................... 3
Document Context .......................................................................................................................... 3
Document References .................................................................................................................. 4
1. Introduction ......................................................................................................................... 4
2. JSON Messages ..................................................................................................................... 5
3. XML Messages ...................................................................................................................... 6
4. Schemas ............................................................................................................................... 6
5. Digital Signature................................................................................................................... 6
JSON Message – Data Items ................................................................................................................... 5
3
Message Guide
Document Version
1.0 Release Candidate 2
Version Date
17/05/2018
Latest Version History
Version
Section
Change Description
1.0
All
Document published.
1.0 Release
Candidate
2
Version updated to 1.0 Release
Candidate 2
Audience
This document is for any software provider who has chosen to build or update their products to
allow for PAYE Modernisation and intend to submit/ or request data via ROS Payroll Reporting
screens.
Document Context
This document provides a technical overview of how to create request messages for submission to
the Revenue’s PAYE Modernisation Services from the ROS Payroll Reporting screens.
This document is intended to be read in conjunction with schema definitions and example files as
well as the rest of the Revenue’s PAYE Modernisation technical documentation.
4
Message Guide
Document References
Reference
Document Link
1. Documents Homepage
https://revenue-ie.github.io/paye-employers-documentation/
1. Introduction
This document is a guide on to how to create messages for submission to the PAYE Modernisation
Payroll and RPN services via Revenue’s Payroll Reporting screens.
5
Message Guide
2. JSON Messages
A JSON envelope schema has been defined which will facilitate using JSON message format for file
upload on the ROS Payroll Reporting screens to complete the following actions:
Look up RPNs for existing employees
Create RPNs for new employees
Make a payroll submission
This JSON envelope schema is required as takes in data items for these services which are provided
as part of the URL if the service is invoked from the REST API.
JSON Message – Data Items
Name
Description
Applicable Message
Request type
Specifies the service to be called. Supported values :
"lookupRPN", "createRPN", "payrollSubmission"
All
Employer
Registration
Number
The registration of the employer (up to 9 chars).
Must be valid Employer Registered number. Format
is 7 digits (including leading zeros) followed by either
1 or 2 letters
All
Tax Year
Tax Year to which the submission or request relates
All
Date Last
Updated
Date to lookup for RPNs updated on or since
Look up RPN
Software Used
References to third party software used to make
RPN request / payroll submission
All
Software Version
Version of software used to make request RPN
request/ submission
All
Agent TAIN
Used to identify the agent submitting on behalf of
the employer and to ensure that an agent link exists
for this employer agent relationship for the period
that the payroll submission relates to.
To be included if the
RPN request or
Payroll submission
is being performed
by an agent on
behalf of an
Employer
Payroll Run
Reference
Used to identify the Payroll event that the
submission refers to e.g. ‘Site 1 Week 1’.
Payroll Submission
Submission ID
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.
Payroll Submission
Employee IDs
Employee's PPS Number and Employee's
Employment ID(Unique identifier for each distinct
employment for an employee) are joined using a
hyphen (eg.'1234567T-1').
Look up RPN – To
be included if
request is for
specific Employees
Request Body
For Payroll submissions, this contains the Employee
level details. For Create RPNs (NewRPN), this
Payroll Submission,
Create RPN
6
Message Guide
contains the Employee level details.
(NewRPN)
3. XML Messages
There is no requirement for an XML envelope schema as the schemas defined for PAYE
Modernisation web services can also be used to create messages for upload through the ROS Payroll
Reporting screens. The following XML messages are supported through the ROS Payroll Reporting
screens:
Look up RPNs for existing employees
Create RPNs for new employees
Make a payroll submission
4. Schemas
Reference
Document Link
JSON Envelope Schema
https://revenue-ie.github.io/paye-employers-
documentation//Screens/ROS_Payroll_Reporting_JSON_Envelope_schema.json
JSON Create RPN
(Request body)
https://revenue-ie.github.io/paye-employers-documentation/rest/paye-
employers-rest-api.json
JSON Payroll Submission
(Request body)
https://revenue-ie.github.io/paye-employers-documentation/rest/paye-
employers-rest-api.json
XML Look up RPNs
https://revenue-ie.github.io/paye-employers-documentation/soap/v1/rpn/rpn-
schema.xsd
XML Create RPNs for
new employees (New
RPNs)
https://revenue-ie.github.io/paye-employers-documentation/soap/v1/rpn/rpn-
schema.xsd
XML Payroll submission
https://revenue-ie.github.io/paye-employers-
documentation/soap/v1/payroll/payroll-schema.xsd
5. Digital Signature
Messages uploaded through the ROS Payroll Reporting screens do not need to be digitally signed
prior to the upload. The ROS Payroll Reporting screens will perform the digital signing as part of the
upload process.

Navigation menu