[Feature Request] UK PAYE Real Time Information (RTI)

[nameduser0]

Pledge your support for this project here!

This integration will allow ERPNext to be published as HMRC Recognised Software on their website.

Pre-requisites

SOAP library XML support Company and Employee identifier doctype such as the Registration doctype (see below)

Feature Goals (Use cases & Requirements)

This is a proposal for integration of ERPNext HR payroll with the UK tax office to issue realtime payroll information. Support for:

• HMRC Transaction Engine: Document Submission Protocol (GovTalk 2.0 XML) - RTI submissions
  • Full Payment Submission (FPS) - employee payments including statutory (sick, maternity, etc)
  • Employer Payment Summary (EPS) - final submission for a tax year, no FPS due, statutory payments received (maternity, etc), CIS
  • NINO Verification Request (NVR) - request or verify a NINO for new employees
  • Earlier Year Update (EYU) - Correct a previous tax year FPS
  • IRmark (submission signature)
• HMRC Data Provisioning Service API (SOAP XML) - HMRC notifications
  • RTI Notification messages
  • Generic Notification messages

Authentication is achieved using Online Services Username and Password (Government Gateway ID and password)

ERPNext considerations:

• Processing will be server-side due to unattended HMRC service polling

• RTI FPS submission should be added as a button to HR -> Payroll Entry & Salary Slip. RTI is submitted per person, so must use values from individual Salary Slips. However, if initiated from a Payroll Entry, the whole batch of Salary Slips can be included in one FPS submission

• Submissions and Responses will be logged and tracked in the Activity Log to save creating other doctypes:

  • FPS:
    • Name: CorrelationID
    • Subject: HMRC Submission - RTI FPS by GovTalk XML
    • Content: Submission and Response(s) (only the GovTalkDetails & Body blocks)
    • Status: Linked (submitted), Success (responded), Failed (completed with error), Closed (completed with successful response and deleted from HMRC)
    • Reference Document Type: Payroll Entry or Salary Slip
    • Reference Name:
  • EPS, as FPS except:
    • Subject: HMRC Submission - RTI EPS by GovTalk XML
    • Reference Document Type: Company
    • Reference Name: Company ID
  • EYU, as FPS except:
    • Subject: HMRC Submission - RTI EYU by GovTalk XML
    • Reference Document Type: Activity Log
    • Reference Name: Activity Log ID
  • NVR, as FPS except:
    • Subject: HMRC Submission - RTI NVR by GovTalk XML
    • Reference Document Type: Employee
    • Reference Name: Employee ID

• EYU will take a previous FPS from the Activity Log and allow the user to amend it for a new submission

• Submission success and failure will both be notified to the user using the ERPNext notification system

• Requires further work to determine if pages can be created that do not relate directly to a doctype, for example with a Report or Custom Form

• HMRC notifications should be saved as Notification Logs (top-right bell) built in to ERPNext

  • Name = Type:Index, e.g. RTI:62346 (Types: P6, P9, SL1, SL2, PGL1, PGL2, AR, NOT, RTI, CIS)
  • Subject = HMRC DPS Notification + subject from message
  • Document Type should be different for each message type. This is because users can be subscribed to different Document messages using native functionality:
    • RTI messages = Payroll Entry/Salary Slip
    • Generic = Company
  • Document Name = lookup on Company or Employee Registration IDs
  • From User = Administrator
  • Email_content = Message content
  • For_user, look up in this order until a user is found:
    • RTI: HR Manager, Accounts Manager, System Manager, Administrator
    • Generic: Accounts Manager, System Manager, Administrator
  • Type = PAYE or CIS
  • Creation date = message date

Recommendations

• Automatic payroll functionality. Creates Payroll Entries, Salary Slips, Bank Entries and Submits RTI FPS automatically
• Function to clean the Activity Log of entries over a certain age

Additional DocTypes and fields (with fieldtype, etc) if any

Doctype	Section	Field	Type	Mandatory	Details
Registration	Head	Document Type	Link	Yes	Company or Employee doctype
Registration	Head	Document Name	Link	Yes	Company or Employee instance
Registration	Head	Type	Select	Yes	e.g. Company Registration, Government ID, Goods and Services Tax, Income Tax, Corporate Tax, Social Insurance Tax, Customs Tax, Excise Tax
Registration	Head	Title	Data	Yes	User defined name
Registration	Data	Value	Data	Yes	Employer Reference = 123/A45678Government Gateway ID = 12-digit numberGovernment Gateway password = textFor authentication. The service generates tokens with 4 hour expiry. Since it is necessary for notifications to be checked (and possibly RTI data submitted) on a schedule unattended, it is necessary to store passwords for automatic token generation.RTI User Key: NINO AB123456C
Registration	Data	Hide Value	Check	No	For hiding password values

Discovery (how will the user find the feature you are building)

• Human Resources -> Payroll Entry button
• Human Resources -> Salary Slip button
• Accounting -> Taxes -> HMRC RTI Employer Payment Summary
• Human Resources -> Payroll -> HMRC RTI Full Payment Submissions
• Human Resources -> Payroll -> HMRC RTI Earlier Year Update
• Human Resources -> Employee -> HMRC RTI NINO Verification Request
• (Maybe also in Integrations for ease of discovery)

Screen Mockups with buttons and any custom UI (TBD)

• Full Payment Submission - none required. Only a link to a filtered list of Activity Logs
• Employer Payment Summary - a page that will allow the user to select a Company, validate mandatory details, complete the relevant recovered amounts and submit
• Earlier Year Update - a page that will allow the user to select a previous FPS submission (parse an Activity Log), amend the values and submit
• NINO Verification Request - a page to select an employee, validate mandatory details and submit

Business Logic

Validations

Company and Employee details required for submissions

Calculations

None

Logs

Activity Log

Links to existing DocTypes

See table above

Reports

None

Rationale

It does not seem necessary to create doctypes for all HMRC functionality because the data is generally stored elsewhere in ERPNext, and for cleanliness, bloat, etc Further information: General HMRC RTI Information HMRC Basic Software Guide HMRC DPS HMRC Transaction Engine

[nameduser0]

Just reading the proposal guidelines and looks like I should request a review. @Anurag810 as HRMS maintainer, could you comment please?

[stale[bot]]

This issue has been automatically marked as inactive because it has not had recent activity and it wasn't validated by maintainer team. It will be closed within a week if no further activity occurs.