ROS Payroll Reporting Message Guide
ROS_Payroll_Reporting_Message_guide
User Manual: Pdf
Open the PDF directly: View PDF 
.
Page Count: 6
| Download | |
| Open PDF In Browser | View PDF |
PAYE Modernisation ROS Payroll Reporting Message Guide Message Guide Contents Latest Version History .................................................................................................................. 3 Audience ......................................................................................................................................... 3 Document Context .......................................................................................................................... 3 Document References .................................................................................................................. 4 1. Introduction ......................................................................................................................... 4 2. JSON Messages..................................................................................................................... 5 JSON Message – Data Items ................................................................................................................... 5 3. XML Messages...................................................................................................................... 6 4. Schemas ............................................................................................................................... 6 5. Digital Signature................................................................................................................... 6 2 Message Guide Document Version 1.0 Release Candidate 2 Version Date 17/05/2018 Latest Version History Version 1.0 1.0 Release Candidate 2 Change Date Section All Change Description Document published. Version updated to 1.0 Release Candidate 2 17/05/2018 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. 3 Message Guide Document References Reference 1. Documents Homepage Document Link 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. 4 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 Request type Employer Registration Number Tax Year Date Last Updated Software Used Software Version Agent TAIN Payroll Run Reference Submission ID Employee IDs Request Body Description Specifies the service to be called. Supported values : "lookupRPN", "createRPN", "payrollSubmission" Applicable Message All 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 Tax Year to which the submission or request relates Date to lookup for RPNs updated on or since All References to third party software used to make RPN request / payroll submission Version of software used to make request RPN request/ submission 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. All Used to identify the Payroll event that the submission refers to e.g. ‘Site 1 Week 1’. 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. 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'). For Payroll submissions, this contains the Employee level details. For Create RPNs (NewRPN), this 5 All Look up RPN All To be included if the RPN request or Payroll submission is being performed by an agent on behalf of an Employer Payroll Submission Payroll Submission Look up RPN – To be included if request is for specific Employees Payroll Submission, Create RPN 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 JSON Envelope Schema JSON Create RPN (Request body) JSON Payroll Submission (Request body) Document Link https://revenue-ie.github.io/paye-employersdocumentation//Screens/ROS_Payroll_Reporting_JSON_Envelope_schema.json https://revenue-ie.github.io/paye-employers-documentation/rest/payeemployers-rest-api.json https://revenue-ie.github.io/paye-employers-documentation/rest/payeemployers-rest-api.json XML Look up RPNs https://revenue-ie.github.io/paye-employers-documentation/soap/v1/rpn/rpnschema.xsd XML Create RPNs for new employees (New RPNs) XML Payroll submission https://revenue-ie.github.io/paye-employers-documentation/soap/v1/rpn/rpnschema.xsd https://revenue-ie.github.io/paye-employersdocumentation/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. 6
Source Exif Data:
File Type : PDF File Type Extension : pdf MIME Type : application/pdf PDF Version : 1.5 Linearized : No Page Count : 6 Language : en-IE Tagged PDF : Yes Producer : Microsoft® Word 2010 Creator : Microsoft® Word 2010 Create Date : 2018:05:15 17:37:40+01:00 Modify Date : 2018:05:15 17:37:40+01:00EXIF Metadata provided by EXIF.tools